Merge pull request #132 from mcode/consolidate-runinstancelogger

Consolidating log functions from app to RunInstanceLogger

Author: dmendelowitz

src/application/app.js

@@ -38,42 +38,8 @@ function checkInputAndConfig(config, fromDate, toDate) {
   }
 }
 
-function checkLogFile(pathToLogs) {
-  // If no custom log file was specified and no default log file exists, create one
-  if (path.resolve(pathToLogs) === path.resolve(path.join('logs', 'run-logs.json')) && !fs.existsSync(pathToLogs)) {
-    logger.info(`No log file found. Creating default log file at ${pathToLogs}`);
-    if (!fs.existsSync('logs')) fs.mkdirSync('logs');
-    fs.appendFileSync(pathToLogs, '[]');
-  }
-  // Check that the given log file exists
-  try {
-    const logFileContent = JSON.parse(fs.readFileSync(pathToLogs));
-    if (!Array.isArray(logFileContent)) throw new Error('Log file needs to be an array.');
-  } catch (err) {
-    logger.error(`The provided filepath to a LogFile, ${pathToLogs}, did not point to a valid JSON file. Create a json file with an empty array at this location.`);
-    throw new Error(err.message);
-  }
-}
-
-// Use previous runs to infer a valid fromDate if none was provided
-function getEffectiveFromDate(fromDate, runLogger) {
-  if (fromDate) return fromDate;
-
-  // Use the most recent ToDate
-  logger.info('No fromDate was provided, inferring an effectiveFromDate');
-  const effectiveFromDate = runLogger.getMostRecentToDate();
-  logger.info(`effectiveFromDate: ${effectiveFromDate}`);
-  if (!effectiveFromDate) {
-    throw new Error('no valid fromDate was supplied, and there are no log records from which we could pull a fromDate');
-  }
-
-  return effectiveFromDate;
-}
-
 async function mcodeApp(Client, fromDate, toDate, pathToConfig, pathToRunLogs, debug, allEntries) {
   if (debug) logger.level = 'debug';
-  // Don't require a run-logs file if we are extracting all-entries. Only required when using --entries-filter.
-  if (!allEntries) checkLogFile(pathToRunLogs);
   const config = getConfig(pathToConfig);
   checkInputAndConfig(config, fromDate, toDate);
 
@@ -86,7 +52,7 @@ async function mcodeApp(Client, fromDate, toDate, pathToConfig, pathToRunLogs, d
 
   // Get RunInstanceLogger for recording new runs and inferring dates from previous runs
   const runLogger = allEntries ? null : new RunInstanceLogger(pathToRunLogs);
-  const effectiveFromDate = allEntries ? null : getEffectiveFromDate(fromDate, runLogger);
+  const effectiveFromDate = allEntries ? null : runLogger.getEffectiveFromDate(fromDate);
   const effectiveToDate = allEntries ? null : toDate;
 
   // Extract the data

src/application/tools/RunInstanceLogger.js

@@ -28,14 +28,36 @@ function createLogObject(fromDate, toDate) {
 class RunInstanceLogger {
   constructor(pathToLogFile) {
     this.logPath = pathToLogFile;
+    if (path.resolve(this.logPath) === path.resolve(path.join('logs', 'run-logs.json')) && !fs.existsSync(this.logPath)) {
+      logger.info(`No log file found. Creating default log file at ${this.logPath}`);
+      if (!fs.existsSync('logs')) fs.mkdirSync('logs');
+      fs.appendFileSync(this.logPath, '[]');
+    }
+    // Check that the given log file exists
     try {
-      this.logs = JSON.parse(fs.readFileSync(path.resolve(this.logPath)));
-      // Sort logs on load
-      this.logs.sort(logSorter);
+      this.logs = JSON.parse(fs.readFileSync(this.logPath));
+      if (!Array.isArray(this.logs)) throw new Error('Log file needs to be an array.');
     } catch (err) {
-      logger.error(`FATAL-Could not parse the logPath provided: ${this.logPath}`);
-      process.exit(1);
+      logger.error(`The provided filepath to a LogFile, ${this.logPath}, did not point to a valid JSON file. Create a json file with an empty array at this location.`);
+      throw new Error(err.message);
     }
+    // Sort logs on load
+    this.logs.sort(logSorter);
+  }
+
+  // Use previous runs to infer a valid fromDate if none was provided
+  getEffectiveFromDate(fromDate) {
+    if (fromDate) return fromDate;
+
+    // Use the most recent ToDate
+    logger.info('No fromDate was provided, inferring an effectiveFromDate');
+    const effectiveFromDate = this.getMostRecentToDate();
+    logger.info(`effectiveFromDate: ${effectiveFromDate}`);
+    if (!effectiveFromDate) {
+      throw new Error('no valid fromDate was supplied, and there are no log records from which we could pull a fromDate');
+    }
+
+    return effectiveFromDate;
   }
 
   // Get the most recent run performed and logged

test/application/app.test.js

@@ -1,12 +1,9 @@
-const fs = require('fs');
 const rewire = require('rewire');
 const testConfig = require('./fixtures/test-config.json');
 
 const app = rewire('../../src/application/app.js');
 const getConfig = app.__get__('getConfig');
 const checkInputAndConfig = app.__get__('checkInputAndConfig');
-const checkLogFile = app.__get__('checkLogFile');
-const getEffectiveFromDate = app.__get__('getEffectiveFromDate');
 
 describe('App Tests', () => {
   describe('getConfig', () => {
@@ -36,50 +33,4 @@ describe('App Tests', () => {
       expect(() => checkInputAndConfig(testConfig, '2020-06-01', '2020-06-30')).not.toThrowError();
     });
   });
-
-  describe('checkLogFile', () => {
-    const fsSpy = jest.spyOn(fs, 'readFileSync');
-    it('should throw error when not provided a path', () => {
-      expect(() => checkLogFile()).toThrowError();
-    });
-
-    it('should throw error when path does not point to valid JSON', () => {
-      expect(() => checkLogFile('./bad-path')).toThrowError();
-    });
-
-    it('should throw error when log file is not an array', () => {
-      fsSpy.mockReturnValueOnce(Buffer.from('{}'));
-      expect(() => checkLogFile('path')).toThrowError('Log file needs to be an array.');
-      expect(fsSpy).toHaveBeenCalled();
-    });
-
-    it('should not throw error when log file is an array', () => {
-      fsSpy.mockReturnValueOnce(Buffer.from('[]'));
-      expect(() => checkLogFile('path')).not.toThrowError();
-      expect(fsSpy).toHaveBeenCalled();
-    });
-  });
-
-  describe('getEffectiveFromDate', () => {
-    const testDate = '2020-06-16';
-    const mockRunLogger = {
-      getMostRecentToDate: jest.fn(),
-    };
-
-    it('should return fromDate when valid', () => {
-      expect(getEffectiveFromDate(testDate)).toEqual(testDate);
-    });
-
-    it('should return most recent date from runLogger', () => {
-      mockRunLogger.getMostRecentToDate.mockReset();
-      mockRunLogger.getMostRecentToDate.mockReturnValue(testDate);
-      expect(getEffectiveFromDate(null, mockRunLogger)).toEqual(testDate);
-    });
-
-    it('should throw error when no recent date from runlogger', () => {
-      mockRunLogger.getMostRecentToDate.mockReset();
-      expect(() => getEffectiveFromDate(null, mockRunLogger)).toThrowError();
-      expect(mockRunLogger.getMostRecentToDate).toHaveBeenCalled();
-    });
-  });
 });

test/application/fixtures/empty-run-logs.json

@@ -0,0 +1 @@
+[]

test/application/fixtures/run-logs.json

@@ -0,0 +1 @@
+[{"dateRun":"2021-06-17T15:10:49.601Z","toDate":"2020-06-16","fromDate":"2019-01-01"}]

test/application/runInstanceLogger.test.js

@@ -0,0 +1,45 @@
+const fs = require('fs');
+const { RunInstanceLogger } = require('../../src/application/tools/RunInstanceLogger.js');
+
+describe('RunInstanceLogger', () => {
+  describe('constructor', () => {
+    const fsSpy = jest.spyOn(fs, 'readFileSync');
+    it('should throw error when not provided a path', () => {
+      expect(() => new RunInstanceLogger()).toThrowError();
+    });
+
+    it('should throw error when path does not point to valid JSON', () => {
+      expect(() => new RunInstanceLogger('./bad-path')).toThrowError();
+    });
+
+    it('should throw error when log file is not an array', () => {
+      fsSpy.mockReturnValueOnce(Buffer.from('{}'));
+      expect(() => new RunInstanceLogger('path')).toThrowError('Log file needs to be an array.');
+      expect(fsSpy).toHaveBeenCalled();
+    });
+
+    it('should not throw error when log file is an array', () => {
+      expect(() => new RunInstanceLogger('./test/application/fixtures/run-logs.json')).not.toThrowError();
+      expect(fsSpy).toHaveBeenCalled();
+    });
+  });
+
+  describe('getEffectiveFromDate', () => {
+    const testDate = '2020-06-16';
+
+    it('should return fromDate when valid', () => {
+      const runLogger = new RunInstanceLogger('./test/application/fixtures/run-logs.json');
+      expect(runLogger.getEffectiveFromDate(testDate)).toEqual(testDate);
+    });
+
+    it('should return most recent date from runLogger', () => {
+      const runLogger = new RunInstanceLogger('./test/application/fixtures/run-logs.json');
+      expect(runLogger.getEffectiveFromDate(null)).toEqual(testDate);
+    });
+
+    it('should throw error when no recent date from runlogger', () => {
+      const runLogger = new RunInstanceLogger('./test/application/fixtures/empty-run-logs.json');
+      expect(() => runLogger.getEffectiveFromDate(null)).toThrowError();
+    });
+  });
+});