feat(csv-generate): set highWaterMark to default

adaltas · Oct 5, 2023 · 8e758cf · 8e758cf
1 parent b1da5a1
commit 8e758cf
Show file tree

Hide file tree

Showing 12 changed files with 44 additions and 25 deletions.
diff --git a/packages/csv-generate/dist/cjs/index.cjs b/packages/csv-generate/dist/cjs/index.cjs
@@ -54,11 +54,13 @@ const normalize_options = (opts) => {
   if(opts.object_mode){
     opts.objectMode = opts.object_mode;
   }
-  opts.objectMode = opts.objectMode ?? false;
   if(opts.high_water_mark){
     opts.highWaterMark = opts.high_water_mark;
   }
-  opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
+  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+  // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+  // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+  // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
   // Clone and camelize options
   const options = {};
   for(const k in opts){

diff --git a/packages/csv-generate/dist/cjs/sync.cjs b/packages/csv-generate/dist/cjs/sync.cjs
@@ -54,11 +54,13 @@ const normalize_options = (opts) => {
   if(opts.object_mode){
     opts.objectMode = opts.object_mode;
   }
-  opts.objectMode = opts.objectMode ?? false;
   if(opts.high_water_mark){
     opts.highWaterMark = opts.high_water_mark;
   }
-  opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
+  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+  // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+  // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+  // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
   // Clone and camelize options
   const options = {};
   for(const k in opts){

diff --git a/packages/csv-generate/dist/esm/index.js b/packages/csv-generate/dist/esm/index.js
@@ -5245,11 +5245,13 @@ const normalize_options = (opts) => {
   if(opts.object_mode){
     opts.objectMode = opts.object_mode;
   }
-  opts.objectMode = opts.objectMode ?? false;
   if(opts.high_water_mark){
     opts.highWaterMark = opts.high_water_mark;
   }
-  opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+  // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+  // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+  // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
   // Clone and camelize options
   const options = {};
   for(const k in opts){

diff --git a/packages/csv-generate/dist/esm/sync.js b/packages/csv-generate/dist/esm/sync.js
@@ -5245,11 +5245,13 @@ const normalize_options = (opts) => {
   if(opts.object_mode){
     opts.objectMode = opts.object_mode;
   }
-  opts.objectMode = opts.objectMode ?? false;
   if(opts.high_water_mark){
     opts.highWaterMark = opts.high_water_mark;
   }
-  opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+  // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+  // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+  // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
   // Clone and camelize options
   const options = {};
   for(const k in opts){

diff --git a/packages/csv-generate/dist/iife/index.js b/packages/csv-generate/dist/iife/index.js
@@ -5248,11 +5248,13 @@ var csv_generate = (function (exports) {
               if(opts.object_mode){
                 opts.objectMode = opts.object_mode;
               }
-              opts.objectMode = opts.objectMode ?? false;
               if(opts.high_water_mark){
                 opts.highWaterMark = opts.high_water_mark;
               }
-              opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+              // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+              // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+              // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+              // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
               // Clone and camelize options
               const options = {};
               for(const k in opts){

diff --git a/packages/csv-generate/dist/iife/sync.js b/packages/csv-generate/dist/iife/sync.js
@@ -5248,11 +5248,13 @@ var csv_generate_sync = (function (exports) {
               if(opts.object_mode){
                 opts.objectMode = opts.object_mode;
               }
-              opts.objectMode = opts.objectMode ?? false;
               if(opts.high_water_mark){
                 opts.highWaterMark = opts.high_water_mark;
               }
-              opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+              // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+              // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+              // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+              // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
               // Clone and camelize options
               const options = {};
               for(const k in opts){

diff --git a/packages/csv-generate/dist/umd/index.js b/packages/csv-generate/dist/umd/index.js
@@ -5251,11 +5251,13 @@
               if(opts.object_mode){
                 opts.objectMode = opts.object_mode;
               }
-              opts.objectMode = opts.objectMode ?? false;
               if(opts.high_water_mark){
                 opts.highWaterMark = opts.high_water_mark;
               }
-              opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+              // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+              // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+              // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+              // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
               // Clone and camelize options
               const options = {};
               for(const k in opts){

diff --git a/packages/csv-generate/dist/umd/sync.js b/packages/csv-generate/dist/umd/sync.js
@@ -5251,11 +5251,13 @@
               if(opts.object_mode){
                 opts.objectMode = opts.object_mode;
               }
-              opts.objectMode = opts.objectMode ?? false;
               if(opts.high_water_mark){
                 opts.highWaterMark = opts.high_water_mark;
               }
-              opts.highWaterMark = opts.highWaterMark ?? Stream.getDefaultHighWaterMark(opts.objectMode);
+              // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+              // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+              // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+              // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
               // Clone and camelize options
               const options = {};
               for(const k in opts){

diff --git a/packages/csv-generate/lib/api/normalize_options.js b/packages/csv-generate/lib/api/normalize_options.js
@@ -9,12 +9,16 @@ const camelize = function(str){
 
 const normalize_options = (opts) => {
   // Convert Stream Readable options if underscored
-  if(opts.high_water_mark){
-    opts.highWaterMark = opts.high_water_mark;
-  }
   if(opts.object_mode){
     opts.objectMode = opts.object_mode;
   }
+  if(opts.high_water_mark){
+    opts.highWaterMark = opts.high_water_mark;
+  }
+  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
+  // Node.js 20 introduced `stream.getDefaultHighWaterMark(opts.objectMode)`
+  // opts.highWaterMark = opts.highWaterMark ?? (opts.objectMode ? 16 : 16384);
+  // opts.highWaterMark = opts.highWaterMark ?? stream.getDefaultHighWaterMark(opts.objectMode);
   // Clone and camelize options
   const options = {};
   for(const k in opts){
@@ -60,4 +64,4 @@ const normalize_options = (opts) => {
   return options;
 };
 
-export {normalize_options};
+export { normalize_options };
diff --git a/packages/csv-generate/lib/sync.js b/packages/csv-generate/lib/sync.js
@@ -22,8 +22,6 @@ const generate = function(options){
   }
   const chunks = [];
   let work = true;
-  // See https://nodejs.org/api/stream.html#stream_new_stream_readable_options
-  options.highWaterMark = options.objectMode ? 16 : 16384;
   const generator = new Generator(options);
   generator.push = function(chunk){
     if(chunk === null){

diff --git a/packages/csv-generate/test/api.types.ts b/packages/csv-generate/test/api.types.ts
@@ -27,7 +27,8 @@ describe('API Types', () => {
       const keys: any = Object.keys(options)
       keys.sort().should.eql([
         'columns', 'delimiter', 'duration', 'encoding', 'end', 'eof',
-        'fixedSize', 'length', 'maxWordLength', 'rowDelimiter', 'seed', 'sleep'
+        'fixedSize', 'length', 'maxWordLength',
+        'rowDelimiter', 'seed', 'sleep'
       ])
     })
 

diff --git a/packages/csv-generate/test/options.columns.coffee b/packages/csv-generate/test/options.columns.coffee
@@ -92,16 +92,16 @@ describe 'Option `columns`', ->
       generator.on 'error', next
       generator.on 'end', ->
         data.should.eql [
-          objectMode: true
-          length: 1
           columns: [ null, null ]
           delimiter: ','
           duration: null
           encoding: null
           end: null
           eof: false
           fixedSize: false
+          length: 1
           maxWordLength: 16
+          objectMode: true
           rowDelimiter: '\n'
           seed: false
           sleep: 0