docker-decoder-stream

Docker Stream decoder

Fast and efficient and TS/JS decoder for Docker streams using WebStreams API or EventEmitter.

Can be used for displaying docker container's logs stream in the follow mode in a browser, or parsing docker's container.exec output.

Uses TypedArray internally as a buffer and is optimized for low memory consumption and performance.

Supports bring-your-own-buffer zero memmory allocation data copying between streams.

Can work in a browser or on the backend. Web Streams API is supported in node 18+, bare-minimum eventemitter version can work in node 16. Can I use Streams API?

8KiB minified. Its only runtime dependency is eventemitter3 to have the same isomorphic events interface in nodejs and browser.

Installation

npm install docker-decoder-stream

Usage

Stream usage

Extracting single IOStream (i.e. stdout) from a docker stream.

import { DockerDecoderStream } from "docker-decoder-stream";

const response = await fetch("/v1.43/containers/{id}/logs?follow=true");
if (!response.ok || !response.body) {
  throw new Error();
}
const reader = response.body
  .pipeThrough(new DockerDecoderStream()) // By default reading "stdout"
  .pipeThrough(new TextDecoderStream())
  .getReader();

for (; ;) {
  const { value, done } = await reader.read();
  if (value !== undefined) {
    // Do something with your text value
  }
  if (done) { break; }
}

// You can specify any other stream in the constructor, that will be used as `reader`
const stderrStreamWithDefault = new DockerDecoderStream("stdin");
// All of the oter streams are still accessible through their properties
stderrStreamWithDefault.stderr // returns ReadableStream<Uint8Array> for stderr

Some bright day we will be able to do:

for await (const chunk of stream) {}

But for now this is blocked in chrome: https://bugs.chromium.org/p/chromium/issues/detail?id=929585

Multiplexed streams usage

Extracting all of the available IOStreams from a docker stream.

import { DockerDecoderStream, mixDownReaders } from "docker-decoder-stream";

const response = await fetch("/v1.43/containers/{id}/logs?follow=true");
if (!response.ok || !response.body) {
  throw new Error();
}
const dockerStreamDecoder = new DockerDecoderStream();
// specific IO streams from docker are available as getters on DockerDecoderStream
const stdout = dockerStreamDecoder.stdout.pipeThrough(new TextDecoderStream("utf-8")).getReader();
const stderr = dockerStreamDecoder.stderr.pipeThrough(new TextDecoderStream("utf-8")).getReader();
response.body?.pipeTo(dockerStreamDecoder.writable)
  .catch(err => console.error("Error piping body:", err));

// `mixDownReaders` provides an async iterator to get all of the chunks from multiple ReadableStreams
for await (const [type, value] of mixDownReaders({ stdout, stderr })) {
  if (type === "stdout") { //< Type will match the name in the object provided in arguments
    console.log("here's your stdout value", value);
  }
}

mixDownReaders combines output of multiple readers. If several readers are ready simultaneously, then it randomly picks one of their values, so we can fairly access their data, without one stream dominating over the other.

Barebone eventemitter usage

When ReadableStream isn't availabe: old nodejs or custom use-cases via DockerDecoder class.

import { DockerDecoder } from "docker-decoder-stream";

const decoder = new DockerDecoder();
// Use separate TextDecoders for different streams to prevent corruption of Unicode chars!
const stdoutDecoder = new TextDecoder("utf-8");
const stderrDecoder = new TextDecoder("utf-8");

const controller = new AbortController();

decoder
  .on("data", (type, payload) => {
    // Do something with the Uint8Array content here
    if (type === "stdout") {
      // You need to immediately synchronously process the payload, otherwise it will be overwritten
      // by the next chunk of data. If you need to process the data in async fashion, you must 
      // copy the payload.
      // @example const data = payload.slice();
      const text = stdoutDecoder.decode(payload, { stream: true });
    }
    if (type === "stderr") {
      const text = stderrDecoder.decode(payload, { stream: true });
    }
  })
  .on("end", (type, payload) => {
    // Decoder may produce a partially read frame, if it was aborted in the mid-chunk
    // You can access it if here if you want.
    if (type === "stdout") {
      const text = stdoutDecoder.decode(payload, { stream: false });
    }
  })
  .on("error", (err) => { controller.abort(err) });

const response = await fetch("/v1.43/containers/{id}/logs?follow=true", { signal: controller.signal });
const reader = response.body.getReader();

for (; ;) {
  const { value, done } = await reader.read();
  if (value !== undefined) {
    decoder.push(value);
  }
  if (done) { break; }
}
// finally:
decoder.close();

Sync usage

DockerDecoder class also provides sync interface, if you have your whole stream in a blob.

import { DockerDecoder } from "docker-decoder-stream";

const dockerLogBlob = await fetch("/v1.43/containers/{id}/logs")
  .then(response => response.blob());

const data = new DockerDecoder().decode(dockerLogBlob);
const text = new TextDecoder().decode(data);

Rendering considerations

During the initial load or if you have a large throughput in docker logs, you can easily overwhelm the browser with a huge number of rerenders, making the page unresponsive.

To avoid that, tie content updates to requestAnimationFrame, accumulating them in some kind of a buffer and applying them all at once at the current framerate.

See the provided examples for possible implementation of such a buffer.

If you're rendering logs just as plain text inside of a reactive framework, it might be a good idea to omit reactivity tools it provides and just to update target element's textContent, to decrease cost of updates even further.

Contributing

If you have any ideas or suggestions or want to report a bug, feel free to write in the issues section or create a PR.

License

docker-decoder-stream is MIT licensed.

Changelog

[0.0.1] - 2024-01-23

Added

• First public release