Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support --socket-path on Windows #151174

Merged
merged 1 commit into from Jun 3, 2022
Merged

Support --socket-path on Windows #151174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
133 changes: 105 additions & 28 deletions src/vs/server/node/extensionHostConnection.ts
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@ import { join, delimiter } from 'vs/base/common/path';
import { VSBuffer } from 'vs/base/common/buffer';
import { IRemoteConsoleLog } from 'vs/base/common/console';
import { Emitter, Event } from 'vs/base/common/event';
import { NodeSocket, WebSocketNodeSocket } from 'vs/base/parts/ipc/node/ipc.net';
import { createRandomIPCHandle, NodeSocket, WebSocketNodeSocket } from 'vs/base/parts/ipc/node/ipc.net';
import { getResolvedShellEnv } from 'vs/platform/shell/node/shellEnv';
import { ILogService } from 'vs/platform/log/common/log';
import { IRemoteExtensionHostStartParams } from 'vs/platform/remote/common/remoteAgentConnection';
Expand All @@ -21,6 +21,7 @@ import { IProcessEnvironment, isWindows } from 'vs/base/common/platform';
import { logRemoteEntry } from 'vs/workbench/services/extensions/common/remoteConsoleUtil';
import { removeDangerousEnvVariables } from 'vs/base/common/processes';
import { IExtensionHostStatusService } from 'vs/server/node/extensionHostStatusService';
import { DisposableStore, toDisposable } from 'vs/base/common/lifecycle';

