Updated 'attributes' to be 'columns'; added test ensuring that unalterableColumns works as expected

Author: Dtphelan1

src/extractors/BaseCSVExtractor.js

@@ -5,12 +5,12 @@ const { validateCSV } = require('../helpers/csvValidator');
 const logger = require('../helpers/logger');
 
 class BaseCSVExtractor extends Extractor {
-  constructor({ filePath, csvSchema, unalterableAttributes }) {
+  constructor({ filePath, csvSchema, unalterableColumns }) {
     super();
-    this.unalterableAttributes = unalterableAttributes || [];
+    this.unalterableColumns = unalterableColumns || [];
     this.csvSchema = csvSchema;
     this.filePath = path.resolve(filePath);
-    this.csvModule = new CSVModule(this.filePath, this.unalterableAttributes);
+    this.csvModule = new CSVModule(this.filePath, this.unalterableColumns);
   }
 
   validate() {

src/extractors/CSVPatientExtractor.js

@@ -55,9 +55,9 @@ function joinAndReformatData(patientData) {
 
 class CSVPatientExtractor extends BaseCSVExtractor {
   constructor({ filePath, mask = [] }) {
-    // Define CSV attributes whose values should never be altered
-    const unalterableAttributes = ['familyName', 'givenName'];
-    super({ filePath, csvSchema: CSVPatientSchema, unalterableAttributes });
+    // Define CSV Columns whose values should never be altered
+    const unalterableColumns = ['familyName', 'givenName'];
+    super({ filePath, csvSchema: CSVPatientSchema, unalterableColumns });
     this.mask = mask;
   }
 

src/modules/CSVModule.js

@@ -3,32 +3,32 @@ const moment = require('moment');
 const parse = require('csv-parse/lib/sync');
 const logger = require('../helpers/logger');
 
-function normalizeEmptyValues(data, unalterableAttributes = []) {
+function normalizeEmptyValues(data, unalterableColumns = []) {
   const EMPTY_VALUES = ['null', 'nil'];
 
   return data.map((row) => {
     const newRow = { ...row };
-    // Filter out unalterable attributes
-    const attributesToNormalize = Object.keys(row).filter((attr) => !unalterableAttributes.includes(attr));
-    attributesToNormalize.forEach((attr) => {
-      const value = newRow[attr];
-      // If the value for this row-attr combo is a value that should be empty, replace it
+    // Filter out unalterable columns
+    const columnsToNormalize = Object.keys(row).filter((col) => !unalterableColumns.includes(col));
+    columnsToNormalize.forEach((col) => {
+      const value = newRow[col];
+      // If the value for this row-col combo is a value that should be empty, replace it
       if (EMPTY_VALUES.includes(value.toLowerCase())) {
-        newRow[attr] = '';
+        newRow[col] = '';
       }
     });
     return newRow;
   });
 }
 
 class CSVModule {
-  constructor(csvFilePath, unalterableAttributes) {
+  constructor(csvFilePath, unalterableColumns) {
     // Parse then normalize the data
     const parsedData = parse(fs.readFileSync(csvFilePath), {
       columns: (header) => header.map((column) => column.toLowerCase()),
       bom: true,
     });
-    this.data = normalizeEmptyValues(parsedData, unalterableAttributes);
+    this.data = normalizeEmptyValues(parsedData, unalterableColumns);
   }
 
   async get(key, value, fromDate, toDate) {

test/modules/CSVModule.test.js

@@ -72,6 +72,14 @@ describe('CSVModule', () => {
       });
     });
 
+    it('Should not modify unalterableColumns, regardless of their value', () => {
+      const data = [{ key: 'null' }, { key: 'NULL' }, { key: 'nuLL' }, { key: 'nil' }, { key: 'NIL' }, { key: 'NIl' }];
+      const normalizedData = normalizeEmptyValues(data, ['key']);
+      normalizedData.forEach((d) => {
+        expect(d.key).not.toBe('');
+      });
+    });
+
     it('Should leave all other values uneffected, regardless of case', () => {
       const data = [{ key: 'anything' }, { key: 'any' }, { key: 'thing' }];
       const normalizedData = normalizeEmptyValues(data);