Merge pull request #84 from MatrixAI/feature-read-buffer-fix

fix: added `readableChunkSize` parameter to config and defaulted the …

Author: tegefaulkes

package-lock.json

@@ -239,21 +239,11 @@ class QUICStream implements ReadableWritablePair<Uint8Array, Uint8Array> {
     // This will setup the readable chunk buffer with the size set to the
     // configured per-stream buffer size. Note that this doubles the memory
     // usage of each stream due to maintaining both the Rust and JS buffers
-    if (this.type === 'uni') {
-      if (initiated === 'local') {
-        // We expect the readable stream to be closed
-        this.readableChunk = undefined;
-      } else if (initiated === 'peer') {
-        this.readableChunk = Buffer.allocUnsafe(config.initialMaxStreamDataUni);
-      }
-    } else if (this.type === 'bidi' && initiated === 'local') {
-      this.readableChunk = Buffer.allocUnsafe(
-        config.initialMaxStreamDataBidiLocal,
-      );
-    } else if (this.type === 'bidi' && initiated === 'peer') {
-      this.readableChunk = Buffer.allocUnsafe(
-        config.initialMaxStreamDataBidiRemote,
-      );
+    if (this.type === 'uni' && initiated === 'local') {
+      // We expect the readable stream to be closed
+      this.readableChunk = undefined;
+    } else {
+      this.readableChunk = Buffer.allocUnsafe(config.readableChunkSize);
     }
     if (this.type === 'uni' && initiated === 'local') {
       // This is just a dummy stream that will be auto-closed during creation

src/QUICStream.ts

@@ -61,6 +61,7 @@ const clientDefault: QUICConfig = {
   disableActiveMigration: true,
   applicationProtos: ['quic'],
   enableEarlyData: true,
+  readableChunkSize: 4 * 1024,
 };
 
 const serverDefault: QUICConfig = {
@@ -83,6 +84,7 @@ const serverDefault: QUICConfig = {
   disableActiveMigration: true,
   applicationProtos: ['quic'],
   enableEarlyData: true,
+  readableChunkSize: 4 * 1024,
 };
 
 /**

src/config.ts

@@ -177,7 +177,7 @@ type QUICConfig = {
   logKeys?: string;
 
   /**
-   * Enable "Generate Random extensions and Sustain Extensibilty".
+   * Enable "Generate Random extensions and Sustain Extensibility".
    * This prevents protocol ossification by periodically introducing
    * random no-op values in the optional fields in TLS.
    * This defaults to true.
@@ -305,6 +305,12 @@ type QUICConfig = {
   applicationProtos: string[];
 
   enableEarlyData: boolean;
+
+  /**
+   * Defines the size of the Buffer used to read out data from the readable stream.
+   * This affects amount of memory reserved by the stream.
+   */
+  readableChunkSize: number;
 };
 
 type QUICClientConfigInput = Partial<QUICConfig>;