storage: `file.download()` of a large object emits MaxListenersExceededWarning since 8.0 (response body piped twice)

Abierto
#9,870 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
52/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
google-cloud, node.js, typescript
Área
cloud

Línea de trabajo

Start with the repro script in the issue, which needs no credentials and triggers the warning on the 2 MiB object. The two pipelines that both read the response body are in build/cjs/src/file.js (createReadStream's onResponse) and in teeny-request's build/src/index.js (stream mode, plus the .resume() call in makeRequest). Done means the 5-download loop reports 0 MaxListenersExceededWarning while the downloads still return the correct bytes, and the fix may belong in either package.

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

Descripción

api: storage

Environment

  • @google-cloud/storage 8.4.0 (also 8.2.0); not 7.16.0
  • teeny-request 11.1.1, node-fetch 3.3.2
  • Node.js 22.23.2

What happens

Each file.download() / createReadStream() of an object large enough to still be streaming when the response arrives prints:

MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 error listeners added to [PassThrough]. MaxListeners is 10.
MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 close listeners added to [PassThrough]. MaxListeners is 10.

The listeners are released when the download ends, so nothing actually leaks. But the warning fires once per download, so it floods the logs.

Cause

The PassThrough is node-fetch's response body. Two pipelines read it:

  1. createReadStream's onResponse runs pipeline(rawResponseStream, ...transformStreams, throughStream, onComplete) (build/cjs/src/file.js, 8.4.0).
  2. teeny-request's stream mode runs pipeline(responseStream, requestStream, () => {}) on the same body (teeny-request/build/src/index.js, requestStream.once('response', ...)). Then makeRequest calls .resume() on that request stream and discards what it reads.

Together with node-fetch's own pump(response_, new PassThrough()) and the error listeners from node-fetch's Body and teeny-request, that comes to 11. With node-fetch 2 (storage 7.x) the total stays under 10, which is presumably why 7.x is quiet. Small objects finish before the second pipeline attaches, so they never warn.

Repro (no credentials, local server)

const http = require('node:http');
const crypto = require('node:crypto');
const { Storage, CRC32C } = require('@google-cloud/storage');

const body = Buffer.alloc(2 * 1024 * 1024, 'x'); // 2 MiB; a few KiB does not trigger it
const md5 = crypto.createHash('md5').update(body).digest('base64');
const c = new CRC32C(); c.update(body); const crc32c = c.toString();

let warnings = 0;
process.on('warning', (w) => { if (w.name === 'MaxListenersExceededWarning') warnings++; });

const server = http.createServer((req, res) => {
  res.writeHead(200, {
    'content-type': 'application/octet-stream',
    'content-length': body.length,
    'x-goog-hash': `crc32c=${crc32c},md5=${md5}`,
    'x-goog-stored-content-encoding': 'identity',
  });
  res.end(body);
});

server.listen(0, '127.0.0.1', async () => {
  const storage = new Storage({ apiEndpoint: `http://127.0.0.1:${server.address().port}`, projectId: 'test' });
  const file = storage.bucket('bucket').file('object');
  for (let i = 0; i < 5; i++) await file.download();
  console.log(`5 downloads, ${warnings} MaxListenersExceededWarning`);
  server.close();
});

Output: 8.4.0 → 5 downloads, 10 MaxListenersExceededWarning; 8.2.0 → 10; 7.16.0 → 0.

Expected

The response body is consumed once, either by storage's pipeline or by the request stream it gets from teeny-request, not by both. Then no warning.

Lenguaje dominante
TypeScript
Estrellas
3.2k
Forks
732
Merge medio
2 d 11 h
PR fusionados (30 d)
99

Preparar el entorno

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.

Más de googleapis/google-cloud-node

Todos los issues de googleapis/google-cloud-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.