Handle timezone in publication fields (effective and expires) #1192

cekk · 2021-08-09T14:43:02Z

The failing test is because also if i customize env var, i can't save a DateTime value in that field with the wanted timezone.

Anyone have an idea on how to fix it? @buchi ?

mister-roboto · 2021-08-09T14:43:07Z

@cekk thanks for creating this Pull Request and help improve Plone!

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass.

Whenever you feel that the pull request is ready to be tested, either start all jenkins jobs pull requests by yourself, or simply add a comment in this pull request stating:

@jenkins-plone-org please run jobs

With this simple comment all the jobs will be started automatically.

Happy hacking!

tisto · 2021-08-24T18:58:47Z

@jenkins-plone-org please run jobs

tisto · 2021-08-31T19:48:10Z

@jenkins-plone-org please run jobs

cekk · 2021-10-26T10:44:20Z

@jenkins-plone-org please run jobs

netlify · 2023-04-07T13:59:01Z

✅ Deploy Preview for plone-restapi canceled.

Name	Link
🔨 Latest commit	`7c89fb6`
🔍 Latest deploy log	https://app.netlify.com/sites/plone-restapi/deploys/6682ae32afa2140007f988a8

avoinea · 2023-04-07T14:21:22Z

Holy mother of... this is here for 2 years and nobody took care of it? 😄

I can confirm @cekk 's conclusions from here plone/volto#2597 (comment)

How to test and reproduce:

Start plone backend with TZ env

docker run -it --rm -p 8080:8080 -e TZ="Europe/Berlin" plone/plone-backend

In Volto publish a News items with publishing date and time after a half an hour
In Volto add a listing block showing all news before today
The News should not be listed yet, but it is.
Play with the Publishing Date until the News item disappear from the listing block
Check the portal_catalog entry and you'll notice the EffectiveDate is actually UTC - 2 😱

avoinea · 2023-04-10T17:26:52Z

src/plone/restapi/deserializer/dxfields.py

+        is_publication_field = self.field.interface == IPublication
+        if is_publication_field:
+            # because IPublication datamanager strips timezones
+            tzinfo = pytz.timezone(default_timezone())


@cekk While this is way better than assuming UTC always, it can still have issues if the server has different timezone than the one from registry, UTC for example (the default behavior of plone/plone-backend Docker image).

And I think @sneridagh can confirm that their installations doesn't provide the TZ environment variable to docker containers, thus UTC by default. While the default timezone registry entry when creating a new Plone instance is Europe/Berlin.

How to test:

docker run -it --rm -p 8080:8080 -e SITE=Plone plone/plone-backend bash git clone https://github.com/plone/plone.restapi.git cd plone.restapi git checkout handle_tz_in_publication_fields cd /app bin/pip install -e ./plone.restapi --no-deps ./docker-entrypoint.sh start

Now add a News Item with Effective Date via Volto and check portal_catalog entry.

erral · 2023-08-28T09:22:07Z

We have been hit by this too, and I can confirm that with this changes the original datetime as entered in Volto interface is correctly saved in Plone.

We configure our Zope instance passing the TZ = Europe/Madrid environment variable.

In all cases here, I have Europe/Madrid configured as a default timezone in Plone.

Item saved with the following datetime through Volto: 2023-08-28 10:00:00

Previous scenario (without this branch):

>>> news = app.Plone.komunikazioa.albisteak['albistea-2023-08-28-10-00-00']
>>> news
<FolderishNewsItem at /Plone/komunikazioa/albisteak/albistea-2023-08-28-10-00-00>
>>> value = news.effective()
>>> value
DateTime('2023/08/28 08:00:00 GMT+2')
>>> value = value.asdatetime()
>>> value
datetime.datetime(2023, 8, 28, 8, 0, tzinfo=<StaticTzInfo 'GMT+2'>)

Current scenario (with this branch)

