feat: Make Logger obey log level settings

Closes #679

Author: FUDCo

packages/kernel-browser-runtime/test/build-tests.ts

@@ -1,7 +1,6 @@
 import { runTests } from '@ocap/repo-tools/build-utils/test';
 import path from 'node:path';
 
-// eslint-disable-next-line n/no-unsupported-features/node-builtins
 const outDir = path.resolve(import.meta.dirname, '../dist/static');
 
 const untransformedFiles = [

packages/kernel-browser-runtime/vite.config.ts

@@ -29,8 +29,6 @@ const staticCopyTargets: readonly (string | Target)[] = [
   '../../kernel-shims/dist/endoify.js',
 ];
 
-// We will only run this where it's available, but ESLint doesn't know that
-// eslint-disable-next-line n/no-unsupported-features/node-builtins
 const sourceDir = path.resolve(import.meta.dirname, 'src');
 const buildDir = path.resolve(sourceDir, '../dist/static');
 

packages/logger/src/constants.ts

@@ -1,2 +1,8 @@
-export const logLevels = ['debug', 'info', 'log', 'warn', 'error'] as const;
+export const logLevels = {
+  debug: 1,
+  info: 2,
+  log: 3,
+  warn: 4,
+  error: 5,
+} as const;
 export const TOKEN_UNDEFINED = 'e790f877-6987-4b06-9ce2-5fc889d5b9ac';

packages/logger/src/logger.test.ts

@@ -2,6 +2,7 @@ import type { DuplexStream } from '@metamask/streams';
 import { delay } from '@ocap/repo-tools/test-utils';
 import { describe, it, expect, vi } from 'vitest';
 
+import { logLevels } from './constants.ts';
 import { Logger } from './logger.ts';
 import { lser } from './stream.ts';
 import type { LogMessage } from './stream.ts';
@@ -113,6 +114,25 @@ describe('Logger', () => {
     });
   });
 
+  describe('logging level limits output', () => {
+    consoleMethod.forEach((level) => {
+      it(`logging at level ${level}`, () => {
+        const testLogger = new Logger({ level });
+        consoleMethod.forEach((method) => {
+          const consoleSpy = vi.spyOn(console, method);
+          testLogger[method](`foo ${method}`);
+          if (logLevels[level] <= logLevels[method]) {
+            // eslint-disable-next-line vitest/no-conditional-expect
+            expect(consoleSpy).toHaveBeenCalledWith(`foo ${method}`);
+          } else {
+            // eslint-disable-next-line vitest/no-conditional-expect
+            expect(consoleSpy).not.toHaveBeenCalled();
+          }
+        });
+      });
+    });
+  });
+
   describe('injectStream', () => {
     it('calls drain on the provided stream', () => {
       const logger = new Logger();

packages/logger/src/logger.ts

@@ -50,6 +50,7 @@
 
 import type { DuplexStream } from '@metamask/streams';
 
+import { logLevels } from './constants.ts';
 import { parseOptions, mergeOptions } from './options.ts';
 import { lunser } from './stream.ts';
 import type { LogMessage } from './stream.ts';
@@ -99,16 +100,24 @@ export class Logger {
 
     // Create aliases for the log methods, allowing them to be used in a
     // manner similar to the console object.
-    const bind = (level: LogLevel): LogMethod =>
-      harden(
-        this.#dispatch.bind(this, {
-          ...this.#options,
-          level,
-        }),
-      ) as LogMethod;
-    this.log = bind('log');
+    const baseLevelIdx = this.#options.level
+      ? logLevels[this.#options.level]
+      : 0;
+    const bind = (level: LogLevel): LogMethod => {
+      if (baseLevelIdx <= logLevels[level]) {
+        return harden(
+          this.#dispatch.bind(this, {
+            ...this.#options,
+            level,
+          }),
+        ) as LogMethod;
+      }
+      // eslint-disable-next-line no-empty-function
+      return harden(() => {}) as LogMethod;
+    };
     this.debug = bind('debug');
     this.info = bind('info');
+    this.log = bind('log');
     this.warn = bind('warn');
     this.error = bind('error');
   }

packages/logger/src/transports.test.ts

@@ -17,9 +17,10 @@ const makeLogEntry = (level: LogLevel): LogEntry => ({
 });
 
 describe('consoleTransport', () => {
-  it.each(logLevels)(
+  it.each(Object.keys(logLevels))(
     'logs to the appropriate console alias: %s',
-    (level: LogLevel) => {
+    (levelString: string) => {
+      const level = levelString as LogLevel;
       const logEntry = makeLogEntry(level);
       const consoleMethodSpy = vi.spyOn(console, level);
       consoleTransport(logEntry);

packages/logger/src/types.ts

@@ -3,7 +3,7 @@ import type { logLevels } from './constants.ts';
 /**
  * The log level for the logger.
  */
-export type LogLevel = (typeof logLevels)[number];
+export type LogLevel = keyof typeof logLevels;
 
 /**
  * The log entry for the logger.

packages/omnium-gatherum/test/build/build-tests.ts

@@ -1,7 +1,6 @@
 import { runTests } from '@ocap/repo-tools/build-utils/test';
 import path from 'node:path';
 
-// eslint-disable-next-line n/no-unsupported-features/node-builtins
 const packageDir = path.resolve(import.meta.dirname, '../../');
 const outDir = path.resolve(packageDir, 'dist');
 const untransformedFiles = [