introduce logger service in ext host and use it to create log service

src/vs/workbench/api/browser/mainThreadLogService.ts

@@ -4,48 +4,44 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers';
-import { ILogService, LogLevel } from 'vs/platform/log/common/log';
+import { ILoggerOptions, ILoggerService, ILogService, log, LogLevel } from 'vs/platform/log/common/log';
 import { IDisposable } from 'vs/base/common/lifecycle';
-import { IExtHostContext, ExtHostContext, MainThreadLogShape, MainContext } from 'vs/workbench/api/common/extHost.protocol';
+import { IExtHostContext, ExtHostContext, MainThreadLoggerShape, MainContext } from 'vs/workbench/api/common/extHost.protocol';
 import { UriComponents, URI } from 'vs/base/common/uri';
-import { FileLogger } from 'vs/platform/log/common/fileLog';
-import { IInstantiationService, ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
-import { basename } from 'vs/base/common/path';
+import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
 import { CommandsRegistry } from 'vs/platform/commands/common/commands';
 import { IEnvironmentService } from 'vs/platform/environment/common/environment';
 
-@extHostNamedCustomer(MainContext.MainThreadLog)
-export class MainThreadLogService implements MainThreadLogShape {
+@extHostNamedCustomer(MainContext.MainThreadLogger)
+export class MainThreadLoggerService implements MainThreadLoggerShape {
 
-	private readonly _loggers = new Map<string, FileLogger>();
 	private readonly _logListener: IDisposable;
 
 	constructor(
 		extHostContext: IExtHostContext,
-		@ILogService private readonly _logService: ILogService,
-		@IInstantiationService private readonly _instaService: IInstantiationService,
+		@ILogService logService: ILogService,
+		@ILoggerService private readonly _loggerService: ILoggerService,
 	) {
-		const proxy = extHostContext.getProxy(ExtHostContext.ExtHostLogService);
-		this._logListener = _logService.onDidChangeLogLevel(level => {
-			proxy.$setLevel(level);
-			this._loggers.forEach(value => value.setLevel(level));
-		});
+		const proxy = extHostContext.getProxy(ExtHostContext.ExtHostLogLevelServiceShape);
+		this._logListener = logService.onDidChangeLogLevel(level => proxy.$setLevel(level));
+	}
+
+	$log(file: UriComponents, messages: [LogLevel, string][]): void {
+		const logger = this._loggerService.getLogger(URI.revive(file));
+		if (!logger) {
+			throw new Error('Create the logger before logging');
+		}
+		for (const [level, message] of messages) {
+			log(logger, level, message);
+		}
+	}
+
+	async $createLogger(file: UriComponents, options?: ILoggerOptions): Promise<void> {
+		this._loggerService.createLogger(URI.revive(file), options);
 	}
 
 	dispose(): void {
 		this._logListener.dispose();
-		this._loggers.forEach(value => value.dispose());
-		this._loggers.clear();
-	}
-
-	$log(file: UriComponents, level: LogLevel, message: any[]): void {
-		const uri = URI.revive(file);
-		let logger = this._loggers.get(uri.toString());
-		if (!logger) {
-			logger = this._instaService.createInstance(FileLogger, basename(file.path), URI.revive(file), this._logService.getLevel(), false);
-			this._loggers.set(uri.toString(), logger);
-		}
-		logger.log(level, message);
 	}
 }
 

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -13,7 +13,7 @@ import { OverviewRulerLane } from 'vs/editor/common/model';
 import * as languageConfiguration from 'vs/editor/common/modes/languageConfiguration';
 import { score } from 'vs/editor/common/modes/languageSelector';
 import * as files from 'vs/platform/files/common/files';
-import { ExtHostContext, MainContext, ExtHostLogServiceShape, UIKind, CandidatePortSource } from 'vs/workbench/api/common/extHost.protocol';
+import { ExtHostContext, MainContext, UIKind, CandidatePortSource, ExtHostLogLevelServiceShape } from 'vs/workbench/api/common/extHost.protocol';
 import { ExtHostApiCommands } from 'vs/workbench/api/common/extHostApiCommands';
 import { ExtHostClipboard } from 'vs/workbench/api/common/extHostClipboard';
 import { IExtHostCommands } from 'vs/workbench/api/common/extHostCommands';
@@ -60,7 +60,7 @@ import { IExtHostDecorations } from 'vs/workbench/api/common/extHostDecorations'
 import { IExtHostTask } from 'vs/workbench/api/common/extHostTask';
 import { IExtHostDebugService } from 'vs/workbench/api/common/extHostDebugService';
 import { IExtHostSearch } from 'vs/workbench/api/common/extHostSearch';
-import { ILogService } from 'vs/platform/log/common/log';
+import { ILoggerService, ILogService } from 'vs/platform/log/common/log';
 import { IURITransformerService } from 'vs/workbench/api/common/extHostUriTransformerService';
 import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
 import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
@@ -113,6 +113,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 	const rpcProtocol = accessor.get(IExtHostRpcService);
 	const extHostStorage = accessor.get(IExtHostStorage);
 	const extensionStoragePaths = accessor.get(IExtensionStoragePaths);
+	const extHostLoggerService = accessor.get(ILoggerService);
 	const extHostLogService = accessor.get(ILogService);
 	const extHostTunnelService = accessor.get(IExtHostTunnelService);
 	const extHostApiDeprecation = accessor.get(IExtHostApiDeprecationService);
@@ -122,7 +123,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 
 	// register addressable instances
 	rpcProtocol.set(ExtHostContext.ExtHostFileSystemInfo, extHostFileSystemInfo);
-	rpcProtocol.set(ExtHostContext.ExtHostLogService, <ExtHostLogServiceShape><any>extHostLogService);
+	rpcProtocol.set(ExtHostContext.ExtHostLogLevelServiceShape, <ExtHostLogLevelServiceShape><any>extHostLoggerService);
 	rpcProtocol.set(ExtHostContext.ExtHostWorkspace, extHostWorkspace);
 	rpcProtocol.set(ExtHostContext.ExtHostConfiguration, extHostConfiguration);
 	rpcProtocol.set(ExtHostContext.ExtHostExtensionService, extensionService);

src/vs/workbench/api/common/extHost.common.services.ts

@@ -23,7 +23,12 @@ import { IExtHostFileSystemInfo, ExtHostFileSystemInfo } from 'vs/workbench/api/
 import { IExtHostSecretState, ExtHostSecretState } from 'vs/workbench/api/common/exHostSecretState';
 import { ExtHostTelemetry, IExtHostTelemetry } from 'vs/workbench/api/common/extHostTelemetry';
 import { ExtHostEditorTabs, IExtHostEditorTabs } from 'vs/workbench/api/common/extHostEditorTabs';
+import { ExtHostLoggerService } from 'vs/workbench/api/common/extHostLoggerService';
+import { ILoggerService, ILogService } from 'vs/platform/log/common/log';
+import { ExtHostLogService } from 'vs/workbench/api/common/extHostLogService';
 
+registerSingleton(ILoggerService, ExtHostLoggerService);
+registerSingleton(ILogService, ExtHostLogService);
 registerSingleton(IExtHostApiDeprecationService, ExtHostApiDeprecationService);
 registerSingleton(IExtHostCommands, ExtHostCommands);
 registerSingleton(IExtHostConfiguration, ExtHostConfiguration);

src/vs/workbench/api/common/extHost.protocol.ts

@@ -31,7 +31,7 @@ import { ConfigurationScope } from 'vs/platform/configuration/common/configurati
 import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions';
 import * as files from 'vs/platform/files/common/files';
 import { ResourceLabelFormatter } from 'vs/platform/label/common/label';
-import { LogLevel } from 'vs/platform/log/common/log';
+import { ILoggerOptions, LogLevel } from 'vs/platform/log/common/log';
 import { IMarkerData } from 'vs/platform/markers/common/markers';
 import { IProgressOptions, IProgressStep } from 'vs/platform/progress/common/progress';
 import * as quickInput from 'vs/platform/quickinput/common/quickInput';
@@ -1895,12 +1895,13 @@ export interface ExtHostWindowShape {
 	$onDidChangeWindowFocus(value: boolean): void;
 }
 
-export interface ExtHostLogServiceShape {
+export interface ExtHostLogLevelServiceShape {
 	$setLevel(level: LogLevel): void;
 }
 
-export interface MainThreadLogShape {
-	$log(file: UriComponents, level: LogLevel, args: any[]): void;
+export interface MainThreadLoggerShape {
+	$log(file: UriComponents, messages: [LogLevel, string][]): void;
+	$createLogger(file: UriComponents, options?: ILoggerOptions): Promise<void>;
 }
 
 export interface ExtHostOutputServiceShape {
@@ -2213,7 +2214,7 @@ export const MainContext = {
 	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
 	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
 	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
-	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
+	MainThreadLogger: createMainId<MainThreadLoggerShape>('MainThreadLogger'),
 	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
 	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
 	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
@@ -2268,7 +2269,7 @@ export const ExtHostContext = {
 	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
 	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
 	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
-	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
+	ExtHostLogLevelServiceShape: createExtId<ExtHostLogLevelServiceShape>('ExtHostLogLevelServiceShape'),
 	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
 	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
 	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),

src/vs/workbench/api/common/extHostLogService.ts

@@ -0,0 +1,20 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ILoggerService, LogService } from 'vs/platform/log/common/log';
+import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
+
+export class ExtHostLogService extends LogService {
+
+	declare readonly _serviceBrand: undefined;
+
+	constructor(
+		@ILoggerService loggerService: ILoggerService,
+		@IExtHostInitDataService initData: IExtHostInitDataService,
+	) {
+		super(loggerService.createLogger(initData.logFile));
+	}
+
+}

src/vs/workbench/api/common/extHostLoggerService.ts

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ILogger, ILoggerOptions, AbstractMessageLogger, LogLevel, AbstractLoggerService } from 'vs/platform/log/common/log';
+import { MainThreadLoggerShape, MainContext, ExtHostLogLevelServiceShape as ExtHostLogLevelServiceShape } from 'vs/workbench/api/common/extHost.protocol';
+import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
+import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
+import { URI } from 'vs/base/common/uri';
+import { Emitter } from 'vs/base/common/event';
+
+export class ExtHostLoggerService extends AbstractLoggerService implements ExtHostLogLevelServiceShape {
+
+	declare readonly _serviceBrand: undefined;
+	private readonly _onDidChangeLogLevel: Emitter<LogLevel>;
+	private readonly _proxy: MainThreadLoggerShape;
+
+	constructor(
+		@IExtHostRpcService rpc: IExtHostRpcService,
+		@IExtHostInitDataService initData: IExtHostInitDataService,
+	) {
+		const emitter = new Emitter<LogLevel>();
+		super(initData.logLevel, emitter.event);
+		this._proxy = rpc.getProxy(MainContext.MainThreadLogger);
+		this._onDidChangeLogLevel = this._register(emitter);
+	}
+
+	$setLevel(level: LogLevel): void {
+		this._onDidChangeLogLevel.fire(level);
+	}
+
+	protected doCreateLogger(resource: URI, logLevel: LogLevel, options?: ILoggerOptions): ILogger {
+		return new Logger(this._proxy, resource, logLevel, options);
+	}
+}
+
+class Logger extends AbstractMessageLogger {
+
+	private isLoggerCreated: boolean = false;
+	private buffer: [LogLevel, string][] = [];
+
+	constructor(
+		private readonly proxy: MainThreadLoggerShape,
+		private readonly file: URI,
+		logLevel: LogLevel,
+		loggerOptions?: ILoggerOptions,
+	) {
+		super(loggerOptions?.always);
+		this.setLevel(logLevel);
+		this.proxy.$createLogger(file, loggerOptions)
+			.then(() => {
+				this.doLog(this.buffer);
+				this.isLoggerCreated = true;
+			});
+	}
+
+	protected log(level: LogLevel, message: string) {
+		const messages: [LogLevel, string][] = [[level, message]];
+		if (this.isLoggerCreated) {
+			this.doLog(messages);
+		} else {
+			this.buffer.push(...messages);
+		}
+	}
+
+	private doLog(messages: [LogLevel, string][]) {
+		this.proxy.$log(this.file, messages);
+	}
+}

src/vs/workbench/api/node/extHost.node.services.ts

@@ -10,7 +10,6 @@ import { ExtHostTask } from 'vs/workbench/api/node/extHostTask';
 import { ExtHostDebugService } from 'vs/workbench/api/node/extHostDebugService';
 import { NativeExtHostSearch } from 'vs/workbench/api/node/extHostSearch';
 import { ExtHostExtensionService } from 'vs/workbench/api/node/extHostExtensionService';
-import { ExtHostLogService } from 'vs/workbench/api/node/extHostLogService';
 import { ExtHostTunnelService } from 'vs/workbench/api/node/extHostTunnelService';
 import { IExtHostDebugService } from 'vs/workbench/api/common/extHostDebugService';
 import { IExtHostExtensionService } from 'vs/workbench/api/common/extHostExtensionService';
@@ -19,9 +18,10 @@ import { IExtHostSearch } from 'vs/workbench/api/common/extHostSearch';
 import { IExtHostTask } from 'vs/workbench/api/common/extHostTask';
 import { IExtHostTerminalService } from 'vs/workbench/api/common/extHostTerminalService';
 import { IExtHostTunnelService } from 'vs/workbench/api/common/extHostTunnelService';
-import { ILogService } from 'vs/platform/log/common/log';
 import { IExtensionStoragePaths } from 'vs/workbench/api/common/extHostStoragePaths';
 import { ExtensionStoragePaths } from 'vs/workbench/api/node/extHostStoragePaths';
+import { ExtHostLoggerService } from 'vs/workbench/api/node/extHostLoggerService';
+import { ILoggerService } from 'vs/platform/log/common/log';
 
 // #########################################################################
 // ###                                                                   ###
@@ -30,7 +30,7 @@ import { ExtensionStoragePaths } from 'vs/workbench/api/node/extHostStoragePaths
 // #########################################################################
 
 registerSingleton(IExtHostExtensionService, ExtHostExtensionService);
-registerSingleton(ILogService, ExtHostLogService);
+registerSingleton(ILoggerService, ExtHostLoggerService);
 registerSingleton(IExtensionStoragePaths, ExtensionStoragePaths);
 
 registerSingleton(IExtHostDebugService, ExtHostDebugService);

src/vs/workbench/api/node/extHostLogService.ts

@@ -1,25 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-import { ILogService, LogService, LogLevel } from 'vs/platform/log/common/log';
-import { ExtHostLogServiceShape } from 'vs/workbench/api/common/extHost.protocol';
-import { ExtensionHostLogFileName } from 'vs/workbench/services/extensions/common/extensions';
-import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
-import { Schemas } from 'vs/base/common/network';
-import { SpdLogLogger } from 'vs/platform/log/node/spdlogLog';
-
-export class ExtHostLogService extends LogService implements ILogService, ExtHostLogServiceShape {
-
-	constructor(
-		@IExtHostInitDataService initData: IExtHostInitDataService,
-	) {
-		if (initData.logFile.scheme !== Schemas.file) { throw new Error('Only file-logging supported'); }
-		super(new SpdLogLogger(ExtensionHostLogFileName, initData.logFile.fsPath, true, initData.logLevel));
-	}
-
-	$setLevel(level: LogLevel): void {
-		this.setLevel(level);
-	}
-}

src/vs/workbench/api/node/extHostLoggerService.ts

@@ -0,0 +1,26 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ILogger, ILoggerOptions, LogLevel } from 'vs/platform/log/common/log';
+import { URI } from 'vs/base/common/uri';
+import { ExtHostLoggerService as BaseExtHostLoggerService } from 'vs/workbench/api/common/extHostLoggerService';
+import { Schemas } from 'vs/base/common/network';
+import { SpdLogLogger } from 'vs/platform/log/node/spdlogLog';
+import { generateUuid } from 'vs/base/common/uuid';
+
+export class ExtHostLoggerService extends BaseExtHostLoggerService {
+
+	protected override doCreateLogger(resource: URI, logLevel: LogLevel, options?: ILoggerOptions): ILogger {
+		if (resource.scheme === Schemas.file) {
+			const logger = new SpdLogLogger(options?.name || generateUuid(), resource.fsPath, !options?.donotRotate, logLevel);
+			if (options?.donotUseFormatters) {
+				(<SpdLogLogger>logger).clearFormatters();
+			}
+			return logger;
+		}
+		return super.doCreateLogger(resource, logLevel, options);
+	}
+
+}

src/vs/workbench/api/worker/extHost.worker.services.ts

@@ -4,11 +4,9 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
-import { ILogService } from 'vs/platform/log/common/log';
 import { IExtHostExtensionService } from 'vs/workbench/api/common/extHostExtensionService';
 import { ExtensionStoragePaths, IExtensionStoragePaths } from 'vs/workbench/api/common/extHostStoragePaths';
 import { ExtHostExtensionService } from 'vs/workbench/api/worker/extHostExtensionService';
-import { ExtHostLogService } from 'vs/workbench/api/worker/extHostLogService';
 
 // #########################################################################
 // ###                                                                   ###
@@ -17,5 +15,4 @@ import { ExtHostLogService } from 'vs/workbench/api/worker/extHostLogService';
 // #########################################################################
 
 registerSingleton(IExtHostExtensionService, ExtHostExtensionService);
-registerSingleton(ILogService, ExtHostLogService);
 registerSingleton(IExtensionStoragePaths, ExtensionStoragePaths);

src/vs/workbench/api/worker/extHostLogService.ts

@@ -1,70 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-import { ILogService, LogLevel, AbstractLogger } from 'vs/platform/log/common/log';
-import { ExtHostLogServiceShape, MainThreadLogShape, MainContext } from 'vs/workbench/api/common/extHost.protocol';
-import { IExtHostInitDataService } from 'vs/workbench/api/common/extHostInitDataService';
-import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
-import { UriComponents } from 'vs/base/common/uri';
-
-export class ExtHostLogService extends AbstractLogger implements ILogService, ExtHostLogServiceShape {
-
-	declare readonly _serviceBrand: undefined;
-
-	private readonly _proxy: MainThreadLogShape;
-	private readonly _logFile: UriComponents;
-
-	constructor(
-		@IExtHostRpcService rpc: IExtHostRpcService,
-		@IExtHostInitDataService initData: IExtHostInitDataService,
-	) {
-		super();
-		this._proxy = rpc.getProxy(MainContext.MainThreadLog);
-		this._logFile = initData.logFile.toJSON();
-		this.setLevel(initData.logLevel);
-	}
-
-	$setLevel(level: LogLevel): void {
-		this.setLevel(level);
-	}
-
-	trace(_message: string, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Trace) {
-			this._proxy.$log(this._logFile, LogLevel.Trace, Array.from(arguments));
-		}
-	}
-
-	debug(_message: string, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Debug) {
-			this._proxy.$log(this._logFile, LogLevel.Debug, Array.from(arguments));
-		}
-	}
-
-	info(_message: string, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Info) {
-			this._proxy.$log(this._logFile, LogLevel.Info, Array.from(arguments));
-		}
-	}
-
-	warn(_message: string, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Warning) {
-			this._proxy.$log(this._logFile, LogLevel.Warning, Array.from(arguments));
-		}
-	}
-
-	error(_message: string | Error, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Error) {
-			this._proxy.$log(this._logFile, LogLevel.Error, Array.from(arguments));
-		}
-	}
-
-	critical(_message: string | Error, ..._args: any[]): void {
-		if (this.getLevel() <= LogLevel.Critical) {
-			this._proxy.$log(this._logFile, LogLevel.Critical, Array.from(arguments));
-		}
-	}
-
-	flush(): void { }
-}