Return metadata from the activate/deactivate API

Previously this just returned a boolean. This is technically a breaking
change, as it now returns a JSON object, with the result in the .success
field, but nobody should be depending on this internal API except the
UI, and that doesn't depend on the result for anything substantial.

Using JSON here instead of a proper result is a compatibility
workaround. In future, the plan is to remove GraphQL entirely, which is
why I'm not extending the complexity of the schema at this stage.

Author: pimterry

src/hide-chrome-warning-server.ts

@@ -1,8 +1,5 @@
 import { getLocal, Mockttp } from 'mockttp';
 
-// Make the types for some of the browser code below happy.
-let targetUrl: string;
-
 // The first tab that opens opens with a Chrome warning about dangerous flags
 // Closing it and immediately opening a new one is a bit cheeky, but
 // is completely gets rid that, more or less invisibly:

src/httptoolkit-server.ts

@@ -25,7 +25,7 @@ const typeDefs = `
             id: ID!,
             proxyPort: Int!,
             options: Json
-        ): Boolean!
+        ): Json
         deactivateInterceptor(
             id: ID!,
             proxyPort: Int!
@@ -74,8 +74,11 @@ const buildResolvers = (
                 const interceptor = interceptors[id];
                 if (!interceptor) throw new Error(`Unknown interceptor ${id}`);
 
+                let metadata: any = null;
                 await Promise.race([
-                    interceptor.activate(proxyPort, options).catch(reportError),
+                    interceptor.activate(proxyPort, options)
+                        .then((result) => metadata = result)
+                        .catch(reportError),
                     delay(30000) // After 30s, we don't stop activating, but we do report failure
                 ]);
 
@@ -87,7 +90,7 @@ const buildResolvers = (
                     reportError(new Error(`Failed to activate ${id}`));
                 }
 
-                return isActive;
+                return { success: isActive, metadata };
             },
             deactivateInterceptor: async (__: void, args: _.Dictionary<any>) => {
                 const { id, proxyPort, options } = args;
@@ -96,7 +99,7 @@ const buildResolvers = (
                 if (!interceptor) throw new Error(`Unknown interceptor ${id}`);
 
                 await interceptor.deactivate(proxyPort, options).catch(reportError);
-                return !interceptor.isActive(proxyPort);
+                return { success: !interceptor.isActive(proxyPort) };
             },
             triggerUpdate: () => {
                 eventEmitter.emit('update-requested');

src/interceptors/index.ts

@@ -14,8 +14,8 @@ export interface Interceptor {
     isActivable(): Promise<boolean>;
     isActive(proxyPort: number): boolean;
 
-    activate(proxyPort: number, options?: any): Promise<void>;
-    deactivate(proxyPort: number, options?: any): Promise<void>;
+    activate(proxyPort: number, options?: any): Promise<void | {}>;
+    deactivate(proxyPort: number, options?: any): Promise<void | {}>;
     deactivateAll(): Promise<void>;
 }