Replace HTTP status codes with StatusCodeInterface constants

This is a more meaningful, easier to maintain approach.
settermjd · Jan 11, 2025 · 9959f4d · 9959f4d
1 parent aabc83b
commit 9959f4d
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 10 deletions.
diff --git a/config/sample.redirecttonewdomainmiddleware.global.php b/config/sample.redirecttonewdomainmiddleware.global.php
@@ -1,5 +1,7 @@
 <?php
 
+use Fig\Http\Message\StatusCodeInterface;
+
 return [
     "redirect-to-new-domain-middleware" => [
         /**
@@ -18,6 +20,6 @@
          * This is the type of redirect, which can be set to either 301 (the
          * default) or 302.
          */
-        "status" => 301,
+        "status" => StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
     ],
 ];
diff --git a/src/Middleware/RedirectToNewDomainMiddleware.php b/src/Middleware/RedirectToNewDomainMiddleware.php
@@ -4,6 +4,7 @@
 
 namespace Settermjd\Middleware;
 
+use Fig\Http\Message\StatusCodeInterface;
 use Laminas\Diactoros\Response\RedirectResponse;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -23,7 +24,7 @@
  */
 final readonly class RedirectToNewDomainMiddleware implements MiddlewareInterface
 {
-    public const int DEFAULT_STATUS = 301;
+    public const int DEFAULT_STATUS = StatusCodeInterface::STATUS_MOVED_PERMANENTLY;
 
     public function __construct(
         /**
@@ -65,9 +66,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                 ?->debug(sprintf("redirecting to: %s", $newRequestUri));
             return new RedirectResponse(
                 $newRequestUri,
-                ! in_array($this->redirectStatus, [301, 302])
-                    ? self::DEFAULT_STATUS
-                    : $this->redirectStatus
+                ! in_array($this->redirectStatus, [
+                    StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
+                    StatusCodeInterface::STATUS_FOUND,
+                ]) ? self::DEFAULT_STATUS
+                   : $this->redirectStatus
             );
         }
 

diff --git a/test/Middleware/RedirectToNewDomainMiddlewareFactoryTest.php b/test/Middleware/RedirectToNewDomainMiddlewareFactoryTest.php
@@ -4,6 +4,7 @@
 
 namespace Settermjd\MiddlewareTest;
 
+use Fig\Http\Message\StatusCodeInterface;
 use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
@@ -31,7 +32,7 @@ public function testCanInstantiateMiddlewareWithConfigDataWhenSet(): void
                     "redirect-to-new-domain-middleware" => [
                         "old"    => "deploywithdockercompose.com",
                         "new"    => "https://deploywithdockercompose.webdevwithmatt.com",
-                        "status" => 301,
+                        "status" => StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
                     ],
                 ],
                 $this->createMock(LoggerInterface::class),

diff --git a/test/Middleware/RedirectToNewDomainMiddlewareTest.php b/test/Middleware/RedirectToNewDomainMiddlewareTest.php
@@ -4,6 +4,7 @@
 
 namespace Settermjd\MiddlewareTest;
 
+use Fig\Http\Message\StatusCodeInterface;
 use Laminas\Diactoros\Response\EmptyResponse;
 use Laminas\Diactoros\Response\RedirectResponse;
 use Laminas\Diactoros\Uri;
@@ -89,7 +90,7 @@ function ($parameters) use ($invokedCount, $originalRequest, $newRequest) {
 
         self::assertInstanceOf(RedirectResponse::class, $response);
         self::assertSame($newRequest, $response->getHeaderLine("location"));
-        self::assertSame(301, $response->getStatusCode());
+        self::assertSame(StatusCodeInterface::STATUS_MOVED_PERMANENTLY, $response->getStatusCode());
     }
 
     #[TestWith(['https://deploywithdockercompose.webdevwithmatt.com'])]
@@ -157,9 +158,18 @@ public function testLogsRequestedDomainIfLoggerIsPresent(string $originalRequest
         $middleware->process($request, $handler);
     }
 
-    #[TestWith([301, 301])]
-    #[TestWith([302, 302])]
-    #[TestWith([303, 301])]
+    #[TestWith([
+        StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
+        StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
+    ])]
+    #[TestWith([
+        StatusCodeInterface::STATUS_FOUND,
+        StatusCodeInterface::STATUS_FOUND,
+    ])]
+    #[TestWith([
+        StatusCodeInterface::STATUS_SEE_OTHER,
+        StatusCodeInterface::STATUS_MOVED_PERMANENTLY,
+    ])]
     public function testCanSetRedirectStatusCodeTo301Or302(int $desiredStatus, int $actualStatus): void
     {
         $middleware = new RedirectToNewDomainMiddleware(