RRule: Include set timezone in serialized result

fixes #37
Icinga · Mar 30, 2023 · e22c2de · e22c2de
1 parent 473c3c6
commit e22c2de
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 2 deletions.
diff --git a/src/RRule.php b/src/RRule.php
@@ -5,6 +5,7 @@
 use BadMethodCallException;
 use DateTime;
 use DateTimeInterface;
+use DateTimeZone;
 use Generator;
 use InvalidArgumentException;
 use ipl\Scheduler\Contract\Frequency;
@@ -185,6 +186,8 @@ public function startAt(DateTimeInterface $start): self
         // When the start time contains microseconds, the first recurrence will always be skipped, as
         // the transformer operates only up to seconds level. See also the upstream issue #155
         $startDate->setTime($start->format('H'), $start->format('i'), $start->format('s'));
+        // In case start time uses a different tz than what the rrule internally does, we force it to use the same
+        $startDate->setTimezone(new DateTimeZone($this->rrule->getTimezone()));
 
         $this->rrule->setStartDate($startDate);
 
@@ -277,13 +280,15 @@ public function getNextRecurrences(
     public function jsonSerialize(): array
     {
         $data = [
-            'rrule'     => $this->rrule->getString(),
+            'rrule'     => $this->rrule->getString(RecurrRule::TZ_FIXED),
             'frequency' => $this->frequency
         ];
 
         $start = $this->getStart();
         if ($start) {
-            $data['start'] = $start->format(static::SERIALIZED_DATETIME_FORMAT);
+            $data['start'] = (clone $start)
+                ->setTimezone(new DateTimeZone('UTC'))
+                ->format(static::SERIALIZED_DATETIME_FORMAT);
         }
 
         return $data;

diff --git a/tests/RRuleTest.php b/tests/RRuleTest.php
@@ -156,4 +156,33 @@ public function testJsonSerializeAndDeserialize()
 
         $this->assertEquals($rrule, RRule::fromJson(json_encode($rrule)));
     }
+
+    public function testSerializationAndDeserializationHandleTimezonesCorrectly()
+    {
+        $oldTz = date_default_timezone_get();
+        date_default_timezone_set('Europe/Berlin');
+
+        try {
+            $startWithTz = new DateTime('01-06-2023T12:00:00', new DateTimeZone('America/New_York'));
+            $endWithTz = new DateTime('01-06-2024T07:00:00', new DateTimeZone('America/New_York'));
+
+            $rrule = RRule::fromJson(json_encode(RRule::fromFrequency(RRule::DAILY)
+                ->startAt($startWithTz)
+                ->endAt($endWithTz)
+                ->jsonSerialize()));
+
+            $this->assertSame(
+                '18',
+                $rrule->getStart()->format('H'),
+                'fromJson(jsonSerialize()) does not restore the start date with a timezone correctly'
+            );
+            $this->assertSame(
+                '13',
+                $rrule->getEnd()->format('H'),
+                'fromJson(jsonSerialize()) does not restore the end date with a timezone correctly'
+            );
+        } finally {
+            date_default_timezone_set($oldTz);
+        }
+    }
 }