Compare commits

...

16 Commits

Author SHA1 Message Date
ba0a2023ad 3.0.29 2023-11-14 10:43:18 +01:00
a09c359847 fix(core): update 2023-11-14 10:43:17 +01:00
e2b4d772b3 3.0.28 2023-11-14 10:29:44 +01:00
0f46b62b2d fix(core): update 2023-11-14 10:29:44 +01:00
9bf37469c6 3.0.27 2023-11-13 21:38:13 +01:00
12bb125bdc fix(core): update 2023-11-13 21:38:12 +01:00
703dc11c6c 3.0.26 2023-11-13 20:34:22 +01:00
28725d1723 fix(core): update 2023-11-13 20:34:21 +01:00
c77e0f2ba6 3.0.25 2023-11-13 19:12:24 +01:00
196fb6d396 fix(core): update 2023-11-13 19:12:23 +01:00
df0ddf04b3 3.0.24 2023-11-13 19:06:02 +01:00
2e1aa4a8ff fix(core): update 2023-11-13 19:06:02 +01:00
bc09033af0 3.0.23 2023-11-13 18:41:05 +01:00
22df9dfd94 fix(core): update 2023-11-13 18:41:04 +01:00
d48ef6eb43 3.0.22 2023-11-13 18:19:11 +01:00
9421c652a2 fix(core): update 2023-11-13 18:19:11 +01:00
8 changed files with 41 additions and 52 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "@push.rocks/smartstream", "name": "@push.rocks/smartstream",
"version": "3.0.21", "version": "3.0.29",
"private": false, "private": false,
"description": "simplifies access to node streams", "description": "simplifies access to node streams",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",

View File

