@tryghost/bunyan-rotating-filestream 0.0.7 → 0.0.9

package/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2013-2021 Ghost Foundation
+MIT License
+
+Copyright (c) 2013-2026 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -17,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

package/README.md

@@ -6,51 +6,59 @@
 
 or
 
-`yarn add @tryghost/bunyan-rotating-filestream`
+`pnpm add @tryghost/bunyan-rotating-filestream`
 
+## Purpose
+
+A rotating file stream for the [bunyan](https://github.com/trentm/node-bunyan) logger, supporting period-based and size-based rotation, gzip compression of archives, and limits on the number and total size of archived files.
 
 ## Usage
 
 Create a bunyan logger using the stream:
 
 ```js
-    var log = bunyan.createLogger({
-        name: 'foo',
-        streams: [{
+const log = bunyan.createLogger({
+    name: 'foo',
+    streams: [
+        {
             stream: new RotatingFileStream({
                 path: '/var/log/foo.log',
-                period: '1d',          // daily rotation
-                totalFiles: 10,        // keep up to 10 backup copies
-                rotateExisting: true,  // Give ourselves a clean file when we start up, based on period
-                threshold: '10m',      // Rotate log files larger than 10 megabytes
-                totalSize: '20m',      // Don't keep more than 20mb of archived log files
-                gzip: true             // Compress the archive log files to save space
-            })
-        }]
-    });
+                period: '1d', // daily rotation
+                totalFiles: 10, // keep up to 10 backup copies
+                rotateExisting: true, // Give ourselves a clean file when we start up, based on period
+                threshold: '10m', // Rotate log files larger than 10 megabytes
+                totalSize: '20m', // Don't keep more than 20mb of archived log files
+                gzip: true, // Compress the archive log files to save space
+            }),
+        },
+    ],
+});
 ```
 
 Other options include `startNewFile` to always open a new file on start-up.
 
 ## Develop
 
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
+This is a mono repository, managed with [Nx](https://nx.dev).
 
-## Test
+Follow the instructions for the top-level repo.
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
+1. `git clone` this repo & `cd` into it as usual
+2. Run `pnpm install` to install top-level dependencies.
+
+## Run
 
+- `pnpm dev`
 
-## Publish
+## Test
 
-- `yarn ship`
+- `pnpm lint` runs oxlint
+- `pnpm test` runs lint and tests
 
 ## Credit
 
 Many thanks to @Rcomian for their work on the original bunyan-rotating-file-stream project, this project borrows lots of the code and all of the ideas in the original.
 
-# Copyright & License 
+# Copyright & License
 
-Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).

package/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, Rotate, NewFile} = require('./lib/customEvents');
+const { BytesWritten, Rotate, NewFile } = require('./lib/customEvents');
 
 const fileStreams = [];
 
@@ -25,10 +25,11 @@ class RotatingFileStream {
         }
         if (config.threshold) {
             const thresholdTrigger = new ThresholdTrigger(config.threshold);
-            this._queue.on(BytesWritten, bytes => thresholdTrigger.updateWritten(bytes));
+            this._queue.on(BytesWritten, (bytes) => thresholdTrigger.updateWritten(bytes));
             this._triggers.push(thresholdTrigger);
         }
         this._rotatingLock = false;
