3.0.33

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.0.24",
+  "version": "3.0.33",
   "private": false,
   "description": "simplifies access to node streams",
   "main": "dist_ts/index.js",
@@ -22,15 +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.84",
+    "@git.zone/tstest": "^1.0.86",
-    "@push.rocks/smartfile": "^11.0.0",
+    "@push.rocks/smartfile": "^11.0.4",
     "@push.rocks/tapbundle": "^5.0.15",
-    "@types/node": "^20.9.0"
+    "@types/node": "^20.11.20"
   },
   "dependencies": {
-    "@push.rocks/lik": "^6.0.12",
+    "@push.rocks/lik": "^6.0.14",
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7"
   },

test/assets/writabletext.txt

@@ -10,3 +10,41 @@ hi+wow
 hi+wow
 hi+wow
 hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow

test/test.backpressure.ts

@@ -19,15 +19,15 @@ tap.test('should run backpressure test', async (toolsArg) => {
       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);
+        await tools.push(chunk);
-        return 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, 100)); // Slow processing
+        await new Promise((resolve) => setTimeout(resolve, 200)); // Slow processing
         console.log(`processed chunk ${chunk} in stream 3`);
       },
     });

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.0.24',
+  version: '3.0.33',
   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,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();
-      });
-    }
-  }
-}

ts/smartstream.classes.smartduplex.ts

@@ -15,12 +15,30 @@ export interface IStreamFinalFunction<rT> {
 }
 
 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>;
+
+  /**
+   * 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>;
-  // Add other custom options if necessary
 }
 
 export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
@@ -35,7 +53,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
   }
 
   // INSTANCE
-  private backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>();
+  private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
   public options: ISmartDuplexOptions<TInput, TOutput>;
   private observableSubscription?: plugins.smartrx.rxjs.Subscription;
   private debugLog(messageArg: string) {
@@ -45,8 +63,11 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
   }
 
   constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
-    super(optionsArg);
+    super(Object.assign({
+      highWaterMark: 1,
+    }, optionsArg));
     this.options = optionsArg;
+    this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
   }
 
   public async _read(size: number): Promise<void> {
@@ -59,12 +80,19 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
     let canPushMore = true; 
     while(this.backpressuredArray.data.length > 0 && canPushMore) {
       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>>();
   // Ensure the _write method types the chunk as TInput and encodes TOutput
   public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
@@ -80,13 +108,8 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
         callback();
       },
       push: async (pushArg: TOutput) => {
-        const canPushMore = this.backpressuredArray.push(pushArg);
+        await this.backpressuredPush(pushArg);
-        if (!canPushMore) {
+      }
-          this.debugLog(`${this.options.name}: cannot push more`);
-          await this.backpressuredArray.waitForSpace();
-          this.debugLog(`${this.options.name}: can push more again`);
-        }
-      },
     };
 
     try {

ts/smartstream.functions.ts

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