Formations — 1 037 leçons en français

Accueil › Node.js › La contre-pression

La contre-pression

Les fluxintermediaire

La contre-pression est le mécanisme qui empêche un producteur rapide de noyer un consommateur lent.

La faute

import { createWriteStream } from "node:fs";

const sortie = createWriteStream("export.csv");

for (const ligne of millionDeLignes) {
  sortie.write(`${ligne.id},${ligne.total}\n`);   // ⛔ valeur de retour ignorée
}
sortie.end();

Lire un million de lignes en mémoire prend quelques secondes ; les écrire sur disque en prend beaucoup plus. Les morceaux non encore écrits s'empilent dans le tampon interne du flux, qui n'a pas de plafond. La mémoire monte régulièrement, et le processus meurt sur JavaScript heap out of memory.

Le signal

if (!sortie.write(ligne)) {
  await new Promise((ok) => sortie.once("drain", ok));
}

write renvoie false quand le tampon dépasse highWaterMark. Le morceau est quand même accepté — rien n'est perdu, et c'est précisément pour cela que le code fautif a l'air de marcher. false veut dire « ralentissez », et la seule réponse correcte est d'attendre drain.

La version qui n'y pense pas

import { pipeline } from "node:stream/promises";
import { Readable } from "node:stream";

await pipeline(
  Readable.from(millionDeLignes),
  async function* (source) {
    for await (const ligne of source) yield `${ligne.id},${ligne.total}\n`;
  },
  createWriteStream("export.csv"),
);

pipeline, .pipe() et for await gèrent la contre-pression. Le code qui la gère mal est presque toujours du code qui appelle write à la main.

Les termes à connaître

Contre-pression

Le mécanisme par lequel un consommateur lent fait ralentir un producteur rapide. Sans elle, les morceaux s'empilent en mémoire jusqu'à l'arrêt du processus.

write

Écrit un morceau et renvoie un booléen : false signifie « le tampon est plein, arrêtez d'écrire ». Ignorer cette valeur est la faute classique.

drain

L'événement émis par un flux inscriptible quand son tampon est redescendu sous le seuil. C'est le signal pour reprendre l'écriture.

highWaterMark

Le seuil au-delà duquel write renvoie false — 16 Ko pour un Writable d'octets, 16 morceaux en mode objet. Ce n'est pas une limite dure.

writableLength

Le volume actuellement en attente dans le tampon interne. Il peut dépasser highWaterMark sans limite si on ignore la contre-pression.

pause / resume

Les méthodes qui arrêtent et relancent un flux lisible en mode coulant. for await et pipeline les appellent pour vous.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.