Report activation error messages & codes back from the API

Author: pimterry

src/api/api-model.ts

@@ -184,7 +184,16 @@ export class ApiModel {
                 addBreadcrumb(`Failed to activate ${id}`, { category: 'interceptor' });
                 reportError(err);
             }
-            return { success: false, metadata: activationError.metadata };
+            return {
+                success: false,
+                metadata: activationError.metadata,
+                error: activationError.reportable !== false
+                    ? {
+                        code: activationError.code,
+                        message: activationError.message
+                    }
+                    : {}
+            };
         }
     }
 

src/interceptors/electron.ts

@@ -10,7 +10,7 @@ import { Interceptor } from '.';
 
 import { HtkConfig } from '../config';
 import { delay } from '../util/promise';
-import { isErrorLike } from '../util/error';
+import { ErrorLike, isErrorLike } from '../util/error';
 import { canAccess, readFile } from '../util/fs';
 import { windowsClose } from '../util/process-management';
 import { getTerminalEnvVars, OVERRIDES_DIR } from './terminal/terminal-env-overrides';
@@ -80,6 +80,7 @@ export class ElectronInterceptor implements Interceptor {
 
         let debugClient: ChromeRemoteInterface.Client | undefined;
         let retries = 10;
+        let spawnError: ErrorLike | undefined;
 
         appProcess.on('error', async (e) => {
             reportError(e);
@@ -92,10 +93,10 @@ export class ElectronInterceptor implements Interceptor {
             }
 
             // If we're still in the process of debugging the app, give up.
-            retries = -1;
+            spawnError = e as ErrorLike;
         });
 
-        while (!debugClient && retries >= 0) {
+        while (!debugClient && retries >= 0 && !spawnError) {
             try {
                 debugClient = await ChromeRemoteInterface({
                     host: '127.0.0.1',
@@ -110,6 +111,8 @@ export class ElectronInterceptor implements Interceptor {
                 await delay(500);
             }
         }
+
+        if (spawnError) throw spawnError;
         if (!debugClient) throw new Error('Could not initialize CDP client');
 
         this.debugClients[proxyPort] = this.debugClients[proxyPort] || [];

src/interceptors/index.ts

@@ -2,6 +2,7 @@ import _ from 'lodash';
 
 import { HtkConfig } from '../config';
 import { addShutdownHandler } from '../shutdown';
+import { ErrorLike } from '../util/error';
 
 import { FreshFirefox } from './fresh-firefox';
 import {
@@ -43,9 +44,23 @@ export interface Interceptor {
     deactivateAll(): Promise<void | {}>;
 }
 
-export interface ActivationError extends Error {
-    metadata?: any; // Any extra metadata with the failure, e.g. if it could be retried
-    reportable?: boolean; // Set to false to disable reporting this error, it's normal
+export interface ActivationError extends ErrorLike {
+    /**
+     * Activation errors can have an extra `metadata` field, to share data with the
+     * client which attempted the activation, e.g. whether it can be retried.
+     */
+    metadata?: any;
+
+    /**
+     * Errors should be thrown with reportable set to `false` if they're a 'normal'
+     * event that shouldn't be logged or exposed to the user. For example, if it's a
+     * temporary failure that will lead to a confirmation flow or similar.
+     *
+     * This disables error logging and reporting of failure details from the API
+     * (it assumes that the metadata will expose any info required, since this is a
+     * recognized failure case).
+     */
+    reportable?: boolean;
 }
 
 export function buildInterceptors(config: HtkConfig): _.Dictionary<Interceptor> {