Investigate using Electron's resolveProxy API (microsoft#60773)

chrmarti · chrmarti · commit 4e436d128c37 · 2018-10-22T20:00:58.000+02:00
diff --git a/package.json b/package.json
@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "applicationinsights": "1.0.6",
+    "electron-proxy-agent": "^1.0.2",
     "fast-plist": "0.1.2",
     "gc-signals": "^0.0.1",
     "getmac": "1.4.1",
diff --git a/src/typings/electron-proxy-agent.d.ts b/src/typings/electron-proxy-agent.d.ts
@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'electron-proxy-agent';
diff --git a/src/vs/platform/request/node/request.ts b/src/vs/platform/request/node/request.ts
@@ -47,6 +47,17 @@ Registry.as<IConfigurationRegistry>(Extensions.Configuration)
 				type: ['null', 'string'],
 				default: null,
 				description: localize('proxyAuthorization', "The value to send as the 'Proxy-Authorization' header for every network request.")
+			},
+			'http.systemProxy': {
+				type: 'string',
+				enum: ['off', 'on', 'force'],
+				enumDescriptions: [
+					localize('systemProxyOff', "Do not use system proxy configuration."),
+					localize('systemProxyOn', "Use system proxy configuration if not specified in the request options."),
+					localize('systemProxyForce', "Always use system proxy configuration."),
+				],
+				default: 'off',
+				description: localize('systemProxy', "Experimental setting: Use the system proxy configuration.")
 			}
 		}
 	});
diff --git a/src/vs/platform/windows/common/windows.ts b/src/vs/platform/windows/common/windows.ts
@@ -167,6 +167,7 @@ export interface IWindowsService {
 	startCrashReporter(config: CrashReporterStartOptions): TPromise<void>;
 
 	openAboutDialog(): TPromise<void>;
+	resolveProxy(windowId: number, url: string): Promise<string | undefined>;
 }
 
 export const IWindowService = createDecorator<IWindowService>('windowService');
@@ -214,6 +215,7 @@ export interface IWindowService {
 	showMessageBox(options: MessageBoxOptions): TPromise<IMessageBoxResult>;
 	showSaveDialog(options: SaveDialogOptions): TPromise<string>;
 	showOpenDialog(options: OpenDialogOptions): TPromise<string[]>;
+	resolveProxy(url: string): Promise<string | undefined>;
 }
 
 export type MenuBarVisibility = 'default' | 'visible' | 'toggle' | 'hidden';
diff --git a/src/vs/platform/windows/electron-browser/windowService.ts b/src/vs/platform/windows/electron-browser/windowService.ts
@@ -163,4 +163,8 @@ export class WindowService implements IWindowService {
 	updateTouchBar(items: ISerializableCommandAction[][]): TPromise<void> {
 		return this.windowsService.updateTouchBar(this.windowId, items);
 	}
+
+	resolveProxy(url: string): Promise<string | undefined> {
+		return this.windowsService.resolveProxy(this.windowId, url);
+	}
 }
diff --git a/src/vs/platform/windows/electron-main/windowsService.ts b/src/vs/platform/windows/electron-main/windowsService.ts
@@ -564,6 +564,19 @@ export class WindowsService implements IWindowsService, IURLHandler, IDisposable
 		return TPromise.wrap(true);
 	}
 
+	resolveProxy(windowId: number, url: string): Promise<string | undefined> {
+		return new Promise(resolve => {
+			const codeWindow = this.windowsMainService.getWindowById(windowId);
+			if (codeWindow) {
+				codeWindow.win.webContents.session.resolveProxy(url, proxy => {
+					resolve(proxy);
+				});
+			} else {
+				resolve();
+			}
+		});
+	}
+
 	dispose(): void {
 		this.disposables = dispose(this.disposables);
 	}
diff --git a/src/vs/platform/windows/node/windowsIpc.ts b/src/vs/platform/windows/node/windowsIpc.ts
@@ -73,6 +73,7 @@ export interface IWindowsChannel extends IChannel {
 	call(command: 'openExternal', arg: string): Thenable<boolean>;
 	call(command: 'startCrashReporter', arg: CrashReporterStartOptions): Thenable<void>;
 	call(command: 'openAboutDialog'): Thenable<void>;
+	call(command: 'resolveProxy', arg: [number, string]): Thenable<string | undefined>;
 }
 
 export class WindowsChannel implements IWindowsChannel {
@@ -178,6 +179,7 @@ export class WindowsChannel implements IWindowsChannel {
 			case 'openExternal': return this.service.openExternal(arg);
 			case 'startCrashReporter': return this.service.startCrashReporter(arg);
 			case 'openAboutDialog': return this.service.openAboutDialog();
+			case 'resolveProxy': return this.service.resolveProxy(arg[0], arg[1]);
 		}
 		return undefined;
 	}
