Fix timezone handling in history endpoint and tests (#1647)

* Fix timezone handling in history endpoint and tests * changelog * lint * Update times in test responses --------- Co-authored-by: Jens W. Klein <jk@kleinundpartner.at>
plone · Jul 14, 2023 · 24f25d7 · 24f25d7
1 parent 8249653
commit 24f25d7
Show file tree

Hide file tree

Showing 40 changed files with 90 additions and 88 deletions.
diff --git a/news/1647.bugfix b/news/1647.bugfix
@@ -0,0 +1 @@
+Fix timezone of dates for revisions in the `@history` service. @davisagli
diff --git a/src/plone/restapi/services/history/get.py b/src/plone/restapi/services/history/get.py
@@ -1,4 +1,5 @@
 from datetime import datetime as dt
+from datetime import timezone
 from plone.app.layout.viewlets.content import ContentHistoryViewlet
 from plone.restapi.bbb import safe_text
 from plone.restapi.interfaces import ISerializeToJson
@@ -71,13 +72,9 @@ def reply(self):
             # Versioning entries use a timestamp,
             # workflow ISO formatted string
             if not isinstance(item["time"], str):
-                # Note that isoformat does not add the Z at the end of the string, The lack of the
-                # timezone specifier causes Intl (and derivative libraries) in the browser not to
-                # use local time, which is considered a bug in applications. Therefore we add the Z
-                # to the end to make sure that the date will be interpreted properly by the client.
-                item["time"] = dt.fromtimestamp(int(item["time"])).strftime(
-                    "%Y-%m-%dT%H:%M:%SZ"
-                )
+                item["time"] = dt.fromtimestamp(
+                    int(item["time"]), tz=timezone.utc
+                ).isoformat(timespec="seconds")
 
             # The create event has an empty 'action', but we like it to say
             # 'Create', alike the transition_title

diff --git a/src/plone/restapi/services/locking/__init__.py b/src/plone/restapi/services/locking/__init__.py
@@ -1,6 +1,7 @@
 """ Locking
 """
 from datetime import datetime
+from datetime import timezone
 from plone import api
 from plone.locking.interfaces import ILockable
 
@@ -20,7 +21,9 @@ def creation_date(timestamp):
     # timezone specifier causes Intl (and derivative libraries) in the browser not to
     # use local time, which is considered a bug in applications. Therefore we add the Z
     # to the end to make sure that the date will be interpreted properly by the client.
-    return datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%dT%H:%M:%SZ")
+    return datetime.fromtimestamp(timestamp, tz=timezone.utc).isoformat(
+        timespec="seconds"
+    )
 
 
 def lock_info(obj):

diff --git a/src/plone/restapi/tests/http-examples/collection.resp b/src/plone/restapi/tests/http-examples/collection.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -96,7 +96,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {
         "@id": "http://localhost:55001/plone/doc1",
         "@type": "Document",

diff --git a/src/plone/restapi/tests/http-examples/collection_fullobjects.resp b/src/plone/restapi/tests/http-examples/collection_fullobjects.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -96,7 +96,7 @@ Content-Type: application/json
             "allow_discussion": false,
             "changeNote": "",
             "contributors": [],
-            "created": "1995-07-31T13:45:00",
+            "created": "1995-07-31T13:45:00+00:00",
             "creators": [
                 "test_user_1_"
             ],
@@ -112,7 +112,7 @@ Content-Type: application/json
                 "locked": false,
                 "stealable": true
             },
-            "modified": "1995-07-31T17:30:00",
+            "modified": "1995-07-31T17:30:00+00:00",
             "next_item": {
                 "@id": "http://localhost:55001/plone/collection",
                 "@type": "Collection",
@@ -178,7 +178,7 @@ Content-Type: application/json
             "allow_discussion": false,
             "changeNote": "",
             "contributors": [],
-            "created": "1995-07-31T13:45:00",
+            "created": "1995-07-31T13:45:00+00:00",
             "creators": [
                 "test_user_1_"
             ],
@@ -194,7 +194,7 @@ Content-Type: application/json
                 "locked": false,
                 "stealable": true
             },
-            "modified": "1995-07-31T17:30:00",
+            "modified": "1995-07-31T17:30:00+00:00",
             "next_item": {
                 "@id": "http://localhost:55001/plone/doc2",
                 "@type": "Document",
@@ -262,7 +262,7 @@ Content-Type: application/json
             "allow_discussion": false,
             "changeNote": "",
             "contributors": [],
-            "created": "1995-07-31T13:45:00",
+            "created": "1995-07-31T13:45:00+00:00",
             "creators": [
                 "test_user_1_"
             ],
@@ -278,7 +278,7 @@ Content-Type: application/json
                 "locked": false,
                 "stealable": true
             },
-            "modified": "1995-07-31T17:30:00",
+            "modified": "1995-07-31T17:30:00+00:00",
             "next_item": {},
             "parent": {
                 "@id": "http://localhost:55001/plone",
@@ -316,7 +316,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {
         "@id": "http://localhost:55001/plone/doc1",
         "@type": "Document",

diff --git a/src/plone/restapi/tests/http-examples/content_get.resp b/src/plone/restapi/tests/http-examples/content_get.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "admin"
     ],
@@ -50,7 +50,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone/folder",

diff --git a/src/plone/restapi/tests/http-examples/content_get_folder.resp b/src/plone/restapi/tests/http-examples/content_get_folder.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -79,7 +79,7 @@ Content-Type: application/json
     "language": "",
     "layout": "listing_view",
     "lock": {},
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "nextPreviousEnabled": false,
     "next_item": {},
     "parent": {

diff --git a/src/plone/restapi/tests/http-examples/content_patch_representation.resp b/src/plone/restapi/tests/http-examples/content_patch_representation.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "admin"
     ],
@@ -50,7 +50,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone/folder",

diff --git a/src/plone/restapi/tests/http-examples/content_post.resp b/src/plone/restapi/tests/http-examples/content_post.resp
@@ -35,7 +35,7 @@ Location: http://localhost:55001/plone/folder/my-document
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "admin"
     ],
@@ -51,7 +51,7 @@ Location: http://localhost:55001/plone/folder/my-document
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone/folder",

diff --git a/src/plone/restapi/tests/http-examples/document.resp b/src/plone/restapi/tests/http-examples/document.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -50,7 +50,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/event.resp b/src/plone/restapi/tests/http-examples/event.resp
@@ -38,7 +38,7 @@ Content-Type: application/json
     "contact_name": null,
     "contact_phone": null,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -57,7 +57,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "open_end": false,
     "parent": {

diff --git a/src/plone/restapi/tests/http-examples/expansion.resp b/src/plone/restapi/tests/http-examples/expansion.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -50,7 +50,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/expansion_expanded.resp b/src/plone/restapi/tests/http-examples/expansion_expanded.resp
@@ -41,7 +41,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -57,7 +57,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/expansion_expanded_full.resp b/src/plone/restapi/tests/http-examples/expansion_expanded_full.resp
@@ -235,7 +235,7 @@ Content-Type: application/json
                     "actor": "test_user_1_",
                     "comments": "",
                     "review_state": "private",
-                    "time": "1995-07-31T17:30:00",
+                    "time": "1995-07-31T17:30:00+00:00",
                     "title": "Private"
                 }
             ],
