Merge branch '4.x' into 4.next

Author: ADmad

.editorconfig

@@ -11,5 +11,8 @@ indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
 
+[*.neon]
+indent_style = tab
+
 [*.js]
 indent_size = 2

.github/dependabot.yml

@@ -3,9 +3,10 @@ updates:
 - package-ecosystem: composer
   directory: "/"
   schedule:
-    interval: daily
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
   open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: phpunit/phpunit
-    versions:
-    - "> 6.0"

.github/workflows/ci.yml

@@ -1,6 +1,5 @@
 name: CI
 
-
 on:
   push:
     branches:
@@ -9,9 +8,12 @@ on:
     branches:
       - '*'
 
+permissions:
+  contents: read
+
 jobs:
   testsuite-linux:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
@@ -34,7 +36,7 @@ jobs:
           POSTGRES_PASSWORD: postgres
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup Service
       if: matrix.db-type == 'mysql'
@@ -58,7 +60,7 @@ jobs:
       run: echo "::set-output name=date::$(date +'%Y-%m')"
 
     - name: Cache composer dependencies
-      uses: actions/cache@v1
+      uses: actions/cache@v3
       with:
         path: ${{ steps.composer-cache.outputs.dir }}
         key: ${{ runner.os }}-composer-${{ steps.key-date.outputs.date }}-${{ hashFiles('composer.json') }}-${{ matrix.prefer-lowest }}
@@ -92,28 +94,32 @@ jobs:
 
     - name: Code Coverage Report
       if: success() && matrix.php-version == '7.4' && matrix.db-type == 'mysql'
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v3
 
   cs-stan:
     name: Coding Standard & Static Analysis
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
         php-version: '7.4'
         extensions: mbstring, intl
         coverage: none
-        tools: psalm:~4.10.0, cs2pr
+        tools: cs2pr
 
     - name: Composer Install
-      run: composer install
+      run: composer stan-setup
 
     - name: Run phpcs
       run: vendor/bin/phpcs --report=checkstyle src/ tests/ | cs2pr
 
     - name: Run psalm
-      run: psalm --output-format=github
+      run: vendor/bin/psalm.phar --output-format=github
+
+    - name: Run phpstan
+      if: always()
+      run: vendor/bin/phpstan.phar analyse --error-format=github

.github/workflows/deploy_docs_4x.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cloning repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 

composer.json

