refactor: unify command complition checking

Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>

lib/Client/Protocol/Command/AppendCommand.php

@@ -4,10 +4,10 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\Parser\ResponseCodeParser;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\ImapException;
-use KTXM\ProviderImap\Client\CommandFailedException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
 use KTXM\ProviderImap\Client\Protocol\Response\ContinuationResponse;
 use KTXM\ProviderImap\Client\Protocol\Response\TaggedResponse;
@@ -81,14 +81,7 @@ final class AppendCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new CommandFailedException(
-                        'APPEND',
-                        $response->status(),
-                        $response->text(),
-                        $this->responseCodeParser->parse($response->text()),
-                    );
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return $this->parseAppendUid($response->text());
             }

lib/Client/Protocol/Command/CapabilityCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\CapabilityResult;
 use KTXM\ProviderImap\Client\ImapException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
@@ -49,9 +50,7 @@ final class CapabilityCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('CAPABILITY failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
             }
         }
 

lib/Client/Protocol/Command/CreateCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
@@ -48,9 +49,7 @@ final class CreateCommand implements CommandInterface
 
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('CREATE failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new CommandCompletion($response->status(), $response->text());
             }

lib/Client/Protocol/Command/DeleteCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
@@ -51,9 +52,7 @@ final class DeleteCommand implements CommandInterface
 
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('DELETE failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new CommandCompletion($response->status(), $response->text());
             }

lib/Client/Protocol/Command/ExpungeCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\Command\Argument\MessageTarget;
 use KTXM\ProviderImap\Client\Protocol\IdentifierMode;
 use KTXM\ProviderImap\Client\ImapException;
@@ -89,11 +90,7 @@ final class ExpungeCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException($this->sequenceSet === null
-                        ? 'EXPUNGE failed: ' . $response->text()
-                        : 'UID EXPUNGE failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->sequenceSet === null ? 'EXPUNGE' : 'UID EXPUNGE', $response);
 
                 return $expunged;
             }

lib/Client/Protocol/Command/ListCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Protocol\Parser\ListResponseParser;
 use KTXM\ProviderImap\Client\Protocol\Parser\StatusResponseParser;
@@ -91,9 +92,7 @@ final class ListCommand implements CommandInterface
                 }
 
                 if ($response instanceof TaggedResponse) {
-                    if (!$response->isOk()) {
-                        throw new ImapException('LIST failed: ' . $response->text());
-                    }
+                    CompletionChecker::assertSuccess($this->name(), $response);
 
                     return;
                 }
