feat(csv-parse): improve record_delimiter validation

adaltas · Nov 6, 2021 · 67b7da8 · 67b7da8
1 parent 67053ab
commit 67b7da8
Show file tree

Hide file tree

Showing 10 changed files with 479 additions and 167 deletions.
diff --git a/packages/csv-parse/dist/cjs/index.cjs b/packages/csv-parse/dist/cjs/index.cjs
@@ -5386,12 +5386,40 @@ class Parser extends Transform {
       throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
     }
     // Normalize option `record_delimiter`
-    if(!options.record_delimiter){
+    if(options.record_delimiter === undefined){
       options.record_delimiter = [];
-    }else if(!Array.isArray(options.record_delimiter)){
+    }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter) ){
+      if(options.record_delimiter.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer,',
+          `got ${JSON.stringify(options.record_delimiter)}`
+        ], options);
+      }
       options.record_delimiter = [options.record_delimiter];
+    }else if(!Array.isArray(options.record_delimiter)){
+      throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+        'Invalid option `record_delimiter`:',
+        'value must be a string, a buffer or array of string|buffer,',
+        `got ${JSON.stringify(options.record_delimiter)}`
+      ], options);
     }
-    options.record_delimiter = options.record_delimiter.map(function(rd){
+    options.record_delimiter = options.record_delimiter.map(function(rd, i){
+      if(typeof rd !== 'string' && ! isBuffer(rd) ){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a string, a buffer or array of string|buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }else if(rd.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }
       if(typeof rd === 'string'){
         rd = Buffer.from(rd, options.encoding);
       }

diff --git a/packages/csv-parse/dist/cjs/sync.cjs b/packages/csv-parse/dist/cjs/sync.cjs
@@ -5386,12 +5386,40 @@ class Parser extends Transform {
       throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
     }
     // Normalize option `record_delimiter`
-    if(!options.record_delimiter){
+    if(options.record_delimiter === undefined){
       options.record_delimiter = [];
-    }else if(!Array.isArray(options.record_delimiter)){
+    }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter)){
+      if(options.record_delimiter.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer,',
+          `got ${JSON.stringify(options.record_delimiter)}`
+        ], options);
+      }
       options.record_delimiter = [options.record_delimiter];
+    }else if(!Array.isArray(options.record_delimiter)){
+      throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+        'Invalid option `record_delimiter`:',
+        'value must be a string, a buffer or array of string|buffer,',
+        `got ${JSON.stringify(options.record_delimiter)}`
+      ], options);
     }
-    options.record_delimiter = options.record_delimiter.map(function(rd){
+    options.record_delimiter = options.record_delimiter.map(function(rd, i){
+      if(typeof rd !== 'string' && ! isBuffer(rd)){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a string, a buffer or array of string|buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }else if(rd.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }
       if(typeof rd === 'string'){
         rd = Buffer.from(rd, options.encoding);
       }

diff --git a/packages/csv-parse/dist/esm/index.js b/packages/csv-parse/dist/esm/index.js
@@ -5382,12 +5382,40 @@ class Parser extends Transform {
       throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
     }
     // Normalize option `record_delimiter`
-    if(!options.record_delimiter){
+    if(options.record_delimiter === undefined){
       options.record_delimiter = [];
-    }else if(!Array.isArray(options.record_delimiter)){
+    }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter) ){
+      if(options.record_delimiter.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer,',
+          `got ${JSON.stringify(options.record_delimiter)}`
+        ], options);
+      }
       options.record_delimiter = [options.record_delimiter];
+    }else if(!Array.isArray(options.record_delimiter)){
+      throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+        'Invalid option `record_delimiter`:',
+        'value must be a string, a buffer or array of string|buffer,',
+        `got ${JSON.stringify(options.record_delimiter)}`
+      ], options);
     }
-    options.record_delimiter = options.record_delimiter.map(function(rd){
+    options.record_delimiter = options.record_delimiter.map(function(rd, i){
+      if(typeof rd !== 'string' && ! isBuffer(rd) ){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a string, a buffer or array of string|buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }else if(rd.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }
       if(typeof rd === 'string'){
         rd = Buffer.from(rd, options.encoding);
       }

diff --git a/packages/csv-parse/dist/esm/sync.js b/packages/csv-parse/dist/esm/sync.js
@@ -5382,12 +5382,40 @@ class Parser extends Transform {
       throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
     }
     // Normalize option `record_delimiter`
-    if(!options.record_delimiter){
+    if(options.record_delimiter === undefined){
       options.record_delimiter = [];
-    }else if(!Array.isArray(options.record_delimiter)){
+    }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter)){
+      if(options.record_delimiter.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer,',
+          `got ${JSON.stringify(options.record_delimiter)}`
+        ], options);
+      }
       options.record_delimiter = [options.record_delimiter];
+    }else if(!Array.isArray(options.record_delimiter)){
+      throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+        'Invalid option `record_delimiter`:',
+        'value must be a string, a buffer or array of string|buffer,',
+        `got ${JSON.stringify(options.record_delimiter)}`
+      ], options);
     }
