Default to an objectMode: true instance but allow creating other instances with other defaults

This commit is contained in:
Lewis Diamond
2020-08-03 18:54:40 -04:00
parent 4aac05c9c0
commit 87c44de799
32 changed files with 241 additions and 76 deletions

View File

@@ -1,10 +1,9 @@
import test from "ava";
import { expect } from "chai";
import { Readable } from "stream";
import { strom } from "../src";
import { accumulator, accumulatorBy } from "../src";
import { FlushStrategy } from "../src/functions/accumulator";
import { performance } from "perf_hooks";
const { accumulator, accumulatorBy } = strom({ objectMode: true });
test.cb("accumulator() rolling", t => {
t.plan(3);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { batch, map, fromArray } = strom({ objectMode: true });
import { batch, map, fromArray } from "../src";
test.cb("batch() batches chunks together", t => {
t.plan(3);

View File

@@ -2,8 +2,7 @@ import * as cp from "child_process";
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { child } = strom();
import { child } from "../src";
test.cb(
"child() allows easily writing to child process stdin and reading from its stdout",

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { collect } = strom();
import { collect } from "../src";
test.cb(
"collect() collects streamed elements into an array (object, flowing mode)",

View File

@@ -2,9 +2,8 @@ import * as test from "ava";
import { expect } from "chai";
import { sleep } from "../src/helpers";
import { Readable, Writable } from "stream";
import { strom } from "../src";
import { compose, map, fromArray } from "../src";
import { performance } from "perf_hooks";
const { compose, map, fromArray } = strom({ objectMode: true });
test.cb("compose() chains two streams together in the correct order", t => {
t.plan(3);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { concat, collect } = strom();
import { concat, collect } from "../src";
test.cb(
"concat() concatenates multiple readable streams (object, flowing mode)",

View File

@@ -1,21 +1,30 @@
import { Readable } from "stream";
import test from "ava";
import { strom } from "../src";
import { batch as _batch, instance as strom } from "../src";
const withDefaultOptions = strom({ objectMode: true });
const withoutOptions = strom();
const withDefaultOptions = strom({ objectMode: false });
test("strom instances can have default options", t => {
let batch = withDefaultOptions.batch();
t.true(batch._readableState.objectMode);
t.true(batch._writableState.objectMode);
t.false(batch._readableState.objectMode);
t.false(batch._writableState.objectMode);
batch = withDefaultOptions.batch(3);
t.true(batch._readableState.objectMode);
t.true(batch._writableState.objectMode);
t.false(batch._readableState.objectMode);
t.false(batch._writableState.objectMode);
batch = withDefaultOptions.batch(3, 1);
t.false(batch._readableState.objectMode);
t.false(batch._writableState.objectMode);
batch = withDefaultOptions.batch(3, 1, { objectMode: true });
t.true(batch._readableState.objectMode);
t.true(batch._writableState.objectMode);
batch = withDefaultOptions.batch(3, 1, { objectMode: false });
batch = _batch(3);
t.true(batch._readableState.objectMode);
t.true(batch._writableState.objectMode);
batch = _batch(3, 1);
t.true(batch._readableState.objectMode);
t.true(batch._writableState.objectMode);
batch = _batch(3, 1, { objectMode: false });
t.false(batch._readableState.objectMode);
t.false(batch._writableState.objectMode);
});

View File

@@ -1,11 +1,10 @@
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
import { demux, map, fromArray } from "../src";
import { Writable, Readable } from "stream";
import * as sinon from "sinon";
import { sleep } from "../src/helpers";
import { performance } from "perf_hooks";
const { demux, map, fromArray } = strom({ objectMode: true });
interface Test {
key: string;

View File

@@ -2,8 +2,7 @@ import * as cp from "child_process";
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { duplex } = strom();
import { duplex } from "../src";
test.cb(
"duplex() combines a writable and readable stream into a ReadWrite stream",

View File

@@ -1,8 +1,7 @@
import test from "ava";
import { expect } from "chai";
import { Readable } from "stream";
import { strom } from "../src";
const { filter } = strom();
import { filter } from "../src";
test.cb("filter() filters elements synchronously", t => {
t.plan(2);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { flatMap } = strom({ objectMode: true });
import { flatMap } from "../src";
test.cb("flatMap() maps elements synchronously", t => {
t.plan(6);

View File

@@ -1,7 +1,6 @@
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { fromArray } = strom();
import { fromArray } from "../src";
test.cb("fromArray() streams array elements in flowing mode", t => {
t.plan(3);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { join } = strom();
import { join } from "../src";
test.cb("join() joins chunks using the specified separator", t => {
t.plan(9);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { last } = strom();
import { last } from "../src";
test("last() resolves to the last chunk streamed by the given readable stream", async t => {
const source = new Readable({ objectMode: true });

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { map } = strom();
import { map } from "../src";
test.cb("map() maps elements synchronously", t => {
t.plan(3);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { merge } = strom();
import { merge } from "../src";
test.cb(
"merge() merges multiple readable streams in chunk arrival order",

View File

@@ -2,9 +2,8 @@ import { Readable } from "stream";
import { performance } from "perf_hooks";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
import { parallelMap } from "../src";
import { sleep } from "../src/helpers";
const { parallelMap } = strom({ objectMode: true });
test.cb("parallelMap() parallel mapping", t => {
t.plan(6);

View File

@@ -1,8 +1,7 @@
import { Readable, finished } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { parse } = strom();
import { parse } from "../src";
test.cb("parse() parses the streamed elements as JSON", t => {
t.plan(3);

View File

@@ -1,12 +1,11 @@
import { Readable } from "stream";
import { performance } from "perf_hooks";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { rate } = strom({ objectMode: true });
import { rate } from "../src";
import { sleep } from "../src/helpers";
test.cb("rate() sends data at a rate of 150", t => {
t.plan(5);
t.plan(15);
const targetRate = 150;
const source = new Readable({ objectMode: true });
const expectedElements = ["a", "b", "c", "d", "e"];
@@ -15,10 +14,10 @@ test.cb("rate() sends data at a rate of 150", t => {
source
.pipe(rate(targetRate))
.on("data", (element: string[]) => {
.on("data", (element: string) => {
const currentRate = (i / (performance.now() - start)) * 1000;
expect(element).to.deep.equal(expectedElements[i]);
expect(currentRate).lessThan(targetRate);
t.is(element, expectedElements[i]);
t.true(currentRate <= targetRate);
t.pass();
i++;
})
@@ -34,7 +33,7 @@ test.cb("rate() sends data at a rate of 150", t => {
});
test.cb("rate() sends data at a rate of 50", t => {
t.plan(5);
t.plan(15);
const targetRate = 50;
const source = new Readable({ objectMode: true });
const expectedElements = ["a", "b", "c", "d", "e"];
@@ -43,10 +42,10 @@ test.cb("rate() sends data at a rate of 50", t => {
source
.pipe(rate(targetRate))
.on("data", (element: string[]) => {
.on("data", (element: string) => {
const currentRate = (i / (performance.now() - start)) * 1000;
expect(element).to.deep.equal(expectedElements[i]);
expect(currentRate).lessThan(targetRate);
t.is(element, expectedElements[i]);
t.true(currentRate <= targetRate);
t.pass();
i++;
})
@@ -62,7 +61,7 @@ test.cb("rate() sends data at a rate of 50", t => {
});
test.cb("rate() sends data at a rate of 1", t => {
t.plan(5);
t.plan(15);
const targetRate = 1;
const source = new Readable({ objectMode: true });
const expectedElements = ["a", "b", "c", "d", "e"];
@@ -71,10 +70,10 @@ test.cb("rate() sends data at a rate of 1", t => {
source
.pipe(rate(targetRate))
.on("data", (element: string[]) => {
.on("data", (element: string) => {
const currentRate = (i / (performance.now() - start)) * 1000;
expect(element).to.deep.equal(expectedElements[i]);
expect(currentRate).lessThan(targetRate);
t.is(element, expectedElements[i]);
t.true(currentRate <= targetRate);
t.pass();
i++;
})
@@ -88,3 +87,41 @@ test.cb("rate() sends data at a rate of 1", t => {
source.push("e");
source.push(null);
});
test("rate() sends data at a rate of 1 and drops extra messages", async t => {
t.plan(9);
const targetRate = 1;
const source = new Readable({
objectMode: true,
read: () => {
return;
},
});
const expectedElements = ["a", "b", "e"];
const start = performance.now();
let i = 0;
let plan = 0;
source
.pipe(rate(targetRate, 1, { behavior: 1 }))
.on("data", (element: string) => {
const currentRate = (i / (performance.now() - start)) * 1000;
t.is(element, expectedElements[i]);
t.true(currentRate <= targetRate);
plan++;
t.pass();
i++;
})
.on("error", t.fail)
.on("end", t.fail);
source.push("a");
await sleep(1000);
source.push("b");
source.push("c");
source.push("d");
await sleep(1000);
source.push("e");
await sleep(1000);
source.push(null);
});

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { reduce } = strom({ objectMode: true });
import { reduce } from "../src";
test.cb("reduce() reduces elements synchronously", t => {
t.plan(1);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { replace } = strom();
import { replace } from "../src";
test.cb(
"replace() replaces occurrences of the given string in the streamed elements with the specified " +

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { split } = strom();
import { split } from "../src";
test.cb("split() splits chunks using the default separator (\\n)", t => {
t.plan(5);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { stringify } = strom();
import { stringify } from "../src";
test.cb("stringify() stringifies the streamed elements as JSON", t => {
t.plan(4);

View File

@@ -1,8 +1,7 @@
import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import { strom } from "../src";
const { unbatch, batch } = strom({ objectMode: true });
import { unbatch, batch } from "../src";
test.cb("unbatch() unbatches", t => {
t.plan(3);

View File

@@ -1,7 +1,6 @@
import test from "ava";
import { collected } from "../../src/utils";
import { strom } from "../../src";
const { fromArray, collect } = strom({ objectMode: true });
import { fromArray, collect } from "../../src";
test("collected returns a promise for the first data point", async t => {
const data = collected(fromArray([1, 2, 3, 4]).pipe(collect()));