3.0.34

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.0.6",
+  "version": "3.0.34",
   "private": false,
   "description": "simplifies access to node streams",
   "main": "dist_ts/index.js",
@@ -22,14 +22,15 @@
   },
   "homepage": "https://gitlab.com/push.rocks/smartstream#readme",
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsbuild": "^2.1.72",
     "@git.zone/tsrun": "^1.2.44",
-    "@git.zone/tstest": "^1.0.77",
+    "@git.zone/tstest": "^1.0.88",
-    "@push.rocks/smartfile": "^10.0.37",
+    "@push.rocks/smartfile": "^11.0.4",
-    "@push.rocks/tapbundle": "^5.0.15",
+    "@push.rocks/tapbundle": "^5.0.17",
-    "@types/node": "^20.8.10"
+    "@types/node": "^20.11.28"
   },
   "dependencies": {
+    "@push.rocks/lik": "^6.0.14",
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7"
   },

test/assets/writabletext.txt

@@ -44,7 +44,4 @@ hi+wow
 hi+wow
 hi+wow
 hi+wow
-hi+wow
+hi
-hi+wow
-hi+wow
-hi+wow

test/test.backpressure.ts

@@ -0,0 +1,68 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import { SmartDuplex, type ISmartDuplexOptions, StreamWrapper } from '../ts/index.js';
+
+tap.test('should run backpressure test', async (toolsArg) => {
+  const done = toolsArg.defer();
+  async function testBackpressure() {
+    const stream1 = new SmartDuplex({
+      name: 'stream1',
+      objectMode: true,
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 10)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 1`);
+        return chunk; // Fast processing
+      },
+    });
+    const stream2 = new SmartDuplex({
+      name: 'stream2',
+      objectMode: true,
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 20)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 2`);
+        await tools.push(chunk);
+        // return chunk, optionally return ;
+      },
+    }); // This stream processes data more slowly
+    const stream3 = new SmartDuplex({
+      objectMode: true,
+      name: 'stream3',
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 200)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 3`);
+      },
+    });
+
+    stream1.pipe(stream2).pipe(stream3);
+
+    let backpressured = false;
+    for (let i = 0; i < 200; i++) {
+      const canContinue = stream1.write(`Chunk ${i}`, 'utf8');
+      if (!canContinue) {
+        backpressured = true;
+        console.log(`Backpressure at chunk ${i}`);
+      }
+    }
+
+    stream1.end();
+
+    stream1.on('finish', () => {
+      console.log('Stream 1 finished processing.');
+    });
+    stream2.on('finish', () => {
+      console.log('Stream 2 finished processing.');
+    });
+    stream3.on('finish', () => {
+      console.log('Stream 3 finished processing.');
+      if (!backpressured) {
+        throw new Error('No backpressure was observed.');
+      } else {
+        done.resolve();
+      }
+    });
+  }
+
+  testBackpressure();
+  await done.promise;
+});
+
+await tap.start();

test/test.smartstream.ts

@@ -5,7 +5,7 @@ import * as fs from 'fs';
 
 tap.test('should create a SmartStream from a Buffer', async () => {
   const bufferData = Buffer.from('This is a test buffer');
-  const smartStream = SmartDuplex.fromBuffer(bufferData);
+  const smartStream = SmartDuplex.fromBuffer(bufferData, {});
   
   let receivedData = Buffer.alloc(0);
   
@@ -21,24 +21,4 @@ tap.test('should create a SmartStream from a Buffer', async () => {
   });
 });
 
-tap.test('should create a SmartStream from an Observable', async () => {
-  const observableData = 'Observable test data';
-  const testObservable = smartrx.rxjs.of(Buffer.from(observableData));
-  
-  const smartStream = SmartDuplex.fromObservable(testObservable);
-  
-  let receivedData = Buffer.alloc(0);
-
-  return new Promise<void>((resolve) => {
-    smartStream.on('data', (chunk: Buffer) => {
-      receivedData = Buffer.concat([receivedData, chunk]);
-    });
-
-    smartStream.on('end', () => {
-      expect(receivedData.toString()).toEqual(observableData);
-      resolve();
-    });
-  });
-});
-
 tap.start();

test/test.streamfunction.ts

@@ -10,7 +10,7 @@ tap.test('should handle a read stream', async (tools) => {
   const streamWrapper = new smartstream.StreamWrapper([
     smartfile.fsStream.createReadStream('./test/assets/readabletext.txt'),
     new smartstream.SmartDuplex({
-      writeAndTransformFunction: async (chunkStringArg: Buffer, streamTools) => {
+      writeFunction: async (chunkStringArg: Buffer, streamTools) => {
         // do something with the stream here
         const result = chunkStringArg.toString().substr(0, 100);
         streamTools.push('wow =========== \n');
@@ -21,7 +21,7 @@ tap.test('should handle a read stream', async (tools) => {
       },
     }),
     new smartstream.SmartDuplex({
-      writeAndTransformFunction: async (chunkStringArg) => {
+      writeFunction: async (chunkStringArg) => {
         console.log(chunkStringArg.toString());
       },
       finalFunction: async (tools) => {
@@ -29,7 +29,7 @@ tap.test('should handle a read stream', async (tools) => {
       },
     })
   ]);
-  // await streamWrapper.run();
+  await streamWrapper.run();
 });
 
 tap.test('should create a valid Intake', async (tools) => {
@@ -37,7 +37,7 @@ tap.test('should create a valid Intake', async (tools) => {
   testIntake.pipe(
       new smartstream.SmartDuplex({
         objectMode: true,
-        writeAndTransformFunction: async (chunkStringArg: string, streamTools) => {
+        writeFunction: async (chunkStringArg: string, streamTools) => {
           await tools.delayFor(100);
           console.log(chunkStringArg);
           return chunkStringArg;

ts/00_commitinfo_data.ts

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

ts/index.ts

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

ts/smartstream.classes.passthrough.ts

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

ts/smartstream.classes.smartduplex.ts

@@ -3,175 +3,158 @@ import { Duplex, type DuplexOptions } from 'stream';
 
 export interface IStreamTools {
   truncate: () => void;
-  push: (pipeObject: any) => void;
+  push: (pipeObject: any) => Promise<boolean>;
 }
 
-export interface IWriteAndTransformFunction<T, rT> {
+export interface IStreamWriteFunction<T, rT> {
   (chunkArg: T, toolsArg: IStreamTools): Promise<rT>;
 }
 
-export interface IStreamEndFunction<rT> {
+export interface IStreamFinalFunction<rT> {
   (toolsArg: IStreamTools): Promise<rT>;
 }
 
-export interface SmartStreamOptions<TInput, TOutput> extends DuplexOptions {
+export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
+  /**
+   * wether to print debug logs
+   */
+  debug?: boolean;
+  /**
+   * the name of the stream
+   */
+  name?: string;
+  /**
+   * a function that is being called to read more stuff from whereever to be processed by the stream
+   * @returns
+   */
   readFunction?: () => Promise<void>;
-  writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
+
-  finalFunction?: IStreamEndFunction<TOutput>;
+  /**
-  // Add other custom options if necessary
+   * the write function is called for every chunk that is being written to the stream
+   * it can push or return chunks (but does not have to) to be written to the readable side of the stream
+   */
+  writeFunction?: IStreamWriteFunction<TInput, TOutput>;
+  
+  /**
+   * a final function that is run at the end of the stream 
+   */
+  finalFunction?: IStreamFinalFunction<TOutput>;
 }
 
 export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
   // STATIC
-  static fromBuffer(buffer: Buffer, options?: DuplexOptions): SmartDuplex {
+  static fromBuffer(buffer: Buffer, options?: ISmartDuplexOptions<any, any>): SmartDuplex {
-    const smartStream = new SmartDuplex(options);
+    const smartDuplex = new SmartDuplex(options);
     process.nextTick(() => {
-      smartStream.push(buffer);
+      smartDuplex.push(buffer);
-      smartStream.push(null); // Signal the end of the data
+      smartDuplex.push(null); // Signal the end of the data
     });
-    return smartStream;
+    return smartDuplex;
-  }
-
-  static fromObservable(
-    observable: plugins.smartrx.rxjs.Observable<any>,
-    options?: DuplexOptions
-  ): SmartDuplex {
-    const smartStream = new SmartDuplex(options);
-    smartStream.observableSubscription = observable.subscribe({
-      next: (data) => {
-        if (!smartStream.push(data)) {
-          // Pause the observable if the stream buffer is full
-          smartStream.observableSubscription?.unsubscribe();
-          smartStream.once('drain', () => {
-            // Resume the observable when the stream buffer is drained
-            smartStream.observableSubscription?.unsubscribe();
-            smartStream.observableSubscription = observable.subscribe((data) => {
-              smartStream.push(data);
-            });
-          });
-        }
-      },
-      error: (err) => {
-        smartStream.emit('error', err);
-      },
-      complete: () => {
-        smartStream.push(null); // Signal the end of the data
-      },
-    });
-
-    return smartStream;
-  }
-
-  static fromReplaySubject(
-    replaySubject: plugins.smartrx.rxjs.ReplaySubject<any>,
-    options?: DuplexOptions
-  ): SmartDuplex {
-    const smartStream = new SmartDuplex(options);
-    let isBackpressured = false;
-
-    // Subscribe to the ReplaySubject
-    const subscription = replaySubject.subscribe({
-      next: (data) => {
-        const canPush = smartStream.push(data);
-        if (!canPush) {
-          // If push returns false, pause the subscription because of backpressure
-          isBackpressured = true;
-          subscription.unsubscribe();
-        }
-      },
-      error: (err) => {
-        smartStream.emit('error', err);
-      },
-      complete: () => {
-        smartStream.push(null); // End the stream when the ReplaySubject completes
-      },
-    });
-
-    // Listen for 'drain' event to resume the subscription if it was paused
-    smartStream.on('drain', () => {
-      if (isBackpressured) {
-        isBackpressured = false;
-        // Resubscribe to the ReplaySubject since we previously paused
-        smartStream.observableSubscription = replaySubject.subscribe({
-          next: (data) => {
-            if (!smartStream.push(data)) {
-              smartStream.observableSubscription?.unsubscribe();
-              isBackpressured = true;
-            }
-          },
-          // No need to repeat error and complete handling here because it's already set up above
-        });
-      }
-    });
-
-    return smartStream;
   }
 
   // INSTANCE
-  private readFunction?: () => Promise<void>;
+  private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
-  private writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
+  public options: ISmartDuplexOptions<TInput, TOutput>;
-  private streamEndFunction?: IStreamEndFunction<TOutput>;
   private observableSubscription?: plugins.smartrx.rxjs.Subscription;
+  private debugLog(messageArg: string) {
+    if (this.options.debug) {
+      console.log(messageArg);
+    }
+  }
 
-  constructor(optionsArg?: SmartStreamOptions<TInput, TOutput>) {
+  constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
-    super(optionsArg);
+    super(Object.assign({
-    this.readFunction = optionsArg?.readFunction;
+      highWaterMark: 1,
-    this.writeAndTransformFunction = optionsArg?.writeAndTransformFunction;
+    }, optionsArg));
-    this.streamEndFunction = optionsArg?.finalFunction;
+    this.options = optionsArg;
+    this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
   }
 
   public async _read(size: number): Promise<void> {
-    if (this.readFunction) {
+    this.debugLog(`${this.options.name}: read was called`);
-      await this.readFunction();
+    await this.backpressuredArray.waitForItems();
+    this.debugLog(`${this.options.name}: successfully waited for items.`);
+    if (this.options.readFunction) {
+      await this.options.readFunction();
+    }
+    let canPushMore = true; 
+    while(this.backpressuredArray.data.length > 0 && canPushMore) {
+      const nextChunk = this.backpressuredArray.shift();
+      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`);
+    }
+    return canPushMore;
+  };
+
+  private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
   // Ensure the _write method types the chunk as TInput and encodes TOutput
   public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
