Push: Make the APNS environment an enum

move-backend · Jul 22, 2024 · 411c308 · 411c308
1 parent 20008a1
commit 411c308
Show file tree

Hide file tree

Showing 11 changed files with 76 additions and 60 deletions.
diff --git a/ApnsPHP/Environment.php b/ApnsPHP/Environment.php
@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * APNS Environment
+ *
+ * SPDX-FileCopyrightText: Copyright 2024 Move Agency Group B.V., Zwolle, The Netherlands
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+namespace ApnsPHP;
+
+/**
+ * APNS Environment.
+ */
+enum Environment
+{
+    /**
+     * Production environment.
+     */
+    case Production;
+
+    /**
+     * Production environment using alternative port.
+     */
+    case AltProduction;
+
+    /**
+     * Sandbox environment.
+     */
+    case Sandbox;
+
+    /**
+     * Sandbox environment using alternative port.
+     */
+    case AltSandbox;
+
+    /**
+     * Get HTTP URL for a given environment
+     *
+     * @return string The URL to the matching APNS environment
+     */
+    public function getUrl(): string
+    {
+        return match ($this) {
+            Environment::Production    => 'https://api.push.apple.com:443',
+            Environment::AltProduction => 'https://api.push.apple.com:2197',
+            Environment::Sandbox       => 'https://api.sandbox.push.apple.com:443',
+            Environment::AltSandbox    => 'https://api.sandbox.push.apple.com:2197',
+        };
+    }
+}
diff --git a/ApnsPHP/Push.php b/ApnsPHP/Push.php
@@ -26,18 +26,6 @@
  */
 class Push
 {
-    /**
-     * Production environment.
-     * @var int
-     */
-    public const ENVIRONMENT_PRODUCTION = 0;
-
-    /**
-     * Sandbox environment.
-     * @var int
-     */
-    public const ENVIRONMENT_SANDBOX = 1;
-
     /**
      * Device token length.
      * @var int
@@ -82,9 +70,9 @@ class Push
 
     /**
      * Active environment.
-     * @var int
+     * @var Environment
      */
-    protected int $environment;
+    protected Environment $environment;
 
     /**
      * Connect timeout in seconds.
@@ -175,15 +163,6 @@ class Push
      */
     protected int $sendRetryTimes = 3;
 
-    /**
-     * HTTP/2 Service URLs environments.
-     * @var array<int,string>
-     */
-    protected array $HTTPServiceURLs = [
-        'https://api.push.apple.com:443', // Production environment
-        'https://api.development.push.apple.com:443' // Sandbox environment
-    ];
-
     /**
      * Message queue.
      * @var array
@@ -199,17 +178,12 @@ class Push
     /**
      * Constructor.
      *
-     * @param int             $environment             Environment.
+     * @param Environment     $environment             Environment.
      * @param string          $providerCertificateFile Provider certificate file with key (Bundled PEM/P8).
      * @param LoggerInterface $logger                  A Logger implementing PSR-3
      */
-    public function __construct(int $environment, string $providerCertificateFile, LoggerInterface $logger)
+    public function __construct(Environment $environment, string $providerCertificateFile, LoggerInterface $logger)
     {
-        if ($environment != self::ENVIRONMENT_PRODUCTION && $environment != self::ENVIRONMENT_SANDBOX) {
-            throw new Exception(
-                "Invalid environment '{$environment}'"
-            );
-        }
         $this->environment = $environment;
 
         if (!is_readable($providerCertificateFile)) {
@@ -635,7 +609,7 @@ private function httpSend(Message $message, &$reply): bool
             CURLOPT_POST => true,
             CURLOPT_URL => sprintf(
                 '%s/3/device/%s',
-                $this->HTTPServiceURLs[$this->environment],
+                $this->environment->getUrl(),
                 $message->getRecipient()
             ),
             CURLOPT_HTTPHEADER => $headers,

diff --git a/ApnsPHP/Tests/PushHttpSendTest.php b/ApnsPHP/Tests/PushHttpSendTest.php
@@ -10,6 +10,7 @@
 
 namespace ApnsPHP\Tests;
 
+use ApnsPHP\Environment;
 use ApnsPHP\Message\Priority;
 use ApnsPHP\Message\PushType;
 
@@ -64,7 +65,7 @@ public function testHttpSendReturnsFalseOnCurlSessionFail(): void
             return false;
         });
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
         $this->set_reflection_property_value('hSocket', curl_init());
 
         $this->setHttpHeaders();
@@ -110,7 +111,7 @@ public function testHttpSendReturnsFalseOnCurlOptsCannotBeSet(): void
             return 'OpenSSL SSL_read: error:14094415:SSL routines:ssl3_read_bytes:sslv3 alert certificate expired';
         });
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
 
         $this->setHttpHeaders();
 
