qa: fixes new Psalm errors due to updating dependencies

- Add laminas-db as a dev requirement, so that Psalm won't error out
- Updates code to remove newly flagged Psalm errors
  - Use assertions instead of `fail()` where possible
  - Add psalm-param annotations where needed
- Adds one item to baseline that cannot be fixed (upstream issue in laminas-servicemanager)

Signed-off-by: Matthew Weier O'Phinney <[email protected]>

Author: weierophinney

composer.json

@@ -36,7 +36,8 @@
         "phpunit/phpunit": "^9.3",
         "vimeo/psalm": "^4.7",
         "psalm/plugin-phpunit": "^0.16.0",
-        "webmozart/assert": "^1.10"
+        "webmozart/assert": "^1.10",
+        "laminas/laminas-db": "^2.13"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.7.3@38c452ae584467e939d55377aaf83b5a26f19dd1">
+<files psalm-version="4.18.1@dda05fa913f4dc6eb3386f2f7ce5a45d37a71bcb">
   <file src="src/Api.php">
     <MissingConstructor occurrences="2">
       <code>$authorization</code>
@@ -103,7 +103,7 @@
       <code>$this-&gt;config['router']['routes'][$config['route_name']]</code>
       <code>$this-&gt;config['router']['routes'][$serviceData['route_name']]</code>
     </MixedArrayOffset>
-    <MixedAssignment occurrences="29">
+    <MixedAssignment occurrences="26">
       <code>$baseOperationData</code>
       <code>$description</code>
       <code>$description</code>
@@ -127,12 +127,9 @@
       <code>$serviceClassName</code>
       <code>$serviceClassName</code>
       <code>$serviceConfig</code>
-      <code>$serviceConfig</code>
       <code>$validatorKey</code>
       <code>$validatorName</code>
       <code>$validators</code>
-      <code>$version</code>
-      <code>$versions[]</code>
     </MixedAssignment>
     <MixedInferredReturnType occurrences="3">
       <code>array</code>
@@ -149,9 +146,6 @@
       <code>$field</code>
       <code>$rpcConfig</code>
     </PossiblyInvalidArgument>
-    <UnusedVariable occurrences="1">
-      <code>$serviceConfig</code>
-    </UnusedVariable>
   </file>
   <file src="src/Controller.php">
     <MixedArgument occurrences="3">
@@ -198,6 +192,9 @@
     <ParamNameMismatch occurrences="1">
       <code>$container</code>
     </ParamNameMismatch>
+    <RedundantConditionGivenDocblockType occurrences="1">
+      <code>$container-&gt;getServiceLocator()</code>
+    </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Factory/ApiFactoryFactory.php">
     <MixedArgument occurrences="3">
@@ -317,10 +314,6 @@
     <DocblockTypeContradiction occurrences="1">
       <code>is_array($code)</code>
     </DocblockTypeContradiction>
-    <InvalidScalarArgument occurrences="2">
-      <code>1</code>
-      <code>1</code>
-    </InvalidScalarArgument>
     <MixedArgument occurrences="2">
       <code>$api</code>
       <code>$api</code>
@@ -336,15 +329,10 @@
     <MixedArrayAccess occurrences="2">
       <code>$api['name']</code>
       <code>$api['versions']</code>
-      <code>$api['versions']</code>
     </MixedArrayAccess>
     <MixedAssignment occurrences="1">
       <code>$api</code>
     </MixedAssignment>
-    <PossiblyNullArgument occurrences="2">
-      <code>var_export($actualCodes, 1)</code>
-      <code>var_export($expectedCodes, 1)</code>
-    </PossiblyNullArgument>
   </file>
   <file src="test/ControllerTest.php">
     <MixedArgument occurrences="1">

psalm-baseline.xml

@@ -9,6 +9,7 @@
 use Laminas\ModuleManager\ModuleManager;
 
 use function array_diff_key;
+use function array_keys;
 use function array_merge;
 use function array_push;
 use function dirname;
@@ -70,7 +71,7 @@ public function createApiList()
                     $serviceConfigs = array_merge($serviceConfigs, $this->config['api-tools-rpc']);
                 }
 
-                foreach ($serviceConfigs as $serviceName => $serviceConfig) {
+                foreach (array_keys($serviceConfigs) as $serviceName) {
                     if (! preg_match($versionRegex, $serviceName, $matches)) {
                         continue;
                     }

src/ApiFactory.php

@@ -97,6 +97,8 @@ protected function setUp(): void
     /**
      * @param int|int[]|string|string[] $expectedCodes
      * @param int[]|string[] $actualCodes
+     * @psalm-param int|string|list<int|string> $expectedCodes
+     * @psalm-param list<int|string> $actualCodes
      */
     public function assertContainsStatusCodes($expectedCodes, array $actualCodes, string $message = ''): void
     {
@@ -118,21 +120,17 @@ public function assertContainsStatusCodes($expectedCodes, array $actualCodes, st
             return true;
         });
 
-        if (empty($expectedCodePairs)) {
-            $this->fail(sprintf(
-                'No codes provided, or no known codes match: %s',
-                var_export($expectedCodes, 1)
-            ));
-        }
+        $this->assertNotEmpty($expectedCodePairs, sprintf(
+            'No codes provided, or no known codes match: %s',
+            var_export($expectedCodes, true)
+        ));
 
         foreach ($expectedCodePairs as $code) {
-            if (! in_array($code, $actualCodes, true)) {
-                $this->fail(sprintf(
-                    "Failed to find code %s in actual codes:\n%s\n",
-                    $code['code'],
-                    var_export($actualCodes, 1)
-                ));
-            }
+            $this->assertContains($code, $actualCodes, sprintf(
+                "Failed to find code %s in actual codes:\n%s\n",
+                $code['code'],
+                var_export($actualCodes, true)
+            ));
         }
     }
 
@@ -196,7 +194,6 @@ public function testCreateRestService(): void
                     break;
                 default:
                     $this->fail('Unexpected HTTP method encountered: ' . $operation->getHttpMethod());
-                    break;
             }
         }
 
@@ -225,7 +222,6 @@ public function testCreateRestService(): void
                     break;
                 default:
                     $this->fail('Unexpected entity HTTP method encountered: ' . $operation->getHttpMethod());
-                    break;
             }
         }
     }
@@ -357,7 +353,6 @@ public function testCreateRpcService(): void
                     break;
                 default:
                     $this->fail('Unexpected HTTP method encountered: ' . $operation->getHttpMethod());
-                    break;
             }
         }
     }