>>> news = app.Plone.komunikazioa.albisteak['albistea-2023-08-28-11-00']
>>> news
<FolderishNewsItem at /Plone/komunikazioa/albisteak/albistea-2023-08-28-11-00>
>>> news.effective()
DateTime('2023/08/28 10:00:00 GMT+2')
>>> news.effective().asdatetime()
datetime.datetime(2023, 8, 28, 10, 0, tzinfo=<StaticTzInfo 'GMT+2'>)

I have made a test without adding the TZ environment variable in the instance configuration and the behavior is the following:

Previous scenario (without this branch)

>>> news = app.Plone.komunikazioa.albisteak['albistea-2023-08-28-12-00']
>>> news
<FolderishNewsItem at /Plone/komunikazioa/albisteak/albistea-2023-08-28-12-00>
>>> value = news.effective()
>>> value
DateTime('2023/08/28 08:00:00 GMT+2')
>>> value.asdatetime()
datetime.datetime(2023, 8, 28, 8, 0, tzinfo=<StaticTzInfo 'GMT+2'>)

Current scenario (with this branch):

>>> news = app.Plone.komunikazioa.albisteak['albistea-2023-08-28-12-00']
>>> newd
<FolderishNewsItem at /Plone/komunikazioa/albisteak/albistea-2023-08-28-12-00>
>>> value = news.effective()
>>> value
DateTime('2023/08/28 10:00:00 GMT+2')
>>> value = value.asdatetime()
>>> value
datetime.datetime(2023, 8, 28, 10, 0, tzinfo=<StaticTzInfo 'GMT+2'>)

stevepiercy · 2024-07-01T13:33:32Z

@tisto @cekk @erral @avoinea @sneridagh can we add this to the Volto Team meeting agenda? This bug has been hanging around for almost 3 years now without resolution. The tests are broken, too.

sneridagh · 2024-07-02T09:12:10Z

@davisagli @jensens @thet related with current dates handling. Aside from the new fixes that we are working on already, we probably will need this patch for now. Are you able to take a look?

jensens

I do not think this nails it. Checking specifically for IPublication is wrong, ugly and is a recipe for harmful future side effects.

The dates of effective/expiration/created/modified are all still Zope DateTime instances - best would to get rid of those and convert to python datetime. But this is lots of work and even if it was planned for 6.0 nobody took time and energy to make it happen. Maybe for 7.0?

One can not rely on it being a Zope Datetime: It could be a Python datetime as well.

To convert Zope DateTime to a Python datetime we have a function pydt in plone.event.utils.
The right way for the serializer is to check if there is a Zope DateTime returned and if so, use pydt to convert it. It's missing_zone parameter passes in a pytz zone to be used, if no timezone is present.

I propose to change this to a generic solution to deal with Zope DateTime instead of covering just one special case here.

claytonc · 2024-09-29T16:47:38Z

Same problem volto version 16.32.1 and plone version 6.0.13, I had to make this correction because the content was not being published on the selected date and time.

…ion_fields

davisagli · 2025-02-12T06:27:13Z

@jenkins-plone-org please run jobs

davisagli · 2025-02-12T06:38:36Z

@cekk @avoinea @erral @stevepiercy @jensens I think I (finally) have this in a state where it can be merged now.

I also tested in a docker container per @avoinea's instructions (thanks, helpful!)

@jensens This is in fact a special case needed for the fields from IPublication, because they use the DCFieldProperty adapter which expects timezone-naive datetimes. It would be cleaner to fix it there, and maybe we can in Plone 6.2 or 7, but I don't think it can be done in a backwards-compatible way. So I'll accept this as a pragmatic workaround in the meantime.

I plan to merge this tomorrow unless someone finds that it is not working correctly.

cekk requested review from buchi and tisto August 9, 2021 14:43

cekk mentioned this pull request Oct 26, 2021

Features that could be removed because already in the core RedTurtle/redturtle.volto#41

Open

3 tasks

avoinea mentioned this pull request Apr 7, 2023

Bug Report: Unexpected "Z" appended to API output #1617

Closed

avoinea requested changes Apr 10, 2023

