1
0
mirror of https://github.com/bitwarden/browser synced 2025-12-15 07:43:35 +00:00

Platform logging lib (#15338)

* Add Platform Logging Lib

* Move console log spec and test util back into libs/common

* Fix ConsoleLogServer re-export

* Fix types error
This commit is contained in:
Justin Baur
2025-07-01 13:47:02 -04:00
committed by GitHub
parent 3ae5e063a7
commit 4cb80b4a03
20 changed files with 201 additions and 78 deletions

View File

@@ -0,0 +1,57 @@
import { LogLevel } from "./log-level";
import { LogService } from "./log.service";
export class ConsoleLogService implements LogService {
protected timersMap: Map<string, [number, number]> = new Map();
constructor(
protected isDev: boolean,
protected filter: ((level: LogLevel) => boolean) | null = null,
) {}
debug(message?: any, ...optionalParams: any[]) {
if (!this.isDev) {
return;
}
this.write(LogLevel.Debug, message, ...optionalParams);
}
info(message?: any, ...optionalParams: any[]) {
this.write(LogLevel.Info, message, ...optionalParams);
}
warning(message?: any, ...optionalParams: any[]) {
this.write(LogLevel.Warning, message, ...optionalParams);
}
error(message?: any, ...optionalParams: any[]) {
this.write(LogLevel.Error, message, ...optionalParams);
}
write(level: LogLevel, message?: any, ...optionalParams: any[]) {
if (this.filter != null && this.filter(level)) {
return;
}
switch (level) {
case LogLevel.Debug:
// eslint-disable-next-line
console.log(message, ...optionalParams);
break;
case LogLevel.Info:
// eslint-disable-next-line
console.log(message, ...optionalParams);
break;
case LogLevel.Warning:
// eslint-disable-next-line
console.warn(message, ...optionalParams);
break;
case LogLevel.Error:
// eslint-disable-next-line
console.error(message, ...optionalParams);
break;
default:
break;
}
}
}

View File

@@ -0,0 +1,3 @@
export { LogService } from "./log.service";
export { LogLevel } from "./log-level";
export { ConsoleLogService } from "./console-log.service";

View File

@@ -0,0 +1,8 @@
// FIXME: update to use a const object instead of a typescript enum
// eslint-disable-next-line @bitwarden/platform/no-enums
export enum LogLevel {
Debug,
Info,
Warning,
Error,
}

View File

@@ -0,0 +1,9 @@
import { LogLevel } from "./log-level";
export abstract class LogService {
abstract debug(message?: any, ...optionalParams: any[]): void;
abstract info(message?: any, ...optionalParams: any[]): void;
abstract warning(message?: any, ...optionalParams: any[]): void;
abstract error(message?: any, ...optionalParams: any[]): void;
abstract write(level: LogLevel, message?: any, ...optionalParams: any[]): void;
}

View File

@@ -0,0 +1,8 @@
import * as lib from "./index";
describe("logging", () => {
// This test will fail until something is exported from index.ts
it("should work", () => {
expect(lib).toBeDefined();
});
});