aboutsummaryrefslogtreecommitdiff
path: root/deno/base/log.ts
blob: d0a5b8067265cfdee00a176204437f860738512c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
import { join } from "@std/path";

import { toFileNameString } from "./date.ts";

export type LogLevel = "error" | "warn" | "info";

export interface LogEntry {
  content: [unknown, ...unknown[]];
  level?: LogLevel;
  cause?: unknown;
}

export interface LogEntryBuilder {
  withLevel(level: LogLevel): LogEntryBuilder;
  withCause(cause: unknown): LogEntryBuilder;
  setError(error: boolean): LogEntryBuilder;
  write(): void;
}

export interface ExternalLogStream extends Disposable {
  stream: WritableStream;
}

export class Logger {
  #indentSize = 2;
  #externalLogDir?: string;

  #contextStack: { depth: number; level: LogLevel }[] = [
    { depth: 0, level: "info" },
  ];

  get #context() {
    return this.#contextStack.at(-1)!;
  }

  get indentSize() {
    return this.#indentSize;
  }

  set indentSize(value: number) {
    this.#indentSize = value;
  }

  get externalLogDir() {
    return this.#externalLogDir;
  }

  set externalLogDir(value: string | undefined) {
    this.#externalLogDir = value;
    if (value != null) {
      Deno.mkdirSync(value, {
        recursive: true,
      });
    }
  }

  write(entry: LogEntry): void {
    const { content, level, cause } = entry;
    const [message, ...rest] = content;
    console[level ?? this.#context.level](
      " ".repeat(this.#indentSize * this.#context.depth) + String(message),
      ...(cause != null ? [cause, ...rest] : rest),
    );
  }

  push(entry: LogEntry): Disposable {
    this.write(entry);
    this.#contextStack.push({
      depth: this.#context.depth + 1,
      level: entry.level ?? this.#context.level,
    });
    return {
      [Symbol.dispose]: () => {
        this.#contextStack.pop();
      },
    };
  }

  info(message: unknown, ...args: unknown[]) {
    this.write({ level: "info", content: [message, ...args] });
  }

  warn(message: unknown, ...args: unknown[]) {
    this.write({ level: "warn", content: [message, ...args] });
  }

  error(message: unknown, ...args: unknown[]) {
    this.write({ level: "error", content: [message, ...args] });
  }

  builder(message: unknown, ...args: unknown[]): LogEntryBuilder {
    const entry: LogEntry = {
      content: [message, ...args],
      level: "info",
      cause: undefined,
    };
    const builder: LogEntryBuilder = {
      withCause: (cause) => {
        entry.cause = cause;
        return builder;
      },
      withLevel: (level) => {
        entry.level = level;
        return builder;
      },
      setError: (error) => {
        if (error) entry.level = "error";
        return builder;
      },
      write: () => {
        this.write(entry);
      },
    };
    return builder;
  }

  async createExternalLogStream(
    name: string,
    options?: {
      noTime?: boolean;
    },
  ): Promise<ExternalLogStream> {
    if (name.includes("/")) {
      throw new Error(`External log stream's name (${name}) contains '/'.`);
    }
    if (this.#externalLogDir == null) {
      throw new Error("External log directory is not set.");
    }

    const logPath = join(
      this.#externalLogDir,
      options?.noTime === true
        ? name
        : `${name}-${toFileNameString(new Date())}`,
    );

    const file = await Deno.open(logPath, {
      read: false,
      write: true,
      append: true,
      create: true,
    });
    return {
      stream: file.writable,
      [Symbol.dispose]: file[Symbol.dispose].bind(file),
    };
  }

  async createExternalLogStreamsForProgram(
    program: string,
  ): Promise<{ stdout: WritableStream; stderr: WritableStream } & Disposable> {
    const stdout = await this.createExternalLogStream(`${program}-stdout`);
    const stderr = await this.createExternalLogStream(`${program}-stderr`);
    return {
      stdout: stdout.stream,
      stderr: stderr.stream,
      [Symbol.dispose]: () => {
        stdout[Symbol.dispose]();
        stderr[Symbol.dispose]();
      },
    };
  }
}