feat: PHP 8.1 support

This patch provides PHP 8.1 support, via the following changes: - Adds `~8.1.0` to the list of allowed PHP versions. - Marks a conflict with symfony/console versions prior to 5.3.11 (first version supporting PHP 8.1) - Replaces usage of `gmstrftime()` with a combination of casting timestamps to `DateTimeImmutable` objects with a GMT timezone, and using `IntlDateFormatter::formatObject()` with an equivalent date/time format to what was used with `gmstrftime()`. - Adds `#[\ReturnTimeWillChange]` attributes to classes implementing `JsonSerialize` to ensure they remain both backwards and forwards compatible. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
mezzio · Dec 1, 2021 · 797dbcd · 797dbcd
1 parent 628721c
commit 797dbcd
Show file tree

Hide file tree

Showing 11 changed files with 188 additions and 140 deletions.
diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
     "extra": {
     },
     "require": {
-        "php": "^7.4 || ~8.0.0",
+        "php": "^7.4 || ~8.0.0 || ~8.1.0",
         "composer/package-versions-deprecated": "^1.11",
         "dflydev/fig-cookies": "^2.0.1 || ^3.0",
         "laminas/laminas-cli": "^0.1.5 || ^1.0",
@@ -48,7 +48,7 @@
         "filp/whoops": "^2.1",
         "laminas/laminas-coding-standard": "~2.2.0",
         "laminas/laminas-servicemanager": "^3.3",
-        "phpunit/phpunit": "^9.3.10",
+        "phpunit/phpunit": "^9.5.5",
         "psalm/plugin-phpunit": "^0.13.0",
         "swoole/ide-helper": "^4.5.5",
         "vimeo/psalm": "^4.0"
@@ -79,7 +79,8 @@
         "test": "phpunit --colors=always",
         "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
     },