@@ -23,7 +23,7 @@
         "source": "https://github.com/cakephp/debug_kit"
     },
     "require": {
-        "php": ">=7.2",
+        "php": ">=7.4",
         "cakephp/cakephp": "^4.4.0",
         "cakephp/chronos": "^2.0",
         "composer/composer": "^1.3 | ^2.0",
@@ -54,9 +54,16 @@
     "scripts": {
         "cs-check": "phpcs --colors --parallel=16 -p src/ tests/",
         "cs-fix": "phpcbf --colors --parallel=16 -p src/ tests/",
-        "test": "phpunit",
+        "phpstan": "phpstan.phar analyse",
         "psalm": "psalm.phar --show-info=false",
-        "psalm-setup": "cp composer.json composer.backup && composer require --dev psalm/phar:^4.10 && mv composer.backup composer.json"
+        "stan": [
+            "@phpstan",
+            "@psalm"
+        ],
+        "stan-baseline": "phpstan.phar --generate-baseline",
+        "psalm-baseline": "psalm.phar --set-baseline=psalm-baseline.xml",
+        "stan-setup": "cp composer.json composer.backup && composer require --dev symfony/polyfill-php81 phpstan/phpstan:~1.7.0 psalm/phar:~4.23.0 && mv composer.backup composer.json",
+        "test": "phpunit"
     },
     "prefer-stable": true,
     "config": {

docs.Dockerfile

@@ -19,7 +19,7 @@ FROM markstory/cakephp-docs-builder:runtime as runtime
 
 # Configure search index script
 ENV LANGS="en fr ja pt"
-ENV SEARCH_SOURCE="/data/docs"
+ENV SEARCH_SOURCE="/usr/share/nginx/html"
 ENV SEARCH_URL_PREFIX="/debugkit/4"
 
 COPY --from=builder /data/docs /data/docs

phpstan-baseline.neon

@@ -0,0 +1,36 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^PHPDoc type array\\<string, mixed\\>\\|Cake\\\\Cache\\\\CacheEngine of property DebugKit\\\\Cache\\\\Engine\\\\DebugEngine\\:\\:\\$_config is not covariant with PHPDoc type array\\<string, mixed\\> of overridden property Cake\\\\Cache\\\\CacheEngine\\:\\:\\$_config\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Property DebugKit\\\\Cache\\\\Engine\\\\DebugEngine\\:\\:\\$_engine \\(Cake\\\\Cache\\\\CacheEngine\\) in isset\\(\\) is not nullable\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Unreachable statement \\- code above always terminates\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Call to function file_get_contents\\(\\) on a separate line has no effect\\.$#"
+			count: 1
+			path: src/Command/BenchmarkCommand.php
+
+		-
+			message: "#^Method DebugKit\\\\Mailer\\\\Transport\\\\DebugKitTransport\\:\\:send\\(\\) should return array\\{headers\\: string, message\\: string\\} but returns array\\{headers\\: non\\-empty\\-array\\<string\\>, message\\: array\\{text\\: string, html\\: string\\}\\}\\.$#"
+			count: 1
+			path: src/Mailer/Transport/DebugKitTransport.php
+
+		-
+			message: "#^Parameter \\#1 \\$request of method DebugKit\\\\ToolbarService\\:\\:saveData\\(\\) expects Cake\\\\Http\\\\ServerRequest, Psr\\\\Http\\\\Message\\\\ServerRequestInterface given\\.$#"
+			count: 1
+			path: src/Middleware/DebugKitMiddleware.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Locator\\\\LocatorInterface\\:\\:genericInstances\\(\\)\\.$#"
+			count: 1
+			path: src/Panel/SqlLogPanel.php

phpstan.neon

@@ -0,0 +1,13 @@
+includes:
+	- phpstan-baseline.neon
+
+parameters:
+	level: 6
+	checkMissingIterableValueType: false
+	checkGenericClassInNonGenericObjectType: false
+	treatPhpDocTypesAsCertain: false
+	bootstrapFiles:
+		- tests/bootstrap.php
+		- vendor/cakephp/cakephp/src/Core/Exception/CakeException.php
+	paths:
+		- src/

psalm-baseline.xml

@@ -45,11 +45,6 @@
       <code>new $className($config)</code>
     </PropertyTypeCoercion>
   </file>
-  <file src="src/Middleware/DebugKitMiddleware.php">
-    <ArgumentTypeCoercion occurrences="1">
-      <code>$request</code>
-    </ArgumentTypeCoercion>
-  </file>
   <file src="src/Panel/DeprecationsPanel.php">
     <InvalidScalarArgument occurrences="4">
       <code>$pluginName</code>
@@ -66,11 +61,6 @@
       <code>$vendorName</code>
     </InvalidScalarArgument>
   </file>
-  <file src="src/Panel/LogPanel.php">
-    <UndefinedInterfaceMethod occurrences="1">
-      <code>count</code>
-    </UndefinedInterfaceMethod>
-  </file>
   <file src="src/Panel/PanelRegistry.php">
     <LessSpecificImplementedReturnType occurrences="1">
       <code>string|null</code>
@@ -83,16 +73,10 @@
     </UnsafeInstantiation>
   </file>
   <file src="src/Panel/SqlLogPanel.php">
-    <TypeDoesNotContainType occurrences="1">
-      <code>!$connection instanceof ConnectionInterface</code>
-    </TypeDoesNotContainType>
     <UndefinedInterfaceMethod occurrences="1">
       <code>genericInstances</code>
     </UndefinedInterfaceMethod>
   </file>
-  <file src="src/Plugin.php">
-    <InvalidArgument occurrences="1"/>
-  </file>
   <file src="src/View/Helper/ToolbarHelper.php">
     <DeprecatedMethod occurrences="1">
       <code>makeNeatArray</code>

psalm.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    totallyTyped="false"
-    resolveFromConfigFile="true"
+    reportMixedIssues="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"