Add HTTPS proxy automated tests (microsoft/vscode#235410)

Author: chrmarti

src/agent.ts

@@ -262,4 +262,5 @@ type PacProxyAgentOptions =
 		SocksProxyAgentOptions & {
 	fallbackToDirect?: boolean;
 	originalAgent?: false | http.Agent;
+	_vscodeTestReplaceCaCerts?: boolean;
 }

src/index.ts

@@ -395,6 +395,7 @@ export function createHttpPatch(params: ProxyAgentParams, originals: typeof http
 					originalAgent: (!useProxySettings || isLocalhost || config === 'fallback') ? originalAgent : undefined,
 					lookupProxyAuthorization: params.lookupProxyAuthorization,
 					// keepAlive: ((originalAgent || originals.globalAgent) as { keepAlive?: boolean }).keepAlive, // Skipping due to https://github.com/microsoft/vscode/issues/228872.
+					_vscodeTestReplaceCaCerts: (options as SecureContextOptionsPatch)._vscodeTestReplaceCaCerts,
 				}, opts => new Promise<void>(resolve => addCertificatesToOptionsV1(params, params.addCertificatesV1(), opts, resolve)));
 				agent.protocol = isHttps ? 'https:' : 'http:';
 				options.agent = agent

tests/docker-compose.yml

@@ -19,12 +19,16 @@ services:
         build: test-proxy-client
         volumes:
             - ..:/repo
+            - ./test-https-proxy/mitmproxy-config:/root/.mitmproxy
         networks:
             - test-proxies
         working_dir: /repo/tests/test-client
         environment:
             - MOCHA_TESTS=src/proxy.test.ts
         command: /bin/sh -c '
+            while [ ! -f /root/.mitmproxy/mitmproxy-ca-cert.pem ]; do sleep 1; done &&
+            cp /root/.mitmproxy/mitmproxy-ca-cert.pem /usr/local/share/ca-certificates/mitmproxy.crt &&
+            update-ca-certificates &&
             /usr/local/bin/configure-kerberos-client.sh &&
             rm -rf /root/.npm &&
             npm run test:watch'
@@ -35,6 +39,8 @@ services:
                 condition: service_started
             test-http-kerberos-proxy:
                 condition: service_started
+            test-https-proxy:
+                condition: service_started
     test-http-proxy:
         image: ubuntu/squid:latest
         networks:
@@ -68,6 +74,21 @@ services:
         depends_on:
             test-https-server:
                 condition: service_healthy
+    test-https-proxy:
+        image: mitmproxy/mitmproxy:latest
+        # https://stackoverflow.com/q/61453754
+        command: /bin/sh -c 'update-ca-certificates && mitmdump --set ssl_insecure=true'
+        volumes:
+            - ./test-https-proxy/mitmproxy-config:/root/.mitmproxy
+            - ./test-https-server/ssl_cert.pem:/usr/local/share/ca-certificates/test-https-server.crt
+        networks:
+            - test-proxies
+            - test-proxies-and-servers
+        ports:
+            - 8080
+        depends_on:
+            test-https-server:
+                condition: service_healthy
     test-https-server:
         image: test-https-server:latest
         build: test-https-server

tests/test-client/package-lock.json

@@ -13,10 +13,11 @@
   "devDependencies": {
     "@types/kerberos": "^1.1.2",
     "@types/mocha": "5.2.5",
-    "@types/node": "^16.17.1",
+    "@types/node": "^20.8.4",
     "kerberos": "^2.0.1",
     "mocha": "10.2.0",
     "ts-node": "9.1.1",
-    "typescript": "^4.2.2"
+    "typescript": "^5.2.2",
+    "undici": "^6.20.1"
   }
 }

tests/test-client/package.json

@@ -1,8 +1,11 @@
 import * as https from 'https';
+import * as tls from 'tls';
 import * as assert from 'assert';
+import * as fs from 'fs';
+import * as path from 'path';
 import * as vpa from '../../..';
 import { createPacProxyAgent } from '../../../src/agent';
-import { testRequest, ca, unusedCa, proxiedProxyAgentParamsV1 } from './utils';
+import { testRequest, ca, unusedCa, proxiedProxyAgentParamsV1, tlsProxiedProxyAgentParamsV1 } from './utils';
 
 describe('Proxied client', function () {
 	it('should use HTTP proxy for HTTPS connection', function () {
@@ -14,6 +17,27 @@ describe('Proxied client', function () {
 		});
 	});
 
+	it('should use HTTPS proxy for HTTPS connection', function () {
+		const { resolveProxyWithRequest: resolveProxy } = vpa.createProxyResolver(tlsProxiedProxyAgentParamsV1);
+		const patchedHttps: typeof https = {
+			...https,
+			...vpa.createHttpPatch(tlsProxiedProxyAgentParamsV1, https, resolveProxy),
+		} as any;
+		return testRequest(patchedHttps, {
+			hostname: 'test-https-server',
+			path: '/test-path',
+			_vscodeTestReplaceCaCerts: true,
+		});
+	});
+
+	it('should use HTTPS proxy for HTTPS connection (fetch)', async function () {
+		const { resolveProxyURL } = vpa.createProxyResolver(tlsProxiedProxyAgentParamsV1);
+		const patchedFetch = vpa.createFetchPatch(tlsProxiedProxyAgentParamsV1, globalThis.fetch, resolveProxyURL);
+		const res = await patchedFetch('https://test-https-server/test-path');
+		assert.strictEqual(res.status, 200);
+		assert.strictEqual((await res.json()).status, 'OK!');
+	});
+
 	it('should support basic auth', function () {
 		return testRequest(https, {
 			hostname: 'test-https-server',

tests/test-client/src/proxy.test.ts

@@ -18,6 +18,7 @@ export const directProxyAgentParams: vpa.ProxyAgentParams = {
 	resolveProxy: async () => 'DIRECT',
 	getProxyURL: () => undefined,
 	getProxySupport: () => 'override',
+    isAdditionalFetchSupportEnabled: () => true,
 	addCertificatesV1: () => false,
 	addCertificatesV2: () => true,
 	log: console,
@@ -42,6 +43,11 @@ export const proxiedProxyAgentParamsV1: vpa.ProxyAgentParams = {
 	resolveProxy: async () => 'PROXY test-http-proxy:3128',
 };
 
+export const tlsProxiedProxyAgentParamsV1: vpa.ProxyAgentParams = {
+	...directProxyAgentParamsV1,
+	resolveProxy: async () => 'HTTPS test-https-proxy:8080',
+};
+
 export async function testRequest<C extends typeof https | typeof http>(client: C, options: C extends typeof https ? (https.RequestOptions & vpa.SecureContextOptionsPatch) : http.RequestOptions, testOptions: { assertResult?: (result: any, req: http.ClientRequest, res: http.IncomingMessage) => void; } = {}) {
 	return new Promise<void>((resolve, reject) => {
 		const req = client.request(options, res => {

tests/test-client/src/utils.ts

@@ -4,10 +4,7 @@
 		"target": "es2015",
 		"esModuleInterop": true,
 		"strict": true,
-		"resolveJsonModule": true,
-		"lib": [
-			"esnext"
-		]
+		"resolveJsonModule": true
 	},
 	"exclude": [
 		"node_modules"

tests/test-client/tsconfig.json

@@ -0,0 +1 @@
+mitmproxy-config