Merge branch '3-confusing-error-message'

Author: sajmonr

src/responses/account-response.ts

@@ -5,6 +5,6 @@ export interface AccountResponse{
     accountAccess: {
         account: {
             accountId: string;
-        }
+        };
     }[];
 }

src/responses/afero-error-response.ts

@@ -0,0 +1,24 @@
+import { isNullOrUndefined } from '../utils';
+
+export interface AferoErrorResponse{
+    /** UNIX timestamp of the request */
+    timestamp: number;
+    /** Request response code */
+    status: number;
+    /** Description of the error */
+    error_description: string;
+    /** URL of the request */
+    path: string;
+}
+
+/**
+ * Checks whether error is caused by Afero response
+ * @param error Error object to check
+ * @returns True if error is from Afero
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function isAferoError(error: any): error is AferoErrorResponse{
+    if(error === null || typeof error !== 'object') return false;
+
+    return isNullOrUndefined(error.timestamp, error.status, error.status_description, error.path);
+}

src/services/device.service.ts

@@ -6,6 +6,7 @@ import { AxiosError, AxiosResponse } from 'axios';
 import { DeviceStatusResponse } from '../responses/device-status-response';
 import { CharacteristicValue } from 'homebridge';
 import { convertNumberToHex } from '../utils';
+import { isAferoError } from '../responses/afero-error-response';
 
 /**
  * Service for interacting with devices
@@ -35,7 +36,8 @@ export class DeviceService{
                 data: this.getDataValue(value)
             });
         }catch(ex){
-            this._platform.log.error('Remote service is not reachable.', (<AxiosError>ex).message);
+            this.handleError(<AxiosError>ex);
+
             return;
         }
 
@@ -59,7 +61,7 @@ export class DeviceService{
                 .get<DeviceStatusResponse>(`accounts/${this._platform.accountService.accountId}/devices/${deviceId}?expansions=attributes`);
             deviceStatus = response.data;
         }catch(ex){
-            this._platform.log.error('Remote service returned an error.', (<AxiosError>ex).message);
+            this.handleError(<AxiosError>ex);
 
             return undefined;
         }
@@ -117,4 +119,11 @@ export class DeviceService{
         throw new Error('The value type is not supported.');
     }
 
+    private handleError(error: AxiosError): void{
+        const responseData = error.response?.data;
+        const errorMessage = isAferoError(responseData) ? responseData.error_description : error.message;
+
+        this._platform.log.error('The remote service returned an error.', errorMessage);
+    }
+
 }

src/utils.ts

@@ -1,10 +1,10 @@
 /**
- * Checks whether value is null or undefined
- * @param value Value to check
- * @returns True if value is null or undefined otherwise false
+ * Checks whether at least one value is null or undefined
+ * @param values Values to check
+ * @returns True if any value is null or undefined otherwise false
  */
-export function isNullOrUndefined(value: unknown): boolean{
-    return value === undefined || value === null;
+export function isNullOrUndefined(...values: unknown[]): boolean{
+    return values.some(v => v === undefined || v === null);
 }
 
 /**