Fix or suppress Psalm 6 issues

Author: trowski

psalm.xml

@@ -23,6 +23,12 @@
             </errorLevel>
         </MissingClosureReturnType>
 
+        <PossiblyUnusedMethod>
+            <errorLevel type="suppress">
+                <directory name="src"/>
+            </errorLevel>
+        </PossiblyUnusedMethod>
+
         <PropertyNotSetInConstructor>
             <errorLevel type="suppress">
                 <file name="src/Driver/Http1Driver.php"/>
@@ -35,5 +41,17 @@
                 <directory name="src" />
             </errorLevel>
         </RiskyTruthyFalsyComparison>
+
+        <UnusedClass>
+            <errorLevel type="suppress">
+                <directory name="src"/>
+            </errorLevel>
+        </UnusedClass>
+
+        <UnusedClosureParam>
+            <errorLevel type="suppress">
+                <directory name="examples"/>
+            </errorLevel>
+        </UnusedClosureParam>
     </issueHandlers>
 </psalm>

src/ClientException.php

@@ -18,6 +18,8 @@
  *
  * Responses returned by request handlers after a ClientException has been thrown will be ignored, as a response has
  * already been generated by the error handler.
+ *
+ * @psalm-suppress ClassMustBeFinal
  */
 class ClientException extends StreamException
 {

src/DefaultErrorHandler.php

@@ -19,6 +19,7 @@ public function handleError(int $status, ?string $reason = null, ?Request $reque
     {
         self::$errorHtml ??= \file_get_contents(\dirname(__DIR__) . "/resources/error.html");
 
+        /** @psalm-suppress PossiblyFalseArgument */
         $body = self::$cache[$status] ??= \str_replace(
             ["{code}", "{reason}"],
             // Using standard reason in HTML for caching purposes.

src/Driver/Http1Driver.php

@@ -78,6 +78,9 @@ public function __construct(
         $this->deferredCancellation = new DeferredCancellation();
     }
 
+    /**
+     * @psalm-suppress UnusedVariable
+     */
     #[\Override]
     public function handleClient(
         Client $client,
@@ -156,7 +159,10 @@ public function handleClient(
                     throw new ClientException($this->client, "Bad Request: invalid request line", HttpStatus::BAD_REQUEST);
                 }
 
-                /** @var non-empty-list<non-empty-string> $matches */
+                /**
+                 * @psalm-suppress UnnecessaryVarAnnotation
+                 * @var non-empty-list<non-empty-string> $matches
+                 */
                 [$startLine, $method, $target, $protocol] = $matches;
                 $rawHeaders = \substr($rawHeaders, \strlen($startLine));
 
@@ -784,13 +790,12 @@ static function (int $bodySize) use (&$bodySizeLimit): void {
             ));
             $this->bodyQueue = null;
 
-            /** @psalm-suppress TypeDoesNotContainType, RedundantCondition */
-            ($trailerDeferred ?? null)?->error($exception ??= new ClientException(
+            /** @psalm-suppress TypeDoesNotContainNull, RedundantCondition */
+            ($trailerDeferred ?? null)?->error($exception ?? new ClientException(
                 $this->client,
                 "Client disconnected",
                 HttpStatus::REQUEST_TIMEOUT
             ));
-            $trailerDeferred = null;
 
             $this->deferredCancellation->cancel();
         }
@@ -852,6 +857,8 @@ protected function write(Request $request, Response $response): void
 
     /**
      * HTTP/1.x response writer.
+     *
+     * @psalm-suppress UnusedVariable $chunk is used, and line-level suppression was not sufficient.
      */
     private function send(?Future $lastWrite, Response $response, ?Request $request = null): void
     {
@@ -895,7 +902,6 @@ private function send(?Future $lastWrite, Response $response, ?Request $request
                 if ($shouldClose) {
                     $this->writableStream->end();
                 }
-                $need = null;
 
                 return;
             }

src/Driver/Http2Driver.php

@@ -270,15 +270,19 @@ protected function write(Request $request, Response $response): void
 
         $streamId = $this->streamIdMap[$request] ?? 1; // Default ID of 1 for upgrade requests.
 
+        /** @psalm-suppress RedundantCondition */
+        \assert((bool)$streamId); // For Psalm.
+
         if (!isset($this->streams[$streamId])) {
             return; // Client closed the stream or connection.
         }
 
+        $stream = $this->streams[$streamId];
+
         if ($streamId & 1) {
             $this->timeoutTracker->update($streamId);
         }
 
-        $stream = $this->streams[$streamId]; // $this->streams[$streamId] may be unset in send().
         $deferred = new DeferredFuture;
         $stream->pendingWrite = $deferred->getFuture();
         $cancellation = $stream->deferredCancellation->getCancellation();
@@ -356,7 +360,7 @@ private function send(int $id, Response $response, Request $request, Cancellatio
             if ($request->getMethod() === "HEAD") {
                 $this->streams[$id]->state |= Http2Stream::LOCAL_CLOSED;
                 $this->writeData("", $id);
-                $need = null;
+
                 return;
             }
 
@@ -501,7 +505,7 @@ private function shutdown(?ClientException $reason = null): void
         } finally {
             if (!empty($this->streams)) {
                 $reason ??= new ClientException($this->client, "Connection closed unexpectedly", Http2Parser::CANCEL);
-                foreach ($this->streams as $id => $stream) {
+                foreach ($this->streams as $id => $_stream) {
                     $this->releaseStream($id, $reason);
                 }
             }
@@ -925,7 +929,7 @@ public function handleConnectionWindowIncrement(int $windowSize): void
     #[\Override]
     public function handleHeaders(int $streamId, array $pseudo, array $headers, bool $streamEnded): void
     {
-        foreach ($pseudo as $name => $value) {
+        foreach ($pseudo as $name => $_value) {
             if (!isset(Http2Parser::KNOWN_REQUEST_PSEUDO_HEADERS[$name])) {
                 throw new Http2StreamException(
                     "Invalid pseudo header",
@@ -1242,7 +1246,7 @@ public function handleData(int $streamId, string $data): void
         $future->ignore();
 
         if ($stream->serverWindow <= self::MINIMUM_WINDOW) {
-            EventLoop::queue(function () use ($future, $stream, $streamId): void {
+            EventLoop::queue(function () use ($future, $streamId): void {
                 try {
                     $future->await();
                 } catch (\Throwable) {

src/Driver/Internal/Http2Stream.php

@@ -10,6 +10,7 @@
  * Used in Http2Driver.
  *
  * @internal
+ * @psalm-suppress PossiblyUnusedProperty False-positive.
  */
 final class Http2Stream
 {

src/Driver/Internal/StreamTimeoutTracker.php

@@ -14,6 +14,7 @@ final class StreamTimeoutTracker
     /** @var array<int, \Closure(int): void> */
     private array $callbacks = [];
 
+    /** @psalm-suppress UnusedProperty False-positive. */
     private int $pingTimeout = 0;
 
     /**

src/SocketHttpServer.php

@@ -293,10 +293,6 @@ public function start(RequestHandler $requestHandler, ErrorHandler $errorHandler
                 throw new CompositeException($exceptions);
             }
 
-            /**
-             * @var SocketAddress $address
-             * @var BindContext|null $bindContext
-             */
             foreach ($this->addresses as [$address, $bindContext]) {
                 $tlsContext = $bindContext?->getTlsContext()?->withApplicationLayerProtocols(
                     $this->httpDriverFactory->getApplicationLayerProtocols(),

test/test-server.php

@@ -41,7 +41,7 @@
 $server->start(new ClosureRequestHandler(static function (Request $request) {
     try {
         // Buffer entire body, but timeout after 100ms.
-        $body = $request->getBody()->buffer(new TimeoutCancellation(0.1));
+        $request->getBody()->buffer(new TimeoutCancellation(0.1));
     } catch (ClientException) {
         // Ignore failure to read body due to RST_STREAM frames.
     } catch (CancelledException) {