nodejs / nodejs/node

diagnostics_channel: add a channel for filesystem operations

Abierto
#65,330 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature request
Lenguaje dominante
JavaScript
Estrellas
122k
Forks
37.3k
Merge medio
4 d 2 h
PR fusionados (30 d)
283

Descripción

What is the problem this feature will solve?

node:diagnostics_channel does not currently expose a built-in channel for filesystem operations performed through node:fs and node:fs/promises.

The proposed scope is the public filesystem APIs. Calls made directly by native addons or arbitrary native code do not need to be included in this contract.

What is the feature you are proposing to solve the problem?

Add a built-in tracing channel family for filesystem operations. One possible naming scheme is:

  • tracing:fs.operation:start
  • tracing:fs.operation:end
  • tracing:fs.operation:asyncStart
  • tracing:fs.operation:asyncEnd
  • tracing:fs.operation:error

The shared event object could contain:

  • operation: a stable operation name such as open, read, stat, readdir, or realpath.
  • api: sync, callback, promise, stream, or filehandle.
  • Path, source/destination, or file descriptor fields when applicable, preserving the value type passed by the caller.
  • result and error following the existing TracingChannel conventions.

Large read/write buffers should not be copied into event metadata. The exact publication layer—public API wrappers or the lowest shared internal filesystem layer—can be determined during implementation, but the documented payload should remain independent of internal FSReqCallback details.

Using one operation family with an operation field avoids requiring wildcard channel subscriptions while allowing subscribers to filter individual operations.

What alternatives have you considered?

Wrapping exports from node:fs and node:fs/promises is incomplete when references have already been captured and requires synchronization with named built-in ESM exports. async_hooks exposes asynchronous resource lifecycles rather than stable filesystem operation semantics and does not cover synchronous calls. Trace events use a different consumption API and payload contract.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con las APIs públicas node:fs y node:fs/promises y las convenciones existentes de TracingChannel de node:diagnostics_channel; compara las rutas síncrona, de callback, de promise, de stream y de filehandle. Resuelve la capa de publicación y los nombres de los canales, manteniendo el payload independiente de los detalles de FSReqCallback. Se considera terminado cuando las operaciones públicas del sistema de archivos compatibles publiquen los eventos de ciclo de vida y los metadatos documentados.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, node.js
Área
api, operating-systems
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.