Bump PHP to 8.1-8.4 + Enable BC checker

.github/workflows/bc.yml

@@ -0,0 +1,33 @@
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'phpunit.xml.dist'
+      - 'psalm.xml'
+  push:
+    branches: ['master']
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'phpunit.xml.dist'
+      - 'psalm.xml'
+
+name: backwards compatibility
+
+jobs:
+  roave_bc_check:
+    uses: yiisoft/actions/.github/workflows/bc.yml@master
+    with:
+      os: >-
+        ['ubuntu-latest']
+      php: >-
+        ['8.4']

.github/workflows/build.yml

@@ -10,6 +10,7 @@ on:
       - 'psalm.xml'
 
   push:
+    branches: ['master']
     paths-ignore:
       - 'docs/**'
       - 'README.md'
@@ -24,8 +25,10 @@ name: build
 jobs:
   phpunit:
     uses: yiisoft/actions/.github/workflows/phpunit.yml@master
+    secrets:
+      codecovToken: ${{ secrets.CODECOV_TOKEN }}
     with:
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-
-        ['7.4', '8.0', '8.1']
+        ['8.1', '8.2', '8.3', '8.4']

.github/workflows/mutation.yml

@@ -9,6 +9,7 @@
       - 'psalm.xml'
 
   push:
+    branches: ['master']
     paths-ignore:
       - 'docs/**'
       - 'README.md'
@@ -21,11 +22,11 @@
 
 jobs:
   mutation:
-    uses: yiisoft/actions/.github/workflows/roave-infection.yml@master
+    uses: yiisoft/actions/.github/workflows/infection.yml@master
     with:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.1']
+        ['8.2']
     secrets:
       STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}

.github/workflows/static.yml

@@ -10,6 +10,7 @@ on:
       - 'phpunit.xml.dist'
 
   push:
+    branches: ['master']
     paths-ignore:
       - 'docs/**'
       - 'README.md'
@@ -28,4 +29,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['7.4', '8.0', '8.1']
+        ['8.1', '8.2', '8.3', '8.4']

.gitignore

@@ -23,13 +23,8 @@ composer.phar
 # Mac DS_Store Files
 .DS_Store
 
-# phpunit itself is not needed
-phpunit.phar
-# local phpunit config
+# PhpUnit
+/phpunit.phar
 /phpunit.xml
-# phpunit cache
-.phpunit.result.cache
-
-# Phan
-analysis.txt
+/.phpunit.cache
 

CHANGELOG.md

@@ -2,7 +2,10 @@
 
 ## 1.1.2 under development
 
-- no changes in this release.
+- Chg #44: Bump minimum PHP version to 8.1 (@vjik) 
+- Chg #44: Change PHP constraint in composer.json to `8.1 - 8.4` (@vjik)
+- Enh #44: Add psalm type `int<1, 2147483647>` to `depth` parameter in `JsonParser` constructor (@vjik)
+- Bug #44: Explicitly mark nullable parameters (@vjik)
 
 ## 1.1.1 June 03, 2024
 

composer.json

@@ -29,22 +29,22 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "8.1 - 8.4",
         "ext-json": "*",
-        "psr/container": "^1.0|^2.0",
-        "psr/http-message": "^1.0|^2.0",
+        "psr/container": "^1.0 || ^2.0",
+        "psr/http-message": "^1.0 || ^2.0",
         "psr/http-message-implementation": "1.0",
         "psr/http-server-handler": "^1.0",
         "psr/http-server-middleware": "^1.0",
         "yiisoft/http": "^1.2"
     },
     "require-dev": {
-        "nyholm/psr7": "^1.0",
-        "phpunit/phpunit": "^9.5",
-        "roave/infection-static-analysis-plugin": "^1.16",
-        "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.18",
-        "yiisoft/test-support": "^1.3"
+        "httpsoft/http-message": "^1.1",
+        "infection/infection": "^0.29.8",
+        "phpunit/phpunit": "^10.5.55",
+        "spatie/phpunit-watcher": "^1.24",
+        "vimeo/psalm": "^6.13.1",
+        "yiisoft/test-support": "^3.0.2"
     },
     "autoload": {
         "psr-4": {

docs/internals.md

@@ -10,11 +10,10 @@ The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
 
 ## Mutation testing
 
-The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
-[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
+The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
 
 ```shell
-./vendor/bin/roave-infection-static-analysis-plugin
+./vendor/bin/infection
 ```
 
 ## Static analysis

infection.json.dist

@@ -11,6 +11,11 @@
         }
     },
     "mutators": {
-        "@default": true
+        "@default": true,
+        "IncrementInteger": {
+            "ignoreSourceCodeByRegex": [
+                ".* explode\\(';', \\$contentType, 2\\);$"
+            ]
+        }
     }
 }

phpunit.xml.dist

@@ -1,24 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit backupGlobals="false"
-         colors="true"
-         verbose="true"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="false"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         executionOrder="random"
          failOnRisky="true"