View reviewed changes

tisto added the 25 status: deferred label Aug 25, 2023

davisagli mentioned this pull request Dec 4, 2023

Cannot set events with a user preferred time zone plone/volto#5324

Open

cekk added 3 commits January 11, 2024 16:04

Fix deserializer/serializer to handle timezone in IPublication fields

8eea75c

fix code-style

49f8812

add changelog

25df696

erral force-pushed the handle_tz_in_publication_fields branch from a6ece0a to 25df696 Compare January 11, 2024 15:04

stevepiercy mentioned this pull request Jan 16, 2024

PLIP #4115: Enhance timezone support in UI for plone.app.event based types plone/Products.CMFPlone#4115

Open

14 tasks

stevepiercy mentioned this pull request Jun 18, 2024

DateTimeWidget uses content language rather than current user's language for format plone/volto#6111

Open

Merge branch 'main' into handle_tz_in_publication_fields

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

Loading
Loading status checks…

7c89fb6

jensens requested changes Jul 4, 2024

View reviewed changes

stevepiercy removed the 25 status: deferred label Feb 9, 2025

davisagli added 3 commits February 10, 2025 21:40

Merge remote-tracking branch 'origin/main' into handle_tz_in_publicat…

Verified

This commit was signed with the committer’s verified signature.

davisagli David Glick

GPG key ID: 8BD25BEDB449C4B0

Verified
Learn about vigilant mode

b5ecb2b

…ion_fields

Make it work

Verified

This commit was signed with the committer’s verified signature.

davisagli David Glick

GPG key ID: 8BD25BEDB449C4B0

Verified
Learn about vigilant mode

Loading
Loading status checks…

4f5c3dd

Fix DateTime patch

Verified

This commit was signed with the committer’s verified signature.

davisagli David Glick

GPG key ID: 8BD25BEDB449C4B0

Verified
Learn about vigilant mode

Loading
Loading status checks…

af0b65b

davisagli merged commit 6e2ab6b into main Feb 13, 2025
24 checks passed

davisagli deleted the handle_tz_in_publication_fields branch February 13, 2025 05:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle timezone in publication fields (effective and expires) #1192

Handle timezone in publication fields (effective and expires) #1192

cekk commented Aug 9, 2021

mister-roboto commented Aug 9, 2021

tisto commented Aug 24, 2021

tisto commented Aug 31, 2021

cekk commented Oct 26, 2021

netlify bot commented Apr 7, 2023 •

edited

Loading

avoinea commented Apr 7, 2023

avoinea Apr 10, 2023

erral commented Aug 28, 2023 •

edited

Loading

stevepiercy commented Jul 1, 2024

sneridagh commented Jul 2, 2024

jensens left a comment •

edited

Loading

claytonc commented Sep 29, 2024

davisagli commented Feb 12, 2025

davisagli commented Feb 12, 2025 •

edited

Loading

Handle timezone in publication fields (effective and expires) #1192

Handle timezone in publication fields (effective and expires) #1192

Conversation

cekk commented Aug 9, 2021

mister-roboto commented Aug 9, 2021

tisto commented Aug 24, 2021

tisto commented Aug 31, 2021

cekk commented Oct 26, 2021

netlify bot commented Apr 7, 2023 • edited Loading

✅ Deploy Preview for plone-restapi canceled.

avoinea commented Apr 7, 2023

avoinea Apr 10, 2023

Choose a reason for hiding this comment

erral commented Aug 28, 2023 • edited Loading

stevepiercy commented Jul 1, 2024

sneridagh commented Jul 2, 2024

jensens left a comment • edited Loading

Choose a reason for hiding this comment

claytonc commented Sep 29, 2024

davisagli commented Feb 12, 2025

davisagli commented Feb 12, 2025 • edited Loading

netlify bot commented Apr 7, 2023 •

edited

Loading

erral commented Aug 28, 2023 •

edited

Loading

jensens left a comment •

edited

Loading

davisagli commented Feb 12, 2025 •

edited

Loading