Warning the user about the usage of timezone without offset

Author: bigmontz

packages/bolt-connection/src/bolt/bolt-protocol-v1.js

@@ -87,7 +87,7 @@ export default class BoltProtocol {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v2.js

@@ -37,7 +37,7 @@ export default class BoltProtocol extends BoltProtocolV1 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v3.js

@@ -48,7 +48,7 @@ export default class BoltProtocol extends BoltProtocolV2 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x0.js

@@ -46,7 +46,7 @@ export default class BoltProtocol extends BoltProtocolV3 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x1.js

@@ -67,7 +67,7 @@ export default class BoltProtocol extends BoltProtocolV4 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x2.js

@@ -34,7 +34,7 @@ export default class BoltProtocol extends BoltProtocolV41 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x3.js

@@ -37,7 +37,7 @@ export default class BoltProtocol extends BoltProtocolV42 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v4x4.js

@@ -37,7 +37,7 @@ export default class BoltProtocol extends BoltProtocolV43 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v5x0.js

@@ -34,7 +34,7 @@ export default class BoltProtocol extends BoltProtocolV44 {
 
   get transformer () {
     if (this._transformer === undefined) {
-      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config)))
+      this._transformer = new Transformer(Object.values(transformersFactories).map(create => create(this._config, this._log)))
     }
     return this._transformer
   }

packages/bolt-connection/src/bolt/bolt-protocol-v5x0.utc.transformer.js

@@ -43,7 +43,7 @@ const DATE_TIME_WITH_ZONE_OFFSET_STRUCT_SIZE = 3
 const DATE_TIME_WITH_ZONE_ID = 0x69
 const DATE_TIME_WITH_ZONE_ID_STRUCT_SIZE = 3
 
-function createDateTimeWithZoneIdTransformer (config) {
+function createDateTimeWithZoneIdTransformer (config, logger) {
   const { disableLosslessIntegers, useBigInt } = config
   const dateTimeWithZoneIdTransformer = v4x4.createDateTimeWithZoneIdTransformer(config)
   return dateTimeWithZoneIdTransformer.extendsWith({
@@ -86,6 +86,12 @@ function createDateTimeWithZoneIdTransformer (config) {
       const offset = value.timeZoneOffsetSeconds != null
         ? value.timeZoneOffsetSeconds
         : getOffsetFromZoneId(value.timeZoneId, epochSecond, value.nanosecond)
+
+      if (value.timeZoneOffsetSeconds == null) {
+        logger.warn('DateTime objects without "timeZoneOffsetSeconds" property ' +
+        'are prune to bugs related to ambiguous times. For instance, ' +
+        '2022-10-30T2:30:00[Europe/Berlin] could be GMT+1 or GMT+2.')
+      }
       const utc = epochSecond.subtract(offset)
 
       const nano = int(value.nanosecond)

packages/bolt-connection/test/bolt/bolt-protocol-v5x0.test.js

@@ -44,7 +44,8 @@ const WRITE = 'WRITE'
 
 const {
   txConfig: { TxConfig },
-  bookmarks: { Bookmarks }
+  bookmarks: { Bookmarks },
+  logger: { Logger }
 } = internal
 
 describe('#unit BoltProtocolV5x0', () => {
@@ -517,12 +518,15 @@ describe('#unit BoltProtocolV5x0', () => {
       ]
     ])('should pack and unpack DateTimeWithZoneId and without offset (%s)', (_, object) => {
       const buffer = alloc(256)
+      const loggerFunction = jest.fn()
       const protocol = new BoltProtocolV5x0(
         new utils.MessageRecordingConnection(),
         buffer,
         {
           disableLosslessIntegers: true
-        }
+        },
+        undefined,
+        new Logger('debug', loggerFunction)
       )
 
       const packable = protocol.packable(object)
@@ -547,6 +551,12 @@ describe('#unit BoltProtocolV5x0', () => {
         unpacked.timeZoneId
       )
 
+      expect(loggerFunction)
+        .toBeCalledWith('warn',
+          'DateTime objects without "timeZoneOffsetSeconds" property ' +
+          'are prune to bugs related to ambiguous times. For instance, ' +
+          '2022-10-30T2:30:00[Europe/Berlin] could be GMT+1 or GMT+2.')
+
       expect(unpackedDateTimeWithoutOffset).toEqual(object)
     })
   })