PHP 8.1 Deprecation fixes (#190)

* Apply changes to avoid PHP deprecations

These changes are introduced to mitigate deprecations from PHP 8.1
and to avoid the lower boundaries test of PHP 8.1 to fail due to
PHPUnit resorting to the use of `$GLOBALS`.

These changes are introduced before the requirement updates to
allow them to be forward and backward compatible.

* Update project requirements

This changes makes the project explicitly compatible with PHP 8.1
and enables testing with that version in the CI.

Additionally, the configuration and requirements of PHPUnit are
updated to be fully compatible with PHP 8.1.

Author: agustingomes

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [ '7.3', '7.4','8.0' ]
+        php: [ '7.3', '7.4', '8.0', '8.1' ]
         stability: [ prefer-lowest, prefer-stable ]
 
     name: PHP ${{ matrix.php }} - ${{ matrix.stability }}

composer.json

@@ -16,13 +16,13 @@
         "source": "https://github.com/messagebird/php-rest-api"
     },
     "require": {
-        "php": ">=7.3|^8.0",
+        "php": ">=7.3|~8.0.0|~8.1.0",
         "ext-curl": "*",
         "ext-json": "*",
         "firebase/php-jwt": "^5.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0|^9.0",
+        "phpunit/phpunit": "^9.5.14",
         "vimeo/psalm": "4.18.1"
     },
     "autoload": {

phpunit.xml.dist

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit backupGlobals="false"
-    backupStaticAttributes="false"
-    colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    processIsolation="false"
-    stopOnFailure="false"
-    bootstrap="autoload.php"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         bootstrap="autoload.php"
 >
     <testsuites>
         <testsuite name="php-rest-api">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+    <coverage>
+        <include>
             <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 </phpunit>

src/MessageBird/Resources/AvailablePhoneNumbers.php

@@ -69,6 +69,10 @@ public function getList(string $countryCode, array $parameters = [])
      */
     private function processRequest(?string $body): Objects\Number
     {
+        if ($body === null) {
+            throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
+        }
+
         try {
             $body = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
         } catch (\JsonException $e) {

src/MessageBird/Resources/Base.php

@@ -117,13 +117,13 @@ public function create($object, ?array $query = null)
      */
     public function processRequest(?string $body)
     {
-        try {
-            $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
-        } catch (\JsonException $e) {
+        if ($body === null) {
             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
         }
 
-        if ($body === null) {
+        try {
+            $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
         }
 

src/MessageBird/Resources/Voice/Base.php

@@ -70,17 +70,17 @@ public function getList($parameters = [])
      */
     public function processRequest(?string $body)
     {
+        if ($body === null) {
+            throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
+        }
+
         try {
             $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
         } catch (\JsonException $e) {
             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
 
         }
 
-        if ($body === null) {
-            throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
-        }
-
         if (empty($body->errors)) {
             return $this->object->loadFromArray($body->data[0]);
         }

src/MessageBird/Resources/Voice/Legs.php

@@ -92,13 +92,13 @@ public function getList(string $callId, array $parameters = [])
      */
     public function processRequest(?string $body): Objects\Voice\Leg
     {
-        try {
-            $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
-        } catch (\JsonException $e) {
+        if ($body === null) {
             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
         }
 
-        if ($body === null) {
+        try {
+            $body = json_decode($body, null, 512, \JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
             throw new Exceptions\ServerException('Got an invalid JSON response from the server.');
         }
 

tests/Unit/RequestValidatorTest.php

@@ -173,27 +173,28 @@ public function __construct($array)
         $this->array = $array;
     }
 
-    function rewind()
+    function rewind(): void
     {
-        return reset($this->array);
+        reset($this->array);
     }
 
-    function current()
+    function current(): array
     {
         return [current($this->array)];
     }
 
+    #[\ReturnTypeWillChange]
     function key()
     {
         return current($this->array)['name'];
     }
 
-    function next()
+    function next(): void
     {
-        return [next($this->array)];
+        next($this->array);
     }
 
-    function valid()
+    function valid(): bool
     {
         return key($this->array) !== null;
     }