Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
  • Algo errado?
#596 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@Dazzanova já está trabalhando nisso.

Desde 27/10/2026.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
82/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
backend

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
TypeScript
Estrelas
580
Forks
56
Merge médio
11h 28min
PRs com merge (30d)
150

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de voidzero-dev/void

Todas as issues de voidzero-dev/void

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.