[TASK] Resolve some psalm issues

jobrouter · May 27, 2020 · fe1568c · fe1568c
1 parent bd02403
commit fe1568c
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 46 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -87,6 +87,6 @@ jobs:
           vendor/bin/psalm --no-progress
       - name: Run infection
         run: |
-          vendor/bin/infection --no-progress --min-msi=94 --threads=4
+          vendor/bin/infection --no-progress --min-msi=93 --threads=4
         env:
           STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
diff --git a/psalm.xml b/psalm.xml
@@ -14,44 +14,6 @@
     </plugins>
 
     <issueHandlers>
-        <LessSpecificReturnType errorLevel="info"/>
-
-        <!-- level 3 issues - slightly lazy code writing, but provably low false-negatives -->
-
-        <DeprecatedMethod errorLevel="info"/>
-        <DeprecatedProperty errorLevel="info"/>
-        <DeprecatedClass errorLevel="info"/>
-        <DeprecatedConstant errorLevel="info"/>
-        <DeprecatedFunction errorLevel="info"/>
-        <DeprecatedInterface errorLevel="info"/>
-        <DeprecatedTrait errorLevel="info"/>
-
-        <InternalMethod errorLevel="info"/>
-        <InternalProperty errorLevel="info"/>
-        <InternalClass errorLevel="info"/>
-
-        <MissingClosureReturnType errorLevel="info"/>
-        <MissingReturnType errorLevel="info"/>
-        <MissingPropertyType errorLevel="info"/>
-        <InvalidDocblock errorLevel="info"/>
-        <MisplacedRequiredParam errorLevel="info"/>
-
-        <PropertyNotSetInConstructor errorLevel="info"/>
-        <MissingConstructor errorLevel="info"/>
-        <MissingClosureParamType errorLevel="info"/>
-        <MissingParamType errorLevel="info"/>
-
-        <RedundantCondition errorLevel="info"/>
-
-        <DocblockTypeContradiction errorLevel="info"/>
-        <RedundantConditionGivenDocblockType errorLevel="info"/>
-
-        <UnresolvableInclude errorLevel="info"/>
-
-        <RawObjectIteration errorLevel="info"/>
-
-        <InvalidStringClass errorLevel="info"/>
-
         <ImpureFunctionCall>
             <errorLevel type="suppress">
                 <!-- str_contains is a false positive -->

diff --git a/src/Client/IncidentsClientDecorator.php b/src/Client/IncidentsClientDecorator.php
@@ -86,6 +86,10 @@ private function buildMultipart(Incident $incident): array
         return \array_merge($multipart, $multipartProcessTableFields, $multipartSubTables);
     }
 
+    /**
+     * @param array<string,mixed> $processTableFields
+     * @return array
+     */
     private function buildProcessTableFieldsForMultipart(array $processTableFields): array
     {
         $multipartProcessTableFields = [];

diff --git a/src/Client/RestClient.php b/src/Client/RestClient.php
@@ -102,7 +102,7 @@ public function authenticate(): void
 
         $this->detectJobRouterVersionFromResponse($response);
 
-        $content = \json_decode($response->getBody()->getContents(), true);
+        $content = (array)\json_decode($response->getBody()->getContents(), true);
 
         if (!isset($content['tokens'][0])) {
             throw new AuthenticationException('Token is unavailable', 1570222016);
@@ -162,7 +162,7 @@ public function request(string $method, string $resource, $data = []): ResponseI
 
         $statusCode = $response->getStatusCode();
         if ($statusCode >= 400) {
-            $content = \json_decode($response->getBody()->getContents(), true);
+            $content = (array)\json_decode($response->getBody()->getContents(), true);
             if (isset($content['errors'])) {
                 $errorMessage .= ': ' . \json_encode($content['errors'], \JSON_UNESCAPED_UNICODE);
             }

diff --git a/src/Middleware/AuthorisationMiddleware.php b/src/Middleware/AuthorisationMiddleware.php
@@ -38,6 +38,10 @@ public function resetToken(): void
         $this->token = null;
     }
 
+    /**
+     * @psalm-suppress MixedInferredReturnType
+     * @psalm-suppress MixedReturnStatement
+     */
     public function handleRequest(RequestInterface $request, callable $next): ?RequestInterface
     {
         if ($this->token) {
@@ -47,6 +51,10 @@ public function handleRequest(RequestInterface $request, callable $next): ?Reque
         return $next($request);
     }
 
+    /**
+     * @psalm-suppress MixedInferredReturnType
+     * @psalm-suppress MixedReturnStatement
+     */
     public function handleResponse(RequestInterface $request, ResponseInterface $response, callable $next): ?ResponseInterface
     {
         return $next($request, $response);

diff --git a/src/Middleware/UserAgentMiddleware.php b/src/Middleware/UserAgentMiddleware.php
@@ -34,6 +34,7 @@ class UserAgentMiddleware implements MiddlewareInterface
 
     public function __construct(string $userAgentAddition = '')
     {
+        /** @psalm-suppress MixedArgument */
         $this->userAgent = \rtrim(
             \sprintf(
                 static::USER_AGENT_TEMPLATE,
@@ -43,13 +44,21 @@ public function __construct(string $userAgentAddition = '')
         );
     }
 
+    /**
+     * @psalm-suppress MixedInferredReturnType
+     * @psalm-suppress MixedReturnStatement
+     */
     public function handleRequest(RequestInterface $request, callable $next): ?RequestInterface
     {
         $request = $request->withHeader('User-Agent', $this->userAgent);
 
         return $next($request);
     }
 
+    /**
+     * @psalm-suppress MixedInferredReturnType
+     * @psalm-suppress MixedReturnStatement
+     */
     public function handleResponse(RequestInterface $request, ResponseInterface $response, callable $next): ?ResponseInterface
     {
         return $next($request, $response);

diff --git a/src/Model/Document.php b/src/Model/Document.php
@@ -20,12 +20,12 @@
 final class Document
 {
     /**
-     * @var array
+     * @var array<string,string>
      */
     private $indexFields = [];
 
     /**
-     * @var array
+     * @var array<string,string>
      */
     private $keywordFields = [];
 

diff --git a/src/Model/Incident.php b/src/Model/Incident.php
@@ -74,12 +74,12 @@ final class Incident
     private $incidentEscalationDate;
 
     /**
-     * @var array
+     * @var array<string,string|int|bool|FileInterface>
      */
     private $processTableFields = [];
 
     /**
-     * @var array
+     * @var array<string,array>
      */
     private $subTables = [];
 
@@ -150,6 +150,7 @@ public function getPriority(): ?int
 
     /**
      * @param int $priority
+     * @psalm-param self::PRIORITY_LOW|self::PRIORITY_NORMAL|self::PRIORITY_HIGH $priority
      * @return $this
      * @throws \InvalidArgumentException
      */

diff --git a/src/Resource/FileStorage.php b/src/Resource/FileStorage.php
@@ -17,7 +17,7 @@
 final class FileStorage implements \Countable, \Iterator
 {
     /**
-     * @var array
+     * @var array<string,FileInterface>
      */
     private $files = [];