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

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

Author: janvanicek

src/JobFactory/Job.php

@@ -10,7 +10,6 @@
 use JsonSerializable;
 use Keboola\JobQueueInternalClient\Exception\ClientException;
 use Keboola\JobQueueInternalClient\JobFactory;
-use Keboola\JobQueueInternalClient\JobFactory\JobObjectEncryptor;
 use Keboola\JobQueueInternalClient\JobFactory\Runtime\Backend;
 use Keboola\JobQueueInternalClient\JobFactory\Runtime\Executor;
 use Keboola\JobQueueInternalClient\Result\JobMetrics;
@@ -27,8 +26,8 @@
 
 class Job implements JsonSerializable, JobInterface
 {
-    private ?DateTimeImmutable $endTime;
-    private ?DateTimeImmutable $startTime;
+    private ?DateTimeImmutable $endTime = null;
+    private ?DateTimeImmutable $startTime = null;
     private ?DateTimeImmutable $createdTime = null;
     private ?string $tokenDecrypted = null;
     private ?string $executionTokenDecrypted = null;
@@ -52,18 +51,17 @@ public function __construct(
         $this->data['isFinished'] = in_array($this->getStatus(), JobInterface::STATUSES_FINISHED);
         $this->data['parentRunId'] = $this->getParentRunId();
 
-        $this->startTime = null;
-        $this->endTime = null;
-
         if (!empty($this->data['startTime'])) {
-            $this->startTime = $this->data['startTime'] = $this->createNormalizedDatetime($this->data['startTime']);
+            $this->startTime = new DateTimeImmutable($this->data['startTime'], new DateTimeZone('utc'));
+            $this->data['startTime'] = $this->startTime->format('c');
         }
         if (!empty($this->data['endTime'])) {
-            $this->endTime = $this->data['endTime']= $this->createNormalizedDatetime($this->data['endTime']);
+            $this->endTime = new DateTimeImmutable($this->data['endTime'], new DateTimeZone('utc'));
+            $this->data['endTime'] = $this->endTime->format('c');
         }
         if (!empty($this->data['createdTime'])) {
-            $this->createdTime = $this->data['createdTime'] =
-                $this->createNormalizedDatetime($this->data['createdTime']);
+            $this->createdTime = new DateTimeImmutable($this->data['createdTime'], new DateTimeZone('utc'));
+            $this->data['createdTime'] = $this->createdTime->format('c');
         }
     }
 
@@ -423,15 +421,4 @@ 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

@@ -20,6 +20,7 @@
 use Keboola\StorageApiBranch\Factory\StorageClientPlainFactory;
 use RuntimeException;
 use Symfony\Component\Uid\Uuid;
+use Throwable;
 
 class JobTest extends BaseTest
 {
@@ -1019,45 +1020,81 @@ public function testGetExecutionTokenDecryptedNoFeature(): void
         self::assertSame('token', $executionToken);
     }
 
-    public static function provideDatetimeStrings(): iterable
+    public static function provideValidDatetimeStrings(): iterable
     {
         yield 'endTime - MySQL offset' => [
             'datetimeString' => '2024-06-11T10:11:37+00:00',
-            'timeField' => 'endTime',
+            'datetimeField' => 'endTime',
         ];
         yield 'endTime - Elastic offset' => [
             'datetimeString' => '2024-06-11T10:11:37.000Z',
-            'timeField' => 'endTime',
+            'datetimeField' => 'endTime',
         ];
         yield 'startTime - MySQL offset' => [
             'datetimeString' => '2024-06-11T10:11:37+00:00',
-            'timeField' => 'startTime',
+            'datetimeField' => 'startTime',
         ];
         yield 'startTime - Elastic offset' => [
             'datetimeString' => '2024-06-11T10:11:37.000Z',
-            'timeField' => 'startTime',
+            'datetimeField' => 'startTime',
         ];
         yield 'createdTime - MySQL offset' => [
             'datetimeString' => '2024-06-11T10:11:37+00:00',
-            'timeField' => 'createdTime',
+            'datetimeField' => 'createdTime',
         ];
         yield 'createdTime - Elastic offset' => [
             'datetimeString' => '2024-06-11T10:11:37.000Z',
-            'timeField' => 'createdTime',
+            'datetimeField' => 'createdTime',
         ];
     }
 
-    /** @dataProvider provideDatetimeStrings */
-    public function testTimeGetters(string $datetimeString, string $timeField): void
+    /** @dataProvider provideValidDatetimeStrings */
+    public function testDatetimeFields(string $datetimeString, string $datetimeField): void
     {
         $jobData = $this->jobData;
-        $getterMethodName = 'get' . ucfirst($timeField);
-        self::assertNull($this->getJob($jobData)->$getterMethodName());
+        $fieldGetterName = 'get' . ucfirst($datetimeField);
+        self::assertNull($this->getJob($jobData)->$fieldGetterName());
 
-        $jobData[$timeField] = $datetimeString;
+        $jobData[$datetimeField] = $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());
+        self::assertEquals(new DateTimeImmutable('2024-06-11T10:11:37+00:00'), $job->$fieldGetterName());
+        self::assertEquals('2024-06-11T10:11:37+00:00', $job->jsonSerialize()[$datetimeField]);
+    }
+
+    public static function provideDatetimeFields(): iterable
+    {
+        yield 'endTime' => ['datetimeField' => 'endTime'];
+        yield 'startTime' => ['datetimeField' => 'startTime'];
+        yield 'createdTime' => ['datetimeField' => 'createdTime'];
+    }
+
+    /** @dataProvider provideDatetimeFields */
+    public function testDatetimeFieldsEmpty(string $datetimeField): void
+    {
+        $jobData = $this->jobData;
+        $fieldGetterName = 'get' . ucfirst($datetimeField);
+        self::assertNull($this->getJob($jobData)->$fieldGetterName());
+
+        $jobData[$datetimeField] = null;
+        $job = $this->getJob($jobData);
+
+        self::assertNull($job->$fieldGetterName());
+        self::assertNull($job->jsonSerialize()[$datetimeField]);
+    }
+
+    /** @dataProvider provideDatetimeFields */
+    public function testDatetimeFieldsException(string $datetimeField): void
+    {
+        $jobData = $this->jobData;
+        $fieldGetterName = 'get' . ucfirst($datetimeField);
+        self::assertNull($this->getJob($jobData)->$fieldGetterName());
+
+        $jobData[$datetimeField] = 'invalid datetime string';
+
+        self::expectException(Throwable::class);
+        self::expectExceptionMessage('Failed to parse time string');
+
+        $this->getJob($jobData);
     }
 }