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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 1 addition & 31 deletions packages/common-nodejs/package.json
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
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
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
20 changes: 0 additions & 20 deletions packages/common-nodejs/src/logger/utils.ts

This file was deleted.

36 changes: 35 additions & 1 deletion packages/common-universal/package.json
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,17 @@
"@sinonjs/fake-timers": "^13.0.5",
"@types/mocha": "^10.0.10",
"@types/ms": "^2.1.0",
"@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"
}
}
15 changes: 15 additions & 0 deletions packages/common-universal/src/logger/LogFormatterObject.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { LogEntry, LogFormatter } from './types.js'

export class LogFormatterObject implements LogFormatter {
Copy link
Member

Choose a reason for hiding this comment

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

I think it's so similiar to json formatter that we can drop it 👍

public format(entry: LogEntry): object {
const core = {
time: entry.time.toISOString(),
level: entry.level,
service: entry.service,
message: entry.message,
error: entry.resolvedError,
}

return { ...core, parameters: entry.parameters }
}
}
Original file line number Diff line number Diff line change
@@ -1,27 +1,9 @@
import { inspect } from 'node:util'
import chalk from 'chalk'

import { LogLevel } from './LogLevel.js'
import { LogEntry, LogFormatter } from './types.js'
import { toJSON } from './utils.js'

const STYLES = {
bigint: 'white',
boolean: 'white',
date: 'white',
module: 'white',
name: 'blue',
null: 'white',
number: 'white',
regexp: 'white',
special: 'white',
string: 'white',
symbol: 'white',
undefined: 'white',
}

const INDENT_SIZE = 4
const INDENT = ' '.repeat(INDENT_SIZE)

interface Options {
colors: boolean
Expand All @@ -45,7 +27,7 @@ export class LogFormatterPretty implements LogFormatter {
const serviceOut = this.formatServicePretty(entry.service, this.options.colors)
const messageOut = entry.message ? ` ${entry.message}` : ''
const paramsOut = this.formatParametersPretty(
this.sanitize(entry.resolvedError ? { ...entry.resolvedError, ...entry.parameters } : (entry.parameters ?? {})),
entry.resolvedError ? { ...entry.resolvedError, ...entry.parameters } : (entry.parameters ?? {}),
this.options.colors,
)

Expand Down Expand Up @@ -86,30 +68,15 @@ export class LogFormatterPretty implements LogFormatter {
}

protected formatParametersPretty(parameters: object, colors: boolean): string {
const oldStyles = inspect.styles
inspect.styles = STYLES

const inspected = inspect(parameters, {
colors,
breakLength: 80 - INDENT_SIZE,
depth: 5,
})

inspect.styles = oldStyles

if (inspected === '{}') {
const jsonParameters = toJSON(parameters, INDENT_SIZE)
if (jsonParameters === '{}') {
return ''
}

const indented = inspected
.split('\n')
.map((x) => INDENT + x)
.join('\n')

if (colors) {
return `\n${chalk.gray(indented)}`
return `\n${chalk.gray(jsonParameters)}`
}
return `\n${indented}`
return `\n${jsonParameters}`
}

protected formatServicePretty(service: string | undefined, colors: boolean): string {
Expand All @@ -118,8 +85,4 @@ export class LogFormatterPretty implements LogFormatter {
}
return colors ? ` ${chalk.gray('[')} ${chalk.yellow(service)} ${chalk.gray(']')}` : ` [ ${service} ]`
}

protected sanitize(parameters: object): object {
return JSON.parse(toJSON(parameters))
}
}
Loading