clarify ipc messages

Author: bpasero

src/vs/code/electron-browser/sharedProcess/sharedProcessMain.ts

@@ -103,7 +103,7 @@ async function main(server: Server, initData: ISharedProcessInitData, configurat
 
 	const onExit = () => disposables.dispose();
 	process.once('exit', onExit);
-	ipcRenderer.once('handshake:mainprocess-goodbye', onExit);
+	ipcRenderer.once('electron-main->shared-process: exit', onExit);
 
 	disposables.add(server);
 
@@ -280,18 +280,19 @@ function setupIPC(hook: string): Promise<Server> {
 
 async function handshake(configuration: ISharedProcessConfiguration): Promise<void> {
 
-	// shared process -> main: give me payload for IPC connection
-	// main -> shared process: payload for IPC connection
+	// receive payload from electron-main to start things
 	const data = await new Promise<ISharedProcessInitData>(c => {
-		ipcRenderer.once('handshake:main-payload', (_: any, r: ISharedProcessInitData) => c(r));
-		ipcRenderer.send('handshake:sharedprocess-hello');
+		ipcRenderer.once('electron-main->shared-process: payload', (_: any, r: ISharedProcessInitData) => c(r));
+
+		// tell electron-main we are ready to receive payload
+		ipcRenderer.send('shared-process->electron-main: ready-for-payload');
 	});
 
-	// shared process => main: IPC connection established
+	// await IPC connection and signal this back to electron-main
 	const server = await setupIPC(data.sharedIPCHandle);
-	ipcRenderer.send('handshake:sharedprocess-ipc-ready');
+	ipcRenderer.send('shared-process->electron-main: ipc-ready');
 
-	// shared process => main: initialization done
+	// await initialization and signal this back to electron-main
 	await main(server, data, configuration);
-	ipcRenderer.send('handshake:sharedprocess-init-ready');
+	ipcRenderer.send('shared-process->electron-main: init-done');
 }

src/vs/code/electron-main/sharedProcess.ts

@@ -31,7 +31,8 @@ export class SharedProcess implements ISharedProcess {
 		@ILogService private readonly logService: ILogService,
 		@IThemeMainService private readonly themeMainService: IThemeMainService
 	) {
-		this._whenReady = new Promise<void>(c => ipcMain.once('handshake:sharedprocess-init-ready', () => c(undefined)));
+		// overall ready promise when shared process signals initialization is done
+		this._whenReady = new Promise<void>(c => ipcMain.once('shared-process->electron-main: init-done', () => c(undefined)));
 	}
 
 	@memoize
@@ -102,16 +103,19 @@ export class SharedProcess implements ISharedProcess {
 		});
 
 		return new Promise<void>(c => {
-			const onHello = Event.once(Event.fromNodeEventEmitter(ipcMain, 'handshake:sharedprocess-hello', ({ sender }: { sender: WebContents }) => sender));
-			disposables.add(onHello(sender => {
-				sender.send('handshake:main-payload', {
+			// send payload once shared process is ready to receive it
+			disposables.add(Event.once(Event.fromNodeEventEmitter(ipcMain, 'shared-process->electron-main: ready-for-payload', ({ sender }: { sender: WebContents }) => sender))(sender => {
+				sender.send('electron-main->shared-process: payload', {
 					sharedIPCHandle: this.environmentService.sharedIPCHandle,
 					args: this.environmentService.args,
 					logLevel: this.logService.getLevel()
 				});
 
-				disposables.add(toDisposable(() => sender.send('handshake:mainprocess-goodbye')));
-				ipcMain.once('handshake:sharedprocess-ipc-ready', () => c(undefined));
+				// signal exit to shared process when we get disposed
+				disposables.add(toDisposable(() => sender.send('electron-main->shared-process: exit')));
+
+				// complete IPC-ready promise when shared process signals this to us
+				ipcMain.once('shared-process->electron-main: ipc-ready', () => c(undefined));
 			}));
 		});
 	}