Initial commit

Author: sam-lord

.editorconfig

@@ -0,0 +1,26 @@
+# 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

.eslintrc.js

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

.github/workflows/test.yml

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

.gitignore

@@ -0,0 +1,71 @@
+# Node template
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# IDE
+.idea/*
+*.iml
+*.sublime-*
+.vscode/*
+
+# OSX
+.DS_Store
+
+# Elasticsearch Bunyan Custom

README.md

@@ -0,0 +1,41 @@
+# Elasticsearch Bunyan
+
+## Install
+
+`npm install elasticsearch-bunyan --save`
+
+or
+
+`yarn add elasticsearch-bunyan`
+
+
+## Usage
+
+
+## Develop
+
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+## Publish
+
+- `yarn ship`
+
+
+# Copyright & License 
+
+Copyright (c) 2021 Ghost Foundation. All rights reserved.
+
+This code is considered closed-source and not for distribution. There is no opensource license associated with this project.

index.js

@@ -0,0 +1,84 @@
+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 fileStreams = [];
+
+class RotatingFileStream {
+    constructor(config) {
+        if (typeof config.path !== 'string') {
+            throw new Error('Must provide a string for path');
+        }
+        if (fileStreams.indexOf(config.path) >= 0) {
+            throw new Error('Rotating log already exists for path: ', config.path);
+        }
+        fileStreams.push(config.path);
+        this._path = config.path;
+        this._rotator = new FileRotator(config);
+        this._queue = new WriteQueue();
+        this._triggers = [];
+        if (config.period) {
+            const periodTrigger = new PeriodTrigger(config.period);
+            this.triggers.push(periodTrigger);
+            if (config.rotateExisting) {
+                this._rotator.once(FileStartTime, (startTime) => {
+                    periodTrigger.setInitialTime(startTime);
+                });
+            }
+        }
+        if (config.threshold) {
+            const thresholdTrigger = new ThresholdTrigger(config.threshold);
+            this._queue.on(BytesWritten, bytes => thresholdTrigger.updateWritten(bytes));
+            this._triggers.push(thresholdTrigger);
+        }
+        this._rotatingLock = false;
+        this._triggers.forEach((trigger) => {
+            trigger.on(Rotate, this._rotate);
+        });
+        this._rotator.on(NewFile, () => {
+            this._queue.setFileHandle(this._rotator.getCurrentHandle());
+            this._triggers.forEach(trigger => trigger.newFile());
+        });
+        this._initialised = this._rotator.initialise();
+    }
+
+    async _rotate() {
+        if (this._rotatingLock) {
+            // Already rotating
+            return;
+        }
+        this._rotatingLock = true;
+        await this._queue.pause();
+        const nextFileHandle = await this._rotator.rotate();
+        this._triggers.forEach(trigger => trigger.rotated());
+        this._queue.setFileHandle(nextFileHandle);
+        this._rotatingLock = false;
+    }
+
+    async write(data) {
+        this._queue.push(data);
+    }
+
+    async end() {
+        await this._initialised;
+        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);
+        }
+    }
+
+    destroy() {
+        this.end();
+    }
+
+    destroySoon() {
+        this.end();
+    }
+}
+
+module.exports = RotatingFileStream;

lib/customEvents.js

@@ -0,0 +1,10 @@
+module.exports = {
+    // Emitted when a new rotation is needed
+    Rotate: Symbol('rotate'),
+    // Emitted when a new file descriptor is in use, after a rotation
+    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')
+};