sandbox - make acquiring message port from sandbox reusable

Author: bpasero

src/vs/base/parts/ipc/electron-sandbox/ipc.mp.ts

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { Event } from 'vs/base/common/event';
+import { generateUuid } from 'vs/base/common/uuid';
+import { ipcMessagePort, ipcRenderer } from 'vs/base/parts/sandbox/electron-sandbox/globals';
+
+interface IMessageChannelResult {
+	nonce: string;
+	port: MessagePort;
+	source: unknown;
+}
+
+export async function acquirePort(requestChannel: string, responseChannel: string): Promise<MessagePort> {
+
+	// Ask to create message channel inside the window
+	// and send over a UUID to correlate the response
+	const nonce = generateUuid();
+	ipcMessagePort.acquire(responseChannel, nonce);
+	ipcRenderer.send(requestChannel, nonce);
+
+	// Wait until the main side has returned the `MessagePort`
+	// We need to filter by the `nonce` to ensure we listen
+	// to the right response.
+	const onMessageChannelResult = Event.fromDOMEventEmitter<IMessageChannelResult>(window, 'message', (e: MessageEvent) => ({ nonce: e.data, port: e.ports[0], source: e.source }));
+	const { port } = await Event.toPromise(Event.once(Event.filter(onMessageChannelResult, e => e.nonce === nonce && e.source === window)));
+
+	return port;
+}

src/vs/workbench/services/ipc/electron-sandbox/sharedProcessService.ts

@@ -3,16 +3,14 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { Event } from 'vs/base/common/event';
-import { ipcMessagePort, ipcRenderer } from 'vs/base/parts/sandbox/electron-sandbox/globals';
 import { Client as MessagePortClient } from 'vs/base/parts/ipc/common/ipc.mp';
 import { IChannel, IServerChannel, getDelayedChannel } from 'vs/base/parts/ipc/common/ipc';
-import { generateUuid } from 'vs/base/common/uuid';
 import { ILogService } from 'vs/platform/log/common/log';
 import { Disposable } from 'vs/base/common/lifecycle';
 import { ISharedProcessService } from 'vs/platform/ipc/electron-sandbox/services';
 import { mark } from 'vs/base/common/performance';
 import { Barrier, timeout } from 'vs/base/common/async';
+import { acquirePort } from 'vs/base/parts/ipc/electron-sandbox/ipc.mp';
 
 export class SharedProcessService extends Disposable implements ISharedProcessService {
 
@@ -44,20 +42,9 @@ export class SharedProcessService extends Disposable implements ISharedProcessSe
 		// is more cruicial.
 		await Promise.race([this.restoredBarrier.wait(), timeout(2000)]);
 
+		// Acquire a message port connected to the shared process
 		mark('code/willConnectSharedProcess');
-
-		// Ask to create message channel inside the window
-		// and send over a UUID to correlate the response
-		const nonce = generateUuid();
-		ipcMessagePort.acquire('vscode:createSharedProcessMessageChannelResult', nonce);
-		ipcRenderer.send('vscode:createSharedProcessMessageChannel', nonce);
-
-		// Wait until the main side has returned the `MessagePort`
-		// We need to filter by the `nonce` to ensure we listen
-		// to the right response.
-		const onMessageChannelResult = Event.fromDOMEventEmitter<{ nonce: string, port: MessagePort, source: unknown }>(window, 'message', (e: MessageEvent) => ({ nonce: e.data, port: e.ports[0], source: e.source }));
-		const { port } = await Event.toPromise(Event.once(Event.filter(onMessageChannelResult, e => e.nonce === nonce && e.source === window)));
-
+		const port = await acquirePort('vscode:createSharedProcessMessageChannel', 'vscode:createSharedProcessMessageChannelResult');
 		mark('code/didConnectSharedProcess');
 		this.logService.trace('Renderer->SharedProcess#connect: connection established');
 

src/vs/workbench/services/textmodelResolver/common/textModelResolverService.ts

@@ -89,15 +89,15 @@ class ResourceModelCollection extends ReferenceCollection<Promise<ITextEditorMod
 		}
 
 		// Track as being disposed before waiting for model to load
-		// to handle the case that the reference is aquired again
+		// to handle the case that the reference is acquired again
 		this.modelsToDispose.add(key);
 
 		(async () => {
 			try {
 				const model = await modelPromise;
 
 				if (!this.modelsToDispose.has(key)) {
-					// return if model has been aquired again meanwhile
+					// return if model has been acquired again meanwhile
 					return;
 				}
 
@@ -108,7 +108,7 @@ class ResourceModelCollection extends ReferenceCollection<Promise<ITextEditorMod
 				}
 
 				if (!this.modelsToDispose.has(key)) {
-					// return if model has been aquired again meanwhile
+					// return if model has been acquired again meanwhile
 					return;
 				}