refactor: promote logger to its own package

package.json

@@ -114,7 +114,9 @@
       "vite>sass>@parcel/watcher": false,
       "vitest>@vitest/browser>webdriverio>@wdio/utils>edgedriver": false,
       "vitest>@vitest/browser>webdriverio>@wdio/utils>geckodriver": false,
-      "vitest>@vitest/mocker>msw": false
+      "vitest>@vitest/mocker>msw": false,
+      "@ocap/cli>@ocap/logger>@ocap/streams": true,
+      "eslint-plugin-import-x>unrs-resolver": false
     }
   },
   "resolutions": {

packages/cli/package.json

@@ -38,6 +38,7 @@
     "@endo/promise-kit": "^1.1.10",
     "@metamask/snaps-utils": "^9.1.0",
     "@metamask/utils": "^11.4.0",
+    "@ocap/logger": "workspace:^",
     "@ocap/shims": "workspace:^",
     "@ocap/utils": "workspace:^",
     "@types/node": "^22.13.1",

packages/cli/src/app.ts

@@ -1,6 +1,6 @@
 import '@endo/init';
 
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 import path from 'node:path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';

packages/cli/src/commands/bundle.test.ts

@@ -1,4 +1,4 @@
-import { Logger } from '@ocap/utils';
+import type { Logger } from '@ocap/logger';
 import { readFile, rm } from 'fs/promises';
 import { basename } from 'path';
 import { describe, it, expect, vi, beforeEach, afterAll } from 'vitest';
@@ -13,11 +13,14 @@ import { fileExists } from '../file.ts';
 const mocks = vi.hoisted(() => {
   return {
     endoBundleSource: vi.fn(),
-    Logger: vi.fn(() => ({
-      info: vi.fn(),
-      error: vi.fn(),
-      subLogger: vi.fn(),
-    })),
+    Logger: vi.fn(
+      () =>
+        ({
+          info: vi.fn(),
+          error: vi.fn(),
+          subLogger: vi.fn(),
+        }) as unknown as Logger,
+    ),
     isDirectory: vi.fn(),
   };
 });
@@ -28,7 +31,7 @@ vi.mock('@endo/bundle-source', () => ({
 
 vi.mock('@endo/init', () => ({}));
 
-vi.mock('@ocap/utils', () => ({
+vi.mock('@ocap/logger', () => ({
   Logger: mocks.Logger,
 }));
 
@@ -54,7 +57,7 @@ describe('bundle', async () => {
   beforeEach(async () => {
     await deleteTestBundles();
     vi.resetModules();
-    logger = new Logger();
+    logger = mocks.Logger();
     vi.resetAllMocks();
   });
 

packages/cli/src/commands/bundle.ts

@@ -1,6 +1,6 @@
 import '@endo/init';
 import endoBundleSource from '@endo/bundle-source';
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 import { glob } from 'glob';
 import { writeFile } from 'node:fs/promises';
 import { resolve, join } from 'node:path';

packages/cli/src/commands/watch.test.ts

@@ -1,6 +1,6 @@
 import '@ocap/shims/endoify';
 
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 import { watch } from 'chokidar';
 import type { FSWatcher } from 'chokidar';
 import type { Stats } from 'fs';

packages/cli/src/commands/watch.ts

@@ -1,5 +1,5 @@
 import { makePromiseKit } from '@endo/promise-kit';
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 import { watch } from 'chokidar';
 import type { FSWatcher, MatchFunction } from 'chokidar';
 import { unlink } from 'fs/promises';

packages/cli/tsconfig.build.json

@@ -9,6 +9,7 @@
     "types": ["ses", "node"]
   },
   "references": [
+    { "path": "../logger/tsconfig.build.json" },
     { "path": "../utils/tsconfig.build.json" },
     { "path": "../shims/tsconfig.build.json" }
   ],

packages/cli/tsconfig.json

@@ -6,7 +6,11 @@
     "types": ["ses", "vitest", "node"],
     "noEmit": true
   },
-  "references": [{ "path": "../test-utils" }, { "path": "../utils" }],
+  "references": [
+    { "path": "../logger" },
+    { "path": "../test-utils" },
+    { "path": "../utils" }
+  ],
   "include": [
     "../../vitest.config.ts",
     "./src/**/*.ts",

packages/extension/package.json

@@ -50,6 +50,7 @@
     "@metamask/utils": "^11.4.0",
     "@ocap/errors": "workspace:^",
     "@ocap/kernel": "workspace:^",
+    "@ocap/logger": "workspace:^",
     "@ocap/rpc-methods": "workspace:^",
     "@ocap/shims": "workspace:^",
     "@ocap/store": "workspace:^",

packages/extension/src/background.ts

@@ -1,9 +1,10 @@
 import { isJsonRpcResponse } from '@metamask/utils';
 import type { Json } from '@metamask/utils';
 import { kernelMethodSpecs } from '@ocap/kernel/rpc';
+import { Logger } from '@ocap/logger';
 import { RpcClient } from '@ocap/rpc-methods';
 import { ChromeRuntimeDuplexStream } from '@ocap/streams/browser';
-import { delay, Logger } from '@ocap/utils';
+import { delay } from '@ocap/utils';
 
 const OFFSCREEN_DOCUMENT_PATH = '/offscreen.html';
 

packages/extension/src/iframe.ts

@@ -1,10 +1,11 @@
 import { VatSupervisor } from '@ocap/kernel';
+import { Logger } from '@ocap/logger';
 import {
   MessagePortDuplexStream,
   receiveMessagePort,
 } from '@ocap/streams/browser';
 import type { JsonRpcMessage } from '@ocap/utils';
-import { isJsonRpcMessage, Logger } from '@ocap/utils';
+import { isJsonRpcMessage } from '@ocap/utils';
 
 const logger = new Logger('iframe');
 

packages/extension/src/kernel-integration/VatWorkerClient.test.ts

@@ -1,10 +1,10 @@
 import { rpcErrors } from '@metamask/rpc-errors';
 import type { JsonRpcResponse } from '@metamask/utils';
 import type { VatId, VatConfig } from '@ocap/kernel';
+import { Logger } from '@ocap/logger';
 import type { PostMessageTarget } from '@ocap/streams/browser';
 import { TestDuplexStream } from '@ocap/test-utils/streams';
-import type { Logger } from '@ocap/utils';
-import { delay, makeLogger, stringify } from '@ocap/utils';
+import { delay, stringify } from '@ocap/utils';
 import { describe, it, expect, beforeEach, vi } from 'vitest';
 
 import type { VatWorkerClientStream } from './VatWorkerClient.ts';
@@ -78,7 +78,7 @@ describe('ExtensionVatWorkerClient', () => {
 
     beforeEach(async () => {
       stream = await TestDuplexStream.make(() => undefined);
-      clientLogger = makeLogger('[test client]');
+      clientLogger = new Logger('test-client');
       client = new ExtensionVatWorkerClient(
         stream as unknown as VatWorkerClientStream,
         clientLogger,

packages/extension/src/kernel-integration/VatWorkerClient.ts

@@ -2,6 +2,7 @@ import { isJsonRpcResponse } from '@metamask/utils';
 import type { JsonRpcId, JsonRpcResponse } from '@metamask/utils';
 import type { VatWorkerManager, VatId, VatConfig } from '@ocap/kernel';
 import { vatWorkerServiceMethodSpecs } from '@ocap/kernel/rpc';
+import { Logger } from '@ocap/logger';
 import { RpcClient } from '@ocap/rpc-methods';
 import type { DuplexStream } from '@ocap/streams';
 import {
@@ -12,8 +13,8 @@ import type {
   PostMessageEnvelope,
   PostMessageTarget,
 } from '@ocap/streams/browser';
-import type { JsonRpcCall, JsonRpcMessage, Logger } from '@ocap/utils';
-import { isJsonRpcMessage, makeLogger, stringify } from '@ocap/utils';
+import type { JsonRpcCall, JsonRpcMessage } from '@ocap/utils';
+import { isJsonRpcMessage, stringify } from '@ocap/utils';
 
 // Appears in the docs.
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -53,7 +54,7 @@ export class ExtensionVatWorkerClient implements VatWorkerManager {
   constructor(stream: VatWorkerClientStream, logger?: Logger) {
     this.#stream = stream;
     this.#portMap = new Map();
-    this.#logger = logger ?? makeLogger('[vat worker client]');
+    this.#logger = logger ?? new Logger('vat-worker-client');
     this.#rpcClient = new RpcClient(
       vatWorkerServiceMethodSpecs,
       async (request) => {

packages/extension/src/kernel-integration/VatWorkerServer.test.ts

@@ -2,10 +2,10 @@ import { rpcErrors } from '@metamask/rpc-errors';
 import type { JsonRpcRequest } from '@metamask/utils';
 import { VatAlreadyExistsError, VatNotFoundError } from '@ocap/errors';
 import type { VatConfig, VatId } from '@ocap/kernel';
+import { Logger } from '@ocap/logger';
 import type { PostMessageTarget } from '@ocap/streams/browser';
 import { TestDuplexStream } from '@ocap/test-utils/streams';
-import type { Logger } from '@ocap/utils';
-import { delay, makeLogger } from '@ocap/utils';
+import { delay } from '@ocap/utils';
 import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
 import type { Mock } from 'vitest';
 
@@ -124,7 +124,7 @@ describe('ExtensionVatWorkerService', () => {
 
     beforeEach(async () => {
       workers = [];
-      logger = makeLogger('[test server]');
+      logger = new Logger('test-server');
       stream = await TestDuplexStream.make(() => undefined);
       server = new ExtensionVatWorkerService(
         stream as unknown as VatWorkerServiceStream,

packages/extension/src/kernel-integration/VatWorkerServer.ts

@@ -10,14 +10,13 @@ import { VatAlreadyExistsError, VatNotFoundError } from '@ocap/errors';
 import type { VatId, VatConfig } from '@ocap/kernel';
 import type { VatWorkerServiceMethod } from '@ocap/kernel/rpc';
 import { vatWorkerServiceMethodSpecs } from '@ocap/kernel/rpc';
+import { Logger } from '@ocap/logger';
 import type { ExtractParams } from '@ocap/rpc-methods';
 import { PostMessageDuplexStream } from '@ocap/streams/browser';
 import type {
   PostMessageEnvelope,
   PostMessageTarget,
 } from '@ocap/streams/browser';
-import type { Logger } from '@ocap/utils';
-import { makeLogger } from '@ocap/utils';
 
 // Appears in the docs.
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -67,7 +66,7 @@ export class ExtensionVatWorkerService {
   ) {
     this.#stream = stream;
     this.#makeWorker = makeWorker;
-    this.#logger = logger ?? makeLogger('[vat worker server]');
+    this.#logger = logger ?? new Logger('vat-worker-server');
   }
 
   /**

packages/extension/src/kernel-integration/iframe-vat-worker.ts

@@ -1,7 +1,7 @@
 import { createWindow } from '@metamask/snaps-utils';
 import type { VatId, VatConfig } from '@ocap/kernel';
+import { Logger } from '@ocap/logger';
 import type { initializeMessageChannel } from '@ocap/streams/browser';
-import { Logger } from '@ocap/utils';
 
 import type { VatWorker } from './VatWorkerServer.ts';
 

packages/extension/src/kernel-integration/kernel-worker.ts

@@ -2,13 +2,14 @@ import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import type { JsonRpcRequest, JsonRpcResponse } from '@metamask/utils';
 import type { ClusterConfig } from '@ocap/kernel';
 import { ClusterConfigStruct, Kernel } from '@ocap/kernel';
+import { Logger } from '@ocap/logger';
 import { makeSQLKernelDatabase } from '@ocap/store/sqlite/wasm';
 import type { PostMessageTarget } from '@ocap/streams/browser';
 import {
   MessagePortDuplexStream,
   receiveMessagePort,
 } from '@ocap/streams/browser';
-import { fetchValidatedJson, isJsonRpcCall, Logger } from '@ocap/utils';
+import { fetchValidatedJson, isJsonRpcCall } from '@ocap/utils';
 import type { JsonRpcCall } from '@ocap/utils';
 
 import { makeLoggingMiddleware } from './middleware/logging.ts';

packages/extension/src/kernel-integration/middleware/logging.test.ts

@@ -3,7 +3,7 @@ import {
   JsonRpcEngine,
 } from '@metamask/json-rpc-engine';
 import type { JsonRpcRequest, JsonRpcSuccess } from '@metamask/utils';
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 
 import { makeLoggingMiddleware } from './logging.ts';

packages/extension/src/kernel-integration/middleware/logging.ts

@@ -1,7 +1,7 @@
 import { createAsyncMiddleware } from '@metamask/json-rpc-engine';
 import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
 import type { Json, JsonRpcParams } from '@metamask/utils';
-import { Logger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 
 export const makeLoggingMiddleware = (
   logger: Logger,

packages/extension/src/kernel-integration/ui-connections.test.ts

@@ -1,8 +1,9 @@
 import type { JsonRpcResponse } from '@metamask/utils';
+import { Logger } from '@ocap/logger';
 import type { PostMessageTarget } from '@ocap/streams/browser';
 import { delay } from '@ocap/test-utils';
 import { TestDuplexStream } from '@ocap/test-utils/streams';
-import type { JsonRpcCall, Logger } from '@ocap/utils';
+import type { JsonRpcCall } from '@ocap/utils';
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 
 import {

packages/extension/src/kernel-integration/ui-connections.ts

@@ -1,8 +1,9 @@
 import { isJsonRpcRequest, isJsonRpcResponse } from '@metamask/utils';
 import type { JsonRpcResponse } from '@metamask/utils';
+import type { Logger } from '@ocap/logger';
 import { PostMessageDuplexStream } from '@ocap/streams/browser';
 import { stringify } from '@ocap/utils';
-import type { JsonRpcCall, Logger } from '@ocap/utils';
+import type { JsonRpcCall } from '@ocap/utils';
 import { nanoid } from 'nanoid';
 
 import { isUiControlCommand } from './ui-control-command.ts';

packages/extension/src/offscreen.ts

@@ -1,13 +1,14 @@
 import { isJsonRpcResponse } from '@metamask/utils';
 import type { JsonRpcResponse } from '@metamask/utils';
+import { Logger } from '@ocap/logger';
 import type { DuplexStream } from '@ocap/streams';
 import {
   initializeMessageChannel,
   ChromeRuntimeDuplexStream,
   MessagePortDuplexStream,
 } from '@ocap/streams/browser';
 import type { PostMessageTarget } from '@ocap/streams/browser';
-import { delay, isJsonRpcCall, Logger } from '@ocap/utils';
+import { delay, isJsonRpcCall } from '@ocap/utils';
 import type { JsonRpcCall } from '@ocap/utils';
 
 import { makeIframeVatWorker } from './kernel-integration/iframe-vat-worker.ts';

packages/extension/src/ui/services/logger.ts

@@ -1,3 +1,3 @@
-import { makeLogger } from '@ocap/utils';
+import { Logger } from '@ocap/logger';
 
-export const logger = makeLogger('[Kernel Panel]');
+export const logger = new Logger('kernel-panel');

packages/extension/tsconfig.build.json

@@ -14,6 +14,7 @@
   },
   "references": [
     { "path": "../kernel/tsconfig.build.json" },
+    { "path": "../logger/tsconfig.build.json" },
     { "path": "../rpc-methods/tsconfig.build.json" },
     { "path": "../shims/tsconfig.build.json" },
     { "path": "../store/tsconfig.build.json" },

packages/extension/tsconfig.json

@@ -21,6 +21,7 @@
   },
   "references": [
     { "path": "../kernel" },
+    { "path": "../logger" },
     { "path": "../rpc-methods" },
     { "path": "../shims" },
     { "path": "../store" },

packages/kernel/package.json

@@ -63,6 +63,7 @@
     "@metamask/superstruct": "^3.2.1",
     "@metamask/utils": "^11.4.0",
     "@ocap/errors": "workspace:^",
+    "@ocap/logger": "workspace:^",
     "@ocap/rpc-methods": "workspace:^",
     "@ocap/store": "workspace:^",
     "@ocap/streams": "workspace:^",

packages/kernel/src/Kernel.ts

@@ -7,11 +7,11 @@ import {
   VatAlreadyExistsError,
   VatNotFoundError,
 } from '@ocap/errors';
+import { Logger } from '@ocap/logger';
 import { RpcService } from '@ocap/rpc-methods';
 import type { ExtractParams, ExtractResult } from '@ocap/rpc-methods';
 import type { KernelDatabase } from '@ocap/store';
 import type { DuplexStream } from '@ocap/streams';
-import { Logger } from '@ocap/utils';
 import type { JsonRpcCall } from '@ocap/utils';
 
 import { KernelQueue } from './KernelQueue.ts';

packages/kernel/src/VatHandle.test.ts

@@ -1,8 +1,9 @@
 import type { Json } from '@metamask/utils';
+import type { Logger } from '@ocap/logger';
 import { delay } from '@ocap/test-utils';
 import { TestDuplexStream } from '@ocap/test-utils/streams';
-import type { JsonRpcMessage, Logger } from '@ocap/utils';
-import { isJsonRpcMessage, makeLogger } from '@ocap/utils';
+import type { JsonRpcMessage } from '@ocap/utils';
+import { isJsonRpcMessage } from '@ocap/utils';
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 import type { MockInstance } from 'vitest';
 
@@ -78,12 +79,14 @@ describe('VatHandle', () => {
     });
 
     it('throws if the stream throws', async () => {
-      const logger = makeLogger(`[vat v0]`);
+      const logger = {
+        error: vi.fn(),
+        subLogger: vi.fn(() => logger),
+      } as unknown as Logger;
       const { stream } = await makeVat({ logger });
-      const logErrorSpy = vi.spyOn(logger, 'error');
       await stream.receiveInput(NaN);
       await delay(10);
-      expect(logErrorSpy).toHaveBeenCalledWith(
+      expect(logger.error).toHaveBeenCalledWith(
         'Unexpected read error',
         expect.any(Error),
       );