-    if (!this.writeAndTransformFunction) {
+    if (!this.options.writeFunction) {
       return callback(new Error('No stream function provided'));
     }
 
+    let isTruncated = false;
     const tools: IStreamTools = {
       truncate: () => {
         this.push(null);
+        isTruncated = true;
         callback();
       },
-      push: (pushArg: TOutput) => this.push(pushArg),
+      push: async (pushArg: TOutput) => {
+        return await this.backpressuredPush(pushArg);
+      }
     };
 
     try {
-      const modifiedChunk = await this.writeAndTransformFunction(chunk, tools);
+      const writeDeferred = plugins.smartpromise.defer();
+      this.asyncWritePromiseObjectmap.add(writeDeferred.promise);
+      const modifiedChunk = await this.options.writeFunction(chunk, tools);
+      if (isTruncated) {
+        return;
+      }
       if (modifiedChunk) {
-        if (!this.push(modifiedChunk)) {
+        await tools.push(modifiedChunk);
-          // Handle backpressure if necessary
-        }
       }
       callback();
+      writeDeferred.resolve();
+      writeDeferred.promise.then(() => {
+        this.asyncWritePromiseObjectmap.remove(writeDeferred.promise);
+      });
     } catch (err) {
       callback(err);
     }
   }
 
   public async _final(callback: (error?: Error | null) => void) {
-    if (this.streamEndFunction) {
+    await Promise.all(this.asyncWritePromiseObjectmap.getArray());
+    if (this.options.finalFunction) {
       const tools: IStreamTools = {
         truncate: () => callback(),
-        push: (pipeObject) => this.push(pipeObject),
+        push: async (pipeObject) => {
+          return this.backpressuredArray.push(pipeObject);
+        },
       };
 
       try {
-        const finalChunk = await this.streamEndFunction(tools);
+        const finalChunk = await this.options.finalFunction(tools);
         if (finalChunk) {
-          this.push(finalChunk);
+          this.backpressuredArray.push(finalChunk);
         }
-        callback();
       } catch (err) {
+        this.backpressuredArray.push(null);
         callback(err);
+        return;
       }
-    } else {
-      this.push(null),
-      callback();
     }
+    this.backpressuredArray.push(null);
+    callback();
   }
 }

