Fix and improve error handling

Author: MariusKnirk

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.6.1 - 2025-08-29
+
+### Fixed
+- Fixed and improved the handling of errors related to the plugin settings.
+
 ## 4.6.0 - 2025-08-28
 
 ### Added

src/controllers/ApiController.php

@@ -359,29 +359,32 @@ public function actionRequestRun(): Response
         }
     }
 
-    private function handleError($e): Response
+    private function handleError(\Exception $e): Response
     {
-        return match (get_class($e)) {
-            NotFoundException::class => $this->handleInvalidSiteIdError(),
-            UnauthorizedException::class => $this->handleInvalidApiTokenError(),
+        return match ($e->getCode()) {
+            404 => $this->handleInvalidSiteIdError(),
+            401, 403 => $this->handleInvalidApiTokenError(),
             default => $this->handleGenericError($e),
         };
-
     }
 
     private function handleInvalidApiTokenError(): Response
     {
         $this->response->setStatusCode(403);
         return $this->asJson([
-            'error' => 'The Oh Dear API token is invalid.',
+            'error' => Craft::t('ohdear', 'The Oh Dear API token "{apiToken}" is invalid.', [
+                'apiToken' => OhDear::$plugin->getSettings()->getApiToken(),
+            ]),
         ]);
     }
 
     private function handleInvalidSiteIdError(): Response
     {
         $this->response->setStatusCode(404);
         return $this->asJson([
-            'error' => 'The Oh Dear site could not be found. Please check your site ID.',
+            'error' => Craft::t('ohdear', 'The Oh Dear site with the ID "{siteId}" could not be found.', [
+                'siteId' => OhDear::$plugin->getSettings()->getSelectedSiteId()
+            ]),
         ]);
     }
 

src/models/Settings.php

@@ -14,7 +14,6 @@
 use craft\base\Model;
 use craft\behaviors\EnvAttributeParserBehavior;
 use craft\helpers\App;
-use Saloon\Exceptions\Request\Statuses\UnauthorizedException;
 use webhubworks\ohdear\OhDear;
 
 /**
@@ -50,12 +49,14 @@ public function behaviors(): array
     }
 
     /**
-     * Determines if the plugin has an API key and
-     * a selected site ID.
+     * Determines if the plugin has an API key and a selected site ID.
      */
     public function hasApiCredentials(): bool
     {
-        return ! empty($this->apiToken) && ! empty($this->selectedSiteId) && ! empty($this->getApiToken()) && ! empty($this->getSelectedSiteId());
+        return ! empty($this->apiToken) &&
+            ! empty($this->selectedSiteId) &&
+            ! empty($this->getApiToken()) &&
+            ! empty($this->getSelectedSiteId());
     }
 
     public function getApiToken(): ?string
@@ -91,34 +92,43 @@ public function rules(): array
             [['apiToken', 'selectedSiteId'], 'default', 'value' => ''],
             ['selectedSiteId', 'required', 'when' => function ($model) {
                 return ! empty($model->apiToken);
-            }],
+            }, 'message' => Craft::t('ohdear', 'Please enter a valid site ID.')],
             [['apiToken'], 'validApiToken'],
             [['selectedSiteId'], 'validSelectedSiteId'],
         ];
     }
-
-    public function validApiToken($attribute, $params): void
+    
+    public function validApiToken($attribute, $params): bool
     {
         try {
             OhDear::$plugin->settingsService->getMe($this->{$attribute});
-        } catch (UnauthorizedException $e) {
-            $this->addError('apiToken', Craft::t('ohdear', 'API authentication failed.'));
+            return true;
+            
         } catch (\Exception $e) {
-            $this->addError('apiToken', $e->getMessage());
+            match ($e->getCode()) {
+                401 => $this->addError('apiToken', Craft::t('ohdear', 'API authentication failed.')),
+                default => $this->addError('apiToken', $e->getMessage()),
+            };
+            return false;
         }
     }
-
-    public function validSelectedSiteId($attribute, $params): void
+    
+    public function validSelectedSiteId($attribute, $params): bool
     {
         try {
             OhDear::$plugin->settingsService->getMonitor(
                 $this->apiToken,
                 (int)$this->{$attribute}
             );
-        } catch (UnauthorizedException $e) {
-            $this->addError('selectedSiteId', Craft::t('ohdear', 'API authentication failed.'));
+            return true;
+            
         } catch (\Exception $e) {
-            $this->addError('selectedSiteId', $e->getMessage());
+            match ($e->getCode()) {
+                404 => $this->addError('selectedSiteId', Craft::t('ohdear', 'A site with the ID "{id}" was not found.', ['id' => $this->{$attribute}])),
+                401 => $this->addError('selectedSiteId', Craft::t('ohdear', 'API authentication failed.')),
+                default => $this->addError('selectedSiteId', $e->getMessage()),
+            };
+            return false;
         }
     }
 }

src/translations/de/ohdear.php

@@ -136,4 +136,8 @@
     'Your Health Check endpoint is protected by this secret. You can find the secret on Oh Dear\'s {link} page. If you change it, make sure to change it in Oh Dear as well.' => 'Der Health-Check-Endpunkt ist durch dieses Secret gesichert. Sie können das Secret in Oh Dears {link} finden. Falls Sie es ändern, stellen Sie sicher, dass Sie es auch in Oh Dear anpassen.',
     'Please provide a valid API token and site ID.' => 'Bitte geben Sie zuerst einen API-Token und eine Site-ID ein.',
     'API authentication failed.' => 'API-Authentifizierung fehlgeschlagen.',
+    'A site with the ID "{id}" was not found.' => 'Eine Seite mit der ID {id} konnte nicht gefunden werden.',
+    'Please enter a valid site ID.' => 'Bitte geben Sie eine gültige Site-ID ein.',
+    'The Oh Dear API token "{apiToken}" is invalid.' => 'Der Oh Dear API-Token "{apiToken}" ist invalide.',
+    'The Oh Dear site with the ID "{siteId}" could not be found.' => 'Die Oh Dear Seite mit der ID "{siteId}" konnte nicht gefunden werden.',
 ];

src/widgets/OhDearWidget.php

@@ -57,14 +57,14 @@ public static function maxColspan(): ?int
     public function rules(): array
     {
         $rules = parent::rules();
-        $rules = array_merge(
+        
+        return array_merge(
             $rules,
             [
                 ['period', 'string'],
                 ['period', 'in', 'range' => ['hour', 'day', 'month']],
             ]
         );
-        return $rules;
     }
 
     /**
@@ -95,6 +95,10 @@ public function getSettingsHtml(): ?string
      */
     public function getBodyHtml(): ?string
     {
+        if (! OhDear::$plugin->getSettings()->hasApiCredentials()) {
+            return null;
+        }
+        
         OhDearAsset::registerLangFile();
 
         return Craft::$app->getView()->renderTemplate(