Improvement: Better PHPStan analysis

Author: michielgerritsen

.github/workflows/phpstan.yml

@@ -14,6 +14,11 @@ jobs:
                 MAGENTO_VERSION: 2.4.6-p4
               - PHP_VERSION: php83-fpm
                 MAGENTO_VERSION: 2.4.7
+              - PHP_VERSION: php83-fpm
+                MAGENTO_VERSION: 2.4.7
+                PHPSTAN_LEVEL: 2
+
+        name: PHP ${{ matrix.PHP_VERSION }} Magento ${{ matrix.MAGENTO_VERSION }}${{ matrix.PHPSTAN_LEVEL && format(' Level {0}', matrix.PHPSTAN_LEVEL) || '' }}
 
         runs-on: ubuntu-latest
         steps:
@@ -35,4 +40,12 @@ jobs:
               run: docker exec magento-project-community-edition ./retry "php bin/magento module:enable Mollie_Payment && php bin/magento setup:upgrade && php bin/magento setup:di:compile"
 
             - name: Run PHPStan
-              run: docker exec magento-project-community-edition /bin/bash -c "./vendor/bin/phpstan analyse --no-progress -c /data/extensions/*/phpstan.neon /data/extensions"
+              continue-on-error: ${{ matrix.PHPSTAN_LEVEL == 2 }}
+              run: |
+                LEVEL_OPTION=""
+
+                if [ -n "${{ matrix.PHPSTAN_LEVEL }}" ]; then
+                  LEVEL_OPTION="--level=${{ matrix.PHPSTAN_LEVEL }}"
+                fi
+
+                docker exec magento-project-community-edition /bin/bash -c "./vendor/bin/phpstan analyse --no-progress $LEVEL_OPTION -c /data/extensions/*/phpstan.neon /data/extensions"

phpstan-baseline.neon

@@ -1,47 +1,46 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Block\\\\Info\\\\Base\\:\\:getOrderId\\(\\) should return string but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\SalesRule\\\\Model\\\\Coupon\\:\\:load\\(\\) method$#"
 			count: 1
-			path: Block/Info/Base.php
+			path: Helper/General.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Controller\\\\Checkout\\\\Process\\:\\:execute\\(\\) should return Magento\\\\Framework\\\\App\\\\ResponseInterface\\|Magento\\\\Framework\\\\Controller\\\\ResultInterface but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\SalesRule\\\\Model\\\\Coupon\\:\\:save\\(\\) method$#"
 			count: 1
-			path: Controller/Checkout/Process.php
+			path: Helper/General.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Controller\\\\Checkout\\\\Redirect\\:\\:execute\\(\\) should return Magento\\\\Framework\\\\App\\\\ResponseInterface\\|Magento\\\\Framework\\\\Controller\\\\ResultInterface but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\Sales\\\\Model\\\\Order\\:\\:save\\(\\) method$#"
 			count: 1
-			path: Controller/Checkout/Redirect.php
+			path: Model/Methods/Reorder.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Controller\\\\Checkout\\\\Restart\\:\\:execute\\(\\) should return Magento\\\\Framework\\\\App\\\\ResponseInterface\\|Magento\\\\Framework\\\\Controller\\\\ResultInterface but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Mollie\\\\Payment\\\\Model\\\\OrderLines\\:\\:load\\(\\) method$#"
 			count: 1
-			path: Controller/Checkout/Restart.php
+			path: Model/OrderLines.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Controller\\\\Checkout\\\\Success\\:\\:execute\\(\\) should return Magento\\\\Framework\\\\App\\\\ResponseInterface\\|Magento\\\\Framework\\\\Controller\\\\ResultInterface but return statement is missing\\.$#"
-			count: 1
-			path: Controller/Checkout/Success.php
+			message: "#^Use service contracts to persist entities in favour of Mollie\\\\Payment\\\\Model\\\\OrderLines\\:\\:save\\(\\) method$#"
+			count: 2
+			path: Model/OrderLines.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Helper\\\\General\\:\\:getBanktransferDueDate\\(\\) should return string\\|false but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\SalesRule\\\\Model\\\\Coupon\\:\\:load\\(\\) method$#"
 			count: 1
-			path: Helper/General.php
+			path: Service/Order/CancelOrder.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Model\\\\Adminhtml\\\\Backend\\\\VerifiyPaymentFee\\:\\:beforeSave\\(\\) should return \\$this\\(Mollie\\\\Payment\\\\Model\\\\Adminhtml\\\\Backend\\\\VerifiyPaymentFee\\) but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\SalesRule\\\\Model\\\\Coupon\\:\\:save\\(\\) method$#"
 			count: 1
-			path: Model/Adminhtml/Backend/VerifiyPaymentFee.php
+			path: Service/Order/CancelOrder.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Model\\\\Methods\\\\Reorder\\:\\:initialize\\(\\) should return \\$this\\(Mollie\\\\Payment\\\\Model\\\\Methods\\\\Reorder\\) but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Mollie\\\\Payment\\\\Model\\\\OrderLines\\:\\:save\\(\\) method$#"
 			count: 1
-			path: Model/Methods/Reorder.php
+			path: Service/Order/Lines/Order.php
 
 		-
-			message: "#^Method Mollie\\\\Payment\\\\Model\\\\Mollie\\:\\:createOrderRefund\\(\\) should return \\$this\\(Mollie\\\\Payment\\\\Model\\\\Mollie\\) but return statement is missing\\.$#"
+			message: "#^Use service contracts to persist entities in favour of Magento\\\\Quote\\\\Model\\\\QuoteIdMask\\:\\:load\\(\\) method$#"
 			count: 1
-			path: Model/Mollie.php
-
+			path: Webapi/PaymentToken.php

phpstan.neon

@@ -14,5 +14,3 @@ parameters:
         - phtml
     excludePaths:
         - Test/*
-        # These fail on Magento 2.2 and that's expected, these are only applicable on Magento 2.3 and higher.
-        - Service/Order/Uncancel/OrderReservation.php