-
Notifications
You must be signed in to change notification settings - Fork 30.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
232 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
148 changes: 148 additions & 0 deletions
148
src/vs/workbench/contrib/logs/common/defaultLogLevels.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
/*--------------------------------------------------------------------------------------------- | ||
* Copyright (c) Microsoft Corporation. All rights reserved. | ||
* Licensed under the MIT License. See License.txt in the project root for license information. | ||
*--------------------------------------------------------------------------------------------*/ | ||
|
||
import { ILogService, ILoggerService, LogLevel, LogLevelToString, getLogLevel, parseLogLevel } from 'vs/platform/log/common/log'; | ||
import { createDecorator } from 'vs/platform/instantiation/common/instantiation'; | ||
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService'; | ||
import { IFileService } from 'vs/platform/files/common/files'; | ||
import { IJSONEditingService } from 'vs/workbench/services/configuration/common/jsonEditing'; | ||
import { isString, isUndefined } from 'vs/base/common/types'; | ||
import { EXTENSION_IDENTIFIER_WITH_LOG_REGEX } from 'vs/platform/environment/common/environmentService'; | ||
import { InstantiationType, registerSingleton } from 'vs/platform/instantiation/common/extensions'; | ||
import { parse } from 'vs/base/common/json'; | ||
|
||
interface ParsedArgvLogLevels { | ||
default?: LogLevel; | ||
extensions?: [string, LogLevel][]; | ||
} | ||
|
||
export type DefaultLogLevels = Required<Readonly<ParsedArgvLogLevels>>; | ||
|
||
export const IDefaultLogLevelsService = createDecorator<IDefaultLogLevelsService>('IDefaultLogLevelsService'); | ||
|
||
export interface IDefaultLogLevelsService { | ||
|
||
readonly _serviceBrand: undefined; | ||
|
||
getDefaultLogLevels(): Promise<DefaultLogLevels>; | ||
|
||
setDefaultLogLevel(logLevel: LogLevel, extensionId?: string): Promise<void>; | ||
} | ||
|
||
class DefaultLogLevelsService implements IDefaultLogLevelsService { | ||
|
||
_serviceBrand: undefined; | ||
|
||
constructor( | ||
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService, | ||
@IFileService private readonly fileService: IFileService, | ||
@IJSONEditingService private readonly jsonEditingService: IJSONEditingService, | ||
@ILogService private readonly logService: ILogService, | ||
@ILoggerService private readonly loggerService: ILoggerService, | ||
) { | ||
} | ||
|
||
async getDefaultLogLevels(): Promise<DefaultLogLevels> { | ||
const argvLogLevel = await this._parseLogLevelsFromArgv(); | ||
return { | ||
default: argvLogLevel?.default ?? this._getDefaultLogLevelFromEnv(), | ||
extensions: argvLogLevel?.extensions ?? this._getExtensionsDefaultLogLevelsFromEnv() | ||
}; | ||
} | ||
|
||
async setDefaultLogLevel(defaultLogLevel: LogLevel, extensionId?: string): Promise<void> { | ||
const argvLogLevel = await this._parseLogLevelsFromArgv() ?? {}; | ||
if (extensionId) { | ||
extensionId = extensionId.toLowerCase(); | ||
const argvLogLevel = await this._parseLogLevelsFromArgv() ?? {}; | ||
const currentDefaultLogLevel = this._getDefaultLogLevel(argvLogLevel, extensionId); | ||
argvLogLevel.extensions = argvLogLevel.extensions ?? []; | ||
const extension = argvLogLevel.extensions.find(([extension]) => extension === extensionId); | ||
if (extension) { | ||
extension[1] = defaultLogLevel; | ||
} else { | ||
argvLogLevel.extensions.push([extensionId, defaultLogLevel]); | ||
} | ||
await this._writeLogLevelsToArgv(argvLogLevel); | ||
const extensionLoggers = [...this.loggerService.getRegisteredLoggers()].filter(logger => logger.extensionId && logger.extensionId.toLowerCase() === extensionId); | ||
for (const { resource } of extensionLoggers) { | ||
if (this.loggerService.getLogLevel(resource) === currentDefaultLogLevel) { | ||
this.loggerService.setLogLevel(resource, defaultLogLevel); | ||
} | ||
} | ||
} else { | ||
const currentLogLevel = this._getDefaultLogLevel(argvLogLevel); | ||
argvLogLevel.default = defaultLogLevel; | ||
await this._writeLogLevelsToArgv(argvLogLevel); | ||
if (this.loggerService.getLogLevel() === currentLogLevel) { | ||
this.loggerService.setLogLevel(defaultLogLevel); | ||
} | ||
} | ||
} | ||
|
||
private _getDefaultLogLevel(argvLogLevels: ParsedArgvLogLevels, extension?: string): LogLevel { | ||
if (extension) { | ||
const extensionLogLevel = argvLogLevels.extensions?.find(([extensionId]) => extensionId === extension); | ||
if (extensionLogLevel) { | ||
return extensionLogLevel[1]; | ||
} | ||
} | ||
return argvLogLevels.default ?? getLogLevel(this.environmentService); | ||
} | ||
|
||
private async _writeLogLevelsToArgv(logLevels: ParsedArgvLogLevels): Promise<void> { | ||
const logLevelsValue: string[] = []; | ||
if (logLevels.default) { | ||
logLevelsValue.push(LogLevelToString(logLevels.default)); | ||
} | ||
for (const [extension, logLevel] of logLevels.extensions ?? []) { | ||
logLevelsValue.push(`${extension}:${LogLevelToString(logLevel)}`); | ||
} | ||
await this.jsonEditingService.write(this.environmentService.argvResource, [{ path: ['log-level'], value: logLevelsValue.length ? logLevelsValue : undefined }], true); | ||
} | ||
|
||
private async _parseLogLevelsFromArgv(): Promise<ParsedArgvLogLevels | undefined> { | ||
const result: ParsedArgvLogLevels = { extensions: [] }; | ||
try { | ||
const content = await this.fileService.readFile(this.environmentService.argvResource); | ||
const argv: { 'log-level'?: string | string[] } = parse(content.value.toString()); | ||
const logLevels = isString(argv['log-level']) ? [argv['log-level']] : Array.isArray(argv['log-level']) ? argv['log-level'] : []; | ||
for (const extensionLogLevel of logLevels) { | ||
const matches = EXTENSION_IDENTIFIER_WITH_LOG_REGEX.exec(extensionLogLevel); | ||
if (matches && matches[1] && matches[2]) { | ||
const logLevel = parseLogLevel(matches[2]); | ||
if (!isUndefined(logLevel)) { | ||
result.extensions?.push([matches[1].toLowerCase(), logLevel]); | ||
} | ||
} else { | ||
const logLevel = parseLogLevel(extensionLogLevel); | ||
if (!isUndefined(logLevel)) { | ||
result.default = logLevel; | ||
} | ||
} | ||
} | ||
} catch (error) { | ||
this.logService.error(error); | ||
} | ||
return !isUndefined(result.default) || result.extensions?.length ? result : undefined; | ||
} | ||
|
||
private _getDefaultLogLevelFromEnv(): LogLevel { | ||
return getLogLevel(this.environmentService); | ||
} | ||
|
||
private _getExtensionsDefaultLogLevelsFromEnv(): [string, LogLevel][] { | ||
const result: [string, LogLevel][] = []; | ||
for (const [extension, logLevelValue] of this.environmentService.extensionLogLevel ?? []) { | ||
const logLevel = parseLogLevel(logLevelValue); | ||
if (!isUndefined(logLevel)) { | ||
result.push([extension, logLevel]); | ||
} | ||
} | ||
return result; | ||
} | ||
} | ||
|
||
registerSingleton(IDefaultLogLevelsService, DefaultLogLevelsService, InstantiationType.Delayed); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters