Simplify codebase

Author: sam-lord

index.js

@@ -2,7 +2,7 @@ const WriteQueue = require('./lib/writeQueue');
 const PeriodTrigger = require('./lib/periodTrigger');
 const ThresholdTrigger = require('./lib/thresholdTrigger');
 const FileRotator = require('./lib/fileRotator');
-const {BytesWritten, FileStartTime, Rotate, NewFile} = require('./lib/customEvents');
+const {BytesWritten, Rotate, NewFile} = require('./lib/customEvents');
 
 const fileStreams = [];
 
@@ -20,13 +20,8 @@ class RotatingFileStream {
         this._queue = new WriteQueue();
         this._triggers = [];
         if (config.period) {
-            const periodTrigger = new PeriodTrigger(config.period);
+            const periodTrigger = new PeriodTrigger(config.period, config.rotateExisting);
             this._triggers.push(periodTrigger);
-            if (config.rotateExisting) {
-                this._rotator.once(FileStartTime, (startTime) => {
-                    periodTrigger.setInitialTime(startTime);
-                });
-            }
         }
         if (config.threshold) {
             const thresholdTrigger = new ThresholdTrigger(config.threshold);
@@ -39,9 +34,9 @@ class RotatingFileStream {
                 this._rotate();
             });
         });
-        this._rotator.on(NewFile, () => {
+        this._rotator.on(NewFile, (fileInfo) => {
             this._queue.setFileHandle(this._rotator.getCurrentHandle());
-            this._triggers.forEach(trigger => trigger.newFile());
+            this._triggers.forEach(trigger => trigger.newFile(fileInfo));
         });
         this._initialised = this._rotator.initialise();
     }

lib/customEvents.js

@@ -1,10 +1,8 @@
 module.exports = {
     // Emitted when a new rotation is needed
     Rotate: Symbol('rotate'),
-    // Emitted when a new file descriptor is in use, after a rotation
+    // Emitted when a new file handle is acquired with the file info
     NewFile: Symbol('newFile'),
-    // Emitted once with the 'created at' of the initial file
-    FileStartTime: Symbol('fileStartTime'),
     // Emitted whenever data is written to the file with the number of bytes
     BytesWritten: Symbol('bytesWritten')
 };

lib/fileRotator.js

@@ -8,9 +8,7 @@ const path = require('path');
 const {processSize} = require('../util/configProcessors');
 
 const {EventEmitter} = require('events');
-const {NewFile, FileStartTime} = require('./customEvents');
-
-// NOTE: Emit NewFile THEN FileStartTime to ensure PeriodTrigger functions correctly
+const {NewFile} = require('./customEvents');
 
 class FileRotator extends EventEmitter {
     constructor(config) {
@@ -36,8 +34,6 @@ class FileRotator extends EventEmitter {
         } else {
             // Will open existing rather than immediately rotate
             await this._initialiseNewFile();
-            const fileInfo = await fs.stat(this._getFileName(0, false));
-            this.emit(FileStartTime, fileInfo.birthtimeMs);
         }
     }
 
@@ -69,7 +65,8 @@ class FileRotator extends EventEmitter {
 
     async _initialiseNewFile() {
         this._currentHandle = await fs.open(this._getFileName(0, false), 'a');
-        this.emit(NewFile);
+        const fileInfo = await this._currentHandle.stat();
+        this.emit(NewFile, fileInfo);
         return this._currentHandle;
     }
 

lib/periodTrigger.js

@@ -69,19 +69,20 @@ const getNextRotation = (period, lastRotation) => {
 };
 
 class PeriodTrigger extends EventEmitter {
-    constructor(period) {
+    constructor(period, rotateExisting) {
         super();
         this._period = processPeriod(period);
+        this._rotateExisting = rotateExisting;
         this._task = null;
         this._rotateAt = null;
     }
 
-    newFile() {
-        this.setNextTask();
-    }
-
-    setInitialTime(birthTime) {
-        this._rotateAt = birthTime;
+    newFile(fileInfo) {
+        if (this._rotateExisting) {
+            this._rotateAt = fileInfo.birthtimeMs;
+            // Only rotate based on the first file once
+            this._rotateExisting = false;
+        }
         this.setNextTask();
     }
 

lib/thresholdTrigger.js

@@ -9,8 +9,12 @@ class ThresholdTrigger extends EventEmitter {
         this._totalWritten = 0;
     }
 
-    newFile() {
-        this._totalWritten = 0;
+    newFile(fileInfo) {
+        this._totalWritten = fileInfo.size;
+        if (this._totalWritten > this.threshold) {
+            // Case where initial file is larger than threshold - usually on config change between boots
+            this.emit(Rotate);
+        }
     }
 
     updateWritten(bytes) {

test/filerotate.test.js

@@ -3,9 +3,9 @@ const assert = require('assert');
 const sandbox = sinon.createSandbox();
 const bunyan = require('bunyan');
 const path = require('path');
-const mkdirp = require('mkdirp');
 
 const RotatingFileStream = require('../index');
+const fs = require('fs').promises;
 const testConfig = {
     path: 'logs/foo.log',
     totalFiles: 10,
@@ -14,9 +14,15 @@ const testConfig = {
     gzip: true
 };
 
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
 describe('RotatingFileStream', function () {
     before(async function () {
-        await mkdirp(path.parse(testConfig.path).dir);
+        await fs.mkdir(path.parse(testConfig.path).dir, {
+            recursive: true
+        });
     });
 
     afterEach(function () {
@@ -40,6 +46,7 @@ describe('RotatingFileStream', function () {
         for (let i = 0; i < 100; i++) {
             logger.info('Testing ' + i);
         }
+        await delay(0); // immediate delay causes logs to sync
         await stream.end();
     });