Skip to content

Commit 53dd80f

Browse files
authored
refactor: promote logger to its own package (#493)
Refs: #217 - creates a new `@ocap/logger` package - moves the `Logger` class from `@ocap/utils` to `@ocap/logger` - replaces deprecated `makeLogger` calls with `new Logger` in refactored packages - standardizes log labels to kebab-lower-case in affected logger construction routines - removes the deprecated `makeLogger` factory from the monorepo
1 parent 2148c20 commit 53dd80f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+946
-578
lines changed

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,9 @@
114114
"vite>sass>@parcel/watcher": false,
115115
"vitest>@vitest/browser>webdriverio>@wdio/utils>edgedriver": false,
116116
"vitest>@vitest/browser>webdriverio>@wdio/utils>geckodriver": false,
117-
"vitest>@vitest/mocker>msw": false
117+
"vitest>@vitest/mocker>msw": false,
118+
"@ocap/cli>@ocap/logger>@ocap/streams": true,
119+
"eslint-plugin-import-x>unrs-resolver": false
118120
}
119121
},
120122
"resolutions": {

packages/cli/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"@endo/promise-kit": "^1.1.10",
3939
"@metamask/snaps-utils": "^9.1.0",
4040
"@metamask/utils": "^11.4.0",
41+
"@ocap/logger": "workspace:^",
4142
"@ocap/shims": "workspace:^",
4243
"@ocap/utils": "workspace:^",
4344
"@types/node": "^22.13.1",

packages/cli/src/app.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import '@endo/init';
22

3-
import { Logger } from '@ocap/utils';
3+
import { Logger } from '@ocap/logger';
44
import path from 'node:path';
55
import yargs from 'yargs';
66
import { hideBin } from 'yargs/helpers';

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

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Logger } from '@ocap/utils';
1+
import type { Logger } from '@ocap/logger';
22
import { readFile, rm } from 'fs/promises';
33
import { basename } from 'path';
44
import { describe, it, expect, vi, beforeEach, afterAll } from 'vitest';
@@ -13,11 +13,14 @@ import { fileExists } from '../file.ts';
1313
const mocks = vi.hoisted(() => {
1414
return {
1515
endoBundleSource: vi.fn(),
16-
Logger: vi.fn(() => ({
17-
info: vi.fn(),
18-
error: vi.fn(),
19-
subLogger: vi.fn(),
20-
})),
16+
Logger: vi.fn(
17+
() =>
18+
({
19+
info: vi.fn(),
20+
error: vi.fn(),
21+
subLogger: vi.fn(),
22+
}) as unknown as Logger,
23+
),
2124
isDirectory: vi.fn(),
2225
};
2326
});
@@ -28,7 +31,7 @@ vi.mock('@endo/bundle-source', () => ({
2831

2932
vi.mock('@endo/init', () => ({}));
3033

31-
vi.mock('@ocap/utils', () => ({
34+
vi.mock('@ocap/logger', () => ({
3235
Logger: mocks.Logger,
3336
}));
3437

@@ -54,7 +57,7 @@ describe('bundle', async () => {
5457
beforeEach(async () => {
5558
await deleteTestBundles();
5659
vi.resetModules();
57-
logger = new Logger();
60+
logger = mocks.Logger();
5861
vi.resetAllMocks();
5962
});
6063

packages/cli/src/commands/bundle.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import '@endo/init';
22
import endoBundleSource from '@endo/bundle-source';
3-
import { Logger } from '@ocap/utils';
3+
import { Logger } from '@ocap/logger';
44
import { glob } from 'glob';
55
import { writeFile } from 'node:fs/promises';
66
import { resolve, join } from 'node:path';

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import '@ocap/shims/endoify';
22

3-
import { Logger } from '@ocap/utils';
3+
import { Logger } from '@ocap/logger';
44
import { watch } from 'chokidar';
55
import type { FSWatcher } from 'chokidar';
66
import type { Stats } from 'fs';

packages/cli/src/commands/watch.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { makePromiseKit } from '@endo/promise-kit';
2-
import { Logger } from '@ocap/utils';
2+
import { Logger } from '@ocap/logger';
33
import { watch } from 'chokidar';
44
import type { FSWatcher, MatchFunction } from 'chokidar';
55
import { unlink } from 'fs/promises';

packages/cli/tsconfig.build.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"types": ["ses", "node"]
1010
},
1111
"references": [
12+
{ "path": "../logger/tsconfig.build.json" },
1213
{ "path": "../utils/tsconfig.build.json" },
1314
{ "path": "../shims/tsconfig.build.json" }
1415
],

packages/cli/tsconfig.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
"types": ["ses", "vitest", "node"],
77
"noEmit": true
88
},
9-
"references": [{ "path": "../test-utils" }, { "path": "../utils" }],
9+
"references": [
10+
{ "path": "../logger" },
11+
{ "path": "../test-utils" },
12+
{ "path": "../utils" }
13+
],
1014
"include": [
1115
"../../vitest.config.ts",
1216
"./src/**/*.ts",

packages/extension/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
"@metamask/utils": "^11.4.0",
5151
"@ocap/errors": "workspace:^",
5252
"@ocap/kernel": "workspace:^",
53+
"@ocap/logger": "workspace:^",
5354
"@ocap/rpc-methods": "workspace:^",
5455
"@ocap/shims": "workspace:^",
5556
"@ocap/store": "workspace:^",

0 commit comments

Comments
 (0)