ts/smartstream.functions.ts

@@ -1,4 +1,5 @@
 import { Transform, type TransformCallback, type TransformOptions } from 'stream';
+import { SmartDuplex } from './smartstream.classes.smartduplex.js';
 
 export interface AsyncTransformFunction<TInput, TOutput> {
   (chunkArg: TInput): Promise<TOutput>;
@@ -7,20 +8,23 @@ export interface AsyncTransformFunction<TInput, TOutput> {
 export function createTransformFunction<TInput, TOutput>(
   asyncFunction: AsyncTransformFunction<TInput, TOutput>,
   options?: TransformOptions
-): Transform {
+): SmartDuplex {
-  const transformStream = new Transform({
+  const smartDuplexStream = new SmartDuplex({
     ...options,
-    objectMode: true, // Ensure we operate in object mode
+    writeFunction: async (chunkArg, toolsArg) => {
-    async transform(chunk: TInput, encoding: string, callback: TransformCallback) {
+      const result = await asyncFunction(chunkArg);
-      try {
+      return result;
-        const transformed = await asyncFunction(chunk);
-        this.push(transformed);
-        callback();
-      } catch (error) {
-        callback(error instanceof Error ? error : new Error(String(error)));
-      }
     }
   });
 
-  return transformStream;
+  return smartDuplexStream;
+}
+
+export const createPassThrough = () => {
+  return new SmartDuplex({
+    objectMode: true,
+    writeFunction: async (chunkArg, toolsArg) => {
+      return chunkArg;
+    }
+  })
 }

ts/smartstream.plugins.ts

@@ -4,8 +4,9 @@ import * as stream from 'stream';
 export { stream };
 
 // pushrocks scope
+import * as lik from '@push.rocks/lik';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrx from '@push.rocks/smartrx';
 
-export { smartpromise, smartrx };
+export { lik, smartpromise, smartrx };