feat(streams): use logger

Author: grypez

packages/streams/src/browser/ChromeRuntimeStream.test.ts

@@ -31,6 +31,21 @@ const makeEnvelope = (
 
 const EXTENSION_ID = 'test-extension-id';
 
+const mocks = vi.hoisted(() => ({
+  logger: {
+    debug: vi.fn(),
+    warn: vi.fn(),
+  },
+}));
+
+vi.mock('@ocap/utils', async (importOriginal) => {
+  const actual = await importOriginal<typeof import('@ocap/utils')>();
+  return {
+    ...actual,
+    makeLogger: vi.fn(() => mocks.logger),
+  };
+});
+
 // This function declares its own return type.
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 const makeRuntime = (extensionId: string = EXTENSION_ID) => {
@@ -165,11 +180,11 @@ describe('ChromeRuntimeReader', () => {
 
     const nextP = reader.next();
 
-    vi.spyOn(console, 'debug');
+    const debugSpy = vi.spyOn(mocks.logger, 'debug');
     listeners[0]?.({ not: 'an envelope' }, { id: EXTENSION_ID });
 
-    expect(console.debug).toHaveBeenCalledWith(
-      `ChromeRuntimeReader received unexpected message: ${stringify({
+    expect(debugSpy).toHaveBeenCalledWith(
+      `received unexpected message: ${stringify({
         not: 'an envelope',
       })}`,
     );
@@ -189,7 +204,7 @@ describe('ChromeRuntimeReader', () => {
 
     const nextP = reader.next();
 
-    vi.spyOn(console, 'warn');
+    vi.spyOn(mocks.logger, 'warn');
     const message1 = { foo: 'bar' };
     dispatchRuntimeMessage(
       message1,

packages/streams/src/browser/ChromeRuntimeStream.ts

@@ -15,7 +15,8 @@
  */
 
 import type { Json } from '@metamask/utils';
-import { stringify } from '@ocap/utils';
+import { makeLogger, stringify } from '@ocap/utils';
+import type { Logger } from '@ocap/utils';
 
 import type { ChromeRuntime, ChromeMessageSender } from './chrome.d.ts';
 import {
@@ -67,6 +68,8 @@ export class ChromeRuntimeReader<Read extends Json> extends BaseReader<Read> {
 
   readonly #extensionId: string;
 
+  readonly #logger: Logger;
+
   constructor(
     runtime: ChromeRuntime,
     target: ChromeRuntimeTarget,
@@ -91,6 +94,7 @@ export class ChromeRuntimeReader<Read extends Json> extends BaseReader<Read> {
     this.#target = target;
     this.#source = source;
     this.#extensionId = runtime.id;
+    this.#logger = makeLogger(`[chrome-runtime-reader ${this.#extensionId}]`);
 
     messageListener = this.#onMessage.bind(this);
     // Begin listening for messages from the Chrome runtime.
@@ -105,19 +109,15 @@ export class ChromeRuntimeReader<Read extends Json> extends BaseReader<Read> {
     }
 
     if (!isMessageEnvelope(message)) {
-      console.debug(
-        `ChromeRuntimeReader received unexpected message: ${stringify(
-          message,
-        )}`,
-      );
+      this.#logger.debug(`received unexpected message: ${stringify(message)}`);
       return;
     }
 
     if (message.target !== this.#target || message.source !== this.#source) {
-      console.debug(
-        `ChromeRuntimeReader received message with incorrect target or source: ${stringify(message)}`,
-        `Expected target: ${this.#target}`,
-        `Expected source: ${this.#source}`,
+      this.#logger.debug(
+        `received message with incorrect target or source: ${stringify(message)}`,
+        `expected target: ${this.#target}`,
+        `expected source: ${this.#source}`,
       );
       return;
     }