+        this._closed = false;
         this._triggers.forEach((trigger) => {
             trigger.on(Rotate, () => {
                 this._rotate();
@@ -36,21 +37,24 @@ class RotatingFileStream {
         });
         this._rotator.on(NewFile, (fileInfo) => {
             this._queue.setFileHandle(this._rotator.getCurrentHandle());
-            this._triggers.forEach(trigger => trigger.newFile(fileInfo));
+            this._triggers.forEach((trigger) => trigger.newFile(fileInfo));
         });
         this._initialised = this._rotator.initialise();
     }
 
     async _rotate() {
-        if (this._rotatingLock) {
-            // Already rotating
+        if (this._rotatingLock || this._closed) {
+            // Already rotating or shutting down
             return;
         }
         this._rotatingLock = true;
-        await this._queue.pause();
-        const nextFileHandle = await this._rotator.rotate();
-        this._queue.setFileHandle(nextFileHandle);
-        this._rotatingLock = false;
+        this._rotating = (async () => {
+            await this._queue.pause();
+            const nextFileHandle = await this._rotator.rotate();
+            this._queue.setFileHandle(nextFileHandle);
+            this._rotatingLock = false;
+        })();
+        await this._rotating;
     }
 
     async write(data) {
@@ -58,10 +62,16 @@ class RotatingFileStream {
     }
 
     async end() {
+        // Block new rotations immediately - the threshold trigger has no timer
+        // to shut down and can still fire while the queue drains below
+        this._closed = true;
         await this._initialised;
+        // Stop triggers first so no new rotation can start, then wait for any
+        // in-flight rotation before closing the file handles
+        this._triggers.forEach((trigger) => trigger.shutdown());
+        await this._rotating;
         await this._queue.shutdown();
         await this._rotator.shutdown();
-        this._triggers.forEach(trigger => trigger.shutdown());
         const fileStreamIndex = fileStreams.indexOf(this._path);
         if (fileStreamIndex >= 0) {
             fileStreams.splice(fileStreamIndex, 1);

package/lib/customEvents.js

@@ -4,5 +4,5 @@ module.exports = {
     // Emitted when a new file handle is acquired with the file info
     NewFile: Symbol('newFile'),
     // Emitted whenever data is written to the file with the number of bytes
-    BytesWritten: Symbol('bytesWritten')
-};
+    BytesWritten: Symbol('bytesWritten'),
+};

package/lib/fileRotator.js

@@ -1,14 +1,14 @@
 const zlib = require('zlib');
-const {pipeline} = require('stream');
-const {promisify} = require('util');
-const {createReadStream, createWriteStream} = require('fs');
+const { pipeline } = require('stream');
+const { promisify } = require('util');
+const { createReadStream, createWriteStream } = require('fs');
 const fs = require('fs').promises;
 const pipe = promisify(pipeline);
 const path = require('path');
-const {processSize} = require('../util/configProcessors');
+const { processSize } = require('../util/configProcessors');
 
-const {EventEmitter} = require('events');
-const {NewFile} = require('./customEvents');
+const { EventEmitter } = require('events');
+const { NewFile } = require('./customEvents');
 
 class FileRotator extends EventEmitter {
     constructor(config) {
@@ -75,7 +75,7 @@ class FileRotator extends EventEmitter {
         const outputName = this._getFileName(0, true);
 
         try {
-            fs.stat(inputName);
+            await fs.stat(inputName);
         } catch (err) {
             if (err.code === 'ENOENT') {
                 return;
@@ -97,11 +97,12 @@ class FileRotator extends EventEmitter {
         const parsedPath = path.parse(this._path);
         let base = `${parsedPath.name}.${String(number - 1)}${parsedPath.ext}`;
         if (number === 0) {
-            base = parsedPath.name
-                .replace('.%N', '')
-                .replace('_%N', '')
-                .replace('-%N', '')
-                .replace('%N', '') + parsedPath.ext;
+            base =
+                parsedPath.name
+                    .replace('.%N', '')
+                    .replace('_%N', '')
+                    .replace('-%N', '')
+                    .replace('%N', '') + parsedPath.ext;
         } else if (parsedPath.name.indexOf('%N') >= 0) {
             base = parsedPath.name.replace('%N', String(number - 1)) + parsedPath.ext;
         }
@@ -124,7 +125,10 @@ class FileRotator extends EventEmitter {
             try {
                 const result = await fs.stat(name);
                 bytesTotal += result.size;
-                if ((this._totalSize && bytesTotal > this._totalSize) || (this._totalFiles && fileNumber >= this._totalFiles)) {
+                if (
+                    (this._totalSize && bytesTotal > this._totalSize) ||
+                    (this._totalFiles && fileNumber >= this._totalFiles)
+                ) {
                     filesToDelete.push(name);
                 }
             } catch (err) {
@@ -159,7 +163,10 @@ class FileRotator extends EventEmitter {
         // Set to last file in sequence
         fileNumber -= 1;
         while (fileNumber >= 0) {
-            await fs.rename(this._getFileName(fileNumber, true), this._getFileName(fileNumber + 1, true));
+            await fs.rename(
+                this._getFileName(fileNumber, true),
+                this._getFileName(fileNumber + 1, true),
+            );
             fileNumber -= 1;
         }
     }
@@ -173,4 +180,4 @@ class FileRotator extends EventEmitter {
     }
 }
 
-module.exports = FileRotator;
+module.exports = FileRotator;

package/lib/periodTrigger.js

@@ -1,68 +1,77 @@
-const {EventEmitter} = require('events');
-const {Rotate} = require('./customEvents');
-const {processPeriod} = require('../util/configProcessors');
-const {setTimeout, clearTimeout} = require('long-timeout');
+const { EventEmitter } = require('events');
+const { Rotate } = require('./customEvents');
+const { processPeriod } = require('../util/configProcessors');
+const { setTimeout, clearTimeout } = require('long-timeout');
 
 const getNextRotation = (period, lastRotation) => {
     var date = new Date();
 
     let nextRotation;
     switch (period.unit) {
-    case 'ms':
-        // Hidden millisecond period for debugging.
-        if (lastRotation) {
-            nextRotation = lastRotation + period.num;
-        } else {
-            nextRotation = Date.now() + period.num;
-        }
-        break;
-    case 'h':
-        if (lastRotation) {
-            nextRotation = lastRotation + period.num * 60 * 60 * 1000;
-        } else {
-            // First time: top of the next hour.
-            nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth(),
-                date.getUTCDate(), date.getUTCHours() + 1);
-        }
-        break;
-    case 'd':
-        if (lastRotation) {
-            nextRotation = lastRotation + period.num * 24 * 60 * 60 * 1000;
-        } else {
-            // First time: start of tomorrow (i.e. at the coming midnight) UTC.
-            nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth(),
-                date.getUTCDate() + 1);
-        }
-        break;
-    case 'w':
-        // Currently, always on Sunday morning at 00:00:00 (UTC).
-        if (lastRotation) {
-            nextRotation = lastRotation + period.num * 7 * 24 * 60 * 60 * 1000;
-        } else {
-            // First time: this coming Sunday.
-            nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth(),
-                date.getUTCDate() + (7 - date.getUTCDay()));
-        }
-        break;
-    case 'm':
-        if (lastRotation) {
-            nextRotation = Date.UTC(date.getUTCFullYear(),
-                date.getUTCMonth() + period.num, 1);
-        } else {
-            // First time: the start of the next month.
-            nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth() + 1, 1);
-        }
-        break;
-    case 'y':
-        if (lastRotation) {
-            nextRotation = Date.UTC(date.getUTCFullYear() + period.num, 0, 1);
-        } else {
-            // First time: the start of the next year.
-            nextRotation = Date.UTC(date.getUTCFullYear() + 1, 0, 1);
-        }
-        break;
-    default:
-        throw new Error(`Invalid period scope: "${period.unit}"`);
+        case 'ms':
+            // Hidden millisecond period for debugging.
+            if (lastRotation) {
+                nextRotation = lastRotation + period.num;
+            } else {
+                nextRotation = Date.now() + period.num;
+            }
+            break;
+        case 'h':
+            if (lastRotation) {
+                nextRotation = lastRotation + period.num * 60 * 60 * 1000;
+            } else {
+                // First time: top of the next hour.
+                nextRotation = Date.UTC(
+                    date.getUTCFullYear(),
+                    date.getUTCMonth(),
+                    date.getUTCDate(),
+                    date.getUTCHours() + 1,
+                );
+            }
+            break;
+        case 'd':
+            if (lastRotation) {
+                nextRotation = lastRotation + period.num * 24 * 60 * 60 * 1000;
+            } else {
+                // First time: start of tomorrow (i.e. at the coming midnight) UTC.
+                nextRotation = Date.UTC(
+                    date.getUTCFullYear(),
+                    date.getUTCMonth(),
+                    date.getUTCDate() + 1,
+                );
+            }
+            break;
+        case 'w':
+            // Currently, always on Sunday morning at 00:00:00 (UTC).
+            if (lastRotation) {
+                nextRotation = lastRotation + period.num * 7 * 24 * 60 * 60 * 1000;
+            } else {
+                // First time: this coming Sunday.
+                nextRotation = Date.UTC(
+                    date.getUTCFullYear(),
+                    date.getUTCMonth(),
+                    date.getUTCDate() + (7 - date.getUTCDay()),
+                );
+            }
+            break;
+        case 'm':
+            if (lastRotation) {
+                nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth() + period.num, 1);
+            } else {
+                // First time: the start of the next month.
+                nextRotation = Date.UTC(date.getUTCFullYear(), date.getUTCMonth() + 1, 1);
+            }
+            break;
+        case 'y':
+            if (lastRotation) {
+                nextRotation = Date.UTC(date.getUTCFullYear() + period.num, 0, 1);
+            } else {
+                // First time: the start of the next year.
+                nextRotation = Date.UTC(date.getUTCFullYear() + 1, 0, 1);
+            }
+            break;
+        default:
+            throw new Error(`Invalid period scope: "${period.unit}"`);
     }
 
     return nextRotation;
@@ -97,10 +106,13 @@ class PeriodTrigger extends EventEmitter {
             clearTimeout(this._task);
         }
         this._rotateAt = getNextRotation(this._period, this._rotateAt);
-        this._task = setTimeout(() => {
-            this._emitRotate();
-            this.setNextTask();
-        }, Math.max(this._rotateAt - Date.now(), 0));
+        this._task = setTimeout(
+            () => {
+                this._emitRotate();
+                this.setNextTask();
+            },
+            Math.max(this._rotateAt - Date.now(), 0),
+        );
         // Prevent timeout from keeping Node.js alive
         this._task.unref();
     }
@@ -110,4 +122,4 @@ class PeriodTrigger extends EventEmitter {
     }
 }
 
-module.exports = PeriodTrigger;
+module.exports = PeriodTrigger;

package/lib/thresholdTrigger.js

@@ -1,6 +1,6 @@
-const {EventEmitter} = require('events');
-const {Rotate} = require('./customEvents');
-const {processSize} = require('../util/configProcessors');
+const { EventEmitter } = require('events');
+const { Rotate } = require('./customEvents');
+const { processSize } = require('../util/configProcessors');
 
 class ThresholdTrigger extends EventEmitter {
     constructor(threshold) {
@@ -29,4 +29,4 @@ class ThresholdTrigger extends EventEmitter {
     }
 }
 
-module.exports = ThresholdTrigger;
+module.exports = ThresholdTrigger;

package/lib/writeQueue.js

@@ -1,5 +1,5 @@
-const {EventEmitter} = require('events');
-const {BytesWritten} = require('./customEvents');
+const { EventEmitter } = require('events');
+const { BytesWritten } = require('./customEvents');
 
 class WriteQueue extends EventEmitter {
     constructor() {
@@ -49,4 +49,4 @@ class WriteQueue extends EventEmitter {
     }
 }
 
-module.exports = WriteQueue;
+module.exports = WriteQueue;

package/package.json

@@ -1,28 +1,33 @@
 {
   "name": "@tryghost/bunyan-rotating-filestream",
-  "version": "0.0.7",
-  "repository": "git@github.com:TryGhost/bunyan-rotating-filestream.git",
-  "author": "Ghost Foundation",
+  "version": "0.0.9",
   "license": "MIT",
-  "private": false,
+  "author": "Ghost Foundation",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TryGhost/framework.git",
+    "directory": "packages/bunyan-rotating-filestream"
+  },
+  "files": [
+    "index.js",
+    "lib",
+    "util"
+  ],
   "main": "index.js",
-  "scripts": {
-    "test": "NODE_ENV=testing mocha './test/**/*.test.js'",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint",
-    "preship": "yarn test",
-    "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn publish --access public && git push --follow-tags; fi"
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "long-timeout": "0.1.1"
   },
   "devDependencies": {
     "bunyan": "1.8.15",
-    "eslint": "7.21.0",
-    "eslint-plugin-ghost": "2.0.0",
-    "mkdirp": "1.0.4",
-    "mocha": "8.3.0",
-    "should": "13.2.3",
-    "sinon": "9.2.4"
+    "sinon": "22.0.0"
   },
-  "dependencies": {
-    "long-timeout": "^0.1.1"
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing vitest run --coverage",
+    "lint": "oxlint -c ../../.oxlintrc.json .",
+    "posttest": "pnpm run lint"
   }
-}
+}

package/util/configProcessors.js

@@ -3,10 +3,10 @@ const processSize = (size) => {
         b: 1,
         k: 1024,
         m: 1024 * 1024,
-        g: 1024 * 1024 * 1024
+        g: 1024 * 1024 * 1024,
     };
-    
-    if (typeof (size) === 'string') {
+
+    if (typeof size === 'string') {
         const [num, unit] = /^([1-9][0-9]*)([bkmg])$/.exec(size).slice(1);
         return Number(num) * multipliers[unit];
     } else {
@@ -17,21 +17,22 @@ const processSize = (size) => {
 const processPeriod = (period) => {
     const result = {
         num: 1,
-        unit: 'd'
+        unit: 'd',
     };
 
     // Parse `period`.
     if (period) {
-        var crackedperiod = {
-            hourly: '1h',
-            daily: '1d',
-            weekly: '1w',
-            monthly: '1m',
-            yearly: '1y'
-        }[period] || period;
+        var crackedperiod =
+            {
+                hourly: '1h',
+                daily: '1d',
+                weekly: '1w',
+                monthly: '1m',
+                yearly: '1y',
+            }[period] || period;
 
         const [num, unit] = /^([1-9][0-9]*)([hdwmy]|ms)$/.exec(crackedperiod).slice(1);
-        
+
         result.num = Number(num);
         result.unit = unit;
     }
@@ -41,5 +42,5 @@ const processPeriod = (period) => {
 
 module.exports = {
     processSize,
-    processPeriod
-};
+    processPeriod,
+};

package/.editorconfig

@@ -1,26 +0,0 @@
-# http://editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 4
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.hbs]
-insert_final_newline = false
-
-[*.json]
-indent_size = 2
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.{yml,yaml}]
-indent_size = 2
-
-[Makefile]
-indent_style = tab

package/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-    plugins: ['ghost'],
-    extends: [
-        'plugin:ghost/node'
-    ]
-};

package/.github/workflows/test.yml

@@ -1,23 +0,0 @@
-name: Test
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [ 10, 12 ]
-    env:
-      FORCE_COLOR: 1
-    name: Node ${{ matrix.node }}
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node }}
-
-      - run: yarn
-      - run: yarn test

package/renovate.json

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "config:base"
-  ]
-}

package/test/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-    plugins: ['ghost'],
-    extends: [
-        'plugin:ghost/test'
-    ]
-};

package/test/filerotate.test.js

@@ -1,98 +0,0 @@
-const sinon = require('sinon');
-const assert = require('assert');
-const sandbox = sinon.createSandbox();
-const bunyan = require('bunyan');
-const path = require('path');
-
-const RotatingFileStream = require('../index');
-const fs = require('fs').promises;
-const testConfig = {
-    path: 'logs/foo.log',
-    totalFiles: 10,
-    threshold: '1k',
-    rotateExisting: true,
-    gzip: true
-};
-
-function delay(ms) {
-    return new Promise(resolve => setTimeout(resolve, ms));
-}
-
-describe('RotatingFileStream', function () {
-    before(async function () {
-        await fs.mkdir(path.parse(testConfig.path).dir, {
-            recursive: true
-        });
-    });
-
-    afterEach(function () {
-        sandbox.restore();
-    });
-
-    it('Processes client configuration', async function () {
-        const rfs = new RotatingFileStream(testConfig);
-        assert.strictEqual(rfs._path, testConfig.path);
-        await rfs.end();
-    });
-
-    it('Writes log files', async function () {
-        const stream = new RotatingFileStream(testConfig);
-        const logger = bunyan.createLogger({
-            name: 'foo',
-            streams: [{
-                stream
-            }]
-        });
-        for (let i = 0; i < 100; i++) {
-            logger.info('Testing ' + i);
-        }
-        await delay(0); // immediate delay causes logs to sync
-        await stream.end();
-    });
-
-    it('Sets up period correctly', async function () {
-        const stream = new RotatingFileStream({
-            period: '1w',
-            ...testConfig
-        });
-        bunyan.createLogger({
-            name: 'foo',
-            streams: [{
-                stream
-            }]
-        });
-        await stream.end();
-    });
-
-    it('Sets up long periods correctly', async function () {
-        const stream = new RotatingFileStream({
-            period: '1y',
-            ...testConfig
-        });
-        bunyan.createLogger({
-            name: 'foo',
-            streams: [{
-                stream
-            }]
-        });
-        await stream.end();
-    });
-
-    it('Goes fast with short periods', async function () {
-        const stream = new RotatingFileStream({
-            period: '50ms',
-            ...testConfig
-        });
-        const logger = bunyan.createLogger({
-            name: 'foo',
-            streams: [{
-                stream
-            }]
-        });
-        for (let i = 0; i < 10; i++) {
-            logger.info(`Testing ${i}!`);
-            await delay(50);
-        }
-        await stream.end();
-    });
-});

package/test/utils/assertions.js

@@ -1,11 +0,0 @@
-/**
- * Custom Should Assertions
- *
- * Add any custom assertions to this file.
- */
-
-// Example Assertion
-// should.Assertion.add('ExampleAssertion', function () {
-//     this.params = {operator: 'to be a valid Example Assertion'};
-//     this.obj.should.be.an.Object;
-// });

package/test/utils/index.js

@@ -1,11 +0,0 @@
-/**
- * Test Utilities
- *
- * Shared utils for writing tests
- */
-
-// Require overrides - these add globals for tests
-require('./overrides');
-
-// Require assertions - adds custom should assertions
-require('./assertions');

package/test/utils/overrides.js

@@ -1,10 +0,0 @@
-// This file is required before any test is run
-
-// Taken from the should wiki, this is how to make should global
-// Should is a global in our eslint test config
-global.should = require('should').noConflict();
-should.extend();
-
-// Sinon is a simple case
-// Sinon is a global in our eslint test config
-global.sinon = require('sinon');