Clean up API error handling with concise user messages

Author: tareqas

Cli/EventListener/ApiErrorListener.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace SensioLabs\Insight\Cli\EventListener;
+
+use SensioLabs\Insight\Sdk\Exception\ApiClientException;
+use SensioLabs\Insight\Sdk\Exception\ApiParserException;
+use SensioLabs\Insight\Sdk\Exception\ApiServerException;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleErrorEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+
+class ApiErrorListener implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ConsoleEvents::ERROR => ['onConsoleError', 256],
+        ];
+    }
+
+    public function onConsoleError(ConsoleErrorEvent $event): void
+    {
+        $output = $event->getOutput();
+        $error = $event->getError();
+
+        if ($error instanceof ApiClientException) {
+            $this->showClientError($error, $output);
+        } elseif ($error instanceof ApiServerException) {
+            $output->writeln('<error>Server temporarily unavailable. Please try again in a few minutes.</error>');
+        } elseif ($error instanceof ApiParserException) {
+            $output->writeln('<error>Unable to process server response. Please try again later.</error>');
+        } elseif ($error instanceof TransportExceptionInterface) {
+            $output->writeln('<error>Network connection failed. Check your internet connection.</error>');
+        } else {
+            $output->writeln('<error>Something went wrong. Please try again, or run with -v for more details.</error>');
+        }
+
+        if ($output->isVerbose()) {
+            throw $error;
+        }
+
+        $event->setExitCode(0);
+    }
+
+    private function showClientError(ApiClientException $e, $output): void
+    {
+        $message = $e->getMessage();
+        if (false !== strpos($message, '401') || false !== strpos($message, 'Unauthorized')) {
+            $output->writeln('<error>Invalid API credentials. Run "php insight.phar configure" to set up your token.</error>');
+        } elseif (false !== strpos($message, '404') || false !== strpos($message, 'Not Found')) {
+            $output->writeln('<error>Project not found. Check the project UUID and try again.</error>');
+        } elseif (false !== strpos($message, '403') || false !== strpos($message, 'Forbidden')) {
+            $output->writeln('<error>Access denied. You don\'t have permission for this project.</error>');
+        } else {
+            $output->writeln('<error>Request failed. Please check your input and try again.</error>');
+        }
+    }
+}

Sdk/Api.php

@@ -289,12 +289,22 @@ private function processClientError(HttpExceptionInterface $e)
 
     private function logException(ExceptionInterface $e)
     {
-        $message = sprintf("Exception: Class: \"%s\", Message: \"%s\", Response:\n%s",
-            \get_class($e),
-            $e->getMessage(),
-            $e->getResponse()->getInfo('debug')
-        );
+        if (!$this->logger) {
+            return;
+        }
+
+        $parts = [
+            sprintf('Exception: Class: "%s"', \get_class($e)),
+            sprintf('Message: "%s"', $e->getMessage()),
+        ];
+
+        if ($e instanceof HttpExceptionInterface) {
+            $debug = $e->getResponse()->getInfo('debug');
+            if ($debug) {
+                $parts[] = "Response:\n".$debug;
+            }
+        }
 
-        $this->logger && $this->logger->error($message, ['exception' => $e]);
+        $this->logger->error(implode(', ', $parts), ['exception' => $e]);
     }
 }

bin/insight

@@ -18,7 +18,11 @@ if (file_exists($a = __DIR__.'/../../../autoload.php')) {
 }
 
 use SensioLabs\Insight\Cli\Application;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use SensioLabs\Insight\Cli\EventListener\ApiErrorListener;
 
 $application = new Application();
-
+$dispatcher = new EventDispatcher();
+$dispatcher->addSubscriber(new ApiErrorListener());
+$application->setDispatcher($dispatcher);
 $application->run();

composer.json

@@ -10,7 +10,8 @@
         "psr/log": "^1.0",
         "symfony/http-client": "^5.4|^6.4|^7.0",
         "symfony/console": "^5.4|^6.4|^7.0",
-        "symfony/expression-language": "^5.4|^6.4|^7.0"
+        "symfony/expression-language": "^5.4|^6.4|^7.0",
+        "symfony/event-dispatcher": "^5.4|^6.4|^7.0"
     },
     "require-dev": {
         "monolog/monolog": "^1.4",