Fix WebPushNotification Shape

kreait · May 22, 2024 · c8785a7 · c8785a7
1 parent 12da466
commit c8785a7
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 24 deletions.
diff --git a/src/Firebase/Messaging/WebPushConfig.php b/src/Firebase/Messaging/WebPushConfig.php
@@ -35,26 +35,24 @@
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Notification/Notification#syntax WebPush Notification Syntax
  *
  * @phpstan-type WebPushNotificationShape array{
- *     title: non-empty-string,
- *     options?: array{
- *         dir?: 'ltr'|'rtl'|'auto',
- *         lang?: string,
- *         badge?: non-empty-string,
- *         body?: non-empty-string,
- *         tag?: non-empty-string,
- *         icon?: non-empty-string,
- *         image?: non-empty-string,
- *         data?: mixed,
- *         vibrate?: list<positive-int>,
- *         renotify?: bool,
- *         requireInteraction?: bool,
- *         actions?: list<array{
- *             action: non-empty-string,
- *             title: non-empty-string,
- *             icon: non-empty-string
- *         }>,
- *         silent?: bool
- *     }
+ *     title: string|null,
+ *     dir?: 'ltr'|'rtl'|'auto',
+ *     lang?: string,
+ *     badge?: non-empty-string,
+ *     body?: non-empty-string,
+ *     tag?: non-empty-string,
+ *     icon?: non-empty-string,
+ *     image?: non-empty-string,
+ *     data?: mixed,
+ *     vibrate?: list<positive-int>,
+ *     renotify?: bool,
+ *     requireInteraction?: bool,
+ *     actions?: list<array{
+ *         action: non-empty-string,
+ *         title: non-empty-string,
+ *         icon: non-empty-string
+ *     }>,
+ *     silent?: bool
  * }
  *
  * @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushconfig WebPush Config Syntax
@@ -142,6 +140,9 @@ public function withUrgency(string $urgency): self
         return $config;
     }
 
+    /**
+     * @return WebPushConfigShape
+     */
     public function jsonSerialize(): array
     {
         // @phpstan-ignore notIdentical.alwaysTrue

diff --git a/tests/Integration/MessagingTest.php b/tests/Integration/MessagingTest.php
@@ -14,6 +14,7 @@
 use Kreait\Firebase\Messaging\WebPushConfig;
 use Kreait\Firebase\Tests\IntegrationTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use PHPUnit\Framework\Attributes\Test;
 
 /**
@@ -395,4 +396,18 @@ public function getAppInstanceForUnknownToken(): void
             throw $e;
         }
     }
+
+    #[Test]
+    #[DoesNotPerformAssertions]
+    public function sendWebPushNotificationWithAnEmptyTitle(): void
+    {
+        $message = CloudMessage::withTarget('token', $this->getTestRegistrationToken())
+            ->withWebPushConfig(WebPushConfig::fromArray([
+                'notification' => [
+                    'title' => '',
+                ],
+            ]));
+
+        $this->messaging->send($message);
+    }
 }
diff --git a/tests/Unit/Messaging/WebPushConfigTest.php b/tests/Unit/Messaging/WebPushConfigTest.php
@@ -34,16 +34,16 @@ public function createFromValidPayload(array $data): void
     public function itCanHaveAPriority(): void
     {
         $config = WebPushConfig::new()->withVeryLowUrgency();
-        $this->assertSame('very-low', $config->jsonSerialize()['headers']['Urgency']);
+        $this->assertSame('very-low', $config->jsonSerialize()['headers']['Urgency'] ?? null);
 
         $config = WebPushConfig::new()->withLowUrgency();
-        $this->assertSame('low', $config->jsonSerialize()['headers']['Urgency']);
+        $this->assertSame('low', $config->jsonSerialize()['headers']['Urgency'] ?? null);
 
         $config = WebPushConfig::new()->withNormalUrgency();
-        $this->assertSame('normal', $config->jsonSerialize()['headers']['Urgency']);
+        $this->assertSame('normal', $config->jsonSerialize()['headers']['Urgency'] ?? null);
 
         $config = WebPushConfig::new()->withHighUrgency();
-        $this->assertSame('high', $config->jsonSerialize()['headers']['Urgency']);
+        $this->assertSame('high', $config->jsonSerialize()['headers']['Urgency'] ?? null);
     }
 
     /**