export async function buildUserEnvironment(startParamsEnv: { [key: string]: string | null } = {}, withUserShellEnvironment: boolean, language: string, isDebug: boolean, environmentService: IServerEnvironmentService, logService: ILogService): Promise<IProcessEnvironment> {
const nlsConfig = await getNLSConfiguration(language, environmentService.userDataPath);
Expand All @@ -44,7 +45,6 @@ export async function buildUserEnvironment(startParamsEnv: { [key: string]: stri
VSCODE_AMD_ENTRYPOINT: 'vs/workbench/api/node/extensionHostProcess',
VSCODE_PIPE_LOGGING: 'true',
VSCODE_VERBOSE_LOGGING: 'true',
VSCODE_EXTHOST_WILL_SEND_SOCKET: 'true',
VSCODE_HANDLES_UNCAUGHT_ERRORS: 'true',
VSCODE_LOG_STACK: 'false',
VSCODE_NLS_CONFIG: JSON.stringify(nlsConfig, undefined, 0)
Expand Down Expand Up @@ -73,21 +73,36 @@ export async function buildUserEnvironment(startParamsEnv: { [key: string]: stri

class ConnectionData {
constructor(
public readonly socket: net.Socket,
public readonly socketDrain: Promise<void>,
public readonly initialDataChunk: VSBuffer,
public readonly skipWebSocketFrames: boolean,
public readonly permessageDeflate: boolean,
public readonly inflateBytes: VSBuffer,
public readonly socket: NodeSocket | WebSocketNodeSocket,
public readonly initialDataChunk: VSBuffer
) { }

public socketDrain(): Promise<void> {
return this.socket.drain();
}

public toIExtHostSocketMessage(): IExtHostSocketMessage {

let skipWebSocketFrames: boolean;
let permessageDeflate: boolean;
let inflateBytes: VSBuffer;

if (this.socket instanceof NodeSocket) {
skipWebSocketFrames = true;
permessageDeflate = false;
inflateBytes = VSBuffer.alloc(0);
} else {
skipWebSocketFrames = false;
permessageDeflate = this.socket.permessageDeflate;
inflateBytes = this.socket.recordedInflateBytes;
}

return {
type: 'VSCODE_EXTHOST_IPC_SOCKET',
initialDataChunk: (<Buffer>this.initialDataChunk.buffer).toString('base64'),
skipWebSocketFrames: this.skipWebSocketFrames,
permessageDeflate: this.permessageDeflate,
inflateBytes: (<Buffer>this.inflateBytes.buffer).toString('base64'),
skipWebSocketFrames: skipWebSocketFrames,
permessageDeflate: permessageDeflate,
inflateBytes: (<Buffer>inflateBytes.buffer).toString('base64'),
};
}
}
Expand All @@ -97,6 +112,7 @@ export class ExtensionHostConnection {
private _onClose = new Emitter<void>();
readonly onClose: Event<void> = this._onClose.event;

private readonly _canSendSocket: boolean;
private _disposed: boolean;
private _remoteAddress: string;
private _extensionHostProcess: cp.ChildProcess | null;
Expand All @@ -111,10 +127,11 @@ export class ExtensionHostConnection {
@ILogService private readonly _logService: ILogService,
@IExtensionHostStatusService private readonly _extensionHostStatusService: IExtensionHostStatusService,
) {
this._canSendSocket = (!isWindows || !this._environmentService.args['socket-path']);
this._disposed = false;
this._remoteAddress = remoteAddress;
this._extensionHostProcess = null;
this._connectionData = ExtensionHostConnection._toConnectionData(socket, initialDataChunk);
this._connectionData = new ConnectionData(socket, initialDataChunk);

this._log(`New connection established.`);
}
Expand All @@ -131,19 +148,46 @@ export class ExtensionHostConnection {
this._logService.error(`${this._logPrefix}${_str}`);
}

private static _toConnectionData(socket: NodeSocket | WebSocketNodeSocket, initialDataChunk: VSBuffer): ConnectionData {
if (socket instanceof NodeSocket) {
return new ConnectionData(socket.socket, socket.drain(), initialDataChunk, true, false, VSBuffer.alloc(0));
} else {
return new ConnectionData(socket.socket.socket, socket.drain(), initialDataChunk, false, socket.permessageDeflate, socket.recordedInflateBytes);
private async _pipeSockets(extHostSocket: net.Socket, connectionData: ConnectionData): Promise<void> {

const disposables = new DisposableStore();
disposables.add(connectionData.socket);
disposables.add(toDisposable(() => {
extHostSocket.destroy();
}));

const stopAndCleanup = () => {
disposables.dispose();
};

disposables.add(connectionData.socket.onEnd(stopAndCleanup));
disposables.add(connectionData.socket.onClose(stopAndCleanup));

disposables.add(Event.fromNodeEventEmitter<void>(extHostSocket, 'end')(stopAndCleanup));
disposables.add(Event.fromNodeEventEmitter<void>(extHostSocket, 'close')(stopAndCleanup));
disposables.add(Event.fromNodeEventEmitter<void>(extHostSocket, 'error')(stopAndCleanup));

disposables.add(connectionData.socket.onData((e) => extHostSocket.write(e.buffer)));
disposables.add(Event.fromNodeEventEmitter<Buffer>(extHostSocket, 'data')((e) => {
connectionData.socket.write(VSBuffer.wrap(e));
}));

if (connectionData.initialDataChunk.byteLength > 0) {
extHostSocket.write(connectionData.initialDataChunk.buffer);
}
}

private async _sendSocketToExtensionHost(extensionHostProcess: cp.ChildProcess, connectionData: ConnectionData): Promise<void> {
// Make sure all outstanding writes have been drained before sending the socket
await connectionData.socketDrain;
await connectionData.socketDrain();
const msg = connectionData.toIExtHostSocketMessage();
extensionHostProcess.send(msg, connectionData.socket);
let socket: net.Socket;
if (connectionData.socket instanceof NodeSocket) {
socket = connectionData.socket.socket;
} else {
socket = connectionData.socket.socket.socket;
}
extensionHostProcess.send(msg, socket);
}

public shortenReconnectionGraceTimeIfNecessary(): void {
Expand All @@ -159,7 +203,7 @@ export class ExtensionHostConnection {
public acceptReconnection(remoteAddress: string, _socket: NodeSocket | WebSocketNodeSocket, initialDataChunk: VSBuffer): void {
this._remoteAddress = remoteAddress;
this._log(`The client has reconnected.`);
const connectionData = ExtensionHostConnection._toConnectionData(_socket, initialDataChunk);
const connectionData = new ConnectionData(_socket, initialDataChunk);

if (!this._extensionHostProcess) {
// The extension host didn't even start up yet
Expand Down Expand Up @@ -197,6 +241,17 @@ export class ExtensionHostConnection {
const env = await buildUserEnvironment(startParams.env, true, startParams.language, !!startParams.debugId, this._environmentService, this._logService);
removeDangerousEnvVariables(env);

let extHostNamedPipeServer: net.Server | null;

if (this._canSendSocket) {
env['VSCODE_EXTHOST_WILL_SEND_SOCKET'] = 'true';
extHostNamedPipeServer = null;
} else {
const { namedPipeServer, pipeName } = await this._listenOnPipe();
env['VSCODE_IPC_HOOK_EXTHOST'] = pipeName;
extHostNamedPipeServer = namedPipeServer;
}

const opts = {
env,
execArgv,
Expand Down Expand Up @@ -240,14 +295,21 @@ export class ExtensionHostConnection {
this._cleanResources();
});

const messageListener = (msg: IExtHostReadyMessage) => {
if (msg.type === 'VSCODE_EXTHOST_IPC_READY') {
this._extensionHostProcess!.removeListener('message', messageListener);
this._sendSocketToExtensionHost(this._extensionHostProcess!, this._connectionData!);
this._connectionData = null;
}
};
this._extensionHostProcess.on('message', messageListener);
if (extHostNamedPipeServer) {
extHostNamedPipeServer.on('connection', (socket) => {
extHostNamedPipeServer!.close();
this._pipeSockets(socket, this._connectionData!);
});
} else {
const messageListener = (msg: IExtHostReadyMessage) => {
if (msg.type === 'VSCODE_EXTHOST_IPC_READY') {
this._extensionHostProcess!.removeListener('message', messageListener);
this._sendSocketToExtensionHost(this._extensionHostProcess!, this._connectionData!);
this._connectionData = null;
}
};
this._extensionHostProcess.on('message', messageListener);
}

} catch (error) {
console.error('ExtensionHostConnection errored');
Expand All @@ -256,6 +318,21 @@ export class ExtensionHostConnection {
}
}
}

private _listenOnPipe(): Promise<{ pipeName: string; namedPipeServer: net.Server }> {
return new Promise<{ pipeName: string; namedPipeServer: net.Server }>((resolve, reject) => {
const pipeName = createRandomIPCHandle();

const namedPipeServer = net.createServer();
namedPipeServer.on('error', reject);
namedPipeServer.listen(pipeName, () => {
if (namedPipeServer) {
namedPipeServer.removeListener('error', reject);
}
resolve({ pipeName, namedPipeServer });
});
});
}
}

function readCaseInsensitive(env: { [key: string]: string | undefined }, key: string): string | undefined {
Expand Down
4 changes: 3 additions & 1 deletion src/vs/workbench/api/node/extensionHostProcess.ts
View file
Open in desktop
Expand Up @@ -210,7 +210,9 @@ function _createExtHostProtocol(): Promise<IMessagePassingProtocol> {

const socket = net.createConnection(pipeName, () => {
socket.removeListener('error', reject);
resolve(new PersistentProtocol(new NodeSocket(socket, 'extHost-renderer')));
const protocol = new PersistentProtocol(new NodeSocket(socket, 'extHost-renderer'));
protocol.sendResume();
resolve(protocol);
});
socket.once('error', reject);

Expand Down