@@ -127,9 +126,7 @@ final class ListCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('LIST failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 foreach ($mailboxes as $mailbox) {
                     yield $mailbox;

lib/Client/Protocol/Command/LoginCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
@@ -48,9 +49,7 @@ final class LoginCommand implements CommandInterface
     {
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('LOGIN failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 $context->setState(SessionState::Authenticated);
 

lib/Client/Protocol/Command/LogoutCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
@@ -42,9 +43,7 @@ final class LogoutCommand implements CommandInterface
     {
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('LOGOUT failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 $context->setSelectedMailbox(null);
                 $context->setState(SessionState::Logout);

lib/Client/Protocol/Command/MessageTransferCommand.php

@@ -4,13 +4,13 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\Parser\ResponseCodeParser;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Result\MessageTransferResult;
 use KTXM\ProviderImap\Client\Protocol\Command\Argument\MessageTarget;
 use KTXM\ProviderImap\Client\Protocol\IdentifierMode;
 use KTXM\ProviderImap\Client\ImapException;
-use KTXM\ProviderImap\Client\CommandFailedException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
 use KTXM\ProviderImap\Client\Protocol\Response\TaggedResponse;
 use KTXM\ProviderImap\Client\Protocol\Response\UntaggedResponse;
@@ -114,14 +114,7 @@ final class MessageTransferCommand implements CommandInterface
                     $highestModSeq,
                 );
 
-                if (!$response->isOk()) {
-                    throw new CommandFailedException(
-                        $this->operation,
-                        $response->status(),
-                        $response->text(),
-                        $this->responseCodeParser->parse($response->text()),
-                    );
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new MessageTransferResult(
                     $response->status(),

lib/Client/Protocol/Command/NoopCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
@@ -44,9 +45,7 @@ final class NoopCommand implements CommandInterface
 
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('NOOP failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new CommandCompletion($response->status(), $response->text());
             }

lib/Client/Protocol/Command/RenameCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
@@ -51,9 +52,7 @@ final class RenameCommand implements CommandInterface
     {
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('RENAME failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 if ($context->selectedMailbox() === $this->fromMailbox) {
                     $context->setSelectedMailbox($this->toMailbox);

lib/Client/Protocol/Command/SearchCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\SearchResult;
 use KTXM\ProviderImap\Client\Protocol\IdentifierMode;
 use KTXM\ProviderImap\Client\ImapException;
@@ -74,9 +75,7 @@ final class SearchCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('SEARCH failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new SearchResult($matches, $this->identifierMode);
             }

lib/Client/Protocol/Command/SelectCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\ImapException;
 use KTXM\ProviderImap\Client\Mailbox;
@@ -76,9 +77,7 @@ final class SelectCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException($this->name() . ' failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 if (str_contains(strtoupper($response->text()), 'READ-ONLY')) {
                     $readOnly = true;

lib/Client/Protocol/Command/SortCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\SortResult;
 use KTXM\ProviderImap\Client\Protocol\IdentifierMode;
 use KTXM\ProviderImap\Client\ImapException;
@@ -82,9 +83,7 @@ final class SortCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('SORT failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new SortResult($matches, $this->identifierMode);
             }

lib/Client/Protocol/Command/StartTlsCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\ImapException;
 use KTXM\ProviderImap\Client\Protocol\RequestFrame;
@@ -38,9 +39,7 @@ final class StartTlsCommand implements CommandInterface
     {
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('STARTTLS failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 $context->connection()->upgradeToTls();
                 $context->replaceCapabilities();

lib/Client/Protocol/Command/StatusCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Protocol\StringEncoder;
 use KTXM\ProviderImap\Client\Protocol\Parser\StatusResponseParser;
 use KTXM\ProviderImap\Client\Result\MailboxStatusResult;
@@ -71,9 +72,7 @@ final class StatusCommand implements CommandInterface
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('STATUS failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new MailboxStatusResult($mailbox, $items);
             }

lib/Client/Protocol/Command/StoreCommand.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace KTXM\ProviderImap\Client\Protocol\Command;
 
+use KTXM\ProviderImap\Client\Protocol\CompletionChecker;
 use KTXM\ProviderImap\Client\Result\CommandCompletion;
 use KTXM\ProviderImap\Client\Protocol\Command\Argument\MessageTarget;
 use KTXM\ProviderImap\Client\Protocol\IdentifierMode;
@@ -90,9 +91,7 @@ final class StoreCommand implements CommandInterface
 
         foreach ($responses as $response) {
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('STORE failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess($this->name(), $response);
 
                 return new CommandCompletion($response->status(), $response->text());
             }

lib/Client/Protocol/CompletionChecker.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KTXM\ProviderImap\Client\Protocol;
+
+use KTXM\ProviderImap\Client\CommandFailedException;
+use KTXM\ProviderImap\Client\ImapException;
+use KTXM\ProviderImap\Client\Protocol\Parser\ResponseCodeParser;
+use KTXM\ProviderImap\Client\Protocol\Response\TaggedResponse;
+
+final class CompletionChecker
+{
+    public static function assertSuccess(string $command, TaggedResponse $response): void
+    {
+        if ($response->isOk()) {
+            return;
+        }
+
+        if (!in_array($response->status(), ['NO', 'BAD'], true)) {
+            throw new ImapException($command . ' received an invalid completion status: ' . $response->status());
+        }
+
+        throw new CommandFailedException(
+            $command,
+            $response->status(),
+            $response->text(),
+            (new ResponseCodeParser())->parse($response->text()),
+        );
+    }
+}

lib/Client/Protocol/FetchResultReader.php

@@ -49,9 +49,7 @@ final class FetchResultReader
             }
 
             if ($response instanceof TaggedResponse) {
-                if (!$response->isOk()) {
-                    throw new ImapException('FETCH failed: ' . $response->text());
-                }
+                CompletionChecker::assertSuccess('FETCH', $response);
 
                 return;
             }

lib/Client/Protocol/ProtocolReader.php

@@ -129,9 +129,12 @@ final class ProtocolReader
             if (str_starts_with($trimmed, $tag . ' ')) {
                 $parts = preg_split('/\s+/', $trimmed, 3) ?: [];
                 $status = strtoupper($parts[1] ?? '');
-                if ($status === 'NO' || $status === 'BAD') {
-                    throw new ImapException(sprintf('FETCH command failed: %s', $trimmed));
-                }
+                CompletionChecker::assertSuccess('FETCH', new TaggedResponse(
+                    $tag,
+                    $status,
+                    $parts[2] ?? '',
+                    $trimmed,
+                ));
                 return null; // Tagged OK without ever finding a literal → UID not found
             }
 
@@ -145,9 +148,7 @@ final class ProtocolReader
             $response = $this->readResponse();
 
             if ($response instanceof TaggedResponse && $response->tag() === $tag) {
-                if (!$response->isOk()) {
-                    throw new ImapException(sprintf('FETCH failed: %s', $response->text()));
-                }
+                CompletionChecker::assertSuccess('FETCH', $response);
                 return $response;
             }
         }