Let WebPushConfig be more lenient with TTL values

kreait · Jul 9, 2022 · d477a6f · d477a6f
1 parent 63b1a47
commit d477a6f
Show file tree

Hide file tree

Showing 5 changed files with 125 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+### Fixed
+
+* The `WebPushConfig` class is now more lenient with TTL values, and urgencies are checked if they are valid
+  ([#713](https://github.com/kreait/firebase-php/issues/716)
+
 ## [6.6.0] - 2022-07-07
 
 ### Fixed

diff --git a/src/Firebase/Messaging/WebPushConfig.php b/src/Firebase/Messaging/WebPushConfig.php
@@ -5,12 +5,12 @@
 namespace Kreait\Firebase\Messaging;
 
 use JsonSerializable;
+use Kreait\Firebase\Exception\Messaging\InvalidArgument;
 
 /**
  * @see https://tools.ietf.org/html/rfc8030#section-5.3 Web Push Message Urgency
- *
  * @phpstan-type WebPushHeadersShape array{
- *     TTL?: positive-int,
+ *     TTL?: positive-int|numeric-string,
  *     Urgency?: self::URGENCY_*
  * }
  *
@@ -59,6 +59,13 @@ final class WebPushConfig implements JsonSerializable
     private const URGENCY_NORMAL = 'normal';
     private const URGENCY_HIGH = 'high';
 
+    private const VALID_URGENCIES = [
+        self::URGENCY_VERY_LOW,
+        self::URGENCY_LOW,
+        self::URGENCY_NORMAL,
+        self::URGENCY_HIGH,
+    ];
+
     /**
      * @var WebPushConfigShape
      */
@@ -82,9 +89,44 @@ public static function new(): self
      */
     public static function fromArray(array $config): self
     {
+        if (array_key_exists('headers', $config) && is_array($config['headers'])) {
+            $config['headers'] = self::ensureValidHeaders($config['headers']);
+        }
+
         return new self($config);
     }
 
+    /**
+     * @param WebPushHeadersShape $headers
+     *
+     * @return WebPushHeadersShape
+     */
+    private static function ensureValidHeaders(array $headers): array
+    {
+        if (array_key_exists('TTL', $headers) && is_int($headers['TTL'])) {
+            $headers['TTL'] = (string) $headers['TTL'];
+        }
+
+        if (
+            array_key_exists('TTL', $headers)
+            && is_string($headers['TTL'])
+            && preg_match('/^[\-0]/', $headers['TTL']) === 1
+        ) {
+            throw new InvalidArgument('The TTL in the WebPushConfig must must be a positive int');
+        }
+
+        if (array_key_exists('Urgency', $headers)) {
+            if (!in_array($headers['Urgency'], self::VALID_URGENCIES, true)) {
+                throw new InvalidArgument(sprintf(
+                    'The Urgency in the WebPushConfig header must must be one of %s',
+                    implode(',', self::VALID_URGENCIES)
+                ));
+            }
+        }
+
+        return $headers;
+    }
+
     public function withHighUrgency(): self
     {
         return $this->withUrgency(self::URGENCY_HIGH);

diff --git a/tests/Integration/MessagingTest.php b/tests/Integration/MessagingTest.php
@@ -13,10 +13,13 @@
 use Kreait\Firebase\Messaging\CloudMessage;
 use Kreait\Firebase\Messaging\MessageTarget;
 use Kreait\Firebase\Messaging\RawMessageFromArray;
+use Kreait\Firebase\Messaging\WebPushConfig;
 use Kreait\Firebase\Tests\IntegrationTestCase;
 
 /**
  * @internal
+ *
+ * @phpstan-import-type WebPushHeadersShape from WebPushConfig
  */
 final class MessagingTest extends IntegrationTestCase
 {
@@ -381,4 +384,25 @@ public function testAndroidConfigTtlWorksWithValidValues($value): void
 
         $this->addToAssertionCount(1);
     }
+
+    /**
+     * @see https://github.com/kreait/firebase-php/issues/716
+     *
+     * @dataProvider \Kreait\Firebase\Tests\Unit\Messaging\WebPushConfigTest::validHeaders
+     *
+     * @param WebPushHeadersShape $headers
+     */
+    public function testWebPushConfigTtlWorksWithValidValues(array $headers): void
+    {
+        $config = WebPushConfig::fromArray([
+            'headers' => $headers,
+        ]);
+
+        $message = CloudMessage::withTarget(MessageTarget::TOKEN, $this->getTestRegistrationToken())
+            ->withWebPushConfig($config);
+
+        $this->messaging->send($message);
+
+        $this->addToAssertionCount(1);
+    }
 }
diff --git a/tests/Unit/Messaging/AndroidConfigTest.php b/tests/Unit/Messaging/AndroidConfigTest.php
@@ -4,18 +4,21 @@
 
 namespace Kreait\Firebase\Tests\Unit\Messaging;
 
+use Beste\Json;
 use Kreait\Firebase\Exception\Messaging\InvalidArgument;
 use Kreait\Firebase\Messaging\AndroidConfig;
 use Kreait\Firebase\Tests\UnitTestCase;
 
 /**
  * @internal
+ *
+ * @phpstan-import-type AndroidConfigShape from AndroidConfig
  */
 final class AndroidConfigTest extends UnitTestCase
 {
     public function testItIsEmptyWhenItIsEmpty(): void
     {
-        $this->assertSame('[]', \json_encode(AndroidConfig::new()));
+        $this->assertSame('[]', Json::encode(AndroidConfig::new()));
     }
 
     public function testItHasADefaultSound(): void
@@ -27,24 +30,24 @@ public function testItHasADefaultSound(): void
         ];
 
         $this->assertJsonStringEqualsJsonString(
-            \json_encode($expected),
-            \json_encode(AndroidConfig::new()->withDefaultSound())
+            Json::encode($expected),
+            Json::encode(AndroidConfig::new()->withDefaultSound())
         );
     }
 
     public function testItCanHaveAPriority(): void
     {
-        $config = AndroidConfig::new()->withNormalPriority();
+        $config = AndroidConfig::new()->withNormalMessagePriority();
         $this->assertSame('normal', $config->jsonSerialize()['priority']);
 
-        $config = AndroidConfig::new()->withHighPriority();
+        $config = AndroidConfig::new()->withHighMessagePriority();
         $this->assertSame('high', $config->jsonSerialize()['priority']);
     }
 
     /**
      * @dataProvider validDataProvider
      *
-     * @param array<string, array<string, mixed>> $data
+     * @param AndroidConfigShape $data
      */
     public function testItCanBeCreatedFromAnArray(array $data): void
     {
@@ -82,7 +85,7 @@ public function testItRejectsInvalidTtls($ttl): void
     }
 
     /**
-     * @return array<string, array<int, array<string, mixed>>>
+     * @return array<array-key, list<AndroidConfigShape>>
      */
     public function validDataProvider(): array
     {

diff --git a/tests/Unit/Messaging/WebPushConfigTest.php b/tests/Unit/Messaging/WebPushConfigTest.php
@@ -4,11 +4,14 @@
 
 namespace Kreait\Firebase\Tests\Unit\Messaging;
 
+use Kreait\Firebase\Exception\Messaging\InvalidArgument;
 use Kreait\Firebase\Messaging\WebPushConfig;
 use Kreait\Firebase\Tests\UnitTestCase;
 
 /**
  * @internal
+ * @phpstan-import-type WebPushConfigShape from WebPushConfig
+ * @phpstan-import-type WebPushHeadersShape from WebPushConfig
  */
 final class WebPushConfigTest extends UnitTestCase
 {
@@ -17,7 +20,7 @@ final class WebPushConfigTest extends UnitTestCase
      *
      * @param array<string, mixed> $data
      */
-    public function testCreateFromArray(array $data): void
+    public function testCreateFromValidPayload(array $data): void
     {
         $config = WebPushConfig::fromArray($data);
 
@@ -40,7 +43,19 @@ public function testItCanHaveAPriority(): void
     }
 
     /**
-     * @return array<string, array<string, array<string, mixed>>>
+     * @dataProvider invalidHeaders
+     *
+     * @param WebPushHeadersShape $headers
+     */
+    public function testItRejectsInvalidHeaders(array $headers): void
+    {
+        $this->expectException(InvalidArgument::class);
+
+        WebPushConfig::fromArray(['headers' => $headers]);
+    }
+
+    /**
+     * @return array<string, array<WebPushConfigShape>>
      */
     public function validDataProvider(): array
     {
@@ -58,4 +73,29 @@ public function validDataProvider(): array
             ],
         ];
     }
+
+    /**
+     * @return array<string, array<WebPushHeadersShape>>
+     */
+    public function validHeaders(): array
+    {
+        return [
+            'positive int ttl' => [['TTL' => 1]],
+            'positive string ttl' => [['TTL' => '1']],
+        ];
+    }
+
+    /**
+     * @return array<string, array<array<string, mixed>>>
+     */
+    public function invalidHeaders(): array
+    {
+        return [
+            'negative int ttl' => [['TTL' => -1]],
+            'negative string ttl' => [['TTL' => '-1']],
+            'zero int ttl' => [['TTL' => -1]],
+            'zero string ttl' => [['TTL' => '-1']],
+            'unsupported urgency' => [['Urgency' => 'unsupported']],
+        ];
+    }
 }