src/vs/platform/log/common/logIpc.ts
176 LOC · 79 covered · 97 uncovered · 17 ranges · 12 concepts · 1 introducers · 8 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
logIpc.ts ×17
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { URI } from '../../../base/common/uri.js';
7
>
import { Event } from '../../../base/common/event.js';
8
>
import { IChannel, IServerChannel } from '../../../base/parts/ipc/common/ipc.js';
9
>
import { AbstractLoggerService, AbstractMessageLogger, AdapterLogger, DidChangeLoggersEvent, ILogger, ILoggerOptions, ILoggerResource, ILoggerService, isLogLevel, LogLevel } from './log.js';
10
>
import { Disposable } from '../../../base/common/lifecycle.js';
11
>
import { IURITransformer } from '../../../base/common/uriIpc.js';
12
>
13
>
export class LoggerChannelClient extends AbstractLoggerService implements ILoggerService {
14
>
15
>
constructor(private readonly windowId: number | undefined, logLevel: LogLevel, logsHome: URI, loggers: ILoggerResource[], private readonly channel: IChannel) {
16
super(logLevel, logsHome, loggers);
17
this._register(channel.listen<LogLevel | [URI, LogLevel]>('onDidChangeLogLevel', windowId)(arg => {
18
if (isLogLevel(arg)) {
19
super.setLogLevel(arg);
20
} else {
21
super.setLogLevel(URI.revive(arg[0]), arg[1]);
22
}
23
}));
24
this._register(channel.listen<[URI, boolean]>('onDidChangeVisibility', windowId)(([resource, visibility]) => super.setVisibility(URI.revive(resource), visibility)));
25
this._register(channel.listen<DidChangeLoggersEvent>('onDidChangeLoggers', windowId)(({ added, removed }) => {
26
for (const loggerResource of added) {
27
super.registerLogger({ ...loggerResource, resource: URI.revive(loggerResource.resource) });
28
}
29
for (const loggerResource of removed) {
30
super.deregisterLogger(loggerResource.resource);
31
}
32
}));
33
}
35
>
createConsoleMainLogger(): ILogger {
36
return new AdapterLogger({
37
log: (level: LogLevel, args: any[]) => {
38
this.channel.call('consoleLog', [level, args]);
39
}
40
});
41
}
43
>
override registerLogger(logger: ILoggerResource): void {
44
super.registerLogger(logger);
45
this.channel.call('registerLogger', [logger, this.windowId]);
46
}
48
>
override deregisterLogger(idOrResource: URI | string): void {
49
const resource = this.toResource(idOrResource);
50
super.deregisterLogger(resource);
51
this.channel.call('deregisterLogger', [resource, this.windowId]);
52
}
54
>
override setLogLevel(logLevel: LogLevel): void;
55
>
override setLogLevel(resource: URI, logLevel: LogLevel): void;
56
>
override setLogLevel(arg1: any, arg2?: any): void {
57
super.setLogLevel(arg1, arg2);
58
this.channel.call('setLogLevel', [arg1, arg2]);
59
}
61
>
override setVisibility(resourceOrId: URI | string, visibility: boolean): void {
62
super.setVisibility(resourceOrId, visibility);
63
this.channel.call('setVisibility', [this.toResource(resourceOrId), visibility]);
64
}
66
>
protected doCreateLogger(file: URI, logLevel: LogLevel, options?: ILoggerOptions): ILogger {
67
return new Logger(this.channel, file, logLevel, options, this.windowId);
68
}
70
>
public static setLogLevel(channel: IChannel, level: LogLevel): Promise<void>;
71
>
public static setLogLevel(channel: IChannel, resource: URI, level: LogLevel): Promise<void>;
72
>
public static setLogLevel(channel: IChannel, arg1: any, arg2?: any): Promise<void> {
73
return channel.call('setLogLevel', [arg1, arg2]);
74
}
76
>
}
77
>
78
>
class Logger extends AbstractMessageLogger {
79
>
80
>
private isLoggerCreated: boolean = false;
81
>
private buffer: [LogLevel, string][] = [];
82
>
83
>
constructor(
84
private readonly channel: IChannel,
85
private readonly file: URI,
86
logLevel: LogLevel,
87
loggerOptions?: ILoggerOptions,
88
windowId?: number | undefined
89
) {
90
super(loggerOptions?.logLevel === 'always');
91
this.setLevel(logLevel);
92
this.channel.call('createLogger', [file, loggerOptions, windowId])
93
.then(() => {
94
this.doLog(this.buffer);
95
this.isLoggerCreated = true;
96
});
97
}
99
>
protected log(level: LogLevel, message: string) {
100
const messages: [LogLevel, string][] = [[level, message]];
101
if (this.isLoggerCreated) {
102
this.doLog(messages);
103
} else {
104
this.buffer.push(...messages);
105
}
106
}
108
>
private doLog(messages: [LogLevel, string][]) {
109
this.channel.call('log', [this.file, messages]);
110
}
112
>
113
>
export class LoggerChannel implements IServerChannel {
114
>
115
>
constructor(private readonly loggerService: ILoggerService, private getUriTransformer: (requestContext: any) => IURITransformer) { }
116
>
117
>
listen(context: any, event: string): Event<any> {
118
const uriTransformer = this.getUriTransformer(context);
119
switch (event) {
120
case 'onDidChangeLoggers': return Event.map<DidChangeLoggersEvent, DidChangeLoggersEvent>(this.loggerService.onDidChangeLoggers, (e) =>
121
({
122
added: [...e.added].map(logger => this.transformLogger(logger, uriTransformer)),
123
removed: [...e.removed].map(logger => this.transformLogger(logger, uriTransformer)),
124
}));
125
case 'onDidChangeVisibility': return Event.map<[URI, boolean], [URI, boolean]>(this.loggerService.onDidChangeVisibility, e => [uriTransformer.transformOutgoingURI(e[0]), e[1]]);
126
case 'onDidChangeLogLevel': return Event.map<LogLevel | [URI, LogLevel], LogLevel | [URI, LogLevel]>(this.loggerService.onDidChangeLogLevel, e => isLogLevel(e) ? e : [uriTransformer.transformOutgoingURI(e[0]), e[1]]);
127
}
128
throw new Error(`Event not found: ${event}`);
129
}
131
>
async call(context: any, command: string, arg?: any): Promise<any> {
132
const uriTransformer: IURITransformer | null = this.getUriTransformer(context);
133
switch (command) {
134
case 'setLogLevel': return isLogLevel(arg[0]) ? this.loggerService.setLogLevel(arg[0]) : this.loggerService.setLogLevel(URI.revive(uriTransformer.transformIncoming(arg[0][0])), arg[0][1]);
135
case 'getRegisteredLoggers': return Promise.resolve([...this.loggerService.getRegisteredLoggers()].map(logger => this.transformLogger(logger, uriTransformer)));
136
}
137
138
throw new Error(`Call not found: ${command}`);
139
}
141
>
private transformLogger(logger: ILoggerResource, transformer: IURITransformer): ILoggerResource {
142
return {
143
...logger,
144
resource: transformer.transformOutgoingURI(logger.resource)
145
};
146
}
148
>
}
149
>
150
>
export class RemoteLoggerChannelClient extends Disposable {
151
>
152
>
constructor(loggerService: ILoggerService, channel: IChannel) {
153
>
super();
154
>
155
>
channel.call('setLogLevel', [loggerService.getLogLevel()]);
156
>
this._register(loggerService.onDidChangeLogLevel(arg => channel.call('setLogLevel', [arg])));
157
>
158
>
channel.call<ILoggerResource[]>('getRegisteredLoggers').then(loggers => {
159
>
for (const loggerResource of loggers) {
160
loggerService.registerLogger({ ...loggerResource, resource: URI.revive(loggerResource.resource) });
161
}
163
>
164
>
this._register(channel.listen<[URI, boolean]>('onDidChangeVisibility')(([resource, visibility]) => loggerService.setVisibility(URI.revive(resource), visibility)));
165
>
166
>
this._register(channel.listen<DidChangeLoggersEvent>('onDidChangeLoggers')(({ added, removed }) => {
167
for (const loggerResource of added) {
168
loggerService.registerLogger({ ...loggerResource, resource: URI.revive(loggerResource.resource) });
169
}
170
for (const loggerResource of removed) {
171
loggerService.deregisterLogger(loggerResource.resource);
172
}
174
>
175
>
}
176
>
}