Minor changes to types

* Add chunk to constructor

* Add test

* Bump version

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jogogo/mhysa",
-    "version": "0.0.1-beta.4",
+    "version": "2.0.0-alpha.4",
     "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": "ava",
-        "test:debug": "NODE_PATH=src node inspect node_modules/ava/profile.js",
-        "test:all": "NODE_PATH=src node node_modules/.bin/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"

src/functions/batch.ts

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

src/functions/compose.ts

@@ -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 = {
+export class Compose extends Transform {
-    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 {
     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) => {
+        pipeline(
-            this.emit("error", err);
+            [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) {
+    public _destroy(error: any, cb: (error?: any) => void) {
-        return (this.last as NodeJS.ReadableStream).pipe(dest);
+        this.streams.forEach(s => (s as any).destroy());
-    }
+        cb(error);
-
-    public _write(chunk: any, encoding: string, cb: any) {
-        (this.first as NodeJS.WritableStream).write(chunk, encoding, cb);
     }
 
     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;
-    }
 }

src/functions/demux.ts

@@ -1,99 +1,131 @@
-import { WritableOptions, Writable } from "stream";
+import { DuplexOptions, Duplex, Transform } from "stream";
 
-enum EventSubscription {
+import { isReadable } from "../helpers";
-    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,
-};
 
 type DemuxStreams = NodeJS.WritableStream | NodeJS.ReadWriteStream;
 
-export function demux(
+export interface DemuxOptions extends DuplexOptions {
-    construct: (destKey?: string) => DemuxStreams,
+    remultiplex?: boolean;
-    demuxBy: string | ((chunk: any) => string),
-    options?: WritableOptions,
-): Writable {
-    return new Demux(construct, demuxBy, options);
 }
 
-// @TODO handle pipe event ie) Multiplex
+export function demux(
-class Demux extends Writable {
+    pipelineConstructor: (
+        destKey?: string,
+        chunk?: any,
+    ) => DemuxStreams | DemuxStreams[],
+    demuxBy: string | ((chunk: any) => string),
+    options?: DemuxOptions,
+): Duplex {
+    return new Demux(pipelineConstructor, demuxBy, options);
+}
+
+class Demux extends Duplex {
     private streamsByKey: {
-        [key: string]: DemuxStreams;
+        [key: string]: DemuxStreams[];
     };
     private demuxer: (chunk: any) => string;
-    private construct: (destKey?: string) => DemuxStreams;
+    private pipelineConstructor: (
+        destKey?: string,
+        chunk?: any,
+    ) => DemuxStreams[];
+    private remultiplex: boolean;
+    private transform: Transform;
     constructor(
-        construct: (destKey?: string) => DemuxStreams,
+        pipelineConstructor: (
+            destKey?: string,
+            chunk?: any,
+        ) => DemuxStreams | 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.pipelineConstructor = (destKey: string, chunk?: any) => {
+            const pipeline = pipelineConstructor(destKey, chunk);
+            return Array.isArray(pipeline) ? pipeline : [pipeline];
+        };
+        this.remultiplex =
+            options.remultiplex === undefined ? true : options.remultiplex;
         this.streamsByKey = {};
+        this.transform = new Transform({
+            ...options,
+            transform: (d, _, cb) => {
+                this.push(d);
+                cb(null);
+            },
+        });
+
+        this.on("unpipe", () => this._flush());
     }
 
+    // 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 newPipelines = this.pipelineConstructor(destKey, chunk);
+            this.streamsByKey[destKey] = newPipelines;
+
+            newPipelines.forEach(newPipeline => {
+                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`,
+                    );
                 }
-        if (!this.streamsByKey[destKey].write(chunk, encoding)) {
-            this.streamsByKey[destKey].once("drain", () => {
-                cb();
             });
-        } else {
+        }
+        const pipelines = this.streamsByKey[destKey];
+        const pendingDrains: Array<Promise<any>> = [];
+
+        pipelines.forEach(pipeline => {
+            if (!pipeline.write(chunk, encoding)) {
+                pendingDrains.push(
+                    new Promise(resolve => {
+                        pipeline.once("drain", () => {
+                            resolve();
+                        });
+                    }),
+                );
+            }
+        });
+        await Promise.all(pendingDrains);
         cb();
     }
+
+    public _flush() {
+        const pipelines: DemuxStreams[] = [].concat.apply(
+            [],
+            Object.values(this.streamsByKey),
+        );
+        const flushPromises: Array<Promise<void>> = [];
+        pipelines.forEach(pipeline => {
+            flushPromises.push(
+                new Promise(resolve => {
+                    pipeline.once("end", () => {
+                        resolve();
+                    });
+                }),
+            );
+        });
+        pipelines.forEach(pipeline => pipeline.end());
+        Promise.all(flushPromises).then(() => {
+            this.push(null);
+            this.emit("end");
+        });
     }
 
-    public on(event: string, cb: any) {
+    public _destroy(error: any, cb: (error?: any) => void) {
-        switch (eventsTarget[event]) {
+        const pipelines: DemuxStreams[] = [].concat.apply(
-            case EventSubscription.Self:
+            [],
-                super.on(event, cb);
+            Object.values(this.streamsByKey),
-                break;
-            case EventSubscription.All:
-                Object.keys(this.streamsByKey).forEach(key =>
-                    this.streamsByKey[key].on(event, cb),
         );
-                break;
+        pipelines.forEach(p => (p as any).destroy());
-            default:
+        cb(error);
-                super.on(event, cb);
-        }
-        return this;
-    }
-
-    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;
     }
 }

src/functions/index.ts

@@ -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,9 +249,10 @@ 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.

src/functions/parse.ts

@@ -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) {
+                if (emitError) {
                     callback(err);
+                } else {
+                    callback();
+                }
             }
         },
     });

src/helpers.ts

@@ -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
+    );
+}

src/index.ts

@@ -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 };

src/utils/collected.ts

@@ -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);
+        });
+    });
+}

src/utils/index.ts

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

tests/batch.spec.ts

@@ -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();
+            });
+    },
+);

tests/compose.spec.ts

@@ -1,9 +1,10 @@
-const test = require("ava");
+import * as test from "ava";
-const { expect } = require("chai");
+import { expect } from "chai";
-const { sleep } = require("../src/helpers");
+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(
+    const composed = compose([first, second]);
-        [first, second],
-        { objectMode: true },
-    );
 
     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(
+    const composed = compose([first, second]);
-        [first, second],
-        { objectMode: true },
-    );
     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(
+        const first = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             chunk.mapped.push(1);
             return chunk;
-            },
+        });
-            {
-                objectMode: true,
-            },
-        );
 
-        const second = map(
+        const second = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             chunk.mapped.push(2);
             return chunk;
-            },
+        });
-            { objectMode: true },
-        );
 
         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) {
+        fromArray(input).pipe(composed);
-            const res = composed.write(item);
-            expect(composed._writableState.length).to.be.at.most(2);
-            t.pass();
-            if (!res) {
-                await sleep(10);
-            }
-        }
     });
 });
 
 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(
+        const first = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             await sleep(_rate);
             chunk.mapped.push(1);
             return chunk;
-            },
+        });
-            {
-                objectMode: true,
-            },
-        );
 
-        const second = map(
+        const second = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             chunk.mapped.push(2);
             return chunk;
-            },
+        });
-            { objectMode: true },
-        );
 
         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--;
+            t.deepEqual(chunk.mapped, [1, 2]);
-            if (pendingReads === 0) {
-                resolve();
-            }
         });
 
+        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: [] },
         ];
-
+        fromArray(input).pipe(composed);
-        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();
-            }
-        }
     });
 });
 
@@ -255,28 +210,23 @@ test.cb(
             key: string;
             mapped: number[];
         }
-        const first = map(
+        const first = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             await sleep(_rate);
             chunk.mapped.push(1);
             return chunk;
-            },
+        });
-            {
-                objectMode: true,
-            },
-        );
 
-        const second = map(
+        const second = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             chunk.mapped.push(2);
             return chunk;
-            },
+        });
-            { objectMode: true },
-        );
 
         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(
+        const first = map((chunk: Chunk) => {
-            (chunk: Chunk) => {
             chunk.mapped.push(1);
             return chunk;
-            },
+        });
-            {
-                objectMode: true,
-            },
-        );
 
         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(
+        const first = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             await sleep(_rate);
             chunk.mapped.push(1);
             return chunk;
-            },
+        });
-            {
-                objectMode: true,
-            },
-        );
 
-        const second = map(
+        const second = map(async (chunk: Chunk) => {
-            async (chunk: Chunk) => {
             chunk.mapped.push(2);
             return chunk;
-            },
+        });
-            { objectMode: true },
-        );
 
         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);
+});

tests/demux.spec.ts

@@ -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));
+    fromArray(input).pipe(demuxed);
-    demuxed.end();
+});
+
+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));
+    fromArray(input).pipe(demuxed);
-    demuxed.end();
 });
 
 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));
+    fromArray(input).pipe(demuxed);
-    demuxed.end();
 });
 
 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));
+    fromArray(input).pipe(demuxed);
-    demuxed.end();
 });
 
-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(
+test.cb(
-    "demux() should emit drain event when third stream is bottleneck",
+    "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 => {
+        fromArray(input).pipe(_demux);
-            _demux.write(item);
-        });
     },
 );
 
 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 => {
+        fromArray(input).pipe(_demux);
-            _demux.write(item);
-        });
     },
 );
 
@@ -536,10 +550,21 @@ 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 => {
+            return first;
+        };
+
+        const _demux = demux(construct, "key", {
+            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(
@@ -550,22 +575,12 @@ test("demux() should be blocked by slowest pipeline", t => {
                 resolve();
             }
         });
-            return first;
-        };
-        const _demux = demux(construct, "key", {
-            objectMode: true,
-            highWaterMark: 1,
-        });
-        _demux.on("error", err => {
-            reject(err);
-        });
 
         const input = [
             { key: "a", mapped: [] },
             { key: "a", mapped: [] },
             { key: "c", mapped: [] },
             { key: "c", mapped: [] },
-            { key: "c", mapped: [] },
             { key: "b", mapped: [] },
         ];
 
@@ -584,74 +599,266 @@ test("demux() should be blocked by slowest pipeline", t => {
     });
 });
 
-test("demux() should emit drain event when second stream in pipeline is bottleneck", t => {
+test.cb("Demux should remux to sink", t => {
-    t.plan(5);
+    t.plan(6);
-    const highWaterMark = 3;
+    let i = 0;
-    return new Promise(async (resolve, reject) => {
+    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 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;
+        });
+
+        return dest;
+    };
+
+    const demuxed = demux(construct, "key", {});
+
+    fromArray(input).pipe(demuxed);
+
+    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[];
     }
-        const sink = new Writable({
+
-            objectMode: true,
+    t.plan(9);
-            write(chunk, encoding, cb) {
-                expect(chunk.mapped).to.deep.equal([1, 2]);
-                t.pass();
-                cb();
-                if (pendingReads === 0) {
-                    resolve();
-                }
-            },
-        });
 
     const construct = (destKey: string) => {
-            const first = map(
+        const dest = map((chunk: any) => {
-                (chunk: Chunk) => {
+            chunk.mapped.push(destKey);
-                    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 },
-            );
-
-            first.pipe(second).pipe(sink);
-            return first;
     };
 
     const _demux = demux(construct, "key", {
-            objectMode: true,
+        highWaterMark: 3,
-            highWaterMark,
-        });
-        _demux.on("error", err => {
-            reject();
     });
 
-        _demux.on("drain", () => {
+    const fakeSource = new Readable({
-            expect(_demux._writableState.length).to.be.equal(0);
+        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: "a", mapped: [] },
+        { key: "b", mapped: [] },
     ];
-        let pendingReads = input.length;
+    fakeSource.push(input[0]);
-
+    fakeSource.push(input[1]);
-        input.forEach(item => {
+    fakeSource.push(null);
-            _demux.write(item);
+});
-        });
+
-    });
+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]);
 });

tests/parse.spec.ts

@@ -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("error", (d: any) => {
-        .on("end", t.end);
+            t.pass();
+            t.end();
+        })
+        .on("end", t.fail);
 
     source.push("{}");
     source.push({});

tests/utils/collected.spec.ts

@@ -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]);
+});