Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move logger to common-universal #691

Merged
merged 22 commits into from
Mar 6, 2025
Merged

Move logger to common-universal #691

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
7e429e4
Add required dependencies
b-tarczynski Mar 5, 2025
c48e600
Add node types
b-tarczynski Mar 6, 2025
5381d1e
Add util and path polyfills to vite config
b-tarczynski Mar 6, 2025
923db3f
Move Logger to common-universal
b-tarczynski Mar 6, 2025
f296f6f
Export logger
b-tarczynski Mar 6, 2025
8ffcfde
Drop path dependency for browsers
b-tarczynski Mar 6, 2025
f8e91d1
Remove logger from common-nodejs
b-tarczynski Mar 6, 2025
8838901
Revert changes to logger
b-tarczynski Mar 6, 2025
5b05a79
Add path to vite.config
b-tarczynski Mar 6, 2025
3918cd2
Move tracer to common-universal
b-tarczynski Mar 6, 2025
357aa02
Export logger and tracer separately
b-tarczynski Mar 6, 2025
377cc21
Update imports and package.json
b-tarczynski Mar 6, 2025
3d53360
Update typesVersions
b-tarczynski Mar 6, 2025
8b5fd75
Extract PrettyLogger
b-tarczynski Mar 6, 2025
463194c
Remove node deps in universal
b-tarczynski Mar 6, 2025
e2dede1
Use pretty-ms instead of ms in universal
b-tarczynski Mar 6, 2025
20b568c
Revert "Use pretty-ms instead of ms in universal"
b-tarczynski Mar 6, 2025
252eca9
Drop inspect util
b-tarczynski Mar 6, 2025
9b52393
Remove cwd from logger
b-tarczynski Mar 6, 2025
e81b14d
Move LogFormatterPretty
b-tarczynski Mar 6, 2025
1f226bc
Add BROWSER logger
b-tarczynski Mar 6, 2025
ce9fc9b
Lint
b-tarczynski Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/app/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ export default defineConfig({
// nodePolyfills needs to be first
nodePolyfills({
// buffer is needed when connecting with a coinbase wallet installed on a phone
include: ['buffer'],
// util and path is needed for common-universal's logger
include: ['buffer', 'util', 'path'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need these? I would prefer not to use node apis in browser

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Util is used for inspect to format objects, path isn't doing anything in browser. I tried to conditionally import a path depending if that's a browser or not, but nothing worked - logger would have to be async which we don't want to do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway using util polyfill breaks frontend tests, so probably we need to figure out something else

}),
react(),
tsconfigPaths(),
Expand Down
32 changes: 1 addition & 31 deletions packages/common-nodejs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,37 +22,11 @@
"types": "./dist/types/env/index.d.ts",
"default": "./dist/cjs/env/index.js"
}
},
"./logger": {
"import": {
"@marsfoundation/local-spark-monorepo": "./src/logger/index.ts",
"types": "./dist/types/logger/index.d.ts",
"default": "./dist/esm/logger/index.js"
},
"require": {
"@marsfoundation/local-spark-monorepo": "./src/logger/index.ts",
"types": "./dist/types/logger/index.d.ts",
"default": "./dist/cjs/logger/index.js"
}
},
"./tracer": {
"import": {
"@marsfoundation/local-spark-monorepo": "./src/tracer/index.ts",
"types": "./dist/types/tracer/index.d.ts",
"default": "./dist/esm/tracer/index.js"
},
"require": {
"@marsfoundation/local-spark-monorepo": "./src/tracer/index.ts",
"types": "./dist/types/tracer/index.d.ts",
"default": "./dist/cjs/tracer/index.js"
}
}
},
"typesVersions": {
"*": {
"env": ["dist/types/env/index.d.ts"],
"logger": ["dist/types/logger/index.d.ts"],
"tracer": ["dist/types/tracer/index.d.ts"]
"env": ["dist/types/env/index.d.ts"]
}
},
"files": ["dist"],
Expand All @@ -72,7 +46,6 @@
"@sinonjs/fake-timers": "^13.0.5",
"@types/express": "^5.0.0",
"@types/mocha": "^10.0.10",
"@types/pretty-ms": "^5.0.1",
"@types/sinonjs__fake-timers": "^8.1.5",
"@types/uuid": "^10.0.0",
"earl": "^1.3.0",
Expand All @@ -81,10 +54,7 @@
"tinyspy": "^3.0.2"
},
"dependencies": {
"chalk": "^5.3.0",
"dotenv": "^16.3.1",
"error-stack-parser": "^2.1.4",
"pretty-ms": "^9.2.0",
"uuid": "^11.0.3"
},
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/common-nodejs/src/http/HttpClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Logger } from '@marsfoundation/common-universal/logger'
import { MockObject, expect, mockFn, mockObject } from 'earl'
import { ZodError, z } from 'zod'
import { Logger } from '../logger/index.js'
import { HttpClient, HttpError } from './HttpClient.js'
import { HttpServerMock, PostBody, getResponseSchema, postBodySchema } from './HttpServer.mock.js'

Expand Down
2 changes: 1 addition & 1 deletion packages/common-nodejs/src/http/HttpClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Logger } from '@marsfoundation/common-universal/logger'
import { mergeDeep } from 'remeda'
import { z } from 'zod'
import { Logger } from '../logger/index.js'
import { RetryOptions, defaultRetryOptions, fetchRetry } from './fetchRetry.js'

