add debug file logging to failed API requests

Author: andyfase

src/lib/bluelink-regions/base.ts

@@ -1,7 +1,9 @@
 import { Config } from '../../config'
 import { defaultImage } from '../../resources/defaultImage'
+import PersistedLog from '../scriptable-utils/io/PersistedLog'
 const KEYCHAIN_CACHE_KEY = 'egmp-bluelink-cache'
 export const DEFAULT_STATUS_CHECK_INTERVAL = 3600 * 1000
+const BLUELINK_LOG_FILE = 'egmp-bluelink-log'
 
 export interface BluelinkTokens {
   accessToken: string
@@ -92,6 +94,7 @@ export class Bluelink {
   protected tempLookup: TempConversion | undefined
   protected tokens: BluelinkTokens | undefined
   protected debugLastRequest: DebugLastRequest | undefined
+  protected logger: any
 
   constructor(config: Config, vin?: string) {
     this.vin = vin
@@ -101,6 +104,7 @@ export class Bluelink {
     this.tokens = undefined
     this.debugLastRequest = undefined
     this.tempLookup = undefined
+    this.logger = PersistedLog(BLUELINK_LOG_FILE)
   }
 
   protected async superInit(config: Config, vin?: string, statusCheckInterval?: number) {
@@ -269,6 +273,7 @@ export class Bluelink {
       const json = await req.loadJSON()
       return { resp: req.response, json: json }
     } catch (error) {
+      await this.logger.log(`Failed to send request to ${props.url}, error ${error}`)
       throw Error(`Failed to send request to ${props.url}, error ${error}`)
     }
   }

src/lib/bluelink-regions/canada.ts

@@ -78,7 +78,10 @@ export class BluelinkCanada extends Bluelink {
         expiry: Math.floor(Date.now() / 1000) + resp.json.result.token.expireIn, // we only get a expireIn not a actual date
       }
     }
-    throw Error(`Login Failed: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`)
+
+    const error = `Login Failed: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async setCar(id: string) {
@@ -89,9 +92,9 @@ export class BluelinkCanada extends Bluelink {
       }),
     })
     if (!this.requestResponseValid(resp.json)) {
-      throw Error(
-        `Failed to set car ${id}: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-      )
+      const error = `Failed to set car ${id}: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+      await this.logger.log(error)
+      throw Error(error)
     }
   }
 
@@ -122,9 +125,9 @@ export class BluelinkCanada extends Bluelink {
         modelTrim: vehicle.trim,
       }
     }
-    throw Error(
-      `Failed to retrieve vehicle list: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to retrieve vehicle list: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected returnCarStatus(status: any, forceUpdate: boolean, odometer?: number): BluelinkStatus {
@@ -199,9 +202,9 @@ export class BluelinkCanada extends Bluelink {
         : this.returnCarStatus(resp.json.result.status, forceUpdate, resp.json.result.vehicle.odometer)
     }
 
-    throw Error(
-      `Failed to retrieve vehicle status: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to retrieve vehicle status: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async getAuthCode(): Promise<string> {
@@ -216,9 +219,9 @@ export class BluelinkCanada extends Bluelink {
     if (this.requestResponseValid(resp.json)) {
       return resp.json.result.pAuth
     }
-    throw Error(
-      `Failed to get auth code: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to get auth code: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async pollForCommandCompletion(
@@ -240,9 +243,9 @@ export class BluelinkCanada extends Bluelink {
       })
 
       if (!this.requestResponseValid(resp.json)) {
-        throw Error(
-          `Failed to poll for command completion: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-        )
+        const error = `Failed to poll for command completion: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+        await this.logger.log(error)
+        throw Error(error)
       }
 
       if (resp.json.result.transaction.apiResult === 'C') {
@@ -291,9 +294,9 @@ export class BluelinkCanada extends Bluelink {
       const transactionId = resp.resp.headers.transactionId
       return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
-    throw Error(
-      `Failed to send lockUnlock command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to send lockUnlock command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async startCharge(id: string): Promise<{ isSuccess: boolean; data: BluelinkStatus }> {
@@ -325,9 +328,9 @@ export class BluelinkCanada extends Bluelink {
       const transactionId = resp.resp.headers.transactionId
       return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
-    throw Error(
-      `Failed to send charge command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to send charge command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async climateOn(id: string, config: ClimateRequest): Promise<{ isSuccess: boolean; data: BluelinkStatus }> {
@@ -368,9 +371,9 @@ export class BluelinkCanada extends Bluelink {
       const transactionId = resp.resp.headers.transactionId
       return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
-    throw Error(
-      `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 
   protected async climateOff(id: string): Promise<{ isSuccess: boolean; data: BluelinkStatus }> {
@@ -391,8 +394,8 @@ export class BluelinkCanada extends Bluelink {
       const transactionId = resp.resp.headers.transactionId
       return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
-    throw Error(
-      `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`,
-    )
+    const error = `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
+    await this.logger.log(error)
+    throw Error(error)
   }
 }