Merge branch 'master' into feat_type_contentencoding_bc

Author: Minishlink

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ '8.1', '8.2', '8.3' ]
+        php: [ '8.1', '8.2', '8.3', '8.4' ]
         ext_base: [ 'none, dom, tokenizer, xml, xmlwriter,' ]
         ext_lib: [ 'curl, mbstring, openssl,' ]
         ext_optional: [ '', 'bcmath', 'gmp' ]

README.md

@@ -203,6 +203,7 @@ $defaultOptions = [
     'urgency' => 'normal', // protocol defaults to "normal". (very-low, low, normal, or high)
     'topic' => 'newEvent', // not defined by default. Max. 32 characters from the URL or filename-safe Base64 characters sets
     'batchSize' => 200, // defaults to 1000
+    'contentType' => 'application/json', // defaults to "application/octet-stream"
 ];
 
 // for every notification
@@ -236,6 +237,11 @@ In order to fix this, WebPush sends notifications in batches. The default size i
 to decrease this number. Do this while instantiating WebPush or calling `setDefaultOptions`. Or, if you want to customize this for a specific flush, give
 it as a parameter : `$webPush->flush($batchSize)`.
 
+#### contentType
+
+Sets the "Content-Type" header for HTTP requests with a non-empty payload sent to the push service. 
+Especially newer [Declarative push messages](https://www.w3.org/TR/push-api/#declarative-push-message) require a specific JSON payload, so this should be set to "application/json" in such cases.
+
 ### Server errors
 
 You can see what the browser vendor's server sends back in case it encountered an error (push subscription expiration, wrong parameters...).

composer.json

@@ -33,9 +33,10 @@
     "ext-json": "*",
     "ext-mbstring": "*",
     "ext-openssl": "*",
-    "guzzlehttp/guzzle": "^7.4.5",
-    "web-token/jwt-library": "^3.3.0|^4.0.0",
-    "spomky-labs/base64url": "^2.0.4"
+    "guzzlehttp/guzzle": "^7.9.2",
+    "spomky-labs/base64url": "^2.0.4",
+    "symfony/polyfill-php82": "^v1.31.0",
+    "web-token/jwt-library": "^3.3.0|^4.0.0"
   },
   "suggest": {
     "ext-bcmath": "Optional for performance.",
@@ -44,7 +45,8 @@
   "require-dev": {
     "phpunit/phpunit": "^10.5.44|^11.5.6",
     "phpstan/phpstan": "^2.1.2",
-    "friendsofphp/php-cs-fixer": "^v3.68.5"
+    "friendsofphp/php-cs-fixer": "^v3.91.3",
+    "symfony/polyfill-iconv": "^1.33"
   },
   "autoload": {
     "psr-4": {

phpstan.neon

@@ -4,5 +4,4 @@ parameters:
         - src
     reportUnmatchedIgnoredErrors: false
     ignoreErrors:
-        - '#Unreachable statement \- code above always terminates\.#'
         - identifier: missingType.iterableValue

src/Encryption.php

@@ -47,10 +47,16 @@ public static function padPayload(string $payload, int $maxLengthToPad, ContentE
      * @param string $userPublicKey Base 64 encoded (MIME or URL-safe)
      * @param string $userAuthToken Base 64 encoded (MIME or URL-safe)
      *
-     * @throws \ErrorException
+     * @throws \ErrorException Thrown on php 8.1
+     * @throws \Random\RandomException Thrown on php 8.2 and higher
      */
-    public static function encrypt(string $payload, string $userPublicKey, string $userAuthToken, ContentEncoding $contentEncoding): array
-    {
+    public static function encrypt(
+        string $payload,
+        string $userPublicKey,
+        #[\SensitiveParameter]
+        string $userAuthToken,
+        ContentEncoding $contentEncoding,
+    ): array {
         return self::deterministicEncrypt(
             $payload,
             $userPublicKey,
@@ -67,6 +73,7 @@ public static function encrypt(string $payload, string $userPublicKey, string $u
     public static function deterministicEncrypt(
         string $payload,
         string $userPublicKey,
+        #[\SensitiveParameter]
         string $userAuthToken,
         ContentEncoding $contentEncoding,
         array $localKeyObject,

src/Notification.php

@@ -43,6 +43,7 @@ public function getOptions(array $defaultOptions = []): array
         $options['TTL'] = array_key_exists('TTL', $options) ? $options['TTL'] : $defaultOptions['TTL'];
         $options['urgency'] = array_key_exists('urgency', $options) ? $options['urgency'] : $defaultOptions['urgency'];
         $options['topic'] = array_key_exists('topic', $options) ? $options['topic'] : $defaultOptions['topic'];
+        $options['contentType'] = array_key_exists('contentType', $options) ? $options['contentType'] : $defaultOptions['contentType'];
 
         return $options;
     }

src/VAPID.php

@@ -97,8 +97,15 @@ public static function validate(array $vapid): array
      * @return array Returns an array with the 'Authorization' and 'Crypto-Key' values to be used as headers
      * @throws \ErrorException
      */
-    public static function getVapidHeaders(string $audience, string $subject, string $publicKey, string $privateKey, ContentEncoding $contentEncoding, ?int $expiration = null): array
-    {
+    public static function getVapidHeaders(
+        string $audience,
+        string $subject,
+        string $publicKey,
+        #[\SensitiveParameter]
+        string $privateKey,
+        ContentEncoding $contentEncoding,
+        ?int $expiration = null,
+    ): array {
         $expirationLimit = time() + 43200; // equal margin of error between 0 and 24h
         if (null === $expiration || $expiration > $expirationLimit) {
             $expiration = $expirationLimit;

src/WebPush.php

@@ -235,8 +235,8 @@ protected function createRejectedReport($reason): MessageSentReport
     }
 
     /**
-     * @throws \ErrorException
-     * add back @throws \Random\RandomException when we drop PHP 8.1 support
+     * @throws \ErrorException Thrown on php 8.1
+     * @throws \Random\RandomException Thrown on php 8.2 and higher
      */
     protected function prepare(array $notifications): array
     {
@@ -263,7 +263,7 @@ protected function prepare(array $notifications): array
                 $localPublicKey = $encrypted['localPublicKey'];
 
                 $headers = [
-                    'Content-Type' => 'application/octet-stream',
+                    'Content-Type' => $options['contentType'],
                     'Content-Encoding' => $contentEncoding,
                 ];
 
@@ -384,6 +384,7 @@ public function setDefaultOptions(array $defaultOptions): WebPush
         $this->defaultOptions['topic'] = $defaultOptions['topic'] ?? null;
         $this->defaultOptions['batchSize'] = $defaultOptions['batchSize'] ?? 1000;
         $this->defaultOptions['requestConcurrency'] = $defaultOptions['requestConcurrency'] ?? 100;
+        $this->defaultOptions['contentType'] = $defaultOptions['contentType'] ?? 'application/octet-stream';
 
 
         return $this;