Enable Docker interception by default (remove feature flag)

pimterry · pimterry · commit cf136585cb0e · 2022-01-21T00:44:24.000+01:00
diff --git a/src/interceptors/terminal/existing-terminal-interceptor.ts b/src/interceptors/terminal/existing-terminal-interceptor.ts
@@ -33,9 +33,7 @@ export class ExistingTerminalInterceptor implements Interceptor {
         return !!serverState && serverState.isActive;
     }
 
-    async activate(proxyPort: number, options: {
-        dockerEnabled?: boolean
-    } = {}): Promise<{ port: number }> {
+    async activate(proxyPort: number): Promise<{ port: number }> {
         if (this.servers[proxyPort]) {
             // Reset isActive, so we wait again for a new request
             this.servers[proxyPort].isActive = false;
@@ -45,9 +43,7 @@ export class ExistingTerminalInterceptor implements Interceptor {
         const server = getLocal();
         await server.start({ startPort: proxyPort + 1, endPort: 65535 });
 
-        const envVars = getTerminalEnvVars(proxyPort, this.config.https, 'runtime-inherit', {}, {
-            dockerEnabled: options.dockerEnabled
-        });
+        const envVars = getTerminalEnvVars(proxyPort, this.config.https, 'runtime-inherit', {});
         const setupScript = getShellScript(server.urlFor('/success'), envVars);
 
         const serverState = { server, isActive: false };
diff --git a/src/interceptors/terminal/fresh-terminal-interceptor.ts b/src/interceptors/terminal/fresh-terminal-interceptor.ts
@@ -202,9 +202,7 @@ export class FreshTerminalInterceptor implements Interceptor {
         return !!(terminals[proxyPort] && terminals[proxyPort]!.length);
     }
 
-    async activate(proxyPort: number, activationOptions: {
-        dockerEnabled?: boolean
-    } = {}): Promise<void> {
+    async activate(proxyPort: number): Promise<void> {
         const terminalSpawnArgs = await getTerminalCommand();
         if (!terminalSpawnArgs) throw new Error('Could not find a suitable terminal');
 
@@ -230,9 +228,7 @@ export class FreshTerminalInterceptor implements Interceptor {
             _.assign(options || {}, {
                 env: {
                     ...currentEnv,
-                    ...getTerminalEnvVars(proxyPort, this.config.https, currentEnv, {}, {
-                        dockerEnabled: activationOptions.dockerEnabled
-                    }),
+                    ...getTerminalEnvVars(proxyPort, this.config.https, currentEnv, {}),
                 },
                 cwd: currentEnv.HOME || currentEnv.USERPROFILE
             })
diff --git a/src/interceptors/terminal/terminal-env-overrides.ts b/src/interceptors/terminal/terminal-env-overrides.ts
@@ -25,8 +25,7 @@ export function getTerminalEnvVars(
         httpToolkitIp?: string,
         overridePath?: string,
         targetPlatform?: NodeJS.Platform
-    } = {},
-    options: { dockerEnabled?: boolean } = { dockerEnabled: false }
+    } = {}
 ): { [key: string]: string } {
     const { overridePath, targetPlatform, httpToolkitIp } = {
         httpToolkitIp: '127.0.0.1',
@@ -130,13 +129,9 @@ export function getTerminalEnvVars(
                 ? `${currentEnv.JAVA_TOOL_OPTIONS} ${javaAgentOption}`
             : javaAgentOption,
 
-        ...(options.dockerEnabled
-            ? {
-                // Run all Docker operations through our Docker-hooking proxy:
-                'DOCKER_HOST': dockerHost,
-                // For now, we don't support intercepting BuildKit builds - disable them:
-                'DOCKER_BUILDKIT': '0'
-            } : {}
-        )
+        // Run all Docker operations through our Docker-hooking proxy:
+        'DOCKER_HOST': dockerHost,
+        // For now, we don't support intercepting BuildKit builds - disable them:
+        'DOCKER_BUILDKIT': '0'
     };
 }
diff --git a/test/interceptors/docker-terminal-interception.spec.ts b/test/interceptors/docker-terminal-interception.spec.ts
@@ -61,11 +61,9 @@ describe('Docker CLI interception', function () {
 
             // Run the resulting container via the intercepting Docker proxy:
             const { server, httpsConfig} = await testSetup;
-            const mainRule = await server.get('https://example.test').thenReply(200);
+            const mainRule = await server.forGet('https://example.test').thenReply(200);
 
-            const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-                dockerEnabled: true
-            });
+            const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
             childProc.spawn(
                 'docker', ['run', '--rm', imageId, 'https://example.test'],
@@ -94,11 +92,9 @@ describe('Docker CLI interception', function () {
     it("should intercept 'docker run' launching a remote image", async () => {
         const { server, httpsConfig } = await testSetup;
 
-        const mainRule = await server.get("https://example.test").thenReply(200);
+        const mainRule = await server.forGet("https://example.test").thenReply(200);
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         const { exitCode, stdout, stderr } = await spawnToResult(
             'docker', ['run', '--rm', 'node:14', '-e', `require("https").get("https://example.test")`],
@@ -120,11 +116,9 @@ describe('Docker CLI interception', function () {
 
         const { server, httpsConfig } = await testSetup;
 
-        const mainRule = await server.anyRequest().thenReply(200, "Mock response\n");
+        const mainRule = await server.forAnyRequest().thenReply(200, "Mock response\n");
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         const { exitCode, stdout, stderr } = await spawnToResult('docker', ['build', '.'], {
             env: { ...process.env, ...terminalEnvOverrides },
@@ -191,11 +185,11 @@ Successfully built <hash>
         this.timeout(30000);
 
         const { server, httpsConfig, getPassThroughOptions } = await testSetup;
-        const externalRule = await server.anyRequest()
+        const externalRule = await server.forAnyRequest()
             .forHost("example.test")
             .thenReply(200, "Mock response");
         const internalRule = await server
-            .unmatchedRequest()
+            .forUnmatchedRequest()
             .thenPassThrough({
                 proxyConfig: ruleParams[`docker-tunnel-proxy-${server.port}`],
                 ...(await getPassThroughOptions())
@@ -209,9 +203,7 @@ Successfully built <hash>
             true
         );
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         // "DC Up" the same project, but in an intercepted env. Should ignore the existing containers,
         // create new intercepted containers, and then up those as normal.
@@ -242,11 +234,11 @@ Successfully built <hash>
         this.timeout(30000);
 
         const { server, httpsConfig, getPassThroughOptions } = await testSetup;
-        await server.anyRequest()
+        await server.forAnyRequest()
             .forHost("example.test")
             .thenReply(200, "Mock response");
         await server
-            .unmatchedRequest()
+            .forUnmatchedRequest()
             .thenPassThrough({
                 proxyConfig: ruleParams[`docker-tunnel-proxy-${server.port}`],
                 ...(await getPassThroughOptions())
@@ -260,9 +252,7 @@ Successfully built <hash>
             true
         );
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         // "DC Up" the same project, but in an intercepted env. Should ignore the existing containers,
         // create new intercepted containers, and then up those as normal.
@@ -296,9 +286,7 @@ Successfully built <hash>
     it("should clean up containers after shutdown", async () => {
         const { server, httpsConfig } = await testSetup;
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         const uninterceptedResult = await spawnToResult('docker', ['create', 'node:14']);
 
@@ -340,9 +328,7 @@ Successfully built <hash>
         const { server, httpsConfig } = await testSetup;
         const docker = new Docker();
 
-        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {}, {
-            dockerEnabled: true
-        });
+        const terminalEnvOverrides = getTerminalEnvVars(server.port, httpsConfig, process.env, {});
 
         // Tunnel doesn't start preemptively:
         await delay(500);
