Create an existing-terminal interceptor

Author: pimterry

src/interceptors/index.ts

@@ -4,7 +4,8 @@ import { HtkConfig } from '../config';
 
 import { FreshChrome } from './fresh-chrome';
 import { FreshFirefox } from './fresh-firefox';
-import { TerminalInterceptor } from './terminal/fresh-terminal-interceptor';
+import { FreshTerminalInterceptor } from './terminal/fresh-terminal-interceptor';
+import { ExistingTerminalInterceptor } from './terminal/existing-terminal-interceptor';
 import { addShutdownHandler } from '../shutdown';
 
 export interface Interceptor {
@@ -23,7 +24,8 @@ export function buildInterceptors(config: HtkConfig): _.Dictionary<Interceptor>
     const interceptors = [
         new FreshChrome(config),
         new FreshFirefox(config),
-        new TerminalInterceptor(config)
+        new FreshTerminalInterceptor(config),
+        new ExistingTerminalInterceptor(config)
     ];
 
     // When the server exits, try to shut down the interceptors too

src/interceptors/terminal/existing-terminal-interceptor.ts

@@ -0,0 +1,54 @@
+
+import { Mockttp, getLocal } from 'mockttp';
+
+import { Interceptor } from '..';
+import { HtkConfig } from '../../config';
+import { getTerminalEnvVars } from './terminal-env-overrides';
+import { getShellScript } from './terminal-scripts';
+
+export class ExistingTerminalInterceptor implements Interceptor {
+
+    private servers: { [proxyPort: number]: Mockttp } = {};
+
+    id = 'existing-terminal';
+    version = '1.0.0';
+
+    constructor(private config: HtkConfig) { }
+
+    isActivable(): Promise<boolean> {
+        return Promise.resolve(true);
+    }
+
+    isActive(proxyPort: number): boolean {
+        return !!this.servers[proxyPort];
+    }
+
+    async activate(proxyPort: number): Promise<{ port: number }> {
+        const server = getLocal();
+        await server.start();
+
+        const envVars = getTerminalEnvVars(proxyPort, this.config.https, 'runtime-inherit');
+        const setupScript = getShellScript(envVars);
+        server.get('/setup').thenReply(200, setupScript, { "content-type": "text/x-shellscript" })
+
+        this.servers[proxyPort] = server;
+
+        return { port: server.port };
+    }
+
+    async deactivate(proxyPort: number): Promise<void> {
+        if (this.isActive(proxyPort)) {
+            await this.servers[proxyPort].stop();
+            delete this.servers[proxyPort];
+        }
+    }
+
+    deactivateAll(): Promise<void> {
+        return Promise.all(
+            Object.keys(this.servers).map((port) =>
+                this.deactivate(parseInt(port, 10))
+            )
+        ).then(() => {});
+    }
+
+}

src/interceptors/terminal/fresh-terminal-interceptor.ts

@@ -214,7 +214,7 @@ const getXfceTerminalCommand = async (command = 'xfce4-terminal'): Promise<Spawn
 
 const terminals: _.Dictionary<ChildProcess[] | undefined> = {}
 
-export class TerminalInterceptor implements Interceptor {
+export class FreshTerminalInterceptor implements Interceptor {
 
     id = 'fresh-terminal';
     version = '1.0.0';

src/interceptors/terminal/terminal-scripts.ts

@@ -71,6 +71,20 @@ if [ -n "$HTTP_TOOLKIT_ACTIVE" ]
 end
 ${END_CONFIG_SECTION}`;
 
+// A source-able shell script. Should work for everything except fish, sadly.
+export const getShellScript = (env: { [name: string]: string }) => `${
+        _.map(env, (value, key) => `    export ${key}="${value}"`).join('\n')
+    }
+
+    if command -v winpty >/dev/null 2>&1; then
+        # Work around for winpty's hijacking of certain commands
+        alias php=php
+        alias node=node
+    fi
+
+    echo 'HTTP Toolkit interception enabled'
+`;
+
 // Find the relevant user shell config file, add the above line to it, so that
 // shells launched with HTTP_TOOLKIT_ACTIVE set use the interception PATH.
 export const editShellStartupScripts = async () => {

test/integration-test.spec.ts

@@ -141,6 +141,12 @@ describe('Integration test', function () {
                 "isActivable": true,
                 "isActive": false,
                 "version": "1.0.0"
+            },
+            {
+                "id": "existing-terminal",
+                "isActivable": true,
+                "isActive": false,
+                "version": "1.0.0"
             }
         ]);
     });