@@ -152,7 +153,7 @@ public function testHttpSendReturnsFalseOnRequestFail(): void
             return 500;
         });
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
 
         $this->setHttpHeaders();
 
@@ -195,7 +196,7 @@ public function testHttpSendReturnsTrueOnSuccess(): void
             return 200;
         });
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
 
         $this->setHttpHeaders();
 

diff --git a/ApnsPHP/Tests/PushInvalidTest.php b/ApnsPHP/Tests/PushInvalidTest.php
@@ -9,6 +9,7 @@
 
 namespace ApnsPHP\Tests;
 
+use ApnsPHP\Environment;
 use ApnsPHP\Push;
 
 /**
@@ -26,19 +27,6 @@ public function setUp(): void
         $this->logger = $this->getMockBuilder('Psr\Log\LoggerInterface')->getMock();
     }
 
-    /**
-     * Test that trying to instantiate the Push class with an invalid environment throws an exception.
-     *
-     * @covers \ApnsPHP\Push::__construct
-     */
-    public function testConstructWithInvalidEnvironment(): void
-    {
-        $this->expectException('ApnsPHP\Push\Exception');
-        $this->expectExceptionMessage("Invalid environment '3'");
-
-        $this->class = new Push(3, 'server_certificates_bundle_sandbox.pem', $this->logger);
-    }
-
     /**
      * Test that trying to instantiate the Push class with an non-existing provider certificate file
      * throws an exception.
@@ -50,7 +38,7 @@ public function testConstructWithNonExistingProviderCertificateFile(): void
         $this->expectException('ApnsPHP\Push\Exception');
         $this->expectExceptionMessage("Unable to read certificate file 'server_certificates_bundle_invalid.pem'");
 
-        $this->class = new Push(0, 'server_certificates_bundle_invalid.pem', $this->logger);
+        $this->class = new Push(Environment::Production, 'server_certificates_bundle_invalid.pem', $this->logger);
     }
 
     /**
@@ -63,6 +51,6 @@ public function testConstructWithUnreadableProviderCertificateFile(): void
         $this->expectException('ApnsPHP\Push\Exception');
         $this->expectExceptionMessage("Unable to read certificate file 'server_certificates_bundle_unreadable.pem'");
 
-        $this->class = new Push(0, 'server_certificates_bundle_unreadable.pem', $this->logger);
+        $this->class = new Push(Environment::Production, 'server_certificates_bundle_unreadable.pem', $this->logger);
     }
 }
diff --git a/ApnsPHP/Tests/PushSendTest.php b/ApnsPHP/Tests/PushSendTest.php
@@ -10,6 +10,7 @@
 
 namespace ApnsPHP\Tests;
 
+use ApnsPHP\Environment;
 use stdClass;
 
 /**
@@ -82,7 +83,7 @@ public function testSendFailsWithoutRetrying(): void
         ];
         $message = [ 1 => [ 'MESSAGE' => $this->message, 'ERRORS' => [] ] ];
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
         $this->set_reflection_property_value('hSocket', curl_init());
         $this->set_reflection_property_value('messageQueue', $message);
         $this->set_reflection_property_value('logger', $this->logger);
@@ -138,7 +139,7 @@ public function testSendFailsWithRetrying(): void
 
         $message = [ 1 => [ 'MESSAGE' => $this->message, 'ERRORS' => [] ] ];
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
         $this->set_reflection_property_value('hSocket', curl_init());
         $this->set_reflection_property_value('messageQueue', $message);
         $this->set_reflection_property_value('logger', $this->logger);
@@ -213,7 +214,7 @@ public function testSendRemovesWhenNoError(): void
 
         $message = [ 1 => [ 'MESSAGE' => $this->message, 'ERRORS' => [] ] ];
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
         $this->set_reflection_property_value('hSocket', curl_init());
         $this->set_reflection_property_value('messageQueue', $message);
         $this->set_reflection_property_value('logger', $this->logger);
@@ -269,7 +270,7 @@ public function testSendSuccessfullySends(): void
 
         $message = [ 1 => [ 'MESSAGE' => $this->message, 'ERRORS' => [] ] ];
 
-        $this->set_reflection_property_value('environment', 1);
+        $this->set_reflection_property_value('environment', Environment::Sandbox);
         $this->set_reflection_property_value('hSocket', curl_init());
         $this->set_reflection_property_value('messageQueue', $message);
         $this->set_reflection_property_value('logger', $this->logger);

diff --git a/ApnsPHP/Tests/PushTest.php b/ApnsPHP/Tests/PushTest.php
@@ -10,6 +10,7 @@
 
 namespace ApnsPHP\Tests;
 
+use ApnsPHP\Environment;
 use ApnsPHP\Message;
 use ApnsPHP\Push;
 use Lunr\Halo\LunrBaseTest;
@@ -49,7 +50,7 @@ public function setUp(): void
                               ->getMock();
 
         $this->class = new Push(
-            Push::ENVIRONMENT_SANDBOX,
+            Environment::Sandbox,
             'server_certificates_bundle_sandbox.pem',
             $this->logger,
         );

diff --git a/sample_push.php b/sample_push.php
@@ -30,7 +30,7 @@ public function log($level, $message, array $context = []): void
 
 // Instantiate a new ApnsPHP_Push object
 $push = new \ApnsPHP\Push(
-    \ApnsPHP\Push::ENVIRONMENT_SANDBOX,
+    \ApnsPHP\Environment::Sandbox,
     'server_certificates_bundle_sandbox.pem',
     new SampleLogger(),
 );

diff --git a/sample_push_custom.php b/sample_push_custom.php
@@ -30,7 +30,7 @@ public function log($level, $message, array $context = []): void
 
 // Instantiate a new ApnsPHP_Push object
 $push = new \ApnsPHP\Push(
-    \ApnsPHP\Push::ENVIRONMENT_SANDBOX,
+    \ApnsPHP\Environment::Sandbox,
     'server_certificates_bundle_sandbox.pem',
     new SampleLogger(),
 );

diff --git a/sample_push_http.php b/sample_push_http.php
@@ -30,7 +30,7 @@ public function log($level, $message, array $context = []): void
 
 // Instantiate a new ApnsPHP_Push object
 $push = new \ApnsPHP\Push(
-    \ApnsPHP\Push::ENVIRONMENT_SANDBOX,
+    \ApnsPHP\Environment::Sandbox,
     'UniversalPushNotificationClientSSLCertificate.p8',
     new SampleLogger(),
 );

diff --git a/sample_push_many.php b/sample_push_many.php
@@ -33,7 +33,7 @@ public function log($level, $message, array $context = []): void
 
 // Instantiate a new ApnsPHP_Push object
 $push = new \ApnsPHP\Push(
-    \ApnsPHP\Push::ENVIRONMENT_SANDBOX,
+    \ApnsPHP\Environment::Sandbox,
     'server_certificates_bundle_sandbox.pem',
     new SampleLogger(),
 );

diff --git a/sample_push_safari.php b/sample_push_safari.php
@@ -30,7 +30,7 @@ public function log($level, $message, array $context = []): void
 
 // Instantiate a new ApnsPHP_Push object
 $push = new \ApnsPHP\Push(
-    \ApnsPHP\Push::ENVIRONMENT_SANDBOX,
+    \ApnsPHP\Environment::Sandbox,
     'server_certificates_bundle_sandbox.pem',
     new SampleLogger(),
 );