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

Ouverte
#9,870 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
Une demi-journée
Accessibilité débutants
52/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
google-cloud, node.js, typescript
Domaine
cloud

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
3.2k
Forks
732
Merge moyen
2 j 11 h
PR mergées (30 j)
99

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de googleapis/google-cloud-node

Toutes les issues de googleapis/google-cloud-node

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.