feat: single-argument, context-aware CommonLogger by fiddur · Pull Request #167 · NaturalCycles/js-libs

fiddur · 2026-10-06T11:48:37Z

Simplifies CommonLogger now that backward compatibility is not needed (Slack thread). Breaking for every consumer of CommonLogger.

logger.debug('hey')                      // { msg: 'hey', level: 'debug' }
logger.error(err)                        // { err, level: 'error' }
logger.log({ structured: 'data' })       // { structured: 'data', level: 'log' }
logger.child({ b: 2 }).warn('foo')       // { b: 2, msg: 'foo', level: 'warn' }

Every log call takes one argument: a string (msg), an Error (err) or a LogData object. Sinks receive a typed LogEntry with the level and the merged context. `child` is part of CommonLogger, `console` is replaced by `consoleLogger`, and `commonLoggerPrefix` by `child({ module })`. Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

Slack send logs the message text as msg, fetcher passes the real error, warn and error get their own level numbers so createCommonLoggerAtLevel(logger, 'warn') drops log, BackendRequest extends CommonLogger, mockBackendRequest gets child. Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

Copilot

Copilot review overview

🟡 Changes recommended

Filtered loggers invoke retained methods with the wrong receiver, breaking valid stateful logger implementations.

Review effort: Balanced
Findings: 1

Open (1)

Filtered logger loses method binding to supplied logger · New

What changed in this PR

This PR introduces a breaking, context-aware structured logging API and migrates consumers across the monorepo.

Changes:

Reworks CommonLogger around one LogInput, structured LogEntry, and child contexts.
Adds console/stdout/GCP/dev/CI/Sentry sink support.
Migrates logger defaults and multi-argument call sites.

