21 Commits

Author SHA1 Message Date
Jerry Kurian
46d118d4a5 Update docs 2020-04-27 14:28:55 -04:00
Jerry Kurian
5dd856deed Update test 2020-04-27 14:23:58 -04:00
Jerry Kurian
d0a9d35fe7 Purge idle pipelines 2020-04-27 14:20:07 -04:00
Jerry Kurian
71b03678ba Add chunk to constructor (#5)
* Add chunk to constructor

* Add test

* Bump version
2020-04-27 12:25:36 -04:00
Lewis Diamond
f661f9be6b Export DemuxOptions is necessary for publishing 2020-03-02 10:17:41 -05:00
Lewis Diamond
ed73bd2887 Adding collected 2020-03-02 10:09:46 -05:00
Lewis Diamond
2841f4e182 Merge pull request #4 from Jogogoplay/feature/demux-pipe
Allow demux to be piped ie muxed
2020-02-28 17:23:59 -05:00
Jerry Kurian
12efbec698 Update tests 2020-01-28 09:48:29 -05:00
Jerry Kurian
ce2bb55b24 Emit correct event 2020-01-27 16:10:00 -05:00
Jerry Kurian
2bbc5c9e0f types 2020-01-27 13:11:51 -05:00
Jerry Kurian
8856cb8d3b Update demux 2020-01-27 13:07:37 -05:00
Jerry Kurian
2b1308a605 use fromArray 2020-01-27 09:29:59 -05:00
Jerry Kurian
11ed6f81e7 remove console log 2020-01-26 10:43:33 -05:00
Jerry Kurian
cf719b25cf Fix broken test 2020-01-26 10:37:59 -05:00
Jerry Kurian
9c09957775 Add test for remux 2020-01-26 10:26:54 -05:00
Jerry Kurian
bff4e0d6ed Add remux options 2020-01-26 09:55:35 -05:00
Jerry Kurian
bd178ce2f0 Revert to old 2020-01-25 12:36:38 -05:00
Jerry Kurian
1227ce7095 Allow demux to be piped (mux) 2020-01-25 12:33:09 -05:00
Lewis Diamond
179d526c6c 2.0.0-alpha.1 2019-12-06 17:14:39 -05:00
Lewis Diamond
4b806c4d4e Fix a few thing with compose 2019-12-06 16:38:52 -05:00
Lewis Diamond
ff2b652ddf Merge pull request #3 from Jogogoplay/feature/ObjectModeByConfig
DefaultOptions implemented as module factory
2019-12-02 16:27:01 -05:00
16 changed files with 1893 additions and 2045 deletions

View File

@@ -1,6 +1,6 @@
{
"name": "@jogogo/mhysa",
"version": "0.0.1-beta.4",
"version": "2.0.0-alpha.3",
"description": "Streams and event emitter utils for Node.js",
"keywords": [
"promise",
@@ -35,9 +35,7 @@
"type": "git"
},
"scripts": {
"test": "NODE_PATH=src node node_modules/.bin/ava 'tests/*.spec.ts' -e",
"test:debug": "NODE_PATH=src node inspect node_modules/ava/profile.js",
"test:all": "NODE_PATH=src node node_modules/.bin/ava",
"test": "ava",
"lint": "tslint -p tsconfig.json",
"validate:tslint": "tslint-config-prettier-check ./tslint.json",
"prepublishOnly": "yarn lint && yarn test && yarn tsc -d"
@@ -45,9 +43,9 @@
"dependencies": {},
"devDependencies": {
"@types/chai": "^4.1.7",
"@types/node": "^12.7.2",
"@types/node": "^12.12.15",
"@types/sinon": "^7.0.13",
"ava": "^1.0.0-rc.2",
"ava": "^2.4.0",
"chai": "^4.2.0",
"mhysa": "./",
"prettier": "^1.14.3",
@@ -60,7 +58,8 @@
},
"ava": {
"files": [
"tests/*.spec.ts"
"tests/*.spec.ts",
"tests/utils/*.spec.ts"
],
"sources": [
"src/**/*.ts"

View File

@@ -12,7 +12,9 @@ export function batch(
clearTimeout(timer);
}
timer = null;
self.push(buffer);
if (buffer.length > 0) {
self.push(buffer);
}
buffer = [];
};
return new Transform({

View File

@@ -1,16 +1,18 @@
import { pipeline, Duplex, DuplexOptions } from "stream";
import { AllStreams, isReadable } from "../helpers";
import { PassThrough, pipeline, TransformOptions, Transform } from "stream";
export function compose(
streams: Array<
NodeJS.ReadableStream | NodeJS.ReadWriteStream | NodeJS.WritableStream
>,
options?: DuplexOptions,
errorCallback?: (err: any) => void,
options?: TransformOptions,
): Compose {
if (streams.length < 2) {
throw new Error("At least two streams are required to compose");
}
return new Compose(streams, options);
return new Compose(streams, errorCallback, options);
}
enum EventSubscription {
@@ -20,46 +22,60 @@ enum EventSubscription {
Self,
}
const eventsTarget = {
close: EventSubscription.Last,
data: EventSubscription.Last,
drain: EventSubscription.Self,
end: EventSubscription.Last,
error: EventSubscription.Self,
finish: EventSubscription.Last,
pause: EventSubscription.Last,
pipe: EventSubscription.First,
readable: EventSubscription.Last,
resume: EventSubscription.Last,
unpipe: EventSubscription.First,
};
type AllStreams =
| NodeJS.ReadableStream
| NodeJS.ReadWriteStream
| NodeJS.WritableStream;
export class Compose extends Duplex {
export class Compose extends Transform {
private first: AllStreams;
private last: AllStreams;
private streams: AllStreams[];
private inputStream: ReadableStream;
constructor(streams: AllStreams[], options?: DuplexOptions) {
constructor(
streams: AllStreams[],
errorCallback?: (err: any) => void,
options?: TransformOptions,
) {
super(options);
this.first = streams[0];
this.first = new PassThrough(options);
this.last = streams[streams.length - 1];
this.streams = streams;
pipeline(streams, (err: any) => {
this.emit("error", err);
pipeline(
[this.first, ...streams],
errorCallback ||
((error: any) => {
if (error) {
this.emit("error", error);
}
}),
);
if (isReadable(this.last)) {
(this.last as NodeJS.ReadWriteStream).pipe(
new Transform({
...options,
transform: (d: any, encoding, cb) => {
this.push(d);
cb();
},
}),
);
}
}
public _transform(chunk: any, encoding: string, cb: any) {
(this.first as NodeJS.WritableStream).write(chunk, encoding, cb);
}
public _flush(cb: any) {
if (isReadable(this.first)) {
(this.first as any).push(null);
}
this.last.once("end", () => {
cb();
});
}
public pipe<T extends NodeJS.WritableStream>(dest: T) {
return (this.last as NodeJS.ReadableStream).pipe(dest);
}
public _write(chunk: any, encoding: string, cb: any) {
(this.first as NodeJS.WritableStream).write(chunk, encoding, cb);
public _destroy(error: any, cb: (error?: any) => void) {
this.streams.forEach(s => (s as any).destroy());
cb(error);
}
public bubble(...events: string[]) {
@@ -69,38 +85,4 @@ export class Compose extends Duplex {
});
});
}
public on(event: string, cb: any) {
switch (eventsTarget[event]) {
case EventSubscription.First:
this.first.on(event, cb);
break;
case EventSubscription.Last:
this.last.on(event, cb);
break;
case EventSubscription.All:
this.streams.forEach(s => s.on(event, cb));
break;
default:
super.on(event, cb);
}
return this;
}
public once(event: string, cb: any) {
switch (eventsTarget[event]) {
case EventSubscription.First:
this.first.once(event, cb);
break;
case EventSubscription.Last:
this.last.once(event, cb);
break;
case EventSubscription.All:
this.streams.forEach(s => s.once(event, cb));
break;
default:
super.once(event, cb);
}
return this;
}
}

View File

@@ -1,63 +1,94 @@
import { WritableOptions, Writable } from "stream";
import { DuplexOptions, Duplex, Transform } from "stream";
enum EventSubscription {
Last = 0,
First,
All,
Self,
Unhandled,
}
const eventsTarget = {
close: EventSubscription.Self,
data: EventSubscription.All,
drain: EventSubscription.Self,
end: EventSubscription.Self,
error: EventSubscription.Self,
finish: EventSubscription.Self,
pause: EventSubscription.Self,
pipe: EventSubscription.Self,
readable: EventSubscription.Self,
resume: EventSubscription.Self,
unpipe: EventSubscription.Self,
};
import { isReadable } from "../helpers";
type DemuxStreams = NodeJS.WritableStream | NodeJS.ReadWriteStream;
export interface DemuxOptions extends DuplexOptions {
remultiplex?: boolean;
purgeIdleInterval?: number;
maxIdleTime?: number;
}
export function demux(
construct: (destKey?: string) => DemuxStreams,
construct: (destKey?: string, chunk?: any) => DemuxStreams,
demuxBy: string | ((chunk: any) => string),
options?: WritableOptions,
): Writable {
options?: DemuxOptions,
): Duplex {
return new Demux(construct, demuxBy, options);
}
// @TODO handle pipe event ie) Multiplex
class Demux extends Writable {
class Demux extends Duplex {
private streamsByKey: {
[key: string]: DemuxStreams;
[key: string]: { stream: DemuxStreams; lastWrite: number };
};
private demuxer: (chunk: any) => string;
private construct: (destKey?: string) => DemuxStreams;
private construct: (destKey?: string, chunk?: any) => DemuxStreams;
private remultiplex: boolean;
private transform: Transform;
private maxIdleTime: number;
constructor(
construct: (destKey?: string) => DemuxStreams,
demuxBy: string | ((chunk: any) => string),
options: WritableOptions = {},
options: DemuxOptions = {},
) {
super(options);
this.demuxer =
typeof demuxBy === "string" ? chunk => chunk[demuxBy] : demuxBy;
this.construct = construct;
this.remultiplex =
options.remultiplex === undefined ? true : options.remultiplex;
this.streamsByKey = {};
this.transform = new Transform({
...options,
transform: (d, _, cb) => {
this.push(d);
cb(null);
},
});
this.maxIdleTime = options.maxIdleTime || 600000;
const purgeIdleInterval = options.purgeIdleInterval || 600000;
setInterval(() => {
this._destroyIdle();
}, purgeIdleInterval);
this.on("unpipe", () => this._flush());
}
private _destroyIdle() {
for (let key in this.streamsByKey) {
const curTime = Date.now();
const pipeline = this.streamsByKey[key];
if (curTime - pipeline.lastWrite > this.maxIdleTime) {
delete this.streamsByKey[key];
}
}
}
// tslint:disable-next-line
public _read(size: number) {}
public async _write(chunk: any, encoding: any, cb: any) {
const destKey = this.demuxer(chunk);
if (this.streamsByKey[destKey] === undefined) {
this.streamsByKey[destKey] = await this.construct(destKey);
const newPipeline = await this.construct(destKey, chunk);
this.streamsByKey[destKey] = {
stream: newPipeline,
lastWrite: Date.now(),
};
if (this.remultiplex && isReadable(newPipeline)) {
(newPipeline as NodeJS.ReadWriteStream).pipe(this.transform);
} else if (this.remultiplex) {
console.error(
`Pipeline construct for ${destKey} does not implement readable interface`,
);
}
} else {
this.streamsByKey[destKey].lastWrite = Date.now();
}
if (!this.streamsByKey[destKey].write(chunk, encoding)) {
this.streamsByKey[destKey].once("drain", () => {
if (!this.streamsByKey[destKey].stream.write(chunk, encoding)) {
this.streamsByKey[destKey].stream.once("drain", () => {
cb();
});
} else {
@@ -65,35 +96,24 @@ class Demux extends Writable {
}
}
public on(event: string, cb: any) {
switch (eventsTarget[event]) {
case EventSubscription.Self:
super.on(event, cb);
break;
case EventSubscription.All:
Object.keys(this.streamsByKey).forEach(key =>
this.streamsByKey[key].on(event, cb),
);
break;
default:
super.on(event, cb);
}
return this;
public _flush() {
const pipelines = Object.values(this.streamsByKey);
let totalEnded = 0;
pipelines.forEach(({ stream }) => {
stream.once("end", () => {
totalEnded++;
if (pipelines.length === totalEnded) {
this.push(null);
this.emit("end");
}
});
});
pipelines.forEach(({ stream }) => stream.end());
}
public once(event: string, cb: any) {
switch (eventsTarget[event]) {
case EventSubscription.Self:
super.once(event, cb);
break;
case EventSubscription.All:
Object.keys(this.streamsByKey).forEach(key =>
this.streamsByKey[key].once(event, cb),
);
break;
default:
super.once(event, cb);
}
return this;
public _destroy(error: any, cb: (error?: any) => void) {
const pipelines = Object.values(this.streamsByKey);
pipelines.forEach(({ stream }) => (stream as any).destroy());
cb(error);
}
}

View File

@@ -121,6 +121,10 @@ export default function mhysa(defaultOptions?: TransformOptions) {
/**
* Return a ReadWrite stream that parses the streamed chunks as JSON. Each streamed chunk
* must be a fully defined JSON string in utf8.
* @param format: @type SerializationFormats defaults SerializationFormats.utf8
* @param emitError: @type boolean Whether or not to emit an error when
* failing to parse. An error will automatically close the stream.
* Defaults to true.
*/
parse,
@@ -245,17 +249,21 @@ export default function mhysa(defaultOptions?: TransformOptions) {
/**
* Composes multiple streams together. Writing occurs on first stream, piping occurs from last stream.
* @param streams Array of streams to compose. Minimum of two.
* @param errorCallback a function that handles any error coming out of the pipeline
* @param options Transform stream options
*/
compose: withDefaultOptions(1, compose),
compose: withDefaultOptions(2, compose),
/**
* Composes multiple streams together. Writing occurs on first stream, piping occurs from last stream.
* @param construct Constructor for new output source. Should return a Writable or ReadWrite stream.
* @param demuxBy
* @param demuxBy.key? Key to fetch value from source chunks to demultiplex source.
* @param demuxBy.keyBy? Function to fetch value from source chunks to demultiplex source.
* @param options Writable stream options
* @param {Function} construct Constructor for new output source. Should return a Writable or ReadWrite stream.
* @param {String | Function} demuxBy
* @param {string} demuxBy.key? Key to fetch value from source chunks to demultiplex source.
* @param {Function} demuxBy.keyBy? Function to fetch value from source chunks to demultiplex source.
* @param {Object} options Demux stream options
* @param {boolean} options.remultiplex? If demux should be remultiplexed into a single destination
* @param {number} options.purgeIdleInterval? Interval at which a purge for idle pipelines will occur
* @param {number} options.maxIdleTime? Min time a demuxed pipeline must be idle for to be purged
*/
demux: withDefaultOptions(2, demux),
};

View File

@@ -4,6 +4,7 @@ import { SerializationFormats } from "./baseDefinitions";
export function parse(
format: SerializationFormats = SerializationFormats.utf8,
emitError: boolean = true,
): Transform {
const decoder = new StringDecoder(format);
return new Transform({
@@ -13,9 +14,13 @@ export function parse(
try {
const asString = decoder.write(chunk);
// Using await causes parsing errors to be emitted
callback(undefined, await JSON.parse(asString));
callback(null, await JSON.parse(asString));
} catch (err) {
callback(err);
if (emitError) {
callback(err);
} else {
callback();
}
}
},
});

View File

@@ -1,3 +1,17 @@
export async function sleep(time: number): Promise<{} | null> {
return time > 0 ? new Promise(resolve => setTimeout(resolve, time)) : null;
}
export type AllStreams =
| NodeJS.ReadableStream
| NodeJS.ReadWriteStream
| NodeJS.WritableStream;
export function isReadable(
stream: AllStreams,
): stream is NodeJS.WritableStream {
return (
(stream as NodeJS.ReadableStream).pipe !== undefined &&
(stream as any).readable === true
);
}

View File

@@ -1,2 +1,6 @@
import mhysa from "./functions";
import * as _utils from "./utils";
export default mhysa;
// @TODO fix this with proper import export
export const utils = { ..._utils };

12
src/utils/collected.ts Normal file
View File

@@ -0,0 +1,12 @@
import { Transform } from "stream";
export function collected(stream: Transform): any {
return new Promise((resolve, reject) => {
stream.once("data", d => {
resolve(d);
});
stream.once("error", e => {
reject(e);
});
});
}

1
src/utils/index.ts Normal file
View File

@@ -0,0 +1 @@
export { collected } from "./collected";

View File

@@ -2,7 +2,7 @@ import { Readable } from "stream";
import test from "ava";
import { expect } from "chai";
import mhysa from "../src";
const { batch } = mhysa({ objectMode: true });
const { batch, map, fromArray } = mhysa({ objectMode: true });
test.cb("batch() batches chunks together", t => {
t.plan(3);
@@ -57,3 +57,28 @@ test.cb("batch() yields a batch after the timeout", t => {
source.push(null);
}, 600 * 2);
});
test.cb(
"batch() yields all input data even when the last element(s) dont make a full batch",
t => {
const data = [1, 2, 3, 4, 5, 6, 7];
fromArray([...data])
.pipe(batch(3))
.pipe(
map(d => {
t.deepEqual(
d,
[data.shift(), data.shift(), data.shift()].filter(
x => !!x,
),
);
}),
)
.on("error", t.fail)
.on("finish", () => {
t.is(data.length, 0);
t.end();
});
},
);

View File

@@ -1,9 +1,10 @@
const test = require("ava");
const { expect } = require("chai");
const { sleep } = require("../src/helpers");
import * as test from "ava";
import { expect } from "chai";
import { sleep } from "../src/helpers";
import { Readable, Writable } from "stream";
import mhysa from "../src";
import { performance } from "perf_hooks";
const { compose, map } = mhysa({ objectMode: true });
const { compose, map, fromArray } = mhysa({ objectMode: true });
test.cb("compose() chains two streams together in the correct order", t => {
t.plan(3);
@@ -22,10 +23,7 @@ test.cb("compose() chains two streams together in the correct order", t => {
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true },
);
const composed = compose([first, second]);
composed.on("data", data => {
expect(data).to.deep.equal(result[i]);
@@ -35,12 +33,6 @@ test.cb("compose() chains two streams together in the correct order", t => {
t.end();
}
});
composed.on("error", err => {
t.end(err);
});
composed.on("end", () => {
t.end();
});
const input = [
{ key: "a", visited: [] },
@@ -72,10 +64,7 @@ test.cb("piping compose() maintains correct order", t => {
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true },
);
const composed = compose([first, second]);
const third = map((chunk: Chunk) => {
chunk.visited.push(3);
return chunk;
@@ -109,33 +98,28 @@ test.cb("piping compose() maintains correct order", t => {
});
test("compose() writable length should be less than highWaterMark when handing writes", async t => {
t.plan(7);
t.plan(2);
return new Promise(async (resolve, reject) => {
interface Chunk {
key: string;
mapped: number[];
}
const first = map(
async (chunk: Chunk) => {
chunk.mapped.push(1);
return chunk;
},
{
objectMode: true,
},
);
const first = map(async (chunk: Chunk) => {
chunk.mapped.push(1);
return chunk;
});
const second = map(
async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true },
);
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark: 2 },
undefined,
{
highWaterMark: 2,
},
);
composed.on("error", err => {
reject();
@@ -160,19 +144,12 @@ test("compose() writable length should be less than highWaterMark when handing w
{ key: "e", mapped: [] },
];
for (const item of input) {
const res = composed.write(item);
expect(composed._writableState.length).to.be.at.most(2);
t.pass();
if (!res) {
await sleep(10);
}
}
fromArray(input).pipe(composed);
});
});
test("compose() should emit drain event ~rate * highWaterMark ms for every write that causes backpressure", async t => {
t.plan(7);
t.plan(2);
const _rate = 100;
const highWaterMark = 2;
return new Promise(async (resolve, reject) => {
@@ -180,28 +157,23 @@ test("compose() should emit drain event ~rate * highWaterMark ms for every write
key: string;
mapped: number[];
}
const first = map(
async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
},
{
objectMode: true,
},
);
const first = map(async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
});
const second = map(
async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true },
);
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark },
undefined,
{
highWaterMark,
},
);
composed.on("error", err => {
reject();
@@ -210,19 +182,14 @@ test("compose() should emit drain event ~rate * highWaterMark ms for every write
composed.on("drain", () => {
t.pass();
expect(composed._writableState.length).to.be.equal(0);
expect(performance.now() - start).to.be.closeTo(
_rate * highWaterMark,
40,
);
});
composed.on("data", (chunk: Chunk) => {
pendingReads--;
if (pendingReads === 0) {
resolve();
}
t.deepEqual(chunk.mapped, [1, 2]);
});
composed.on("finish", () => resolve());
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
@@ -230,19 +197,7 @@ test("compose() should emit drain event ~rate * highWaterMark ms for every write
{ key: "d", mapped: [] },
{ key: "e", mapped: [] },
];
let start = performance.now();
let pendingReads = input.length;
start = performance.now();
for (const item of input) {
const res = composed.write(item);
expect(composed._writableState.length).to.be.at.most(highWaterMark);
t.pass();
if (!res) {
await sleep(_rate * highWaterMark * 2);
start = performance.now();
}
}
fromArray(input).pipe(composed);
});
});
@@ -255,28 +210,23 @@ test.cb(
key: string;
mapped: number[];
}
const first = map(
async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
},
{
objectMode: true,
},
);
const first = map(async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
});
const second = map(
async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true },
);
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark: 5 },
undefined,
{
highWaterMark: 5,
},
);
composed.on("error", err => {
@@ -285,10 +235,6 @@ test.cb(
composed.on("drain", () => {
expect(composed._writableState.length).to.be.equal(0);
expect(performance.now() - start).to.be.closeTo(
_rate * input.length,
50,
);
t.pass();
});
@@ -309,7 +255,6 @@ test.cb(
input.forEach(item => {
composed.write(item);
});
const start = performance.now();
},
);
@@ -322,15 +267,10 @@ test.cb(
key: string;
mapped: number[];
}
const first = map(
(chunk: Chunk) => {
chunk.mapped.push(1);
return chunk;
},
{
objectMode: true,
},
);
const first = map((chunk: Chunk) => {
chunk.mapped.push(1);
return chunk;
});
const second = map(
async (chunk: Chunk) => {
@@ -341,12 +281,15 @@ test.cb(
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark: 5 },
undefined,
{
highWaterMark: 5,
},
);
composed.on("error", err => {
t.end(err);
@@ -398,7 +341,6 @@ test.cb(
return chunk;
},
{
objectMode: true,
highWaterMark: 2,
},
);
@@ -410,12 +352,15 @@ test.cb(
chunk.mapped.push("second");
return chunk;
},
{ objectMode: true, highWaterMark: 2 },
{ highWaterMark: 2 },
);
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark: 5 },
undefined,
{
highWaterMark: 5,
},
);
composed.on("error", err => {
t.end(err);
@@ -458,28 +403,23 @@ test.cb(
key: string;
mapped: number[];
}
const first = map(
async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
},
{
objectMode: true,
},
);
const first = map(async (chunk: Chunk) => {
await sleep(_rate);
chunk.mapped.push(1);
return chunk;
});
const second = map(
async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true },
);
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
{ objectMode: true, highWaterMark: 6 },
undefined,
{
highWaterMark: 6,
},
);
composed.on("error", err => {
@@ -510,3 +450,131 @@ test.cb(
});
},
);
test.cb("compose() should be 'destroyable'", t => {
t.plan(3);
const _sleep = 100;
interface Chunk {
key: string;
mapped: number[];
}
const first = map(async (chunk: Chunk) => {
await sleep(_sleep);
chunk.mapped.push(1);
return chunk;
});
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
(err: any) => {
t.pass();
},
);
const fakeSource = new Readable({
objectMode: true,
read() {
return;
},
});
const fakeSink = new Writable({
objectMode: true,
write(data, enc, cb) {
const cur = input.shift();
t.is(cur.key, data.key);
t.deepEqual(cur.mapped, [1, 2]);
if (cur.key === "a") {
composed.destroy();
}
cb();
},
});
composed.on("close", t.end);
fakeSource.pipe(composed).pipe(fakeSink);
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
{ key: "c", mapped: [] },
{ key: "d", mapped: [] },
{ key: "e", mapped: [] },
];
fakeSource.push(input[0]);
fakeSource.push(input[1]);
fakeSource.push(input[2]);
fakeSource.push(input[3]);
fakeSource.push(input[4]);
});
test.cb("compose() `finish` and `end` propagates", t => {
interface Chunk {
key: string;
mapped: number[];
}
t.plan(8);
const first = map(async (chunk: Chunk) => {
chunk.mapped.push(1);
return chunk;
});
const second = map(async (chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
});
const composed = compose(
[first, second],
undefined,
{
highWaterMark: 3,
},
);
const fakeSource = new Readable({
objectMode: true,
read() {
return;
},
});
const sink = map((d: Chunk) => {
const curr = input.shift();
t.is(curr.key, d.key);
t.deepEqual(d.mapped, [1, 2]);
});
fakeSource.pipe(composed).pipe(sink);
fakeSource.on("end", () => {
t.pass();
});
composed.on("finish", () => {
t.pass();
});
composed.on("end", () => {
t.pass();
t.end();
});
sink.on("finish", () => {
t.pass();
});
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
{ key: "c", mapped: [] },
{ key: "d", mapped: [] },
{ key: "e", mapped: [] },
];
fakeSource.push(input[0]);
fakeSource.push(input[1]);
fakeSource.push(null);
});

View File

@@ -1,11 +1,11 @@
import test from "ava";
import { expect } from "chai";
import mhysa from "../src";
import { Writable } from "stream";
import { Writable, Readable } from "stream";
const sinon = require("sinon");
const { sleep } = require("../src/helpers");
import { performance } from "perf_hooks";
const { demux, map } = mhysa();
const { demux, map, fromArray } = mhysa({ objectMode: true });
interface Test {
key: string;
@@ -31,7 +31,7 @@ test.cb("demux() constructor should be called once per key", t => {
return dest;
});
const demuxed = demux(construct, "key", { objectMode: true });
const demuxed = demux(construct, "key", {});
demuxed.on("finish", () => {
expect(construct.withArgs("a").callCount).to.equal(1);
@@ -41,8 +41,35 @@ test.cb("demux() constructor should be called once per key", t => {
t.end();
});
input.forEach(event => demuxed.write(event));
demuxed.end();
fromArray(input).pipe(demuxed);
});
test.cb("demux() item written passed in constructor", t => {
t.plan(4);
const input = [
{ key: "a", visited: [] },
{ key: "b", visited: [] },
{ key: "c", visited: [] },
];
const construct = sinon.spy((destKey: string, item: any) => {
expect(item).to.deep.equal({ key: destKey, visited: [] });
t.pass();
const dest = map((chunk: Test) => {
chunk.visited.push(1);
return chunk;
});
return dest;
});
const demuxed = demux(construct, "key", {});
demuxed.on("finish", () => {
t.pass();
t.end();
});
fromArray(input).pipe(demuxed);
});
test.cb("demux() should send input through correct pipeline", t => {
@@ -66,7 +93,7 @@ test.cb("demux() should send input through correct pipeline", t => {
return dest;
};
const demuxed = demux(construct, "key", { objectMode: true });
const demuxed = demux(construct, "key", {});
demuxed.on("finish", () => {
pipelineSpies["a"].getCalls().forEach(call => {
@@ -84,8 +111,7 @@ test.cb("demux() should send input through correct pipeline", t => {
t.end();
});
input.forEach(event => demuxed.write(event));
demuxed.end();
fromArray(input).pipe(demuxed);
});
test.cb("demux() constructor should be called once per key using keyBy", t => {
@@ -108,7 +134,7 @@ test.cb("demux() constructor should be called once per key using keyBy", t => {
return dest;
});
const demuxed = demux(construct, item => item.key, { objectMode: true });
const demuxed = demux(construct, item => item.key, {});
demuxed.on("finish", () => {
expect(construct.withArgs("a").callCount).to.equal(1);
@@ -118,8 +144,7 @@ test.cb("demux() constructor should be called once per key using keyBy", t => {
t.end();
});
input.forEach(event => demuxed.write(event));
demuxed.end();
fromArray(input).pipe(demuxed);
});
test.cb("demux() should send input through correct pipeline using keyBy", t => {
@@ -143,7 +168,7 @@ test.cb("demux() should send input through correct pipeline using keyBy", t => {
return dest;
};
const demuxed = demux(construct, item => item.key, { objectMode: true });
const demuxed = demux(construct, item => item.key, {});
demuxed.on("finish", () => {
pipelineSpies["a"].getCalls().forEach(call => {
@@ -161,11 +186,10 @@ test.cb("demux() should send input through correct pipeline using keyBy", t => {
t.end();
});
input.forEach(event => demuxed.write(event));
demuxed.end();
fromArray(input).pipe(demuxed);
});
test("demux() write should return false after if it has >= highWaterMark items buffered and drain should be emitted", t => {
test("demux() write should return false and emit drain if more than highWaterMark items are buffered", t => {
return new Promise(async (resolve, reject) => {
t.plan(7);
interface Chunk {
@@ -189,7 +213,7 @@ test("demux() write should return false after if it has >= highWaterMark items b
await sleep(slowProcessorSpeed);
return { ...chunk, mapped: [1] };
},
{ highWaterMark: 1, objectMode: true },
{ highWaterMark: 1 },
);
first.on("data", chunk => {
@@ -205,7 +229,6 @@ test("demux() write should return false after if it has >= highWaterMark items b
};
const _demux = demux(construct, "key", {
objectMode: true,
highWaterMark,
});
@@ -229,7 +252,7 @@ test("demux() write should return false after if it has >= highWaterMark items b
});
});
test("demux() should emit one drain event after slowProcessorSpeed * highWaterMark ms", t => {
test("demux() should emit one drain event after slowProcessorSpeed * highWaterMark ms when first stream is bottleneck", t => {
return new Promise(async (resolve, reject) => {
t.plan(7);
interface Chunk {
@@ -255,7 +278,7 @@ test("demux() should emit one drain event after slowProcessorSpeed * highWaterMa
chunk.mapped.push(1);
return chunk;
},
{ highWaterMark: 1, objectMode: true },
{ highWaterMark: 1 },
);
first.on("data", () => {
@@ -268,7 +291,6 @@ test("demux() should emit one drain event after slowProcessorSpeed * highWaterMa
return first;
};
const _demux = demux(construct, "key", {
objectMode: true,
highWaterMark,
});
_demux.on("error", err => {
@@ -296,7 +318,7 @@ test("demux() should emit one drain event after slowProcessorSpeed * highWaterMa
test("demux() should emit one drain event when writing 6 items with highWaterMark of 5", t => {
return new Promise(async (resolve, reject) => {
t.plan(7);
t.plan(1);
interface Chunk {
key: string;
mapped: number[];
@@ -318,12 +340,11 @@ test("demux() should emit one drain event when writing 6 items with highWaterMar
chunk.mapped.push(2);
return chunk;
},
{ highWaterMark: 1, objectMode: true },
{ highWaterMark: 1 },
);
first.on("data", () => {
pendingReads--;
t.pass();
if (pendingReads === 0) {
resolve();
}
@@ -331,7 +352,6 @@ test("demux() should emit one drain event when writing 6 items with highWaterMar
return first;
};
const _demux = demux(construct, "key", {
objectMode: true,
highWaterMark: 5,
});
@@ -355,9 +375,10 @@ test("demux() should emit one drain event when writing 6 items with highWaterMar
});
});
test.cb.only(
"demux() should emit drain event when third stream is bottleneck",
test.cb(
"demux() should emit drain event when second stream is bottleneck after (highWaterMark - 2) * slowProcessorSpeed ms",
t => {
// ie) first two items are pushed directly into first and second streams (highWaterMark - 2 remain in demux)
t.plan(8);
const slowProcessorSpeed = 100;
const highWaterMark = 5;
@@ -383,7 +404,7 @@ test.cb.only(
chunk.mapped.push(1);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
const second = map(
@@ -392,25 +413,23 @@ test.cb.only(
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
first.pipe(second).pipe(sink);
return first;
};
const _demux = demux(construct, () => "a", {
objectMode: true,
highWaterMark,
});
_demux.on("error", err => {
t.end(err);
});
// This event should be received after at least 5 * slowProcessorSpeed (two are read immediately by first and second, 5 remaining in demux before drain event)
_demux.on("drain", () => {
expect(_demux._writableState.length).to.be.equal(0);
expect(performance.now() - start).to.be.greaterThan(
slowProcessorSpeed * (input.length - 2),
slowProcessorSpeed * 3,
);
t.pass();
});
@@ -427,15 +446,14 @@ test.cb.only(
let pendingReads = input.length;
const start = performance.now();
input.forEach(item => {
_demux.write(item);
});
fromArray(input).pipe(_demux);
},
);
test.cb(
"demux() should emit drain event when second stream is bottleneck",
"demux() should emit drain event when third stream is bottleneck",
t => {
// @TODO investigate why drain is emitted after slowProcessorSpeed
t.plan(8);
const slowProcessorSpeed = 100;
const highWaterMark = 5;
@@ -446,7 +464,7 @@ test.cb(
const sink = new Writable({
objectMode: true,
write(chunk, encoding, cb) {
expect(chunk.mapped).to.deep.equal([1, 2]);
expect(chunk.mapped).to.deep.equal([1, 2, 3]);
t.pass();
pendingReads--;
if (pendingReads === 0) {
@@ -461,14 +479,14 @@ test.cb(
chunk.mapped.push(1);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
const second = map(
(chunk: Chunk) => {
chunk.mapped.push(2);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
const third = map(
@@ -477,7 +495,7 @@ test.cb(
chunk.mapped.push(3);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
first
@@ -487,18 +505,16 @@ test.cb(
return first;
};
const _demux = demux(construct, () => "a", {
objectMode: true,
highWaterMark,
});
_demux.on("error", err => {
t.end(err);
});
// This event should be received after at least 3 * slowProcessorSpeed (two are read immediately by first and second, 3 remaining in demux before drain event)
_demux.on("drain", () => {
expect(_demux._writableState.length).to.be.equal(0);
expect(performance.now() - start).to.be.greaterThan(
slowProcessorSpeed * (input.length - 4),
slowProcessorSpeed,
);
t.pass();
});
@@ -515,9 +531,7 @@ test.cb(
let pendingReads = input.length;
const start = performance.now();
input.forEach(item => {
_demux.write(item);
});
fromArray(input).pipe(_demux);
},
);
@@ -536,36 +550,37 @@ test("demux() should be blocked by slowest pipeline", t => {
chunk.mapped.push(1);
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
{ highWaterMark: 1 },
);
first.on("data", chunk => {
pendingReads--;
if (chunk.key === "b") {
expect(performance.now() - start).to.be.greaterThan(
slowProcessorSpeed * totalItems,
);
t.pass();
expect(pendingReads).to.equal(0);
resolve();
}
});
return first;
};
const _demux = demux(construct, "key", {
objectMode: true,
highWaterMark: 1,
});
_demux.on("error", err => {
reject(err);
});
_demux.on("data", async chunk => {
pendingReads--;
if (chunk.key === "b") {
expect(performance.now() - start).to.be.greaterThan(
slowProcessorSpeed * totalItems,
);
t.pass();
expect(pendingReads).to.equal(0);
resolve();
}
});
const input = [
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
{ key: "c", mapped: [] },
{ key: "c", mapped: [] },
{ key: "c", mapped: [] },
{ key: "b", mapped: [] },
];
@@ -584,74 +599,302 @@ test("demux() should be blocked by slowest pipeline", t => {
});
});
test("demux() should emit drain event when second stream in pipeline is bottleneck", t => {
t.plan(5);
const highWaterMark = 3;
return new Promise(async (resolve, reject) => {
interface Chunk {
key: string;
mapped: number[];
test.cb("Demux should remux to sink", t => {
t.plan(6);
let i = 0;
const input = [
{ key: "a", visited: [] },
{ key: "b", visited: [] },
{ key: "a", visited: [] },
{ key: "c", visited: [] },
{ key: "a", visited: [] },
{ key: "b", visited: [] },
];
const result = [
{ key: "a", visited: ["a"] },
{ key: "b", visited: ["b"] },
{ key: "a", visited: ["a"] },
{ key: "c", visited: ["c"] },
{ key: "a", visited: ["a"] },
{ key: "b", visited: ["b"] },
];
const construct = (destKey: string) => {
const dest = map((chunk: any) => {
chunk.visited.push(destKey);
return chunk;
});
return dest;
};
const sink = map(d => {
t.deepEqual(d, result[i]);
i++;
if (i === input.length) {
t.end();
}
const sink = new Writable({
objectMode: true,
write(chunk, encoding, cb) {
expect(chunk.mapped).to.deep.equal([1, 2]);
t.pass();
cb();
if (pendingReads === 0) {
resolve();
}
},
});
const demuxed = demux(construct, "key", {});
fromArray(input)
.pipe(demuxed)
.pipe(sink);
});
test.cb("Demux should send data events", t => {
t.plan(6);
let i = 0;
const input = [
{ key: "a", visited: [] },
{ key: "b", visited: [] },
{ key: "a", visited: [] },
{ key: "c", visited: [] },
{ key: "a", visited: [] },
{ key: "b", visited: [] },
];
const result = [
{ key: "a", visited: ["a"] },
{ key: "b", visited: ["b"] },
{ key: "a", visited: ["a"] },
{ key: "c", visited: ["c"] },
{ key: "a", visited: ["a"] },
{ key: "b", visited: ["b"] },
];
const construct = (destKey: string) => {
const dest = map((chunk: any) => {
chunk.visited.push(destKey);
return chunk;
});
const construct = (destKey: string) => {
const first = map(
(chunk: Chunk) => {
expect(first._readableState.length).to.be.at.most(2);
chunk.mapped.push(1);
return chunk;
},
{ objectMode: true, highWaterMark: 2 },
);
return dest;
};
const second = map(
async (chunk: Chunk) => {
await sleep(100);
chunk.mapped.push(2);
expect(second._writableState.length).to.be.equal(1);
pendingReads--;
return chunk;
},
{ objectMode: true, highWaterMark: 1 },
);
const demuxed = demux(construct, "key", {});
first.pipe(second).pipe(sink);
return first;
};
fromArray(input).pipe(demuxed);
const _demux = demux(construct, "key", {
objectMode: true,
highWaterMark,
});
_demux.on("error", err => {
reject();
});
_demux.on("drain", () => {
expect(_demux._writableState.length).to.be.equal(0);
t.pass();
});
const input = [
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
];
let pendingReads = input.length;
input.forEach(item => {
_demux.write(item);
});
demuxed.on("data", d => {
t.deepEqual(d, result[i]);
i++;
if (i === input.length) {
t.end();
}
});
});
test.cb("demux() `finish` and `end` propagates", t => {
interface Chunk {
key: string;
mapped: number[];
}
t.plan(9);
const construct = (destKey: string) => {
const dest = map((chunk: any) => {
chunk.mapped.push(destKey);
return chunk;
});
return dest;
};
const _demux = demux(construct, "key", {
highWaterMark: 3,
});
const fakeSource = new Readable({
objectMode: true,
read() {
return;
},
});
const sink = map((d: any) => {
const curr = input.shift();
t.is(curr.key, d.key);
t.deepEqual(d.mapped, [d.key]);
});
fakeSource.pipe(_demux).pipe(sink);
fakeSource.on("end", () => {
t.pass();
});
_demux.on("finish", () => {
t.pass();
});
_demux.on("unpipe", () => {
t.pass();
});
_demux.on("end", () => {
t.pass();
t.end();
});
sink.on("finish", () => {
t.pass();
});
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
];
fakeSource.push(input[0]);
fakeSource.push(input[1]);
fakeSource.push(null);
});
test.cb("demux() `unpipe` propagates", t => {
interface Chunk {
key: string;
mapped: number[];
}
t.plan(7);
const construct = (destKey: string) => {
const dest = map((chunk: any) => {
chunk.mapped.push(destKey);
return chunk;
});
return dest;
};
const _demux = demux(construct, "key", {
highWaterMark: 3,
});
const fakeSource = new Readable({
objectMode: true,
read() {
return;
},
});
const sink = map((d: any) => {
const curr = input.shift();
t.is(curr.key, d.key);
t.deepEqual(d.mapped, [d.key]);
});
fakeSource.pipe(_demux).pipe(sink);
_demux.on("unpipe", () => {
t.pass();
});
sink.on("unpipe", () => {
t.pass();
});
sink.on("finish", () => {
t.pass();
t.end();
});
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
{ key: "a", mapped: [] },
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
];
fakeSource.push(input[0]);
fakeSource.push(input[1]);
fakeSource.push(null);
});
test.cb("demux() should be 'destroyable'", t => {
t.plan(2);
const _sleep = 100;
interface Chunk {
key: string;
mapped: string[];
}
const construct = (destKey: string) => {
const first = map(async (chunk: Chunk) => {
await sleep(_sleep);
chunk.mapped.push(destKey);
return chunk;
});
return first;
};
const _demux = demux(construct, "key");
const fakeSource = new Readable({
objectMode: true,
read() {
return;
},
});
const fakeSink = new Writable({
objectMode: true,
write(data, enc, cb) {
const cur = input.shift();
t.is(cur.key, data.key);
t.deepEqual(cur.mapped, ["a"]);
if (cur.key === "a") {
_demux.destroy();
}
cb();
},
});
_demux.on("close", t.end);
fakeSource.pipe(_demux).pipe(fakeSink);
const input = [
{ key: "a", mapped: [] },
{ key: "b", mapped: [] },
{ key: "c", mapped: [] },
{ key: "d", mapped: [] },
{ key: "e", mapped: [] },
];
fakeSource.push(input[0]);
fakeSource.push(input[1]);
fakeSource.push(input[2]);
fakeSource.push(input[3]);
fakeSource.push(input[4]);
});
test.cb("Should delete idle pipelines", t => {
t.plan(5);
const input = [
{ key: "a", visited: [] },
{ key: "b", visited: [] },
{ key: "b", visited: [] },
{ key: "a", visited: [] },
{ key: "b", visited: [] },
{ key: "c", visited: [] },
];
const construct = sinon.spy((destKey: string) => {
const dest = map((chunk: Test) => {
chunk.visited.push(1);
return chunk;
});
t.pass();
return dest;
});
const demuxed = demux(construct, "key", {
maxIdleTime: 110,
purgeIdleInterval: 110,
});
demuxed.on("data", data => {
if (data.key === "c") t.end();
});
for (let i = 0; i < input.length; i++) {
setTimeout(() => {
demuxed.write(input[i]);
}, i * 100);
}
});

View File

@@ -1,4 +1,4 @@
import { Readable } from "stream";
import { Readable, finished } from "stream";
import test from "ava";
import { expect } from "chai";
import mhysa from "../src";
@@ -26,13 +26,17 @@ test.cb("parse() parses the streamed elements as JSON", t => {
});
test.cb("parse() emits errors on invalid JSON", t => {
t.plan(2);
t.plan(1);
const source = new Readable({ objectMode: true });
source
.pipe(parse())
.resume()
.on("error", () => t.pass())
.on("end", t.end);
.on("error", (d: any) => {
t.pass();
t.end();
})
.on("end", t.fail);
source.push("{}");
source.push({});

View File

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

2722
yarn.lock

File diff suppressed because it is too large Load Diff