343 lines
16 KiB
TypeScript
343 lines
16 KiB
TypeScript
import { field } from '@coder/logger';
|
|
import { release } from 'os';
|
|
import * as fs from 'fs';
|
|
import * as net from 'net';
|
|
import * as path from 'path';
|
|
import { Emitter } from 'vs/base/common/event';
|
|
import { Schemas } from 'vs/base/common/network';
|
|
import { URI } from 'vs/base/common/uri';
|
|
import { getMachineId } from 'vs/base/node/id';
|
|
import { ClientConnectionEvent, IPCServer, IServerChannel, ProxyChannel } from 'vs/base/parts/ipc/common/ipc';
|
|
import { LogsDataCleaner } from 'vs/code/electron-browser/sharedProcess/contrib/logsDataCleaner';
|
|
import { main } from 'vs/code/node/cliProcessMain';
|
|
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
|
|
import { ConfigurationService } from 'vs/platform/configuration/common/configurationService';
|
|
import { ExtensionHostDebugBroadcastChannel } from 'vs/platform/debug/common/extensionHostDebugIpc';
|
|
import { NativeParsedArgs } from 'vs/platform/environment/common/argv';
|
|
import { IEnvironmentService, INativeEnvironmentService } from 'vs/platform/environment/common/environment';
|
|
import { NativeEnvironmentService } from 'vs/platform/environment/node/environmentService';
|
|
import { ExtensionGalleryService } from 'vs/platform/extensionManagement/common/extensionGalleryService';
|
|
import { IExtensionGalleryService, IExtensionManagementService } from 'vs/platform/extensionManagement/common/extensionManagement';
|
|
import { ExtensionManagementChannel } from 'vs/platform/extensionManagement/common/extensionManagementIpc';
|
|
import { ExtensionManagementService } from 'vs/platform/extensionManagement/node/extensionManagementService';
|
|
import { IFileService } from 'vs/platform/files/common/files';
|
|
import { FileService } from 'vs/platform/files/common/fileService';
|
|
import { DiskFileSystemProvider } from 'vs/platform/files/node/diskFileSystemProvider';
|
|
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
|
|
import { InstantiationService } from 'vs/platform/instantiation/common/instantiationService';
|
|
import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection';
|
|
import { ILocalizationsService } from 'vs/platform/localizations/common/localizations';
|
|
import { LocalizationsService } from 'vs/platform/localizations/node/localizations';
|
|
import { ConsoleLogger, getLogLevel, ILoggerService, ILogService, MultiplexLogService } from 'vs/platform/log/common/log';
|
|
import { LogLevelChannel } from 'vs/platform/log/common/logIpc';
|
|
import { LoggerService } from 'vs/platform/log/node/loggerService';
|
|
import { SpdLogLogger } from 'vs/platform/log/node/spdlogLog';
|
|
import product from 'vs/platform/product/common/product';
|
|
import { IProductService } from 'vs/platform/product/common/productService';
|
|
import { ConnectionType, ConnectionTypeRequest } from 'vs/platform/remote/common/remoteAgentConnection';
|
|
import { RemoteAgentConnectionContext } from 'vs/platform/remote/common/remoteAgentEnvironment';
|
|
import { IRequestService } from 'vs/platform/request/common/request';
|
|
import { RequestChannel } from 'vs/platform/request/common/requestIpc';
|
|
import { RequestService } from 'vs/platform/request/node/requestService';
|
|
import ErrorTelemetry from 'vs/platform/telemetry/browser/errorTelemetry';
|
|
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
|
|
import { TelemetryLogAppender } from 'vs/platform/telemetry/common/telemetryLogAppender';
|
|
import { TelemetryService } from 'vs/platform/telemetry/common/telemetryService';
|
|
import { combinedAppender, NullTelemetryService } from 'vs/platform/telemetry/common/telemetryUtils';
|
|
import { AppInsightsAppender } from 'vs/platform/telemetry/node/appInsightsAppender';
|
|
import { resolveCommonProperties } from 'vs/platform/telemetry/common/commonProperties';
|
|
import { TelemetryChannel } from 'vs/server/common/telemetry';
|
|
import { Query, VscodeOptions, WorkbenchOptions } from 'vs/server/ipc';
|
|
import { ExtensionEnvironmentChannel, FileProviderChannel, TerminalProviderChannel } from 'vs/server/node/channel';
|
|
import { Connection, ExtensionHostConnection, ManagementConnection } from 'vs/server/node/connection';
|
|
import { TelemetryClient } from 'vs/server/node/insights';
|
|
import { logger } from 'vs/server/node/logger';
|
|
import { getLocaleFromConfig, getNlsConfiguration } from 'vs/server/node/nls';
|
|
import { Protocol } from 'vs/server/node/protocol';
|
|
import { getUriTransformer } from 'vs/server/node/util';
|
|
import { REMOTE_TERMINAL_CHANNEL_NAME } from 'vs/workbench/contrib/terminal/common/remoteTerminalChannel';
|
|
import { REMOTE_FILE_SYSTEM_CHANNEL_NAME } from 'vs/workbench/services/remote/common/remoteAgentFileSystemChannel';
|
|
import { RemoteExtensionLogFileName } from 'vs/workbench/services/remote/common/remoteAgentService';
|
|
import { localize } from 'vs/nls';
|
|
|
|
export class Vscode {
|
|
public readonly _onDidClientConnect = new Emitter<ClientConnectionEvent>();
|
|
public readonly onDidClientConnect = this._onDidClientConnect.event;
|
|
private readonly ipc = new IPCServer<RemoteAgentConnectionContext>(this.onDidClientConnect);
|
|
|
|
private readonly maxExtraOfflineConnections = 0;
|
|
private readonly connections = new Map<ConnectionType, Map<string, Connection>>();
|
|
|
|
private readonly services = new ServiceCollection();
|
|
private servicesPromise?: Promise<void>;
|
|
|
|
public async cli(args: NativeParsedArgs): Promise<void> {
|
|
return main(args);
|
|
}
|
|
|
|
public async initialize(options: VscodeOptions): Promise<WorkbenchOptions> {
|
|
const transformer = getUriTransformer(options.remoteAuthority);
|
|
if (!this.servicesPromise) {
|
|
this.servicesPromise = this.initializeServices(options.args);
|
|
}
|
|
await this.servicesPromise;
|
|
const environment = this.services.get(IEnvironmentService) as INativeEnvironmentService;
|
|
const startPath = options.startPath;
|
|
const parseUrl = (url: string): URI => {
|
|
// This might be a fully-specified URL or just a path.
|
|
try {
|
|
return URI.parse(url, true);
|
|
} catch (error) {
|
|
return URI.from({
|
|
scheme: Schemas.vscodeRemote,
|
|
authority: options.remoteAuthority,
|
|
path: url,
|
|
});
|
|
}
|
|
};
|
|
return {
|
|
workbenchWebConfiguration: {
|
|
workspaceUri: startPath && startPath.workspace ? parseUrl(startPath.url) : undefined,
|
|
folderUri: startPath && !startPath.workspace ? parseUrl(startPath.url) : undefined,
|
|
remoteAuthority: options.remoteAuthority,
|
|
logLevel: getLogLevel(environment),
|
|
workspaceProvider: {
|
|
payload: [
|
|
['userDataPath', environment.userDataPath],
|
|
['enableProposedApi', JSON.stringify(options.args['enable-proposed-api'] || [])]
|
|
],
|
|
},
|
|
homeIndicator: options.args.home ? {
|
|
href: options.args.home,
|
|
icon: 'code',
|
|
title: localize('home', "Home"),
|
|
} : undefined,
|
|
},
|
|
remoteUserDataUri: transformer.transformOutgoing(URI.file(environment.userDataPath)),
|
|
productConfiguration: product,
|
|
nlsConfiguration: await getNlsConfiguration(environment.args.locale || await getLocaleFromConfig(environment.userDataPath), environment.userDataPath),
|
|
commit: product.commit || 'development',
|
|
};
|
|
}
|
|
|
|
public async handleWebSocket(socket: net.Socket, query: Query, permessageDeflate: boolean): Promise<true> {
|
|
if (!query.reconnectionToken) {
|
|
throw new Error('Reconnection token is missing from query parameters');
|
|
}
|
|
const protocol = new Protocol(socket, {
|
|
reconnectionToken: <string>query.reconnectionToken,
|
|
reconnection: query.reconnection === 'true',
|
|
skipWebSocketFrames: query.skipWebSocketFrames === 'true',
|
|
permessageDeflate,
|
|
recordInflateBytes: permessageDeflate,
|
|
});
|
|
try {
|
|
await this.connect(await protocol.handshake(), protocol);
|
|
} catch (error) {
|
|
protocol.sendMessage({ type: 'error', reason: error.message });
|
|
protocol.dispose();
|
|
protocol.getSocket().dispose();
|
|
}
|
|
return true;
|
|
}
|
|
|
|
private async connect(message: ConnectionTypeRequest, protocol: Protocol): Promise<void> {
|
|
if (product.commit && message.commit !== product.commit) {
|
|
logger.warn(`Version mismatch (${message.commit} instead of ${product.commit})`);
|
|
}
|
|
|
|
switch (message.desiredConnectionType) {
|
|
case ConnectionType.ExtensionHost:
|
|
case ConnectionType.Management:
|
|
if (!this.connections.has(message.desiredConnectionType)) {
|
|
this.connections.set(message.desiredConnectionType, new Map());
|
|
}
|
|
const connections = this.connections.get(message.desiredConnectionType)!;
|
|
|
|
const ok = async () => {
|
|
return message.desiredConnectionType === ConnectionType.ExtensionHost
|
|
? { debugPort: await this.getDebugPort() }
|
|
: { type: 'ok' };
|
|
};
|
|
|
|
const token = protocol.options.reconnectionToken;
|
|
if (protocol.options.reconnection && connections.has(token)) {
|
|
protocol.sendMessage(await ok());
|
|
const buffer = protocol.readEntireBuffer();
|
|
protocol.dispose();
|
|
return connections.get(token)!.reconnect(protocol.getSocket(), buffer);
|
|
} else if (protocol.options.reconnection || connections.has(token)) {
|
|
throw new Error(protocol.options.reconnection
|
|
? 'Unrecognized reconnection token'
|
|
: 'Duplicate reconnection token'
|
|
);
|
|
}
|
|
|
|
logger.debug('New connection', field('token', token));
|
|
protocol.sendMessage(await ok());
|
|
|
|
let connection: Connection;
|
|
if (message.desiredConnectionType === ConnectionType.Management) {
|
|
connection = new ManagementConnection(protocol, token);
|
|
this._onDidClientConnect.fire({
|
|
protocol, onDidClientDisconnect: connection.onClose,
|
|
});
|
|
} else {
|
|
const buffer = protocol.readEntireBuffer();
|
|
connection = new ExtensionHostConnection(
|
|
message.args ? message.args.language : 'en',
|
|
protocol, buffer, token,
|
|
this.services.get(IEnvironmentService) as INativeEnvironmentService,
|
|
);
|
|
}
|
|
connections.set(token, connection);
|
|
connection.onClose(() => {
|
|
logger.debug('Connection closed', field('token', token));
|
|
connections.delete(token);
|
|
});
|
|
this.disposeOldOfflineConnections(connections);
|
|
break;
|
|
case ConnectionType.Tunnel: return protocol.tunnel();
|
|
default: throw new Error('Unrecognized connection type');
|
|
}
|
|
}
|
|
|
|
private disposeOldOfflineConnections(connections: Map<string, Connection>): void {
|
|
const offline = Array.from(connections.values())
|
|
.filter((connection) => typeof connection.offline !== 'undefined');
|
|
for (let i = 0, max = offline.length - this.maxExtraOfflineConnections; i < max; ++i) {
|
|
logger.debug('Disposing offline connection', field('token', offline[i].token));
|
|
offline[i].dispose();
|
|
}
|
|
}
|
|
|
|
private async initializeServices(args: NativeParsedArgs): Promise<void> {
|
|
/*
|
|
NOTE@coder: this initializeServices is loosely based off this file:
|
|
Reference: - ../../electron-browser/sharedProcess/sharedProcessMain.ts#L148
|
|
|
|
If upstream changes cause conflicts, look there ^.
|
|
3/11/21 @jsjoeio
|
|
*/
|
|
const environmentService = new NativeEnvironmentService(args);
|
|
// https://github.com/cdr/code-server/issues/1693
|
|
fs.mkdirSync(environmentService.globalStorageHome.fsPath, { recursive: true });
|
|
/*
|
|
NOTE@coder: Made these updates on based on this file (and lines):
|
|
Reference: - ../../electron-browser/sharedProcess/sharedProcessMain.ts#L144-L149
|
|
|
|
More details (from @code-asher):
|
|
I think the logLevel channel is only used in the electron version of vscode so we can probably skip it.
|
|
With that in mind we wouldn't need logLevelClient which means we wouldn't need the follower service
|
|
either and we can use the multiplex log service directly.
|
|
3/11/21 @jsjoeio
|
|
*/
|
|
const logService = new MultiplexLogService([
|
|
new ConsoleLogger(getLogLevel(environmentService)),
|
|
new SpdLogLogger(RemoteExtensionLogFileName, path.join(environmentService.logsPath, `${RemoteExtensionLogFileName}.log`), false, getLogLevel(environmentService))
|
|
]);
|
|
const fileService = new FileService(logService);
|
|
fileService.registerProvider(Schemas.file, new DiskFileSystemProvider(logService));
|
|
|
|
const loggerService = new LoggerService(logService, fileService);
|
|
|
|
const piiPaths = [
|
|
path.join(environmentService.userDataPath, 'clp'), // Language packs.
|
|
environmentService.appRoot,
|
|
environmentService.extensionsPath,
|
|
environmentService.builtinExtensionsPath,
|
|
...environmentService.extraExtensionPaths,
|
|
...environmentService.extraBuiltinExtensionPaths,
|
|
];
|
|
|
|
/*
|
|
NOTE@coder: we changed this channel registration from LogLevel to LogLevelChannel
|
|
because it changed upstream.
|
|
|
|
3/15/21 jsjoeio
|
|
*/
|
|
this.ipc.registerChannel('logger', new LogLevelChannel(logService));
|
|
this.ipc.registerChannel(ExtensionHostDebugBroadcastChannel.ChannelName, new ExtensionHostDebugBroadcastChannel());
|
|
|
|
this.services.set(ILogService, logService);
|
|
this.services.set(IEnvironmentService, environmentService);
|
|
this.services.set(INativeEnvironmentService, environmentService);
|
|
/*
|
|
NOTE@coder: we changed this from LoggerService to the loggerService defined above.
|
|
3/11/21 @jsjoeio
|
|
*/
|
|
this.services.set(ILoggerService, loggerService);
|
|
|
|
const configurationService = new ConfigurationService(environmentService.settingsResource, fileService);
|
|
await configurationService.initialize();
|
|
this.services.set(IConfigurationService, configurationService);
|
|
|
|
this.services.set(IRequestService, new SyncDescriptor(RequestService));
|
|
this.services.set(IFileService, fileService);
|
|
this.services.set(IProductService, { _serviceBrand: undefined, ...product });
|
|
|
|
const machineId = await getMachineId();
|
|
|
|
await new Promise((resolve) => {
|
|
const instantiationService = new InstantiationService(this.services);
|
|
|
|
instantiationService.invokeFunction((accessor) => {
|
|
instantiationService.createInstance(LogsDataCleaner);
|
|
|
|
let telemetryService: ITelemetryService;
|
|
if (!environmentService.disableTelemetry) {
|
|
telemetryService = new TelemetryService({
|
|
appender: combinedAppender(
|
|
new AppInsightsAppender('code-server', null, () => new TelemetryClient() as any),
|
|
new TelemetryLogAppender(accessor.get(ILoggerService), environmentService)
|
|
),
|
|
sendErrorTelemetry: true,
|
|
commonProperties: resolveCommonProperties(
|
|
fileService, release(), process.arch, product.commit, product.version, machineId,
|
|
[], environmentService.installSourcePath, 'code-server',
|
|
),
|
|
piiPaths,
|
|
}, configurationService);
|
|
} else {
|
|
telemetryService = NullTelemetryService;
|
|
}
|
|
|
|
this.services.set(ITelemetryService, telemetryService);
|
|
|
|
this.services.set(IExtensionManagementService, new SyncDescriptor(ExtensionManagementService));
|
|
this.services.set(IExtensionGalleryService, new SyncDescriptor(ExtensionGalleryService));
|
|
this.services.set(ILocalizationsService, new SyncDescriptor(LocalizationsService));
|
|
|
|
this.ipc.registerChannel('extensions', new ExtensionManagementChannel(
|
|
accessor.get(IExtensionManagementService),
|
|
(context) => getUriTransformer(context.remoteAuthority),
|
|
));
|
|
this.ipc.registerChannel('remoteextensionsenvironment', new ExtensionEnvironmentChannel(
|
|
environmentService, logService, telemetryService, '',
|
|
));
|
|
this.ipc.registerChannel('request', new RequestChannel(accessor.get(IRequestService)));
|
|
this.ipc.registerChannel('telemetry', new TelemetryChannel(telemetryService));
|
|
/*
|
|
NOTE@coder: they renamed createChannelReceiver and made it part of the ProxyChannel namespace
|
|
See: https://github.com/microsoft/vscode/commit/e371faebfb679ca0dcdb61f4f2f33b3d69922a77
|
|
|
|
And see this as an example similar to our code below:
|
|
https://github.com/microsoft/vscode/blob/e371faebfb679ca0dcdb61f4f2f33b3d69922a77/src/vs/code/electron-browser/sharedProcess/sharedProcessMain.ts#L273
|
|
3/11/2021 by @jsjoeio
|
|
*/
|
|
this.ipc.registerChannel('localizations', <IServerChannel<any>>ProxyChannel.fromService(accessor.get(ILocalizationsService)));
|
|
this.ipc.registerChannel(REMOTE_FILE_SYSTEM_CHANNEL_NAME, new FileProviderChannel(environmentService, logService));
|
|
this.ipc.registerChannel(REMOTE_TERMINAL_CHANNEL_NAME, new TerminalProviderChannel(logService));
|
|
resolve(new ErrorTelemetry(telemetryService));
|
|
});
|
|
});
|
|
}
|
|
|
|
/**
|
|
* TODO: implement.
|
|
*/
|
|
private async getDebugPort(): Promise<number | undefined> {
|
|
return undefined;
|
|
}
|
|
}
|