Expand API error handling and alert error details in Frida interception

Author: pimterry

src/components/intercept/config/frida-config.tsx

@@ -4,7 +4,7 @@ import { computed, observable, action, autorun, flow, runInAction } from 'mobx';
 import { observer, inject, disposeOnUnmount } from 'mobx-react';
 
 import { delay } from '../../../util/promise';
-import { UnreachableCheck } from '../../../util/error';
+import { ErrorLike, UnreachableCheck } from '../../../util/error';
 import { styled } from '../../../styles';
 import { Icon } from '../../../icons';
 
@@ -16,6 +16,7 @@ import { RulesStore } from '../../../model/rules/rules-store';
 import { FridaActivationOptions, FridaHost, FridaTarget } from '../../../model/interception/frida';
 
 import { getDetailedInterceptorMetadata } from '../../../services/server-api';
+import { ActivationFailure } from '../../../services/server-api-types';
 
 import { TextInput } from '../../common/inputs';
 import { InterceptionTargetList } from './intercept-target-list';
@@ -162,6 +163,16 @@ const INCOMPATIBLE_APP_IDS: string[] = [
     "com.google.android.googlequicksearchbox"
 ];
 
+const alertActivationError = (action: string, error: ErrorLike) => {
+    if (error instanceof ActivationFailure) {
+        alert(`Failed to ${action}: ${error.failureMessage} (${error.errorCode})`);
+    } else {
+        alert(`Failed to ${action}: ${error.message ?? error}`);
+    }
+
+    throw error;
+};
+
 @inject('proxyStore')
 @inject('rulesStore')
 @inject('eventsStore')
@@ -319,7 +330,7 @@ class FridaConfig extends React.Component<{
             await this.props.activateInterceptor({
                 action: 'setup',
                 hostId
-            });
+            }).catch((e) => alertActivationError('setup Frida', e));
 
             this.setHostProgress(hostId, 75);
             await this.launchInterceptor(hostId);
@@ -343,7 +354,7 @@ class FridaConfig extends React.Component<{
             await this.props.activateInterceptor({
                 action: 'launch',
                 hostId
-            });
+            }).catch((e) => alertActivationError('launch Frida', e));
 
             this.setHostProgress(hostId, 100);
             await delay(10); // Tiny delay, purely for nice UI purposes
@@ -374,7 +385,9 @@ class FridaConfig extends React.Component<{
             action: 'intercept',
             hostId: host.id,
             targetId
-        }).then(() => {
+        })
+        .catch((e) => alertActivationError(`intercept ${targetId}`, e))
+        .then(() => {
             this.props.reportSuccess();
         }).finally(action(() => {
             _.pull(this.inProgressTargetIds, targetId);

src/components/send/send-page.tsx

@@ -69,8 +69,8 @@ class SendPage extends React.Component<{
 
         sendRequest(selectedRequest).catch(e => {
             console.log(e);
-            const errorMessage = (e instanceof ApiError && e.apiErrorMessage)
-                ? e.apiErrorMessage
+            const errorMessage = (e instanceof ApiError && e.apiError?.message)
+                ? e.apiError?.message
                 : e.message ?? e;
             alert(errorMessage);
         });

src/services/server-api-types.ts

@@ -1,5 +1,6 @@
 import { NetworkInterfaceInfo } from 'os';
 import { ProxySetting } from 'mockttp';
+import { ErrorLike } from '../util/error';
 
 export interface ServerInterceptor {
     id: string;
@@ -29,9 +30,39 @@ export class ApiError extends Error {
         message: string,
         readonly operationName: string,
         readonly errorCode?: string | number,
-        public apiErrorMessage?: string
+        public apiError?: {
+            message?: string,
+            code?: string
+        }
     ) {
         super(`API error during ${operationName}: ${message}`);
+        if (apiError) {
+            this.cause = new Error(apiError?.message ?? '[Unknown API error]');
+            this.cause.code = apiError?.code ?? 'unknown';
+            this.cause.stack = '(From server API)';
+        }
     }
 
+    private cause?: ErrorLike;
+
+}
+
+export class ActivationFailure extends Error {
+    constructor(
+        readonly interceptorId: string,
+        readonly failureMessage: string,
+        readonly errorCode?: string,
+        readonly cause?: ErrorLike
+    ) {
+        super(`Failed to activate interceptor ${interceptorId}: ${failureMessage}`);
+    }
+}
+
+export class ActivationNonSuccess extends Error {
+    constructor(
+        readonly interceptorId: string,
+        readonly metadata: unknown
+    ) {
+        super(`Interceptor ${interceptorId} activation ran unsuccessfully`);
+    }
 }

src/services/server-api.ts

@@ -7,7 +7,7 @@ import {
     SERVER_REST_API_SUPPORTED
 } from './service-versions';
 
-import { type ServerConfig, type NetworkInterfaces, type ServerInterceptor, ApiError } from './server-api-types';
+import { type ServerConfig, type NetworkInterfaces, type ServerInterceptor, ApiError, ActivationFailure, ActivationNonSuccess } from './server-api-types';
 export type { ServerConfig, NetworkInterfaces, ServerInterceptor };
 
 import { GraphQLApiClient } from './server-graphql-api';
@@ -97,20 +97,29 @@ export async function getDetailedInterceptorMetadata<M extends unknown>(
 }
 
 export async function activateInterceptor(id: string, proxyPort: number, options?: any): Promise<unknown> {
-    const result = await (await apiClient).activateInterceptor(id, proxyPort, options);
+    try {
+        const result = await (await apiClient).activateInterceptor(id, proxyPort, options);
 
-    if (result.success) {
-        return result.metadata;
-    } else {
-        // Some kind of failure:
-        console.log('Activation result', JSON.stringify(result));
-
-        const error = Object.assign(
-            new ApiError(`failed to activate interceptor ${id}`, `activate-interceptor-${id}`),
-            result
-        );
+        if (result.success) {
+            return result.metadata;
+        } else {
+            // Some kind of failure (either non-critical, or old server that returned all errors
+            // like this without a 500):
+            console.log('Activation result', JSON.stringify(result));
 
-        throw error;
+            throw new ActivationNonSuccess(id, result.metadata);
+        }
+    } catch (e: any) {
+        if (e instanceof ApiError) {
+            throw new ActivationFailure(
+                id,
+                e.apiError?.message ?? `Failed to activate interceptor ${id}`,
+                e.apiError?.code,
+                e
+            )
+        } else {
+            throw e;
+        }
     }
 }
 

src/services/server-rest-api.ts

@@ -81,7 +81,7 @@ export class RestApiClient {
                 }`,
                 operationName,
                 response.status,
-                errorMessage
+                { message: errorMessage, code: errorCode }
             );
         }