@@ -404,4 +406,8 @@ export class WindowsChannelClient implements IWindowsService {
 	openAboutDialog(): TPromise<void> {
 		return TPromise.wrap(this.channel.call('openAboutDialog'));
 	}
+
+	resolveProxy(windowId: number, url: string): Promise<string | undefined> {
+		return Promise.resolve(this.channel.call('resolveProxy', [windowId, url]));
+	}
 }
diff --git a/src/vs/workbench/api/electron-browser/mainThreadWorkspace.ts b/src/vs/workbench/api/electron-browser/mainThreadWorkspace.ts
@@ -40,6 +40,7 @@ export class MainThreadWorkspace implements MainThreadWorkspaceShape {
 		@IConfigurationService private readonly _configurationService: IConfigurationService,
 		@IWorkspaceEditingService private readonly _workspaceEditingService: IWorkspaceEditingService,
 		@IStatusbarService private readonly _statusbarService: IStatusbarService,
+		@IWindowService private readonly _windowService: IWindowService,
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
 		@ILabelService private readonly _labelService: ILabelService
 	) {
@@ -231,6 +232,10 @@ export class MainThreadWorkspace implements MainThreadWorkspaceShape {
 			return result.results.every(each => each.success === true);
 		});
 	}
+
+	$resolveProxy(url: string): Thenable<string> {
+		return this._windowService.resolveProxy(url);
+	}
 }
 
 CommandsRegistry.registerCommand('_workbench.enterWorkspace', async function (accessor: ServicesAccessor, workspace: URI, disableExtensions: string[]) {
diff --git a/src/vs/workbench/api/node/extHost.protocol.ts b/src/vs/workbench/api/node/extHost.protocol.ts
@@ -487,6 +487,7 @@ export interface MainThreadWorkspaceShape extends IDisposable {
 	$checkExists(includes: string[], token: CancellationToken): Thenable<boolean>;
 	$saveAll(includeUntitled?: boolean): Thenable<boolean>;
 	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string }[]): Thenable<void>;
+	$resolveProxy(url: string): Thenable<string>;
 }
 
 export interface IFileChangeDto {
diff --git a/src/vs/workbench/api/node/extHostExtensionService.ts b/src/vs/workbench/api/node/extHostExtensionService.ts
@@ -147,12 +147,13 @@ export class ExtHostExtensionService implements ExtHostExtensionServiceShape {
 		extHostContext: IMainContext,
 		extHostWorkspace: ExtHostWorkspace,
 		extHostConfiguration: ExtHostConfiguration,
-		extHostLogService: ExtHostLogService
+		extHostLogService: ExtHostLogService,
+		mainThreadTelemetry: MainThreadTelemetryShape
 	) {
 		this._barrier = new Barrier();
 		this._registry = new ExtensionDescriptionRegistry(initData.extensions);
 		this._extHostLogService = extHostLogService;
-		this._mainThreadTelemetry = extHostContext.getProxy(MainContext.MainThreadTelemetry);
+		this._mainThreadTelemetry = mainThreadTelemetry;
 		this._storage = new ExtHostStorage(extHostContext);
 		this._storagePath = new ExtensionStoragePath(initData.workspace, initData.environment);
 		this._proxy = extHostContext.getProxy(MainContext.MainThreadExtensionService);
diff --git a/src/vs/workbench/api/node/extHostWorkspace.ts b/src/vs/workbench/api/node/extHostWorkspace.ts
@@ -454,4 +454,8 @@ export class ExtHostWorkspace implements ExtHostWorkspaceShape {
 	saveAll(includeUntitled?: boolean): Thenable<boolean> {
 		return this._proxy.$saveAll(includeUntitled);
 	}
+
+	resolveProxy(url: string): Thenable<string> {
+		return this._proxy.$resolveProxy(url);
+	}
 }
diff --git a/src/vs/workbench/node/extensionHostMain.ts b/src/vs/workbench/node/extensionHostMain.ts
@@ -22,6 +22,7 @@ import { ExtHostLogService } from 'vs/workbench/api/node/extHostLogService';
 import { timeout } from 'vs/base/common/async';
 import { Counter } from 'vs/base/common/numbers';
 import { CancellationTokenSource } from 'vs/base/common/cancellation';
+import { connectProxyResolver } from 'vs/workbench/node/proxyResolver';
 
 // we don't (yet) throw when extensions parse
 // uris that have no scheme
@@ -89,7 +90,9 @@ export class ExtensionHostMain {
 		this._extHostLogService.trace('initData', initData);
 
 		this._extHostConfiguration = new ExtHostConfiguration(rpcProtocol.getProxy(MainContext.MainThreadConfiguration), extHostWorkspace, initData.configuration);
-		this._extensionService = new ExtHostExtensionService(initData, rpcProtocol, extHostWorkspace, this._extHostConfiguration, this._extHostLogService);
+		const mainThreadTelemetry = rpcProtocol.getProxy(MainContext.MainThreadTelemetry);
+		connectProxyResolver(extHostWorkspace, this._extHostConfiguration, this._extHostLogService, mainThreadTelemetry);
+		this._extensionService = new ExtHostExtensionService(initData, rpcProtocol, extHostWorkspace, this._extHostConfiguration, this._extHostLogService, mainThreadTelemetry);
 
 		// error forwarding and stack trace scanning
 		Error.stackTraceLimit = 100; // increase number of stack frames (from 10, https://github.com/v8/v8/wiki/Stack-Trace-API)
diff --git a/src/vs/workbench/node/proxyResolver.ts b/src/vs/workbench/node/proxyResolver.ts
@@ -0,0 +1,103 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ExtHostWorkspace } from 'vs/workbench/api/node/extHostWorkspace';
+import { ExtHostConfiguration } from 'vs/workbench/api/node/extHostConfiguration';
+import * as http from 'http';
+import * as https from 'https';
+import ElectronProxyAgent = require('electron-proxy-agent');
+import { MainThreadTelemetryShape } from 'vs/workbench/api/node/extHost.protocol';
+import { ExtHostLogService } from 'vs/workbench/api/node/extHostLogService';
+import { toErrorMessage } from 'vs/base/common/errorMessage';
+
+export function connectProxyResolver(extHostWorkspace: ExtHostWorkspace, extHostConfiguration: ExtHostConfiguration, extHostLogService: ExtHostLogService, mainThreadTelemetry: MainThreadTelemetryShape) {
+	let timeout: NodeJS.Timer | undefined;
+	let count = 0;
+	let duration = 0;
+	let errorCount = 0;
+	function logEvent() {
+		timeout = undefined;
+		/* __GDPR__
+			"resolveProxy" : {
+				"count": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true },
+				"duration": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true },
+				"errorCount": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true },
+				"${include}": [
+					"${TypeScriptCommonProperties}"
+				]
+			}
+		*/
+		mainThreadTelemetry.$publicLog('resolveProxy', { count, duration, errorCount });
+		count = duration = errorCount = 0;
+	}
+
+	function resolveProxy(url: string, callback: (proxy?: string) => void) {
+		if (!timeout) {
+			timeout = setTimeout(logEvent, 10 * 60 * 1000);
+		}
+
+		const start = Date.now();
+		extHostWorkspace.resolveProxy(url)
+			.then(proxy => {
+				callback(proxy);
+			}).then(() => {
+				count++;
+				duration = Date.now() - start + duration;
+			}, err => {
+				errorCount++;
+				extHostLogService.error('resolveProxy', toErrorMessage(err));
+				callback();
+			});
+	}
+
+	const agent = new ElectronProxyAgent({ resolveProxy });
+
+	let config = extHostConfiguration.getConfiguration('http').get('systemProxy') || 'off';
+	extHostConfiguration.onDidChangeConfiguration(e => {
+		config = extHostConfiguration.getConfiguration('http').get('systemProxy') || 'off';
+	});
+
+	function patch(original: typeof http.get) {
+		function patched(url: string | URL, options?: http.RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest {
+			if (config === 'off') {
+				return original.apply(null, arguments);
+			}
+
+			if (typeof url !== 'string' && !(url && (<any>url).searchParams)) {
+				callback = <any>options;
+				options = url;
+				url = null;
+			}
+			if (typeof options === 'function') {
+				callback = options;
+				options = null;
+			}
+			options = options || {};
+
+			if (config === 'force' || config === 'on' && !options.agent) {
+				if (url) {
+					const parsed = typeof url === 'string' ? new URL(url) : url;
+					options = {
+						protocol: parsed.protocol,
+						hostname: parsed.hostname,
+						port: parsed.port,
+						path: parsed.pathname,
+						...options
+					};
+				}
+				options.agent = agent;
+				return original(options, callback);
+			}
+
+			return original.apply(null, arguments);
+		}
+		return patched;
+	}
+
+	(<any>http).get = patch(http.get);
+	(<any>http).request = patch(http.request);
+	(<any>https).get = patch(https.get);
+	(<any>https).request = patch(https.request);
+}
diff --git a/src/vs/workbench/test/workbenchTestServices.ts b/src/vs/workbench/test/workbenchTestServices.ts
@@ -1124,6 +1124,10 @@ export class TestWindowService implements IWindowService {
 	updateTouchBar(_items: ISerializableCommandAction[][]): TPromise<void> {
 		return TPromise.as(void 0);
 	}
+
+	resolveProxy(url: string): Promise<string | undefined> {
+		return Promise.resolve(void 0);
+	}
 }
 
 export class TestLifecycleService implements ILifecycleService {
@@ -1380,6 +1384,10 @@ export class TestWindowsService implements IWindowsService {
 	openAboutDialog(): TPromise<void> {
 		return TPromise.as(void 0);
 	}
+
+	resolveProxy(windowId: number, url: string): Promise<string | undefined> {
+		return Promise.resolve(void 0);
+	}
 }
 
 export class TestTextResourceConfigurationService implements ITextResourceConfigurationService {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -167,6 +167,7 @@ export interface IWindowsService {`
`167`	`167`	`startCrashReporter(config: CrashReporterStartOptions): TPromise<void>;`
`168`	`168`
`169`	`169`	`openAboutDialog(): TPromise<void>;`
	`170`	`+ resolveProxy(windowId: number, url: string): Promise<string \| undefined>;`
`170`	`171`	`}`
`171`	`172`
`172`	`173`	`export const IWindowService = createDecorator<IWindowService>('windowService');`
`@@ -214,6 +215,7 @@ export interface IWindowService {`
`214`	`215`	`showMessageBox(options: MessageBoxOptions): TPromise<IMessageBoxResult>;`
`215`	`216`	`showSaveDialog(options: SaveDialogOptions): TPromise<string>;`
`216`	`217`	`showOpenDialog(options: OpenDialogOptions): TPromise<string[]>;`
	`218`	`+ resolveProxy(url: string): Promise<string \| undefined>;`
`217`	`219`	`}`
`218`	`220`
`219`	`221`	`export type MenuBarVisibility = 'default' \| 'visible' \| 'toggle' \| 'hidden';`
Original file line number	Diff line number	Diff line change
`@@ -163,4 +163,8 @@ export class WindowService implements IWindowService {`
`163`	`163`	`updateTouchBar(items: ISerializableCommandAction[][]): TPromise<void> {`
`164`	`164`	`return this.windowsService.updateTouchBar(this.windowId, items);`
`165`	`165`	`}`
	`166`	`+`
	`167`	`+ resolveProxy(url: string): Promise<string \| undefined> {`
	`168`	`+ return this.windowsService.resolveProxy(this.windowId, url);`
	`169`	`+ }`
`166`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ export interface IWindowsChannel extends IChannel {`
`73`	`73`	`call(command: 'openExternal', arg: string): Thenable<boolean>;`
`74`	`74`	`call(command: 'startCrashReporter', arg: CrashReporterStartOptions): Thenable<void>;`
`75`	`75`	`call(command: 'openAboutDialog'): Thenable<void>;`
	`76`	`+ call(command: 'resolveProxy', arg: [number, string]): Thenable<string \| undefined>;`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`export class WindowsChannel implements IWindowsChannel {`
`@@ -178,6 +179,7 @@ export class WindowsChannel implements IWindowsChannel {`
`178`	`179`	`case 'openExternal': return this.service.openExternal(arg);`
`179`	`180`	`case 'startCrashReporter': return this.service.startCrashReporter(arg);`
`180`	`181`	`case 'openAboutDialog': return this.service.openAboutDialog();`
	`182`	`+ case 'resolveProxy': return this.service.resolveProxy(arg[0], arg[1]);`
`181`	`183`	`}`
`182`	`184`	`return undefined;`
`183`	`185`	`}`
`@@ -404,4 +406,8 @@ export class WindowsChannelClient implements IWindowsService {`
`404`	`406`	`openAboutDialog(): TPromise<void> {`
`405`	`407`	`return TPromise.wrap(this.channel.call('openAboutDialog'));`
`406`	`408`	`}`
	`409`	`+`
	`410`	`+ resolveProxy(windowId: number, url: string): Promise<string \| undefined> {`
	`411`	`+ return Promise.resolve(this.channel.call('resolveProxy', [windowId, url]));`
	`412`	`+ }`
`407`	`413`	`}`
Original file line number	Diff line number	Diff line change
`@@ -487,6 +487,7 @@ export interface MainThreadWorkspaceShape extends IDisposable {`
`487`	`487`	`$checkExists(includes: string[], token: CancellationToken): Thenable<boolean>;`
`488`	`488`	`$saveAll(includeUntitled?: boolean): Thenable<boolean>;`
`489`	`489`	`$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string }[]): Thenable<void>;`
	`490`	`+ $resolveProxy(url: string): Thenable<string>;`
`490`	`491`	`}`
`491`	`492`
`492`	`493`	`export interface IFileChangeDto {`