FIX broker properties default timezone

Author: AymDev

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.1] - 2022-02-15
+### Fixed
+ - **AzureBrokerPropertiesStamp** **DateTime** properties timezones are now set to the current default timezone.
+
 ## [1.1.0] - 2022-02-14
 ### Added
  - **AzureMessageStamp** stamp for sent/received messages with *queue*/*topic* name, message, subscription name and delete location
@@ -17,7 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
  - **Symfony Messenger** transport for **Azure Service Bus** *queues* and *topics*
 
-[Unreleased]: https://github.com/AymDev/MessengerAzureBundle/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/AymDev/MessengerAzureBundle/compare/v1.1.1...HEAD
+[1.1.1]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.1.1
 [1.1.0]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.1.0
 [1.0.0]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.0.0
 

README.md

@@ -59,7 +59,7 @@ framework:
 
 ## Stamps
 
-This transport provides 2 stamps:
+This transport provides a few stamps:
 
 ### AzureMessageStamp
 

src/Messenger/Stamp/AzureBrokerPropertiesStamp.php

@@ -129,28 +129,41 @@ public static function createFromResponse(ResponseInterface $response): self
          * } $properties
          */
         $properties = json_decode($header, true);
+        $defaultTimeZone = new \DateTimeZone(date_default_timezone_get());
+
+        $lockedUntilUtc = null;
+        if (isset($properties['LockedUntilUtc'])) {
+            $lockedUntilUtc = new \DateTimeImmutable($properties['LockedUntilUtc']);
+            $lockedUntilUtc = $lockedUntilUtc->setTimezone($defaultTimeZone);
+        }
+
+        $enqueuedTimeUtc = null;
+        if (isset($properties['EnqueuedTimeUtc'])) {
+            $enqueuedTimeUtc = new \DateTimeImmutable($properties['EnqueuedTimeUtc']);
+            $enqueuedTimeUtc = $enqueuedTimeUtc->setTimezone($defaultTimeZone);
+        }
+
+        $scheduledEnqueueTimeUtc = null;
+        if (isset($properties['ScheduledEnqueueTimeUtc'])) {
+            $scheduledEnqueueTimeUtc = new \DateTimeImmutable($properties['ScheduledEnqueueTimeUtc']);
+            $scheduledEnqueueTimeUtc = $scheduledEnqueueTimeUtc->setTimezone($defaultTimeZone);
+        }
 
         return new self(
             $properties['ContentType'] ?? null,
             $properties['CorrelationId'] ?? null,
             $properties['SessionID'] ?? null,
             $properties['DeliveryCount'] ?? null,
-            isset($properties['LockedUntilUtc'])
-                ? new \DateTimeImmutable($properties['LockedUntilUtc'])
-                : null,
+            $lockedUntilUtc,
             $properties['LockToken'] ?? null,
             $properties['MessageId'] ?? null,
             $properties['Label'] ?? null,
             $properties['ReplyTo'] ?? null,
-            isset($properties['EnqueuedTimeUtc'])
-                ? new \DateTimeImmutable($properties['EnqueuedTimeUtc'])
-                : null,
+            $enqueuedTimeUtc,
             $properties['SequenceNumber'] ?? null,
             $properties['TimeToLive'] ?? null,
             $properties['To'] ?? null,
-            isset($properties['ScheduledEnqueueTimeUtc'])
-                ? new \DateTimeImmutable($properties['ScheduledEnqueueTimeUtc'])
-                : null,
+            $scheduledEnqueueTimeUtc,
             $properties['ReplyToSessionId'] ?? null,
             $properties['PartitionKey'] ?? null
         );

tests/Messenger/Stamp/AzureBrokerPropertiesStampTest.php

@@ -161,6 +161,38 @@ public function testCreateFromResponse(): void
         self::assertSame($partitionKey, $stamp->getPartitionKey());
     }
 
+    /**
+     * The date objects must be set to the current timezone when created from a response
+     */
+    public function testDateTimePropertiesAreSetToCurrentTimeZone(): void
+    {
+        // Expects a GMT+1
+        $sourceTime = 'Sun, 06 Nov 1994 08:49:37 GMT';
+        $expectedTime = '1994-11-06 09:49:37';
+        date_default_timezone_set('Europe/Paris');
+
+        $httpClient = new MockHttpClient([
+            new MockResponse('', [
+                'response_headers' => [
+                    'BrokerProperties' => json_encode([
+                        'LockedUntilUtc' => $sourceTime,
+                        'EnqueuedTimeUtc' => $sourceTime,
+                        'ScheduledEnqueueTimeUtc' => $sourceTime,
+                    ]),
+                ],
+            ])
+        ]);
+
+        $response = $httpClient->request('TEST', '/');
+        $stamp = AzureBrokerPropertiesStamp::createFromResponse($response);
+        self::assertInstanceOf(\DateTimeInterface::class, $stamp->getLockedUntilUtc());
+        self::assertSame($expectedTime, $stamp->getLockedUntilUtc()->format('Y-m-d H:i:s'));
+        self::assertInstanceOf(\DateTimeInterface::class, $stamp->getEnqueuedTimeUtc());
+        self::assertSame($expectedTime, $stamp->getEnqueuedTimeUtc()->format('Y-m-d H:i:s'));
+        self::assertInstanceOf(\DateTimeInterface::class, $stamp->getScheduledEnqueueTimeUtc());
+        self::assertSame($expectedTime, $stamp->getScheduledEnqueueTimeUtc()->format('Y-m-d H:i:s'));
+    }
+
     /**
      * The encoding of the BrokerProperties must encode in JSON, remove null values and format datetimes
      */