Merge pull request #416 from keboola/jv-fix-datetime-format

[internal-api-client] Fix datetime timezone offset format

Author: janvanicek

src/JobFactory/Job.php

@@ -29,6 +29,7 @@ class Job implements JsonSerializable, JobInterface
 {
     private ?DateTimeImmutable $endTime;
     private ?DateTimeImmutable $startTime;
+    private ?DateTimeImmutable $createdTime = null;
     private ?string $tokenDecrypted = null;
     private ?string $executionTokenDecrypted = null;
     private ?array $componentConfigurationDecrypted = null;
@@ -50,21 +51,19 @@ public function __construct(
 
         $this->data['isFinished'] = in_array($this->getStatus(), JobInterface::STATUSES_FINISHED);
         $this->data['parentRunId'] = $this->getParentRunId();
+
         $this->startTime = null;
         $this->endTime = null;
-        try {
-            if (!empty($this->data['startTime'])) {
-                $this->startTime = new DateTimeImmutable($this->data['startTime'], new DateTimeZone('utc'));
-            }
-        } catch (Throwable $e) {
-            // intentionally empty
+
+        if (!empty($this->data['startTime'])) {
+            $this->startTime = $this->data['startTime'] = $this->createNormalizedDatetime($this->data['startTime']);
         }
-        try {
-            if (!empty($this->data['endTime'])) {
-                $this->endTime = new DateTimeImmutable($this->data['endTime'], new DateTimeZone('utc'));
-            }
-        } catch (Throwable $e) {
-            // intentionally empty
+        if (!empty($this->data['endTime'])) {
+            $this->endTime = $this->data['endTime']= $this->createNormalizedDatetime($this->data['endTime']);
+        }
+        if (!empty($this->data['createdTime'])) {
+            $this->createdTime = $this->data['createdTime'] =
+                $this->createNormalizedDatetime($this->data['createdTime']);
         }
     }
 
@@ -420,4 +419,19 @@ private function getStorageClientWrapper(): ClientWrapper
             new ClientOptions(null, $this->getTokenDecrypted(), $this->getBranchId()),
         );
     }
+    public function getCreatedTime(): ?DateTimeImmutable
+    {
+        return $this->createdTime;
+    }
+
+    private function createNormalizedDatetime(string $datetimeString): ?DateTimeImmutable
+    {
+        try {
+            $date = new DateTimeImmutable($datetimeString, new DateTimeZone('utc'));
+            $timezoneOffset = $date->format('P'); // e.g. Z => +00:00
+            return $date->setTimezone(new DateTimeZone($timezoneOffset));
+        } catch (Throwable) {
+            return null;
+        }
+    }
 }

tests/JobFactory/JobTest.php

@@ -4,6 +4,7 @@
 
 namespace Keboola\JobQueueInternalClient\Tests\JobFactory;
 
+use DateTimeImmutable;
 use Keboola\JobQueueInternalClient\Exception\ClientException;
 use Keboola\JobQueueInternalClient\JobFactory;
 use Keboola\JobQueueInternalClient\JobFactory\Job;
@@ -1017,4 +1018,46 @@ public function testGetExecutionTokenDecryptedNoFeature(): void
 
         self::assertSame('token', $executionToken);
     }
+
+    public static function provideDatetimeStrings(): iterable
+    {
+        yield 'endTime - MySQL offset' => [
+            'datetimeString' => '2024-06-11T10:11:37+00:00',
+            'timeField' => 'endTime',
+        ];
+        yield 'endTime - Elastic offset' => [
+            'datetimeString' => '2024-06-11T10:11:37.000Z',
+            'timeField' => 'endTime',
+        ];
+        yield 'startTime - MySQL offset' => [
+            'datetimeString' => '2024-06-11T10:11:37+00:00',
+            'timeField' => 'startTime',
+        ];
+        yield 'startTime - Elastic offset' => [
+            'datetimeString' => '2024-06-11T10:11:37.000Z',
+            'timeField' => 'startTime',
+        ];
+        yield 'createdTime - MySQL offset' => [
+            'datetimeString' => '2024-06-11T10:11:37+00:00',
+            'timeField' => 'createdTime',
+        ];
+        yield 'createdTime - Elastic offset' => [
+            'datetimeString' => '2024-06-11T10:11:37.000Z',
+            'timeField' => 'createdTime',
+        ];
+    }
+
+    /** @dataProvider provideDatetimeStrings */
+    public function testTimeGetters(string $datetimeString, string $timeField): void
+    {
+        $jobData = $this->jobData;
+        $getterMethodName = 'get' . ucfirst($timeField);
+        self::assertNull($this->getJob($jobData)->$getterMethodName());
+
+        $jobData[$timeField] = $datetimeString;
+        $job = $this->getJob($jobData);
+
+        self::assertEquals(new DateTimeImmutable('2024-06-11T10:11:37+00:00'), $job->$getterMethodName());
+        self::assertEquals('+00:00', $job->$getterMethodName()->getTimezone()->getName());
+    }
 }