export class HttpClient {
Expand Down
37 changes: 36 additions & 1 deletion packages/common-universal/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,36 @@
"types": "./dist/types/index.d.ts",
"default": "./dist/cjs/index.js"
}
},
"./logger": {
"import": {
"@marsfoundation/local-spark-monorepo": "./src/logger/index.ts",
"types": "./dist/types/logger/index.d.ts",
"default": "./dist/esm/logger/index.js"
},
"require": {
"@marsfoundation/local-spark-monorepo": "./src/logger/index.ts",
"types": "./dist/types/logger/index.d.ts",
"default": "./dist/cjs/logger/index.js"
}
},
"./tracer": {
"import": {
"@marsfoundation/local-spark-monorepo": "./src/tracer/index.ts",
"types": "./dist/types/tracer/index.d.ts",
"default": "./dist/esm/tracer/index.js"
},
"require": {
"@marsfoundation/local-spark-monorepo": "./src/tracer/index.ts",
"types": "./dist/types/tracer/index.d.ts",
"default": "./dist/cjs/tracer/index.js"
}
}
},
"typesVersions": {
"*": {
"logger": ["dist/types/logger/index.d.ts"],
"tracer": ["dist/types/tracer/index.d.ts"]
}
},
"files": ["dist"],
Expand All @@ -48,13 +78,18 @@
"@sinonjs/fake-timers": "^13.0.5",
"@types/mocha": "^10.0.10",
"@types/ms": "^2.1.0",
"@types/node": "^22.13.9",
"@types/pretty-ms": "^5.0.1",
"@types/sinonjs__fake-timers": "^8.1.5",
"earl": "^1.3.0",
"mocha": "^10.8.2"
},
"dependencies": {
"chalk": "^5.3.0",
"error-stack-parser": "^2.1.4",
"fetch-retry": "^5.0.6",
"ms": "^2.1.3",
"p-limit": "^6.1.0"
"p-limit": "^6.1.0",
"pretty-ms": "^9.2.0"
}
}
0 ...mon-nodejs/src/logger/LogFormatterJson.ts → ...-universal/src/logger/LogFormatterJson.ts
View file
Open in desktop
File renamed without changes.
0 ...n-nodejs/src/logger/LogFormatterPretty.ts → ...niversal/src/logger/LogFormatterPretty.ts
View file
Open in desktop
File renamed without changes.
0 ...ages/common-nodejs/src/logger/LogLevel.ts → ...s/common-universal/src/logger/LogLevel.ts
View file
Open in desktop
File renamed without changes.
0 ...s/common-nodejs/src/logger/LogThrottle.ts → ...ommon-universal/src/logger/LogThrottle.ts
View file
Open in desktop
File renamed without changes.
0 ...s/common-nodejs/src/logger/Logger.test.ts → ...ommon-universal/src/logger/Logger.test.ts
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion packages/common-nodejs/src/logger/Logger.ts → ...ges/common-universal/src/logger/Logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { join } from 'node:path'

import { assertNever } from '@marsfoundation/common-universal'
import { assertNever } from '../assert/assertNever.js'
import { LogFormatterJson } from './LogFormatterJson.js'
import { LogFormatterPretty } from './LogFormatterPretty.js'
import { LEVEL, LogLevel } from './LogLevel.js'
Expand Down
0 packages/common-nodejs/src/logger/README.md → ...ges/common-universal/src/logger/README.md
View file
Open in desktop
File renamed without changes.
0 packages/common-nodejs/src/logger/index.ts → ...ages/common-universal/src/logger/index.ts
View file
Open in desktop
File renamed without changes.
0 ...dejs/src/logger/parseLogArguments.test.ts → ...rsal/src/logger/parseLogArguments.test.ts
View file
Open in desktop
File renamed without changes.
0 ...on-nodejs/src/logger/parseLogArguments.ts → ...universal/src/logger/parseLogArguments.ts
View file
Open in desktop
File renamed without changes.
0 .../common-nodejs/src/logger/resolveError.ts → ...mmon-universal/src/logger/resolveError.ts
View file
Open in desktop
File renamed without changes.
0 ...es/common-nodejs/src/logger/tagService.ts → ...common-universal/src/logger/tagService.ts
View file
Open in desktop
File renamed without changes.
0 packages/common-nodejs/src/logger/types.ts → ...ages/common-universal/src/logger/types.ts
View file
Open in desktop
File renamed without changes.
0 packages/common-nodejs/src/logger/utils.ts → ...ages/common-universal/src/logger/utils.ts
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...s/common-nodejs/src/tracer/Tracer.mock.ts → ...ommon-universal/src/tracer/Tracer.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PublicInterface } from '@marsfoundation/common-universal'
import { PublicInterface } from '../typeHelpers.js'
import { Tracer } from './Tracer.js'

export function TracerMock(): Tracer {
Expand Down
2 changes: 1 addition & 1 deletion packages/common-nodejs/src/tracer/Tracer.ts → ...ges/common-universal/src/tracer/Tracer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import prettyMilliseconds from 'pretty-ms'
import { ILogger } from '../logger/index.js'
import { ILogger } from '../logger/Logger.js'

interface TracerOptions {
service?: string
Expand Down
0 packages/common-nodejs/src/tracer/index.ts → ...ages/common-universal/src/tracer/index.ts
View file
Open in desktop
File renamed without changes.
Loading
Loading