-    options.record_delimiter = options.record_delimiter.map(function(rd){
+    options.record_delimiter = options.record_delimiter.map(function(rd, i){
+      if(typeof rd !== 'string' && ! isBuffer(rd)){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a string, a buffer or array of string|buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }else if(rd.length === 0){
+        throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+          'Invalid option `record_delimiter`:',
+          'value must be a non empty string or buffer',
+          `at index ${i},`,
+          `got ${JSON.stringify(rd)}`
+        ], options);
+      }
       if(typeof rd === 'string'){
         rd = Buffer.from(rd, options.encoding);
       }

diff --git a/packages/csv-parse/dist/iife/index.js b/packages/csv-parse/dist/iife/index.js
@@ -5385,12 +5385,40 @@ var csv_parse = (function (exports) {
                   throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
                 }
                 // Normalize option `record_delimiter`
-                if(!options.record_delimiter){
+                if(options.record_delimiter === undefined){
                   options.record_delimiter = [];
-                }else if(!Array.isArray(options.record_delimiter)){
+                }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter) ){
+                  if(options.record_delimiter.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer,',
+                      `got ${JSON.stringify(options.record_delimiter)}`
+                    ], options);
+                  }
                   options.record_delimiter = [options.record_delimiter];
+                }else if(!Array.isArray(options.record_delimiter)){
+                  throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                    'Invalid option `record_delimiter`:',
+                    'value must be a string, a buffer or array of string|buffer,',
+                    `got ${JSON.stringify(options.record_delimiter)}`
+                  ], options);
                 }
-                options.record_delimiter = options.record_delimiter.map(function(rd){
+                options.record_delimiter = options.record_delimiter.map(function(rd, i){
+                  if(typeof rd !== 'string' && ! isBuffer(rd) ){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a string, a buffer or array of string|buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }else if(rd.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }
                   if(typeof rd === 'string'){
                     rd = Buffer.from(rd, options.encoding);
                   }

diff --git a/packages/csv-parse/dist/iife/sync.js b/packages/csv-parse/dist/iife/sync.js
@@ -5385,12 +5385,40 @@ var csv_parse_sync = (function (exports) {
                   throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
                 }
                 // Normalize option `record_delimiter`
-                if(!options.record_delimiter){
+                if(options.record_delimiter === undefined){
                   options.record_delimiter = [];
-                }else if(!Array.isArray(options.record_delimiter)){
+                }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter)){
+                  if(options.record_delimiter.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer,',
+                      `got ${JSON.stringify(options.record_delimiter)}`
+                    ], options);
+                  }
                   options.record_delimiter = [options.record_delimiter];
+                }else if(!Array.isArray(options.record_delimiter)){
+                  throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                    'Invalid option `record_delimiter`:',
+                    'value must be a string, a buffer or array of string|buffer,',
+                    `got ${JSON.stringify(options.record_delimiter)}`
+                  ], options);
                 }
-                options.record_delimiter = options.record_delimiter.map(function(rd){
+                options.record_delimiter = options.record_delimiter.map(function(rd, i){
+                  if(typeof rd !== 'string' && ! isBuffer(rd)){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a string, a buffer or array of string|buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }else if(rd.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }
                   if(typeof rd === 'string'){
                     rd = Buffer.from(rd, options.encoding);
                   }

diff --git a/packages/csv-parse/dist/umd/index.js b/packages/csv-parse/dist/umd/index.js
@@ -5388,12 +5388,40 @@
                   throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
                 }
                 // Normalize option `record_delimiter`
-                if(!options.record_delimiter){
+                if(options.record_delimiter === undefined){
                   options.record_delimiter = [];
-                }else if(!Array.isArray(options.record_delimiter)){
+                }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter) ){
+                  if(options.record_delimiter.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer,',
+                      `got ${JSON.stringify(options.record_delimiter)}`
+                    ], options);
+                  }
                   options.record_delimiter = [options.record_delimiter];
+                }else if(!Array.isArray(options.record_delimiter)){
+                  throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                    'Invalid option `record_delimiter`:',
+                    'value must be a string, a buffer or array of string|buffer,',
+                    `got ${JSON.stringify(options.record_delimiter)}`
+                  ], options);
                 }
-                options.record_delimiter = options.record_delimiter.map(function(rd){
+                options.record_delimiter = options.record_delimiter.map(function(rd, i){
+                  if(typeof rd !== 'string' && ! isBuffer(rd) ){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a string, a buffer or array of string|buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }else if(rd.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }
                   if(typeof rd === 'string'){
                     rd = Buffer.from(rd, options.encoding);
                   }

diff --git a/packages/csv-parse/dist/umd/sync.js b/packages/csv-parse/dist/umd/sync.js
@@ -5388,12 +5388,40 @@
                   throw new Error(`Invalid Option: raw must be true, got ${JSON.stringify(options.raw)}`);
                 }
                 // Normalize option `record_delimiter`
-                if(!options.record_delimiter){
+                if(options.record_delimiter === undefined){
                   options.record_delimiter = [];
-                }else if(!Array.isArray(options.record_delimiter)){
+                }else if(typeof options.record_delimiter === 'string' || isBuffer(options.record_delimiter)){
+                  if(options.record_delimiter.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer,',
+                      `got ${JSON.stringify(options.record_delimiter)}`
+                    ], options);
+                  }
                   options.record_delimiter = [options.record_delimiter];
+                }else if(!Array.isArray(options.record_delimiter)){
+                  throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                    'Invalid option `record_delimiter`:',
+                    'value must be a string, a buffer or array of string|buffer,',
+                    `got ${JSON.stringify(options.record_delimiter)}`
+                  ], options);
                 }
-                options.record_delimiter = options.record_delimiter.map(function(rd){
+                options.record_delimiter = options.record_delimiter.map(function(rd, i){
+                  if(typeof rd !== 'string' && ! isBuffer(rd)){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a string, a buffer or array of string|buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }else if(rd.length === 0){
+                    throw new CsvError('CSV_INVALID_OPTION_RECORD_DELIMITER', [
+                      'Invalid option `record_delimiter`:',
+                      'value must be a non empty string or buffer',
+                      `at index ${i},`,
+                      `got ${JSON.stringify(rd)}`
+                    ], options);
+                  }
                   if(typeof rd === 'string'){
                     rd = Buffer.from(rd, options.encoding);
                   }