Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

`void/log`: add `logger.child(fields)` to bind fields to every line

Offen
  • Stimmt etwas nicht?
#596 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
82/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
backend

Rechercherichtung

Start with void/src/runtime/log.ts and the existing format() try block to see how fields are copied and filtered. Then read test/unit/runtime-log.test.ts and add coverage for bound fields, overrides, nested children, and throwing getters; update the Logging methods line in docs/reference/api/resources.md with a one-line example. Done when the requested behaviors pass and logging still returns the safe line for throwing getters.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Summary

Apps usually tag every log line from a module with the same fields (component, queue, job), so the lines can be filtered in Workers Logs and with void project logs --filter. void/log has no way to bind those fields, so each call repeats them, or each app writes its own wrapper. The obvious wrapper breaks the logger's guarantee that it never throws.

The wrapper apps write today

import { logger as baseLogger } from 'void/log';

type Fields = Record<string, unknown>;

export const logger = {
  ...baseLogger,
  child: (bound: Fields) => ({
    error: (msg: string, fields?: Fields) => baseLogger.error(msg, { ...bound, ...fields }),
    warn: (msg: string, fields?: Fields) => baseLogger.warn(msg, { ...bound, ...fields }),
    info: (msg: string, fields?: Fields) => baseLogger.info(msg, { ...bound, ...fields }),
  }),
};

The spread { ...bound, ...fields } runs before format(). That means it runs outside the try that makes logging safe. A field whose getter throws makes the base logger fall back to its safe line, but the wrapper throws the error into the caller instead ([email protected]; format() on main has the same try):

const fields = Object.defineProperty({}, 'boom', {
  enumerable: true,
  get() {
    throw new Error('getter');
  },
});

logger.info('base.ok', fields);
// {"msg":"base.ok","error":"log: fields not serializable"}

logger.child({ component: 'x' }).info('child.call', fields);
// throws Error: getter

A log call inside a catch or a queue consumer can then throw where it was meant to only record. Supporting this in void/log means each app no longer copies the wrapper, and the merge stays inside the guarantee.

Proposal

import { logger } from 'void/log';

const log = logger.child({ component: 'queue', queue: 'tasks' });

log.warn('task.retry', { taskId, attempt: 2 });
// {"msg":"task.retry","component":"queue","queue":"tasks","taskId":"…","attempt":2}
  • logger.child(fields) returns a logger with error, warn, info and child.
  • Lines keep the { msg, ...fields } shape, so Cloudflare Tail capture and platform log filtering don't change.
  • Fields passed in a call override bound fields with the same name.
  • child() can be nested: log.child({ taskId }) adds to the fields already bound.
  • Bound fields get the same handling as call fields. msg, toJSON, __proto__ and constructor are skipped, functions are dropped, and Error values are serialized (#583).
  • Logging never throws, including when bound or call fields have throwing getters.

Implementation

In packages/void/src/runtime/log.ts, build each logger from a bound object and have format(message, bound, fields) copy both inside the existing try. Bound fields are copied first, then call fields, using the same key filters. logger stays the root, with no bound fields, so existing calls behave the same.

Tests in packages/void/test/unit/runtime-log.test.ts:

  • bound fields appear on every level
  • call fields override bound fields
  • nested child() merges fields
  • reserved keys and functions in bound fields are skipped
  • a throwing getter in bound or call fields falls back to the safe line instead of throwing

Docs: add logger.child(fields) to the methods line under Logging in docs/reference/api/resources.md, with a one-line example.

I'm happy to send the PR.

Vorherrschende Sprache
TypeScript
Sterne
580
Forks
56
Ø Merge
12 Std. 25 Min.
Gemergte PRs (30 T.)
134

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus voidzero-dev/void

Alle Issues in voidzero-dev/void

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.