File	Description
`packages/sqlite-lib/src/sqliteKeyValueDB.ts`	Uses `consoleLogger` by default.
`packages/redis-lib/src/redisClient.ts`	Migrates defaults and structured logging.
`packages/nodejs-lib/src/stream/transform/transformThrottle.ts`	Structures throttle startup logs.
`packages/nodejs-lib/src/stream/transform/transformTap.ts`	Migrates defaults and error logs.
`packages/nodejs-lib/src/stream/transform/transformMapSync.ts`	Structures error logs.
`packages/nodejs-lib/src/stream/transform/transformMapSimple.ts`	Migrates defaults and errors.
`packages/nodejs-lib/src/stream/transform/transformMap.ts`	Structures error logs.
`packages/nodejs-lib/src/stream/stream.model.ts`	Updates logger documentation.
`packages/nodejs-lib/src/stream/progressLogger.ts`	Migrates default and error logging.
`packages/nodejs-lib/src/slack/slack.service.ts`	Adapts Slack logging sink.
`packages/nodejs-lib/src/script/runScript.ts`	Migrates script lifecycle logging.
`packages/nodejs-lib/src/log/log.util.ts`	Adds `LogEntry` string rendering.
`packages/nodejs-lib/src/log/log.util.test.ts`	Tests entry rendering.
`packages/mysql-lib/src/schema/mysql.schema.util.ts`	Structures schema diagnostics.
`packages/mysql-lib/src/query.util.ts`	Uses `consoleLogger` by default.
`packages/mysql-lib/src/mysql.db.ts`	Adds child context and structured logs.
`packages/mongo-lib/src/mongo.db.ts`	Replaces prefixing with child context.
`packages/js-lib/src/promise/pRetry.ts`	Migrates retry logging.
`packages/js-lib/src/promise/pQueue.ts`	Updates default documentation.
`packages/js-lib/src/promise/pQueue.ai.test.ts`	Updates logger test doubles.
`packages/js-lib/src/promise/pMap.ts`	Migrates defaults and errors.
`packages/js-lib/src/promise/pGradualQueue.ts`	Updates default documentation.
`packages/js-lib/src/log/commonLogger.ts`	Implements the new logging API.
`packages/js-lib/src/log/commonLogger.test.ts`	Tests structured and child logging.
`packages/js-lib/src/http/fetcher.ts`	Migrates HTTP request/response logging.
`packages/js-lib/src/http/fetcher.test.ts`	Verifies the new default logger.
`packages/js-lib/src/http/fetcher.model.ts`	Updates logger documentation.
`packages/js-lib/src/error/tryCatch.ts`	Migrates warning logs.
`packages/js-lib/src/decorators/memoSimple.decorator.ts`	Uses `consoleLogger` by default.
`packages/js-lib/src/decorators/memoizedAsync.ts`	Migrates async cache errors.
`packages/js-lib/src/decorators/memoized.ts`	Migrates cache errors.
`packages/js-lib/src/decorators/memo.decorator.ts`	Migrates memo logger defaults.
`packages/js-lib/src/decorators/logMethod.decorator.ts`	Produces single structured entries.
`packages/js-lib/src/decorators/asyncMemo.decorator.ts`	Migrates async memo logging.
`packages/js-lib/src/asyncManager.ts`	Migrates unhandled rejection logging.
`packages/js-lib/src/asyncManager.test.ts`	Updates logging expectations.
`packages/firestore-lib/src/firestoreStreamReadable.ts`	Structures stream diagnostics.
`packages/firestore-lib/src/firestoreShardedReadable.ts`	Structures sharded stream logs.
`packages/firestore-lib/src/firestore.db.ts`	Uses `consoleLogger` by default.
`packages/dev-lib/src/testing/testing.util.ts`	Uses shared entry rendering.
`packages/db-lib/src/kv/commonKeyValueDao.ts`	Migrates defaults and errors.
`packages/db-lib/src/inmemory/inMemory.db.ts`	Uses `consoleLogger` by default.
`packages/db-lib/src/commondao/commonDaoTransaction.ts`	Structures rollback errors.
`packages/db-lib/src/commondao/common.dao.ts`	Uses `consoleLogger` by default.
`packages/db-lib/src/commondao/common.dao.model.ts`	Updates logger documentation.
`packages/db-lib/src/adapter/file/file.db.ts`	Uses `consoleLogger` by default.
`packages/db-lib/src/adapter/file/file.db.model.ts`	Updates logger documentation.
`packages/db-lib/src/adapter/cachedb/cache.db.ts`	Uses `consoleLogger` by default.
`packages/db-lib/src/adapter/cachedb/cache.db.model.ts`	Updates logger documentation.
`packages/datastore-lib/src/datastoreStreamReadable.ts`	Structures stream diagnostics.
`packages/datastore-lib/src/datastore.model.ts`	Updates logger documentation.
`packages/datastore-lib/src/datastore.db.ts`	Migrates defaults and error logs.
`packages/cloud-storage-lib/src/cloudStorage.ts`	Uses `consoleLogger` by default.
`packages/backend-lib/src/test/server/server.ts`	Migrates test-server logging.
`packages/backend-lib/src/test/mocks.ts`	Uses the no-op logger mock.
`packages/backend-lib/src/server/server.model.ts`	Makes requests `CommonLogger`s.
`packages/backend-lib/src/server/logMiddleware.ts`	Rebuilds backend logging sinks.
`packages/backend-lib/src/server/logMiddleware.test.ts`	Tests structured backend sinks.
`packages/backend-lib/src/server/genericErrorMiddleware.ts`	Structures request errors.
`packages/backend-lib/src/server/asyncLocalStorageMiddleware.ts`	Adds a context-aware logger proxy.
`packages/backend-lib/src/sentry/sentry.shared.service.ts`	Adapts Sentry logging and breadcrumbs.
`packages/backend-lib/src/admin/base.admin.service.ts`	Migrates admin request logs.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

fiddur added 2 commits October 6, 2026 11:48

refactor: logEntryToString helper for text sinks

10da0e7

Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

fiddur force-pushed the feat/common-logger-single-arg branch from f945fc6 to 10da0e7 Compare October 6, 2026 13:54

fiddur requested a balanced review from Copilot October 6, 2026 15:00

Copilot started reviewing on behalf of fiddur October 6, 2026 15:00

View session

Copilot AI reviewed Oct 6, 2026

View reviewed changes

Comment thread packages/js-lib/src/log/commonLogger.ts Outdated

fix: keep the methods bound in createCommonLoggerAtLevel

bd64a2d

Claude-Session: https://claude.ai/code/session_01JuGyKbJyWXdXBeNS7VdnU1

fiddur marked this pull request as ready for review October 6, 2026 15:07

fiddur requested a review from kirillgroshkov as a code owner October 6, 2026 15:07

kirillgroshkov approved these changes Oct 7, 2026

View reviewed changes

kirillgroshkov merged commit 21db55b into main Oct 7, 2026
3 checks passed

kirillgroshkov deleted the feat/common-logger-single-arg branch October 7, 2026 13:25

fiddur mentioned this pull request Oct 8, 2026

feat: CommonLogger accepts a message with data #168

Merged

Navigation Menu

Repository navigation

feat: single-argument, context-aware CommonLogger - #167

feat: single-argument, context-aware CommonLogger#167
kirillgroshkov merged 4 commits into
mainfrom
feat/common-logger-single-arg

fiddur commented Oct 6, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

fiddur commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fiddur commented Oct 6, 2026 •

edited

Loading