@ -7,7 +7,6 @@ tap.test('should run backpressure test', async (toolsArg) => {
const stream1 = new SmartDuplex({ const stream1 = new SmartDuplex({
name: 'stream1', name: 'stream1',
objectMode: true, objectMode: true,
handleBackpressure: true,
writeFunction: async (chunk, tools) => { writeFunction: async (chunk, tools) => {
await new Promise((resolve) => setTimeout(resolve, 10)); // Slow processing await new Promise((resolve) => setTimeout(resolve, 10)); // Slow processing
console.log(`processed chunk ${chunk} in stream 1`); console.log(`processed chunk ${chunk} in stream 1`);
@ -17,19 +16,18 @@ tap.test('should run backpressure test', async (toolsArg) => {
const stream2 = new SmartDuplex({ const stream2 = new SmartDuplex({
name: 'stream2', name: 'stream2',
objectMode: true, objectMode: true,
handleBackpressure: true,
writeFunction: async (chunk, tools) => { writeFunction: async (chunk, tools) => {
await new Promise((resolve) => setTimeout(resolve, 20)); // Slow processing await new Promise((resolve) => setTimeout(resolve, 20)); // Slow processing
console.log(`processed chunk ${chunk} in stream 2`); console.log(`processed chunk ${chunk} in stream 2`);
return chunk; await tools.push(chunk);
// return chunk;
}, },
}); // This stream processes data more slowly }); // This stream processes data more slowly
const stream3 = new SmartDuplex({ const stream3 = new SmartDuplex({
objectMode: true, objectMode: true,
name: 'stream3', name: 'stream3',
handleBackpressure: true,
writeFunction: async (chunk, tools) => { writeFunction: async (chunk, tools) => {
await new Promise((resolve) => setTimeout(resolve, 100)); // Slow processing await new Promise((resolve) => setTimeout(resolve, 200)); // Slow processing
console.log(`processed chunk ${chunk} in stream 3`); console.log(`processed chunk ${chunk} in stream 3`);
}, },
}); });

View File

@ -5,9 +5,7 @@ import * as fs from 'fs';
tap.test('should create a SmartStream from a Buffer', async () => { tap.test('should create a SmartStream from a Buffer', async () => {
const bufferData = Buffer.from('This is a test buffer'); const bufferData = Buffer.from('This is a test buffer');
const smartStream = SmartDuplex.fromBuffer(bufferData, { const smartStream = SmartDuplex.fromBuffer(bufferData, {});
handleBackpressure: false,
});
let receivedData = Buffer.alloc(0); let receivedData = Buffer.alloc(0);

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartstream', name: '@push.rocks/smartstream',
version: '3.0.21', version: '3.0.29',
description: 'simplifies access to node streams' description: 'simplifies access to node streams'
} }

View File

@ -1,4 +1,3 @@
export * from './smartstream.classes.passthrough.js';
export * from './smartstream.classes.smartduplex.js'; export * from './smartstream.classes.smartduplex.js';
export * from './smartstream.classes.streamwrapper.js'; export * from './smartstream.classes.streamwrapper.js';
export * from './smartstream.classes.streamintake.js'; export * from './smartstream.classes.streamintake.js';

View File

@ -1,21 +0,0 @@
import * as plugins from './smartstream.plugins.js';
export class PassThrough extends plugins.stream.Duplex {
constructor(options?: plugins.stream.DuplexOptions) {
super(options);
}
_read(size: number): void {
// No-op: Data written will be automatically available for reading.
}
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
if (this.push(chunk, encoding)) {
callback();
} else {
this.once('drain', () => {
callback();
});
}
}
}

View File

@ -3,7 +3,7 @@ import { Duplex, type DuplexOptions } from 'stream';
export interface IStreamTools { export interface IStreamTools {
truncate: () => void; truncate: () => void;
push: (pipeObject: any) => void; push: (pipeObject: any) => Promise<void>;
} }
export interface IStreamWriteFunction<T, rT> { export interface IStreamWriteFunction<T, rT> {
@ -17,7 +17,6 @@ export interface IStreamFinalFunction<rT> {
export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions { export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
debug?: boolean; debug?: boolean;
name?: string; name?: string;
handleBackpressure?: boolean;
readFunction?: () => Promise<void>; readFunction?: () => Promise<void>;
writeFunction?: IStreamWriteFunction<TInput, TOutput>; writeFunction?: IStreamWriteFunction<TInput, TOutput>;
finalFunction?: IStreamFinalFunction<TOutput>; finalFunction?: IStreamFinalFunction<TOutput>;
@ -36,7 +35,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
} }
// INSTANCE // INSTANCE
private backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(); private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
public options: ISmartDuplexOptions<TInput, TOutput>; public options: ISmartDuplexOptions<TInput, TOutput>;
private observableSubscription?: plugins.smartrx.rxjs.Subscription; private observableSubscription?: plugins.smartrx.rxjs.Subscription;
private debugLog(messageArg: string) { private debugLog(messageArg: string) {
@ -46,8 +45,11 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
} }
constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) { constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
super(optionsArg); super(Object.assign({
highWaterMark: 4,
}, optionsArg));
this.options = optionsArg; this.options = optionsArg;
this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 4)
} }
public async _read(size: number): Promise<void> { public async _read(size: number): Promise<void> {
@ -60,11 +62,18 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
let canPushMore = true; let canPushMore = true;
while(this.backpressuredArray.data.length > 0 && canPushMore) { while(this.backpressuredArray.data.length > 0 && canPushMore) {
const nextChunk = this.backpressuredArray.shift(); const nextChunk = this.backpressuredArray.shift();
if (nextChunk) {
canPushMore = this.push(nextChunk); canPushMore = this.push(nextChunk);
} }
} }
public async backpressuredPush (pushArg: TOutput) {
const canPushMore = this.backpressuredArray.push(pushArg);
if (!canPushMore) {
this.debugLog(`${this.options.name}: cannot push more`);
await this.backpressuredArray.waitForSpace();
this.debugLog(`${this.options.name}: can push more again`);
} }
};
private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>(); private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
// Ensure the _write method types the chunk as TInput and encodes TOutput // Ensure the _write method types the chunk as TInput and encodes TOutput
@ -80,9 +89,9 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
isTruncated = true; isTruncated = true;
callback(); callback();
}, },
push: (pushArg: TOutput) => { push: async (pushArg: TOutput) => {
this.backpressuredArray.push(pushArg); await this.backpressuredPush(pushArg);
}, }
}; };
try { try {
@ -93,12 +102,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
return; return;
} }
if (modifiedChunk) { if (modifiedChunk) {
const canPushMore = this.backpressuredArray.push(modifiedChunk); await tools.push(modifiedChunk);
if (!canPushMore) {
this.debugLog(`${this.options.name}: cannot push more`);
await this.backpressuredArray.waitForSpace();
this.debugLog(`${this.options.name}: can push more again`);
}
} }
callback(); callback();
writeDeferred.resolve(); writeDeferred.resolve();
@ -115,21 +119,23 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
if (this.options.finalFunction) { if (this.options.finalFunction) {
const tools: IStreamTools = { const tools: IStreamTools = {
truncate: () => callback(), truncate: () => callback(),
push: (pipeObject) => this.push(pipeObject), push: async (pipeObject) => {
this.backpressuredArray.push(pipeObject);
},
}; };
try { try {
const finalChunk = await this.options.finalFunction(tools); const finalChunk = await this.options.finalFunction(tools);
if (finalChunk) { if (finalChunk) {
this.push(finalChunk); this.backpressuredArray.push(finalChunk);
} }
} catch (err) { } catch (err) {
this.push(null); this.backpressuredArray.push(null);
callback(err); callback(err);
return; return;
} }
} }
this.push(null); this.backpressuredArray.push(null);
callback(); callback();
} }
} }

View File

@ -19,3 +19,12 @@ export function createTransformFunction<TInput, TOutput>(
return smartDuplexStream; return smartDuplexStream;
} }
export const createPassThrough = () => {
return new SmartDuplex({
objectMode: true,
writeFunction: async (chunkArg, toolsArg) => {
return chunkArg;
}
})
}