Skip to content

Commit 7ecb582

Browse files
author
Benjamin Pasero
committed
debt - remove IWindowService#log in favor of a logger that can log to the main side
1 parent 36e6149 commit 7ecb582

17 files changed

Lines changed: 155 additions & 69 deletions

File tree

‎src/vs/code/electron-browser/issue/issueReporterMain.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { EnvironmentService } from 'vs/platform/environment/node/environmentServ
3232
import { IssueReporterModel, IssueReporterData as IssueReporterModelData } from 'vs/code/electron-browser/issue/issueReporterModel';
3333
import { IssueReporterData, IssueReporterStyles, IssueType, ISettingsSearchIssueReporterData, IssueReporterFeatures, IssueReporterExtensionData } from 'vs/platform/issue/node/issue';
3434
import BaseHtml from 'vs/code/electron-browser/issue/issueReporterPage';
35-
import { LogLevelSetterChannelClient, FollowerLogService } from 'vs/platform/log/common/logIpc';
35+
import { LoggerChannelClient, FollowerLogService } from 'vs/platform/log/common/logIpc';
3636
import { ILogService, getLogLevel } from 'vs/platform/log/common/log';
3737
import { OcticonLabel } from 'vs/base/browser/ui/octiconLabel/octiconLabel';
3838
import { normalizeGitHubUrl } from 'vs/code/electron-browser/issue/issueReporterUtil';
@@ -300,8 +300,8 @@ export class IssueReporter extends Disposable {
300300
this.environmentService = new EnvironmentService(configuration, configuration.execPath);
301301

302302
const logService = new SpdLogService(`issuereporter${configuration.windowId}`, this.environmentService.logsPath, getLogLevel(this.environmentService));
303-
const logLevelClient = new LogLevelSetterChannelClient(mainProcessService.getChannel('loglevel'));
304-
this.logService = new FollowerLogService(logLevelClient, logService);
303+
const loggerClient = new LoggerChannelClient(mainProcessService.getChannel('logger'));
304+
this.logService = new FollowerLogService(loggerClient, logService);
305305

306306
const sharedProcess = (<IWindowsService>serviceCollection.get(IWindowsService)).whenSharedProcessReady()
307307
.then(() => connectNet(this.environmentService.sharedIPCHandle, `window:${configuration.windowId}`));

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import { IWindowsService } from 'vs/platform/windows/common/windows';
3030
import { WindowsService } from 'vs/platform/windows/electron-browser/windowsService';
3131
import { ipcRenderer } from 'electron';
3232
import { ILogService, LogLevel } from 'vs/platform/log/common/log';
33-
import { LogLevelSetterChannelClient, FollowerLogService } from 'vs/platform/log/common/logIpc';
33+
import { LoggerChannelClient, FollowerLogService } from 'vs/platform/log/common/logIpc';
3434
import { LocalizationsService } from 'vs/platform/localizations/node/localizations';
3535
import { ILocalizationsService } from 'vs/platform/localizations/common/localizations';
3636
import { LocalizationsChannel } from 'vs/platform/localizations/node/localizationsIpc';
@@ -96,8 +96,8 @@ async function main(server: Server, initData: ISharedProcessInitData, configurat
9696
const environmentService = new EnvironmentService(initData.args, process.execPath);
9797

9898
const mainRouter = new StaticRouter(ctx => ctx === 'main');
99-
const logLevelClient = new LogLevelSetterChannelClient(server.getChannel('loglevel', mainRouter));
100-
const logService = new FollowerLogService(logLevelClient, new SpdLogService('sharedprocess', environmentService.logsPath, initData.logLevel));
99+
const loggerClient = new LoggerChannelClient(server.getChannel('logger', mainRouter));
100+
const logService = new FollowerLogService(loggerClient, new SpdLogService('sharedprocess', environmentService.logsPath, initData.logLevel));
101101
disposables.add(logService);
102102
logService.info('main', JSON.stringify(configuration));
103103

@@ -135,7 +135,7 @@ async function main(server: Server, initData: ISharedProcessInitData, configurat
135135
const services = new ServiceCollection();
136136
const environmentService = accessor.get(IEnvironmentService);
137137
const { appRoot, extensionsPath, extensionDevelopmentLocationURI: extensionDevelopmentLocationURI, isBuilt, installSourcePath } = environmentService;
138-
const telemetryLogService = new FollowerLogService(logLevelClient, new SpdLogService('telemetry', environmentService.logsPath, initData.logLevel));
138+
const telemetryLogService = new FollowerLogService(loggerClient, new SpdLogService('telemetry', environmentService.logsPath, initData.logLevel));
139139
telemetryLogService.info('The below are logs for every telemetry event sent from VS Code once the log level is set to trace.');
140140
telemetryLogService.info('===========================================================');
141141

‎src/vs/code/electron-main/app.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import { DarwinUpdateService } from 'vs/platform/update/electron-main/updateServ
4747
import { IIssueService } from 'vs/platform/issue/node/issue';
4848
import { IssueChannel } from 'vs/platform/issue/electron-main/issueIpc';
4949
import { IssueMainService } from 'vs/platform/issue/electron-main/issueMainService';
50-
import { LogLevelSetterChannel } from 'vs/platform/log/common/logIpc';
50+
import { LoggerChannel } from 'vs/platform/log/common/logIpc';
5151
import { setUnexpectedErrorHandler, onUnexpectedError } from 'vs/base/common/errors';
5252
import { ElectronURLListener } from 'vs/platform/url/electron-main/electronUrlListener';
5353
import { serve as serveDriver } from 'vs/platform/driver/electron-main/driver';
@@ -567,9 +567,9 @@ export class CodeApplication extends Disposable {
567567
const storageChannel = this._register(new GlobalStorageDatabaseChannel(this.logService, storageMainService));
568568
electronIpcServer.registerChannel('storage', storageChannel);
569569

570-
const logLevelChannel = new LogLevelSetterChannel(accessor.get(ILogService));
571-
electronIpcServer.registerChannel('loglevel', logLevelChannel);
572-
sharedProcessClient.then(client => client.registerChannel('loglevel', logLevelChannel));
570+
const loggerChannel = new LoggerChannel(accessor.get(ILogService));
571+
electronIpcServer.registerChannel('logger', loggerChannel);
572+
sharedProcessClient.then(client => client.registerChannel('logger', loggerChannel));
573573

574574
// ExtensionHost Debug broadcast service
575575
electronIpcServer.registerChannel(ExtensionHostDebugBroadcastChannel.ChannelName, new ExtensionHostDebugBroadcastChannel());

‎src/vs/platform/log/common/log.ts‎

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { IDisposable, Disposable } from 'vs/base/common/lifecycle';
88
import { isWindows } from 'vs/base/common/platform';
99
import { Event, Emitter } from 'vs/base/common/event';
1010
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
11+
import { LoggerChannelClient } from 'vs/platform/log/common/logIpc';
1112

1213
export const ILogService = createServiceDecorator<ILogService>('logService');
1314

@@ -183,6 +184,54 @@ export class ConsoleLogService extends AbstractLogService implements ILogService
183184
dispose(): void { }
184185
}
185186

187+
export class ConsoleLogInMainService extends AbstractLogService implements ILogService {
188+
189+
_serviceBrand: undefined;
190+
191+
constructor(private readonly client: LoggerChannelClient, logLevel: LogLevel = DEFAULT_LOG_LEVEL) {
192+
super();
193+
this.setLevel(logLevel);
194+
}
195+
196+
trace(message: string, ...args: any[]): void {
197+
if (this.getLevel() <= LogLevel.Trace) {
198+
this.client.consoleLog('trace', [message, ...args]);
199+
}
200+
}
201+
202+
debug(message: string, ...args: any[]): void {
203+
if (this.getLevel() <= LogLevel.Debug) {
204+
this.client.consoleLog('debug', [message, ...args]);
205+
}
206+
}
207+
208+
info(message: string, ...args: any[]): void {
209+
if (this.getLevel() <= LogLevel.Info) {
210+
this.client.consoleLog('info', [message, ...args]);
211+
}
212+
}
213+
214+
warn(message: string | Error, ...args: any[]): void {
215+
if (this.getLevel() <= LogLevel.Warning) {
216+
this.client.consoleLog('warn', [message, ...args]);
217+
}
218+
}
219+
220+
error(message: string, ...args: any[]): void {
221+
if (this.getLevel() <= LogLevel.Error) {
222+
this.client.consoleLog('error', [message, ...args]);
223+
}
224+
}
225+
226+
critical(message: string, ...args: any[]): void {
227+
if (this.getLevel() <= LogLevel.Critical) {
228+
this.client.consoleLog('critical', [message, ...args]);
229+
}
230+
}
231+
232+
dispose(): void { }
233+
}
234+
186235
export class MultiplexLogService extends AbstractLogService implements ILogService {
187236
_serviceBrand: undefined;
188237

@@ -326,4 +375,4 @@ export function getLogLevel(environmentService: IEnvironmentService): LogLevel {
326375
}
327376
}
328377
return DEFAULT_LOG_LEVEL;
329-
}
378+
}

‎src/vs/platform/log/common/logIpc.ts‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { IChannel, IServerChannel } from 'vs/base/parts/ipc/common/ipc';
77
import { LogLevel, ILogService, DelegatedLogService } from 'vs/platform/log/common/log';
88
import { Event } from 'vs/base/common/event';
99

10-
export class LogLevelSetterChannel implements IServerChannel {
10+
export class LoggerChannel implements IServerChannel {
1111

1212
onDidChangeLogLevel: Event<LogLevel>;
1313

@@ -26,13 +26,32 @@ export class LogLevelSetterChannel implements IServerChannel {
2626
call(_: unknown, command: string, arg?: any): Promise<any> {
2727
switch (command) {
2828
case 'setLevel': this.service.setLevel(arg); return Promise.resolve();
29+
case 'consoleLog': this.consoleLog(arg[0], arg[1]); return Promise.resolve();
2930
}
3031

3132
throw new Error(`Call not found: ${command}`);
3233
}
34+
35+
private consoleLog(severity: string, args: string[]): void {
36+
let consoleFn = console.log;
37+
38+
switch (severity) {
39+
case 'error':
40+
consoleFn = console.error;
41+
break;
42+
case 'warn':
43+
consoleFn = console.warn;
44+
break;
45+
case 'info':
46+
consoleFn = console.info;
47+
break;
48+
}
49+
50+
consoleFn.call(console, ...args);
51+
}
3352
}
3453

35-
export class LogLevelSetterChannelClient {
54+
export class LoggerChannelClient {
3655

3756
constructor(private channel: IChannel) { }
3857

@@ -43,17 +62,21 @@ export class LogLevelSetterChannelClient {
4362
setLevel(level: LogLevel): void {
4463
this.channel.call('setLevel', level);
4564
}
65+
66+
consoleLog(severity: string, args: string[]): void {
67+
this.channel.call('consoleLog', [severity, args]);
68+
}
4669
}
4770

4871
export class FollowerLogService extends DelegatedLogService implements ILogService {
4972
_serviceBrand: undefined;
5073

51-
constructor(private master: LogLevelSetterChannelClient, logService: ILogService) {
74+
constructor(private master: LoggerChannelClient, logService: ILogService) {
5275
super(logService);
5376
this._register(master.onDidChangeLogLevel(level => logService.setLevel(level)));
5477
}
5578

5679
setLevel(level: LogLevel): void {
5780
this.master.setLevel(level);
5881
}
59-
}
82+
}

‎src/vs/platform/windows/common/windows.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,6 @@ export interface IWindowsService {
156156
openExtensionDevelopmentHostWindow(args: ParsedArgs, env: IProcessEnvironment): Promise<void>;
157157
getWindows(): Promise<{ id: number; workspace?: IWorkspaceIdentifier; folderUri?: ISingleFolderWorkspaceIdentifier; title: string; filename?: string; }[]>;
158158
getWindowCount(): Promise<number>;
159-
log(severity: string, args: string[]): Promise<void>;
160159
showItemInFolder(path: URI): Promise<void>;
161160
getActiveWindowId(): Promise<number | undefined>;
162161

‎src/vs/platform/windows/common/windowsIpc.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ export class WindowsChannel implements IServerChannel {
109109
case 'whenSharedProcessReady': return this.service.whenSharedProcessReady();
110110
case 'toggleSharedProcess': return this.service.toggleSharedProcess();
111111
case 'quit': return this.service.quit();
112-
case 'log': return this.service.log(arg[0], arg[1]);
113112
case 'showItemInFolder': return this.service.showItemInFolder(URI.revive(arg));
114113
case 'getActiveWindowId': return this.service.getActiveWindowId();
115114
case 'openExternal': return this.service.openExternal(arg);

‎src/vs/platform/windows/electron-browser/windowsService.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,6 @@ export class WindowsService implements IWindowsService {
226226
return this.channel.call('getWindowCount');
227227
}
228228

229-
log(severity: string, args: string[]): Promise<void> {
230-
return this.channel.call('log', [severity, args]);
231-
}
232-
233229
showItemInFolder(path: URI): Promise<void> {
234230
return this.channel.call('showItemInFolder', path);
235231
}

‎src/vs/platform/windows/electron-main/windowsService.ts‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -336,24 +336,6 @@ export class WindowsService extends Disposable implements IWindowsService, IURLH
336336
return this.windowsMainService.getWindows().length;
337337
}
338338

339-
async log(severity: string, args: string[]): Promise<void> {
340-
let consoleFn = console.log;
341-
342-
switch (severity) {
343-
case 'error':
344-
consoleFn = console.error;
345-
break;
346-
case 'warn':
347-
consoleFn = console.warn;
348-
break;
349-
case 'info':
350-
consoleFn = console.info;
351-
break;
352-
}
353-
354-
consoleFn.call(console, ...args);
355-
}
356-
357339
async showItemInFolder(resource: URI): Promise<void> {
358340
this.logService.trace('windowsService#showItemInFolder');
359341

‎src/vs/workbench/api/browser/mainThreadConsole.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers';
77
import { MainContext, MainThreadConsoleShape, IExtHostContext } from 'vs/workbench/api/common/extHost.protocol';
88
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
9-
import { IRemoteConsoleLog, log, parse } from 'vs/base/common/console';
9+
import { IRemoteConsoleLog, log } from 'vs/base/common/console';
10+
import { logRemoteEntry } from 'vs/workbench/services/extensions/common/remoteConsoleUtil';
1011
import { parseExtensionDevOptions } from 'vs/workbench/services/extensions/common/extensionDevOptions';
11-
import { IWindowsService } from 'vs/platform/windows/common/windows';
12+
import { ILogService } from 'vs/platform/log/common/log';
1213
import { IExtensionHostDebugService } from 'vs/platform/debug/common/extensionHostDebug';
1314

1415
@extHostNamedCustomer(MainContext.MainThreadConsole)
@@ -20,7 +21,7 @@ export class MainThreadConsole implements MainThreadConsoleShape {
2021
constructor(
2122
extHostContext: IExtHostContext,
2223
@IEnvironmentService private readonly _environmentService: IEnvironmentService,
23-
@IWindowsService private readonly _windowsService: IWindowsService,
24+
@ILogService private readonly _logService: ILogService,
2425
@IExtensionHostDebugService private readonly _extensionHostDebugService: IExtensionHostDebugService,
2526
) {
2627
const devOpts = parseExtensionDevOptions(this._environmentService);
@@ -40,7 +41,7 @@ export class MainThreadConsole implements MainThreadConsoleShape {
4041

4142
// Log on main side if running tests from cli
4243
if (this._isExtensionDevTestFromCli) {
43-
this._windowsService.log(entry.severity, parse(entry).args);
44+
logRemoteEntry(this._logService, entry);
4445
}
4546

4647
// Broadcast to other windows if we are in development mode

0 commit comments

Comments
 (0)