@@ -261,7 +261,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -277,7 +277,7 @@ Content-Type: application/json
         "locked": false,
         "stealable": true
     },
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/file.resp b/src/plone/restapi/tests/http-examples/file.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -52,7 +52,7 @@ Content-Type: application/json
     "language": "",
     "layout": "file_view",
     "lock": {},
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/folder.resp b/src/plone/restapi/tests/http-examples/folder.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -65,7 +65,7 @@ Content-Type: application/json
     "language": "",
     "layout": "listing_view",
     "lock": {},
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "nextPreviousEnabled": false,
     "next_item": {},
     "parent": {

diff --git a/src/plone/restapi/tests/http-examples/history_get.resp b/src/plone/restapi/tests/http-examples/history_get.resp
@@ -13,7 +13,7 @@ Content-Type: application/json
         },
         "comments": "Initial version",
         "may_revert": true,
-        "time": "1995-07-31T17:30:00Z",
+        "time": "1995-07-31T17:30:00+00:00",
         "transition_title": "Edited",
         "type": "versioning",
         "version": 0
@@ -29,7 +29,7 @@ Content-Type: application/json
         "comments": "",
         "review_state": "private",
         "state_title": "Private",
-        "time": "1995-07-31T18:30:00Z",
+        "time": "1995-07-31T18:30:00+00:00",
         "transition_title": "Create",
         "type": "workflow"
     }

diff --git a/src/plone/restapi/tests/http-examples/image.resp b/src/plone/restapi/tests/http-examples/image.resp
@@ -33,7 +33,7 @@ Content-Type: application/json
     "UID": "SomeUUID000000000000000000000002",
     "allow_discussion": false,
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -111,7 +111,7 @@ Content-Type: application/json
     "language": "",
     "layout": "image_view",
     "lock": {},
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",

diff --git a/src/plone/restapi/tests/http-examples/link.resp b/src/plone/restapi/tests/http-examples/link.resp
@@ -34,7 +34,7 @@ Content-Type: application/json
     "allow_discussion": false,
     "changeNote": "",
     "contributors": [],
-    "created": "1995-07-31T13:45:00",
+    "created": "1995-07-31T13:45:00+00:00",
     "creators": [
         "test_user_1_"
     ],
@@ -47,7 +47,7 @@ Content-Type: application/json
     "language": "",
     "layout": "link_redirect_view",
     "lock": {},
-    "modified": "1995-07-31T17:30:00",
+    "modified": "1995-07-31T17:30:00+00:00",
     "next_item": {},
     "parent": {
         "@id": "http://localhost:55001/plone",