1
>
/*---------------------------------------------------------------------------------------------
traceLogger.ts
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 { LogEntryLike } from '../executionGraph.js';
7
>
import { Trace, TraceContext } from './trace.js';
8
>
9
>
/**
10
>
* A minimal logger for tests that captures the active {@link Trace} at log
11
>
* time so messages can later be woven into a swimlane diagram next to the
12
>
* timer events that produced them.
13
>
*/
14
>
export interface ITraceLogger {
15
>
log(message: string): void;
16
>
warn(message: string): void;
17
>
error(message: string): void;
18
>
/**
19
>
* Run `fn` synchronously and log it as a marker in the trace. The
20
>
* marker text is `fn.toString()` so call sites read naturally as e.g.
21
>
* `logger.logRun(() => model.trigger())`. Returns whatever `fn`
22
>
* returns.
23
>
*/
24
>
logRun<T>(fn: () => T): T;
25
>
}
26
>
27
>
/**
28
>
* One log entry produced by an {@link ITraceLogger}. Extends
29
>
* {@link LogEntryLike} (consumed by `buildHistoryFromTasks`) with a level so
30
>
* renderers can differentiate `log` / `warn` / `error`.
31
>
*/
32
>
export interface ITraceLogEntry extends LogEntryLike {
33
>
readonly trace: Trace;
34
>
readonly level: 'log' | 'warn' | 'error';
35
>
}
36
>
37
>
/**
38
>
* Build an {@link ITraceLogger} that pushes every call into `buffer`,
39
>
* tagging each entry with the trace that's current at call time.
40
>
*
41
>
* Pass the same `buffer` to `buildHistoryFromTasks(history, startTime,
42
>
* buffer)` to interleave log lines with the timer swimlane.
43
>
*/
44
>
export function createTraceLogger(buffer: ITraceLogEntry[]): ITraceLogger {
45
const make = (level: 'log' | 'warn' | 'error') => (message: string) => {
46
buffer.push({