-    "replace": {
-        "zendframework/zend-expressive-swoole": "^2.5.0"
+    "conflict": {
+        "symfony/console": "<5.3.11",
+        "zendframework/zend-expressive-swoole": "*"
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,13 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="test/bootstrap.php" colors="true">
-  <coverage processUncoveredFiles="true">
-    <include>
-      <directory suffix=".php">./src</directory>
-    </include>
-  </coverage>
-  <testsuites>
-    <testsuite name="mezzio-swoole">
-      <directory>./test</directory>
-    </testsuite>
-  </testsuites>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="test/bootstrap.php"
+    convertDeprecationsToExceptions="true"
+    colors="true">
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+
+    <testsuites>
+        <testsuite name="mezzio-swoole">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
 </phpunit>
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.12.0@e42bc4a23f67acba28a23bb09c348e2ff38a1d87">
+<files psalm-version="4.13.1@5cf660f63b548ccd4a56f62d916ee4d6028e01a3">
   <file src="src/AbstractStaticResourceHandlerFactory.php">
     <MixedArgument occurrences="3">
       <code>$compressionLevel</code>

diff --git a/src/StaticResourceHandler/LastModifiedMiddleware.php b/src/StaticResourceHandler/LastModifiedMiddleware.php
@@ -9,12 +9,12 @@
 namespace Mezzio\Swoole\StaticResourceHandler;
 
 use DateTimeImmutable;
+use DateTimeZone;
+use IntlDateFormatter;
 use Swoole\Http\Request;
 
 use function filemtime;
-use function gmstrftime;
 use function preg_match;
-use function trim;
 
 class LastModifiedMiddleware implements MiddlewareInterface
 {
@@ -42,7 +42,11 @@ public function __invoke(Request $request, string $filename, callable $next): St
         }
 
         $lastModified          = filemtime($filename) ?: 0;
-        $formattedLastModified = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModified          = new DateTimeImmutable('@' . $lastModified, new DateTimeZone('GMT'));
+        $formattedLastModified = IntlDateFormatter::formatObject(
+            $lastModified,
+            'EEEE dd-MMM-yy HH:mm:ss z'
+        );
 
         $response->addHeader('Last-Modified', $formattedLastModified);
 

diff --git a/src/Task/ServiceBasedTask.php b/src/Task/ServiceBasedTask.php
@@ -9,6 +9,8 @@
 namespace Mezzio\Swoole\Task;
 
 use Psr\Container\ContainerInterface;
+// phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
+use ReturnTypeWillChange;
 use Webmozart\Assert\Assert;
 
 /**
@@ -59,6 +61,7 @@ public function __invoke(ContainerInterface $container)
      *
      * @return array
      */
+    #[ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return [

diff --git a/src/Task/Task.php b/src/Task/Task.php
@@ -9,6 +9,8 @@
 namespace Mezzio\Swoole\Task;
 
 use Psr\Container\ContainerInterface;
+// phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
+use ReturnTypeWillChange;
 use Webmozart\Assert\Assert;
 
 use function array_shift;
@@ -63,6 +65,7 @@ public function __invoke(ContainerInterface $container)
      *
      * @return array
      */
+    #[ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return [

diff --git a/test/FormatTimestampTrait.php b/test/FormatTimestampTrait.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MezzioTest\Swoole;
+
+use DateTimeImmutable;
+use DateTimeZone;
+use IntlDateFormatter;
+
+trait FormatTimestampTrait
+{
+    public function formatTimestamp(int $timestamp): string
+    {
+        $dateTime = new DateTimeImmutable('@' . $timestamp, new DateTimeZone('GMT'));
+        return IntlDateFormatter::formatObject(
+            $dateTime,
+            'EEEE dd-MMM-yy HH:mm:ss z'
+        );
+    }
+}
diff --git a/test/StaticResourceHandler/IntegrationMappedTest.php b/test/StaticResourceHandler/IntegrationMappedTest.php
@@ -20,23 +20,24 @@
 use Mezzio\Swoole\StaticResourceHandler\MethodNotAllowedMiddleware;
 use Mezzio\Swoole\StaticResourceHandler\OptionsMiddleware;
 use Mezzio\Swoole\StaticResourceHandler\StaticResourceResponse;
+use MezzioTest\Swoole\FormatTimestampTrait;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Swoole\Http\Request as SwooleHttpRequest;
 use Swoole\Http\Response as SwooleHttpResponse;
 
 use function filemtime;
 use function filesize;
-use function gmstrftime;
 use function md5_file;
 use function sprintf;
-use function trim;
 
 /**
  * Integraiton tests for StaticMappedResourceHandler
  */
 class IntegrationMappedTest extends TestCase
 {
+    use FormatTimestampTrait;
+
     /**
      * @var FileLocationRepositoryInterface|MockObject
      * @psalm-var MockObject&FileLocationRepositoryInterface
@@ -148,7 +149,7 @@ public function testSendStaticResourceEmitsContentAndHeadersMatchingDirectivesFo
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -200,7 +201,7 @@ public function testSendStaticResourceEmitsHeadersOnlyWhenMatchingDirectivesForH
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -254,7 +255,7 @@ public function testSendStaticResourceEmitsAllowHeaderWithHeadersAndNoBodyWhenMa
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -309,7 +310,7 @@ public function testSendStaticResourceViaGetSkipsClientSideCacheMatchingIfNoETag
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -362,7 +363,7 @@ public function testSendStaticResourceViaHeadSkipsClientSideCacheMatchingIfNoETa
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -565,7 +566,7 @@ public function testSendStaticResourceViaGetHitsClientSideCacheMatchingIfLastMod
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
 
         $request         = $this->createMock(SwooleHttpRequest::class);
         $request->header = [
@@ -613,9 +614,9 @@ public function testGetDoesNotHitClientSideCacheMatchingIfLastModifiedDoesNotMat
         $this->mockFileLocRepo->method('findFile')->with('/content.txt')->willReturn($file);
 
         $lastModified             = filemtime($file);
-        $lastModifiedFormatted    = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted    = $this->formatTimestamp($lastModified);
         $ifModifiedSince          = $lastModified - 3600;
-        $ifModifiedSinceFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $ifModifiedSince));
+        $ifModifiedSinceFormatted = $this->formatTimestamp($ifModifiedSince);
 
         $request         = $this->createMock(SwooleHttpRequest::class);
         $request->header = [

diff --git a/test/StaticResourceHandler/IntegrationTest.php b/test/StaticResourceHandler/IntegrationTest.php
@@ -10,19 +10,20 @@
 
 use Mezzio\Swoole\StaticResourceHandler;
 use Mezzio\Swoole\StaticResourceHandler\StaticResourceResponse;
+use MezzioTest\Swoole\FormatTimestampTrait;
 use PHPUnit\Framework\TestCase;
 use Swoole\Http\Request as SwooleHttpRequest;
 use Swoole\Http\Response as SwooleHttpResponse;
 
 use function filemtime;
 use function filesize;
-use function gmstrftime;
 use function md5_file;
 use function sprintf;
-use function trim;
 
 class IntegrationTest extends TestCase
 {
+    use FormatTimestampTrait;
+
     /**
      * @var string
      * @psalm-var non-empty-string
@@ -117,7 +118,7 @@ public function testSendStaticResourceEmitsContentAndHeadersMatchingDirectivesFo
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -164,7 +165,7 @@ public function testSendStaticResourceEmitsHeadersOnlyWhenMatchingDirectivesForH
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -213,7 +214,7 @@ public function testSendStaticResourceEmitsAllowHeaderWithHeadersAndNoBodyWhenMa
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -263,7 +264,7 @@ public function testSendStaticResourceViaGetSkipsClientSideCacheMatchingIfNoETag
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -311,7 +312,7 @@ public function testSendStaticResourceViaHeadSkipsClientSideCacheMatchingIfNoETa
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
         $etag                  = sprintf('W/"%x-%x"', $lastModified, filesize($file));
 
         $request         = $this->createMock(SwooleHttpRequest::class);
@@ -494,7 +495,7 @@ public function testSendStaticResourceViaGetHitsClientSideCacheMatchingIfLastMod
     {
         $file                  = $this->docRoot . '/content.txt';
         $lastModified          = filemtime($file);
-        $lastModifiedFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted = $this->formatTimestamp($lastModified);
 
         $request         = $this->createMock(SwooleHttpRequest::class);
         $request->header = [
@@ -537,9 +538,9 @@ public function testGetDoesNotHitClientSideCacheMatchingIfLastModifiedDoesNotMat
     {
         $file                     = $this->docRoot . '/content.txt';
         $lastModified             = filemtime($file);
-        $lastModifiedFormatted    = trim(gmstrftime('%A %d-%b-%y %T %Z', $lastModified));
+        $lastModifiedFormatted    = $this->formatTimestamp($lastModified);
         $ifModifiedSince          = $lastModified - 3600;
-        $ifModifiedSinceFormatted = trim(gmstrftime('%A %d-%b-%y %T %Z', $ifModifiedSince));
+        $ifModifiedSinceFormatted = $this->formatTimestamp($ifModifiedSince);
 
         $request         = $this->createMock(SwooleHttpRequest::class);
         $request->header = [

diff --git a/test/StaticResourceHandler/LastModifiedMiddlewareTest.php b/test/StaticResourceHandler/LastModifiedMiddlewareTest.php
@@ -12,17 +12,17 @@
 use Mezzio\Swoole\StaticResourceHandler\LastModifiedMiddleware;
 use Mezzio\Swoole\StaticResourceHandler\StaticResourceResponse;
 use MezzioTest\Swoole\AssertResponseTrait;
+use MezzioTest\Swoole\FormatTimestampTrait;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Swoole\Http\Request;
 
-use function gmstrftime;
 use function time;
-use function trim;
 
 class LastModifiedMiddlewareTest extends TestCase
 {
     use AssertResponseTrait;
+    use FormatTimestampTrait;
 
     /** @var callable */
     private $next;
@@ -82,7 +82,7 @@ public function testMiddlewareCreatesLastModifiedHeaderWhenPathMatchesARegex():
     public function testMiddlewareDisablesContentWhenLastModifiedIsGreaterThanClientExpectation(): void
     {
         $ifModifiedSince = time() + 3600;
-        $ifModifiedSince = trim(gmstrftime('%A %d-%b-%y %T %Z', $ifModifiedSince));
+        $ifModifiedSince = $this->formatTimestamp($ifModifiedSince);
 
         $this->request->server = [
             'request_uri' => '/images/image.png',