[FIX] Refinery: Handle deprecated DateTimeInterface::RFC7231 format

Author: mjansenDatabay

components/ILIAS/Refinery/src/KindlyTo/Transformation/DateTimeTransformation.php

@@ -39,6 +39,8 @@ class DateTimeTransformation implements Transformation
     use DeriveApplyToFromTransform;
     use DeriveInvokeFromTransform;
 
+    private const string RFC7231 = 'D, d M Y H:i:s \G\M\T';
+
     /**
      * @inheritDoc
      */
@@ -53,7 +55,7 @@ public function transform($from): DateTimeImmutable
             DateTimeInterface::COOKIE,
             DateTimeInterface::ISO8601,
             DateTimeInterface::RFC822,
-            DateTimeInterface::RFC7231,
+            self::RFC7231, // DateTimeInterface::RFC7231 format (deprecated constant in PHP 8.5)
             DateTimeInterface::RFC3339_EXTENDED
         ];
 

components/ILIAS/Refinery/tests/KindlyTo/Transformation/DateTimeTransformationTest.php

@@ -26,6 +26,7 @@
 use ILIAS\Refinery\KindlyTo\Transformation\DateTimeTransformation;
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
+use DateTimeZone;
 
 class DateTimeTransformationTest extends TestCase
 {
@@ -45,6 +46,29 @@ public function testDateTimeISOTransformation(mixed $originVal, DateTimeImmutabl
         $this->assertEquals($expectedVal, $transformedValue);
     }
 
+    /**
+     * @see https://github.com/php/php-src/pull/2450
+     * @see https://github.com/php/php-src/pull/12989
+     */
+    public function testRFC7231ResultsInMisleadingFormattedDateString(): void
+    {
+        $gmt_format = 'D, d M Y H:i:s \G\M\T'; // former DateTimeInterface::RFC7231
+        $test_gmt_date_time = 'Mon, 06 Jul 2020 12:23:05 GMT';
+
+        $exptected = DateTimeImmutable::createFromFormat(
+            $gmt_format,
+            $test_gmt_date_time
+        );
+
+        $actual = $this->transformation->transform($test_gmt_date_time);
+        $this->assertEquals($exptected, $actual);
+
+        $actual = $actual->setTimezone(new DateTimeZone('Europe/Berlin'));
+        // GMT in the provided format is just a string, it does not effect the presented timezone
+        $this->assertSame('Mon, 06 Jul 2020 14:23:05 GMT', $actual->format($gmt_format));
+        $this->assertEquals($exptected, $actual);
+    }
+
     #[DataProvider('TransformationFailureDataProvider')]
     public function testTransformIsInvalid(string $failingValue): void
     {
@@ -57,20 +81,47 @@ public static function DateTimeTransformationDataProvider(): array
         $now = new DateTimeImmutable();
         return [
             'datetime' => [$now, $now],
-            'iso8601' => ['2020-07-06T12:23:05+0000',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::ISO8601, '2020-07-06T12:23:05+0000')],
-            'atom' => ['2020-07-06T12:23:05+00:00',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::ATOM, '2020-07-06T12:23:05+00:00')],
-            'rfc3339_ext' => ['2020-07-06T12:23:05.000+00:00',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::RFC3339_EXTENDED, '2020-07-06T12:23:05.000+00:00')],
-            'cookie' => ['Monday, 06-Jul-2020 12:23:05 GMT+0000',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::COOKIE, 'Monday, 06-Jul-2020 12:23:05 GMT+0000')],
-            'rfc822' => ['Mon, 06 Jul 20 12:23:05 +0000',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::RFC822, 'Mon, 06 Jul 20 12:23:05 +0000')],
-            'rfc7231' => ['Mon, 06 Jul 2020 12:23:05 GMT',
-                DateTimeImmutable::createFromFormat(DateTimeInterface::RFC7231, 'Mon, 06 Jul 2020 12:23:05 GMT')],
-            'unix_timestamp' => [481556262, DateTimeImmutable::createFromFormat(DateTimeInterface::ISO8601, '1985-04-05T13:37:42+0000')],
-            'unix_timestamp_float' => [481556262.4, DateTimeImmutable::createFromFormat(DateTimeInterface::ISO8601, '1985-04-05T13:37:42+0000')]
+            'iso8601' => [
+                '2020-07-06T12:23:05+0000',
+                DateTimeImmutable::createFromFormat(DateTimeInterface::ISO8601, '2020-07-06T12:23:05+0000')
+            ],
+            'atom' => [
+                '2020-07-06T12:23:05+00:00',
+                DateTimeImmutable::createFromFormat(DateTimeInterface::ATOM, '2020-07-06T12:23:05+00:00')
+            ],
+            'rfc3339_ext' => [
+                '2020-07-06T12:23:05.000+00:00',
+                DateTimeImmutable::createFromFormat(
+                    DateTimeInterface::RFC3339_EXTENDED,
+                    '2020-07-06T12:23:05.000+00:00'
+                )
+            ],
+            'cookie' => [
+                'Monday, 06-Jul-2020 12:23:05 GMT+0000',
+                DateTimeImmutable::createFromFormat(DateTimeInterface::COOKIE, 'Monday, 06-Jul-2020 12:23:05 GMT+0000')
+            ],
+            'rfc822' => [
+                'Mon, 06 Jul 20 12:23:05 +0000',
+                DateTimeImmutable::createFromFormat(DateTimeInterface::RFC822, 'Mon, 06 Jul 20 12:23:05 +0000')
+            ],
+            'rfc7231' => [
+                'Mon, 06 Jul 2020 12:23:05 GMT',
+                DateTimeImmutable::createFromFormat('D, d M Y H:i:s \G\M\T', 'Mon, 06 Jul 2020 12:23:05 GMT')
+            ],
+            'unix_timestamp' => [
+                481556262,
+                DateTimeImmutable::createFromFormat(
+                    DateTimeInterface::ISO8601,
+                    '1985-04-05T13:37:42+0000'
+                )
+            ],
+            'unix_timestamp_float' => [
+                481556262.4,
+                DateTimeImmutable::createFromFormat(
+                    DateTimeInterface::ISO8601,
+                    '1985-04-05T13:37:42+0000'
+                )
+            ]
         ];
     }