-         failOnWarning="true">
+         failOnWarning="true"
+         stopOnFailure="false"
+         colors="true"
+         displayDetailsOnPhpunitDeprecations="true"
+>
     <php>
         <ini name="error_reporting" value="-1"/>
     </php>
 
     <testsuites>
-        <testsuite name="Yii Request body parsers tests">
+        <testsuite name="Yii Request Body Parser tests">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
 
-    <coverage>
+    <source>
         <include>
-            <directory>./src</directory>
+            <directory suffix=".php">./src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>

psalm.xml

@@ -1,7 +1,10 @@
 <?xml version="1.0"?>
 <psalm
     errorLevel="1"
-    resolveFromConfigFile="true"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+    ensureOverrideAttribute="false"
+    strictBinaryOperands="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
@@ -12,4 +15,7 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+    <issueHandlers>
+        <MixedAssignment errorLevel="suppress" />
+    </issueHandlers>
 </psalm>

src/BadRequestHandler.php

@@ -7,7 +7,6 @@
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
-
 use Yiisoft\Http\Status;
 
 /**
@@ -41,7 +40,7 @@
 
     public function withParserException(ParserException $e): BadRequestHandlerInterface
     {
         $new = clone $this;
         $new->parserException = $e;
         return $new;
     }

src/Parser/JsonParser.php

@@ -18,17 +18,20 @@
 final class JsonParser implements ParserInterface
 {
     private bool $convertToAssociativeArray;
+    /** @psalm-var int<1, 2147483647>  */
     private int $depth;
     private int $options;
 
     /**
      * @param bool $convertToAssociativeArray Whether objects should be converted to associative array during parsing.
      * @param int $depth Maximum JSON recursion depth.
      * @param int $options JSON decoding options. {@see json_decode()}.
+     *
+     * @psalm-param int<1, 2147483647> $depth
      */
     public function __construct(
         bool $convertToAssociativeArray = true,
         int $depth = 512,
         int $options = JSON_THROW_ON_ERROR | JSON_INVALID_UTF8_IGNORE
     ) {
         $this->convertToAssociativeArray = $convertToAssociativeArray;
@@ -43,7 +46,6 @@
         }
 
         try {
-            /** @var mixed $result */
             $result = json_decode($rawBody, $this->convertToAssociativeArray, $this->depth, $this->options);
             if (is_array($result) || is_object($result)) {
                 return $result;

src/ParserException.php

@@ -6,6 +6,8 @@
 
 /**
  * Exception during parsing request.
+ *
+ * @psalm-suppress ClassMustBeFinal We want to allow extending this exception.
  */
 class ParserException extends \RuntimeException
 {

src/RequestBodyParser.php

@@ -44,7 +44,7 @@
     public function __construct(
         ResponseFactoryInterface $responseFactory,
         ContainerInterface $container,
-        BadRequestHandlerInterface $badRequestHandler = null
+        BadRequestHandlerInterface|null $badRequestHandler = null
     ) {
         $this->container = $container;
         $this->badRequestHandler = $badRequestHandler ?? new BadRequestHandler($responseFactory);
@@ -89,7 +89,7 @@
             return $new;
         }
         foreach ($mimeTypes as $mimeType) {
             $this->validateMimeType($mimeType);
             unset($new->parsers[$this->normalizeMimeType($mimeType)]);
         }
         return $new;
@@ -114,7 +114,7 @@
             try {
                 /** @var mixed $parsed */
                 $parsed = $parser->parse((string)$request->getBody());
                 if ($parsed !== null && !is_object($parsed) && !is_array($parsed)) {
                     $parserClass = get_class($parser);
                     throw new RuntimeException(
                         "$parserClass::parse() return value must be an array, an object, or null."
@@ -147,12 +147,12 @@
     private function getContentType(ServerRequestInterface $request): ?string
     {
         $contentType = $request->getHeaderLine(Header::CONTENT_TYPE);
         if (trim($contentType) !== '') {
             if (str_contains($contentType, ';')) {
                 $contentTypeParts = explode(';', $contentType, 2);
                 return strtolower(trim($contentTypeParts[0]));
             }
             return strtolower(trim($contentType));
         }
         return null;
     }

tests/BadRequestHandlerTest.php

@@ -4,11 +4,10 @@
 
 namespace Yiisoft\Request\Body\Tests;
 
-use Nyholm\Psr7\Factory\Psr17Factory;
-use Nyholm\Psr7\ServerRequest;
+use HttpSoft\Message\ResponseFactory;
+use HttpSoft\Message\ServerRequest;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
-use Yiisoft\Http\Method;
 use Yiisoft\Http\Status;
 use Yiisoft\Request\Body\BadRequestHandler;
 
@@ -32,11 +31,11 @@ public function testShouldReturnCorrectErrorInBody(): void
 
     private function createHandler(): BadRequestHandler
     {
-        return new BadRequestHandler(new Psr17Factory());
+        return new BadRequestHandler(new ResponseFactory());
     }
 
     private function createRequest(string $uri = '/'): ServerRequestInterface
     {
-        return new ServerRequest(Method::GET, $uri);
+        return new ServerRequest(uri: $uri);
     }
 }