Bump glob-parent from 5.1.0 to 5.1.2 (#237)

Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.0 to 5.1.2.
- [Release notes](https://github.com/gulpjs/glob-parent/releases)
- [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md)
- [Commits](https://github.com/gulpjs/glob-parent/compare/v5.1.0...v5.1.2)

---
updated-dependencies:
- dependency-name: glob-parent
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.eslintignore

@@ -1,2 +0,0 @@
-web/assets/tinycon.min.js
-web/assets/ansi_up.js

.eslintrc.json

@@ -1,11 +0,0 @@
-{
-  "extends": "airbnb-base",
-  "rules": {
-    "no-console": "off",
-    "strict": "off",
-    "comma-dangle": ["error", { "functions": "never" }]
-  },
-  "env": {
-    "node": true
-  }
-}

.github/workflows/push.yml

@@ -0,0 +1,20 @@
+on: push
+name: Build, Lint, Test, and Publish
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm install
+      - run: npm test
+      - run: npm run lint
+      - uses: primer/publish@master
+        if: github.ref == 'refs/heads/master'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          NPM_REGISTRY_URL: registry.npmjs.org

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 test/fixtures/*.pem
 npm-debug.log
-dist
+dist
+.DS_Store

.travis.yml

@@ -10,7 +10,7 @@ deploy:
   provider: npm
   email: maciej.winnicki@gmail.com
   api_key:
-    secure: S7VCwq19j0w2vBn27f0pQBWIFCN/3iZTyy9fUXuaTrvHztB7YQHBVxkIDNPYgWAttQLKsu0PH9BFzNeA7/StrKYKsn+z6fwh07GSOQGGwVO/OxvjfjglfgzNwLsuuT+N4R2ClrkqzIn7NaYVEM3bxofL+gwlHxWSfXfErW7mUds=
+    secure: OuE8bOpsq/XN2AL6z0SWqHtpfKB5Qg3wug+hZVka+AdWaU6Gm0uvs4yA7B/uw9o5gH6KKgM+CP50Lq1xhC12CZbKLjkAUuFJQb9FrU/7jEAp+t+DKpoVBcru8bBjTxxx4wO1zXFcbJZ9zb4c4h76j2nfaNVuPTBB+mDF/HDd914=
   on:
     tags: true
     repo: mthenw/frontail

Dockerfile

@@ -1,4 +1,4 @@
-FROM mhart/alpine-node:8.12.0
+FROM node:12-buster-slim
 
 WORKDIR /frontail
 ADD . .

README.md

@@ -4,33 +4,33 @@
 
 ![frontial](https://user-images.githubusercontent.com/455261/29570317-660c8122-8756-11e7-9d2f-8fea19e05211.gif)
 
-[![Build Status](https://img.shields.io/travis/mthenw/frontail.svg?style=flat)](https://travis-ci.org/mthenw/frontail)
 [![Docker Pulls](https://img.shields.io/docker/pulls/mthenw/frontail.svg)](https://hub.docker.com/r/mthenw/frontail/)
 
 ## Quick start
 
-* `npm i frontail -g` or download a binary file from [Releases](https://github.com/mthenw/frontail/releases) page
-* `frontail /var/log/syslog`
-* visit [http://127.0.0.1:9001](http://127.0.0.1:9001)
+- `npm i frontail -g` or download a binary file from [Releases](https://github.com/mthenw/frontail/releases) page
+- `frontail /var/log/syslog`
+- visit [http://127.0.0.1:9001](http://127.0.0.1:9001)
 
 ## Features
 
-* log rotation
-* auto-scrolling
-* marking logs
-* number of unread logs in favicon
-* themes (default, dark)
-* [highlighting](#highlighting)
-* search (`Tab` to focus, `Esc` to clear)
-* set filter from url parameter `filter`
-* tailing [multiple files](#tailing-multiple-files) and [stdin](#stdin)
-* basic authentication
+- log rotation (not on Windows)
+- auto-scrolling
+- marking logs
+- pausing logs
+- number of unread logs in favicon
+- themes (default, dark)
+- [highlighting](#highlighting)
+- search (`Tab` to focus, `Esc` to clear)
+- set filter from url parameter `filter`
+- tailing [multiple files](#tailing-multiple-files) and [stdin](#stdin)
+- basic authentication
 
 ## Installation options
 
-* download a binary file from [Releases](https://github.com/mthenw/frontail/releases) page (currently `frontail` doesn't work on Windows)
-* using [npm package](https://www.npmjs.com/package/frontail): `npm i frontail -g`
-* using [Docker image](https://cloud.docker.com/repository/docker/mthenw/frontail): `docker run -d -P -v /var/log:/log mthenw/frontail /log/syslog`
+- download a binary file from [Releases](https://github.com/mthenw/frontail/releases) pagegit st
+- using [npm package](https://www.npmjs.com/package/frontail): `npm i frontail -g`
+- using [Docker image](https://cloud.docker.com/repository/docker/mthenw/frontail): `docker run -d -P -v /var/log:/log mthenw/frontail /log/syslog`
 
 ## Usage
 
@@ -38,7 +38,6 @@
 
     Options:
 
-      -h, --help                    output usage information
       -V, --version                 output the version number
       -h, --host <host>             listening host, default 0.0.0.0
       -p, --port <port>             listening port, default 9001
@@ -58,8 +57,10 @@
       --ui-highlight                highlight words or lines if defined string found in logs, default preset
       --ui-highlight-preset <path>  custom preset for highlighting (see ./preset/default.json)
       --path <path>                 prefix path for the running application, default /
+      --disable-usage-stats         disable gathering usage statistics
+      --help                        output usage information
 
-Web interface runs on **http://127.0.0.1:[port]**.
+Web interface runs on **http://[host]:[port]**.
 
 ### Tailing multiple files
 
@@ -91,6 +92,7 @@ which means that every "err" string will be in red and every line containing "er
 _New presets are very welcome. If you don't like default or you would like to share yours, please create PR with json file._
 
 Available presets:
+
 - default
 - npmlog
 - python
@@ -121,3 +123,10 @@ http {
     }
 }
 ```
+
+### Usage statistics
+
+`frontail` by default (from `v4.5.0`) gathers **anonymous** usage statistics in Google Analytics. It can be disabled with
+`--disable-usage-stats`.
+
+The data is used to help me understand how `frontail` is used and I can make it better.

RELEASING.md

@@ -18,23 +18,18 @@ After all [pull requests](https://github.com/mthenw/frontail/pulls) for a releas
     $ git commit -am "Release <version>"
     ```
 
-1. Tag the version.
+1. Push the commit.
 
     ```sh
-    $ git tag v<version>
+    $ git push origin head
     ```
 
-1. Push the commit and tag.
-
-    ```sh
-    $ git push origin head --tags
-    ```
-
-1. Travis CI will publish new version to NPM.
+1. GitHub action will publish new version to NPM and push new tag.
 
 1. Publish new release on GitHub with [`release`](https://github.com/zeit/release) package.
 
     ```sh
+    $ git pull
     $ npx release -P
     ```
 

docker-entrypoint.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 set -euo pipefail
 

index.js

@@ -4,7 +4,7 @@ const cookie = require('cookie');
 const cookieParser = require('cookie-parser');
 const crypto = require('crypto');
 const path = require('path');
-const SocketIO = require('socket.io');
+const { Server } = require('socket.io');
 const fs = require('fs');
 const untildify = require('untildify');
 const tail = require('./lib/tail');
@@ -12,6 +12,7 @@ const connectBuilder = require('./lib/connect_builder');
 const program = require('./lib/options_parser');
 const serverBuilder = require('./lib/server_builder');
 const daemonize = require('./lib/daemonize');
+const usageStats = require('./lib/stats');
 
 /**
  * Parse args
@@ -22,6 +23,13 @@ if (program.args.length === 0) {
   process.exit();
 }
 
+/**
+ * Init usage statistics
+ */
+const stats = usageStats(!program.disableUsageStats, program);
+stats.track('runtime', 'init');
+stats.time('runtime', 'runtime');
+
 /**
  * Validate params
  */
@@ -29,16 +37,13 @@ const doAuthorization = !!(program.user && program.password);
 const doSecure = !!(program.key && program.certificate);
 const sessionSecret = String(+new Date()) + Math.random();
 const files = program.args.join(' ');
-const filesNamespace = crypto
-  .createHash('md5')
-  .update(files)
-  .digest('hex');
+const filesNamespace = crypto.createHash('md5').update(files).digest('hex');
 const urlPath = program.urlPath.replace(/\/$/, ''); // remove trailing slash
 
 if (program.daemonize) {
   daemonize(__filename, program, {
     doAuthorization,
-    doSecure
+    doSecure,
   });
 } else {
   /**
@@ -50,8 +55,13 @@ if (program.daemonize) {
     appBuilder.authorize(program.user, program.password);
   }
   appBuilder
-    .static(path.join(__dirname, 'web/assets'))
-    .index(path.join(__dirname, 'web/index.html'), files, filesNamespace, program.theme);
+    .static(path.join(__dirname, 'web', 'assets'))
+    .index(
+      path.join(__dirname, 'web', 'index.html'),
+      files,
+      filesNamespace,
+      program.theme
+    );
 
   const builder = serverBuilder();
   if (doSecure) {
@@ -66,7 +76,7 @@ if (program.daemonize) {
   /**
    * socket.io setup
    */
-  const io = new SocketIO({ path: path.join(urlPath, '/socket.io') });
+  const io = new Server({ path: `${urlPath}/socket.io` });
   io.attach(server);
 
   if (doAuthorization) {
@@ -78,7 +88,10 @@ if (program.daemonize) {
         if (!sessionIdEncoded) {
           return next(new Error('Session cookie not provided'), false);
         }
-        const sessionId = cookieParser.signedCookie(sessionIdEncoded, sessionSecret);
+        const sessionId = cookieParser.signedCookie(
+          sessionIdEncoded,
+          sessionSecret
+        );
         if (sessionId) {
           return next(null);
         }
@@ -97,7 +110,7 @@ if (program.daemonize) {
     let presetPath;
 
     if (!program.uiHighlightPreset) {
-      presetPath = path.join(__dirname, 'preset/default.json');
+      presetPath = path.join(__dirname, 'preset', 'default.json');
     } else {
       presetPath = path.resolve(untildify(program.uiHighlightPreset));
     }
@@ -113,7 +126,7 @@ if (program.daemonize) {
    * When connected send starting data
    */
   const tailer = tail(program.args, {
-    buffer: program.number
+    buffer: program.number,
   });
 
   const filesSocket = io.of(`/${filesNamespace}`).on('connection', (socket) => {
@@ -143,11 +156,15 @@ if (program.daemonize) {
     filesSocket.emit('line', line);
   });
 
+  stats.track('runtime', 'started');
+
   /**
    * Handle signals
    */
   const cleanExit = () => {
-    process.exit();
+    stats.timeEnd('runtime', 'runtime', () => {
+      process.exit();
+    });
   };
   process.on('SIGINT', cleanExit);
   process.on('SIGTERM', cleanExit);

lib/connect_builder.js

@@ -14,7 +14,10 @@ function ConnectBuilder(urlPath) {
 ConnectBuilder.prototype.authorize = function authorize(user, pass) {
   this.app.use(
     this.urlPath,
-    basicAuth((incomingUser, incomingPass) => user === incomingUser && pass === incomingPass)
+    basicAuth(
+      (incomingUser, incomingPass) =>
+        user === incomingUser && pass === incomingPass
+    )
   );
 
   return this;
@@ -24,13 +27,18 @@ ConnectBuilder.prototype.build = function build() {
   return this.app;
 };
 
-ConnectBuilder.prototype.index = function index(path, files, filesNamespace, themeOpt) {
+ConnectBuilder.prototype.index = function index(
+  path,
+  files,
+  filesNamespace,
+  themeOpt
+) {
   const theme = themeOpt || 'default';
 
   this.app.use(this.urlPath, (req, res) => {
     fs.readFile(path, (err, data) => {
       res.writeHead(200, {
-        'Content-Type': 'text/html'
+        'Content-Type': 'text/html',
       });
       res.end(
         data
@@ -53,7 +61,7 @@ ConnectBuilder.prototype.session = function sessionf(secret) {
     expressSession({
       secret,
       resave: false,
-      saveUninitialized: true
+      saveUninitialized: true,
     })
   );
   return this;
@@ -64,4 +72,4 @@ ConnectBuilder.prototype.static = function staticf(path) {
   return this;
 };
 
-module.exports = urlPath => new ConnectBuilder(urlPath);
+module.exports = (urlPath) => new ConnectBuilder(urlPath);

lib/daemonize.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 
 const defaultOptions = {
   doAuthorization: false,
-  doSecure: false
+  doSecure: false,
 };
 
 module.exports = (script, params, opts) => {
@@ -23,7 +23,7 @@ module.exports = (script, params, opts) => {
     '-l',
     params.lines,
     '-t',
-    params.theme
+    params.theme,
   ];
 
   if (options.doAuthorization) {
@@ -54,11 +54,15 @@ module.exports = (script, params, opts) => {
     args.push('--ui-highlight-preset', params.uiHighlightPreset);
   }
 
+  if (params.disableUsageStats) {
+    args.push('--disable-usage-stats', params.disableUsageStats);
+  }
+
   args = args.concat(params.args);
 
   const proc = daemon.daemon(script, args, {
     stdout: logFile,
-    stderr: logFile
+    stderr: logFile,
   });
 
   fs.writeFileSync(params.pidPath, proc.pid);

lib/options_parser.js

@@ -3,11 +3,32 @@ const program = require('commander');
 program
   .version(require('../package.json').version)
   .usage('[options] [file ...]')
-  .option('-h, --host <host>', 'listening host, default 0.0.0.0', String, '0.0.0.0')
+  .helpOption('--help')
+  .option(
+    '-h, --host <host>',
+    'listening host, default 0.0.0.0',
+    String,
+    '0.0.0.0'
+  )
   .option('-p, --port <port>', 'listening port, default 9001', Number, 9001)
-  .option('-n, --number <number>', 'starting lines number, default 10', Number, 10)
-  .option('-l, --lines <lines>', 'number on lines stored in browser, default 2000', Number, 2000)
-  .option('-t, --theme <theme>', 'name of the theme (default, dark)', String, 'default')
+  .option(
+    '-n, --number <number>',
+    'starting lines number, default 10',
+    Number,
+    10
+  )
+  .option(
+    '-l, --lines <lines>',
+    'number on lines stored in browser, default 2000',
+    Number,
+    2000
+  )
+  .option(
+    '-t, --theme <theme>',
+    'name of the theme (default, dark)',
+    String,
+    'default'
+  )
   .option('-d, --daemonize', 'run as daemon')
   .option(
     '-U, --user <username>',
@@ -45,7 +66,12 @@ program
     String,
     '/dev/null'
   )
-  .option('--url-path <path>', 'URL path for the browser application, default /', String, '/')
+  .option(
+    '--url-path <path>',
+    'URL path for the browser application, default /',
+    String,
+    '/'
+  )
   .option('--ui-hide-topbar', 'hide topbar (log file name and search box)')
   .option('--ui-no-indent', "don't indent log lines")
   .option(
@@ -55,6 +81,7 @@ program
   .option(
     '--ui-highlight-preset <path>',
     'custom preset for highlighting (see ./preset/default.json)'
-  );
+  )
+  .option('--disable-usage-stats', 'disable gathering usage statistics');
 
 module.exports = program;

lib/server_builder.js

@@ -15,9 +15,11 @@ ServerBuilder.prototype.build = function build() {
   if (this._key && this._cert) {
     const options = {
       key: this._key,
-      cert: this._cert
+      cert: this._cert,
     };
-    return https.createServer(options, this._callback).listen(this._port, this._host);
+    return https
+      .createServer(options, this._callback)
+      .listen(this._port, this._host);
   }
 
   return http.createServer(this._callback).listen(this._port, this._host);

lib/stats.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const ua = require('universal-analytics');
+const isDocker = require('is-docker');
+const Configstore = require('configstore');
+const uuidv4 = require('uuid/v4');
+const pkg = require('../package.json');
+
+const trackingID = 'UA-129582046-1';
+
+// Usage stats
+function Stats(enabled, opts) {
+  this.timer = {};
+
+  if (enabled === true) {
+    const config = new Configstore(pkg.name);
+    let clientID = uuidv4();
+    if (config.has('clientID')) {
+      clientID = config.get('clientID');
+    } else {
+      config.set('clientID', clientID);
+    }
+
+    const tracker = ua(trackingID, clientID);
+    tracker.set('aip', 1); // Anonymize IP
+    tracker.set('an', 'frontail'); // Application Name
+    tracker.set('av', pkg.version); // Application Version
+    tracker.set('ds', 'app'); // Data Source
+    tracker.set('cd1', process.platform); // platform
+    tracker.set('cd2', process.arch); // arch
+    tracker.set('cd3', process.version.match(/^v(\d+\.\d+)/)[1]); // Node version
+    tracker.set('cd4', isDocker()); // is Docker
+    tracker.set('cd5', opts.number !== 10); // is --number parameter set
+    this.tracker = tracker;
+  }
+
+  return this;
+}
+
+Stats.prototype.track = function track(category, action) {
+  if (!this.tracker) {
+    return;
+  }
+  this.tracker.event(category, action).send();
+};
+
+Stats.prototype.time = function time(category, action) {
+  if (!this.tracker) {
+    return;
+  }
+
+  if (!this.timer[category]) {
+    this.timer[category] = {};
+  }
+  this.timer[category][action] = Date.now();
+};
+
+Stats.prototype.timeEnd = function timeEnd(category, action, cb) {
+  if (!this.tracker) {
+    cb();
+    return;
+  }
+
+  this.tracker
+    .timing(category, action, Date.now() - this.timer[category][action])
+    .send(cb);
+};
+
+module.exports = (enabled, opts) => new Stats(enabled, opts);

lib/tail.js

@@ -4,50 +4,64 @@
 
 const events = require('events');
 const childProcess = require('child_process');
+const tailStream = require('fs-tail-stream');
 const util = require('util');
 const CBuffer = require('CBuffer');
 const byline = require('byline');
+const commandExistsSync = require('command-exists').sync;
 
 function Tail(path, opts) {
   events.EventEmitter.call(this);
 
   const options = opts || {
-    buffer: 0
+    buffer: 0,
   };
   this._buffer = new CBuffer(options.buffer);
 
+  let stream;
+
   if (path[0] === '-') {
-    byline(process.stdin).on('data', (line) => {
-      const str = line.toString();
-      this._buffer.push(str);
-      this.emit('line', str);
-    });
+    stream = process.stdin;
   } else {
-    let followOpt = '-F';
-    if (process.platform === 'openbsd') {
-      followOpt = '-f';
-    }
-
-    const tail = childProcess.spawn('tail', ['-n', options.buffer, followOpt].concat(path));
-
-    tail.stderr.on('data', (data) => {
-      // If there is any important error then display it in the console. Tail will keep running.
-      // File can be truncated over network.
-      if (data.toString().indexOf('file truncated') === -1) {
-        console.error(data.toString());
+    /* Check if this os provides the `tail` command. */
+    const hasTailCommand = commandExistsSync('tail');
+    if (hasTailCommand) {
+      let followOpt = '-F';
+      if (process.platform === 'openbsd') {
+        followOpt = '-f';
       }
-    });
 
-    byline(tail.stdout).on('data', (line) => {
-      const str = line.toString();
-      this._buffer.push(str);
-      this.emit('line', str);
-    });
+      const cp = childProcess.spawn(
+        'tail',
+        ['-n', options.buffer, followOpt].concat(path)
+      );
+      cp.stderr.on('data', (data) => {
+        // If there is any important error then display it in the console. Tail will keep running.
+        // File can be truncated over network.
+        if (data.toString().indexOf('file truncated') === -1) {
+          console.error(data.toString());
+        }
+      });
+      stream = cp.stdout;
 
-    process.on('exit', () => {
-      tail.kill();
-    });
+      process.on('exit', () => {
+        cp.kill();
+      });
+    } else {
+      /* This is used if the os does not support the `tail`command. */
+      stream = tailStream.createReadStream(path.join(), {
+        encoding: 'utf8',
+        start: options.buffer,
+        tail: true,
+      });
+    }
   }
+
+  byline(stream, { keepEmptyLines: true }).on('data', (line) => {
+    const str = line.toString();
+    this._buffer.push(str);
+    this.emit('line', str);
+  });
 }
 util.inherits(Tail, events.EventEmitter);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "frontail",
-  "version": "4.4.0",
+  "version": "4.9.2",
   "description": "streaming logs to the browser",
   "homepage": "https://github.com/mthenw/frontail",
   "author": "Maciej Winnicki <maciej.winnicki@gmail.com>",
@@ -8,33 +8,40 @@
   "bin": "./bin/frontail",
   "dependencies": {
     "CBuffer": "0.1.4",
-    "basic-auth-connect": "^1.0.0",
-    "byline": "^5.0.0",
-    "commander": "1.3.2",
-    "connect": "3.6.6",
+    "basic-auth-connect": "1.0.0",
+    "byline": "5.0.0",
+    "command-exists": "1.2.8",
+    "commander": "3.0.1",
+    "configstore": "4.0.0",
+    "connect": "3.7.0",
     "cookie": "0.1.0",
-    "cookie-parser": "^1.4.3",
+    "cookie-parser": "1.4.5",
     "daemon-fix41": "1.1.2",
-    "express-session": "^1.15.6",
-    "serve-static": "^1.13.2",
-    "socket.io": "^1.7.0",
-    "untildify": "^3.0.2"
+    "express-session": "1.15.6",
+    "fs-tail-stream": "1.1.0",
+    "is-docker": "1.1.0",
+    "serve-static": "1.14.1",
+    "socket.io": "3.1.2",
+    "universal-analytics": "0.4.23",
+    "untildify": "3.0.2",
+    "uuid": "3.3.2"
   },
   "devDependencies": {
-    "eslint": "^5.6.1",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.14.0",
-    "jsdom": "^11.11.0",
-    "mocha": "^2.3.2",
-    "pkg": "^4.3.3",
+    "eslint": "~6.8.0",
+    "eslint-config-airbnb-base": "~14.0.0",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-import": "~2.20.0",
+    "jsdom": "~11.12.0",
+    "mocha": "~5.2.0",
+    "pkg": "~4.4.7",
     "should": "~3.3.2",
     "sinon": "~1.7.3",
-    "supertest": "~0.8.1",
+    "supertest": "^3.3.0",
     "temp": "~0.8.1"
   },
   "scripts": {
     "lint": "eslint .",
-    "test": "mocha -r should --reporter spec test/*.js",
+    "test": "mocha -r should --exit test/*.js",
     "pkg": "pkg --out-path=dist ."
   },
   "pkg": {
@@ -43,11 +50,34 @@
       "web/**/*"
     ],
     "targets": [
-      "node8-alpine-x64",
-      "node8-linux-x64",
-      "node8-macos-x64"
+      "node12-alpine-x64",
+      "node12-linux-x64",
+      "node12-macos-x64",
+      "node12-windows-x64"
     ]
   },
+  "eslintConfig": {
+    "extends": [
+      "airbnb-base",
+      "prettier"
+    ],
+    "rules": {
+      "no-console": "off",
+      "strict": "off",
+      "implicit-arrow-linebreak": "off"
+    },
+    "env": {
+      "node": true
+    },
+    "ignorePatterns": [
+      "web/assets/tinycon.min.js",
+      "web/assets/ansi_up.js"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
   "repository": {
     "type": "git",
     "url": "http://github.com/mthenw/frontail.git"

test/app.js

@@ -13,8 +13,9 @@ describe('browser application', () => {
       socket: io,
       container: window.document.querySelector('.log'),
       filterInput: window.document.querySelector('#filter'),
+      pauseBtn: window.document.querySelector('#pauseBtn'),
       topbar: window.document.querySelector('.topbar'),
-      body: window.document.querySelector('body')
+      body: window.document.querySelector('body'),
     });
   }
 
@@ -42,8 +43,10 @@ describe('browser application', () => {
 
   beforeEach((done) => {
     io = new events.EventEmitter();
-    const html = '<title></title><body><div class="topbar"></div>'
-      + '<div class="log"></div><input type="test" id="filter"/></body>';
+    const html =
+      '<title></title><body><div class="topbar"></div>' +
+      '<div class="log"></div><button type="button" id="pauseBtn"></button>' +
+      '<input type="test" id="filter"/></body>';
     const ansiup = fs.readFileSync('./web/assets/ansi_up.js', 'utf-8');
     const src = fs.readFileSync('./web/assets/app.js', 'utf-8');
 
@@ -56,7 +59,7 @@ describe('browser application', () => {
 
         initApp();
         done();
-      }
+      },
     });
   });
 
@@ -68,7 +71,9 @@ describe('browser application', () => {
     log.childNodes[0].textContent.should.be.equal('test');
     log.childNodes[0].className.should.be.equal('line');
     log.childNodes[0].tagName.should.be.equal('DIV');
-    log.childNodes[0].innerHTML.should.be.equal('<p class="inner-line">test</p>');
+    log.childNodes[0].innerHTML.should.be.equal(
+      '<p class="inner-line">test</p>'
+    );
   });
 
   it('should select line when clicked', () => {
@@ -121,20 +126,23 @@ describe('browser application', () => {
   it('should highlight word', () => {
     io.emit('options:highlightConfig', {
       words: {
-        line: 'background: black'
-      }
+        foo: 'background: black',
+        bar: 'background: black',
+      },
     });
-    io.emit('line', 'line1');
+    io.emit('line', 'foo bar');
 
     const line = window.document.querySelector('.line');
-    line.innerHTML.should.containEql('<span style="background: black">line</span>');
+    line.innerHTML.should.containEql(
+      '<span style="background: black">foo</span> <span style="background: black">bar</span>'
+    );
   });
 
   it('should highlight line', () => {
     io.emit('options:highlightConfig', {
       lines: {
-        line: 'background: black'
-      }
+        line: 'background: black',
+      },
     });
     io.emit('line', 'line1');
 
@@ -198,4 +206,37 @@ describe('browser application', () => {
     log.childNodes[2].style.display.should.be.equal('none');
     window.location.href.should.containEql('filter=other');
   });
+
+  it('should pause', () => {
+    io.emit('line', 'line1');
+    const btn = window.document.querySelector('#pauseBtn');
+    const event = window.document.createEvent('Event');
+    event.initEvent('mouseup', true, true);
+    btn.dispatchEvent(event);
+    io.emit('line', 'line2');
+    io.emit('line', 'line3');
+
+    btn.className.should.containEql('play');
+    const log = window.document.querySelector('.log');
+    log.childNodes.length.should.be.equal(2);
+    log.lastChild.textContent.should.be.equal('==> SKIPPED: 2 <==');
+  });
+
+  it('should play', () => {
+    const btn = window.document.querySelector('#pauseBtn');
+    const event = window.document.createEvent('Event');
+    event.initEvent('mouseup', true, true);
+    btn.dispatchEvent(event);
+    io.emit('line', 'line1');
+    const log = window.document.querySelector('.log');
+    log.childNodes.length.should.be.equal(1);
+    log.lastChild.textContent.should.be.equal('==> SKIPPED: 1 <==');
+    btn.className.should.containEql('play');
+    btn.dispatchEvent(event);
+    io.emit('line', 'line2');
+
+    btn.className.should.not.containEql('play');
+    log.childNodes.length.should.be.equal(2);
+    log.lastChild.textContent.should.be.equal('line2');
+  });
 });

test/connect_builder.js

@@ -6,18 +6,12 @@ const connectBuilder = require('../lib/connect_builder');
 
 describe('connectBuilder', () => {
   it('should build connect app', () => {
-    connectBuilder('/')
-      .build()
-      .should.have.property('use');
-    connectBuilder()
-      .build()
-      .should.have.property('listen');
+    connectBuilder('/').build().should.have.property('use');
+    connectBuilder().build().should.have.property('listen');
   });
 
   it('should build app requiring authorized user', (done) => {
-    const app = connectBuilder('/')
-      .authorize('user', 'pass')
-      .build();
+    const app = connectBuilder('/').authorize('user', 'pass').build();
 
     request(app)
       .get('/')
@@ -26,9 +20,7 @@ describe('connectBuilder', () => {
   });
 
   it('should build app allowing user to login', (done) => {
-    const app = connectBuilder('/')
-      .authorize('user', 'pass')
-      .build();
+    const app = connectBuilder('/').authorize('user', 'pass').build();
     app.use((req, res) => {
       res.end('secret!');
     });
@@ -40,9 +32,7 @@ describe('connectBuilder', () => {
   });
 
   it('should build app that setup session', (done) => {
-    const app = connectBuilder('/')
-      .session('secret')
-      .build();
+    const app = connectBuilder('/').session('secret').build();
     app.use((req, res) => {
       res.end();
     });
@@ -57,9 +47,7 @@ describe('connectBuilder', () => {
       .static(path.join(__dirname, 'fixtures'))
       .build();
 
-    request(app)
-      .get('/foo')
-      .expect('bar', done);
+    request(app).get('/foo.txt').expect('bar', done);
   });
 
   it('should build app that serve index file', (done) => {
@@ -67,10 +55,7 @@ describe('connectBuilder', () => {
       .index(path.join(__dirname, 'fixtures/index'), '/testfile')
       .build();
 
-    request(app)
-      .get('/')
-      .expect(200)
-      .expect('Content-Type', 'text/html', done);
+    request(app).get('/').expect(200).expect('Content-Type', 'text/html', done);
   });
 
   it('should build app that serve index file on specified path', (done) => {
@@ -89,24 +74,30 @@ describe('connectBuilder', () => {
       .index(path.join(__dirname, 'fixtures/index_with_title'), '/testfile')
       .build();
 
-    request(app)
-      .get('/')
-      .expect('<head><title>/testfile</title></head>', done);
+    request(app).get('/').expect('<head><title>/testfile</title></head>', done);
   });
 
   it('should build app that sets socket.io namespace based on files', (done) => {
     const app = connectBuilder('/')
-      .index(path.join(__dirname, 'fixtures/index_with_ns'), '/testfile', 'ns', 'dark')
+      .index(
+        path.join(__dirname, 'fixtures/index_with_ns'),
+        '/testfile',
+        'ns',
+        'dark'
+      )
       .build();
 
-    request(app)
-      .get('/')
-      .expect('ns', done);
+    request(app).get('/').expect('ns', done);
   });
 
   it('should build app that sets theme', (done) => {
     const app = connectBuilder('/')
-      .index(path.join(__dirname, '/fixtures/index_with_theme'), '/testfile', 'ns', 'dark')
+      .index(
+        path.join(__dirname, '/fixtures/index_with_theme'),
+        '/testfile',
+        'ns',
+        'dark'
+      )
       .build();
 
     request(app)

test/daemonize.js

@@ -10,7 +10,7 @@ describe('daemonize', () => {
   beforeEach(() => {
     sinon.stub(daemon, 'daemon');
     daemon.daemon.returns({
-      pid: 1000
+      pid: 1000,
     });
     sinon.stub(fs, 'writeFileSync');
     sinon.stub(fs, 'openSync');
@@ -70,41 +70,89 @@ describe('daemonize', () => {
     });
 
     it('with authorization', () => {
-      optionsParser.parse(['node', '/path/to/frontail', '-U', 'user', '-P', 'passw0rd']);
+      optionsParser.parse([
+        'node',
+        '/path/to/frontail',
+        '-U',
+        'user',
+        '-P',
+        'passw0rd',
+      ]);
 
       daemonize('script', optionsParser, {
-        doAuthorization: true
+        doAuthorization: true,
       });
 
-      daemon.daemon.lastCall.args[1].should.containDeep(['-U', 'user', '-P', 'passw0rd']);
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '-U',
+        'user',
+        '-P',
+        'passw0rd',
+      ]);
     });
 
     it('without authorization if option doAuthorization not passed', () => {
-      optionsParser.parse(['node', '/path/to/frontail', '-U', 'user', '-P', 'passw0rd']);
+      optionsParser.parse([
+        'node',
+        '/path/to/frontail',
+        '-U',
+        'user',
+        '-P',
+        'passw0rd',
+      ]);
 
       daemonize('script', optionsParser);
 
-      daemon.daemon.lastCall.args[1].should.not.containDeep(['-U', 'user', '-P', 'passw0rd']);
+      daemon.daemon.lastCall.args[1].should.not.containDeep([
+        '-U',
+        'user',
+        '-P',
+        'passw0rd',
+      ]);
     });
 
     it('with secure connection', () => {
-      optionsParser.parse(['node', '/path/to/frontail', '-k', 'key.file', '-c', 'cert.file']);
+      optionsParser.parse([
+        'node',
+        '/path/to/frontail',
+        '-k',
+        'key.file',
+        '-c',
+        'cert.file',
+      ]);
 
       daemonize('script', optionsParser, {
-        doSecure: true
+        doSecure: true,
       });
 
-      daemon.daemon.lastCall.args[1].should.containDeep(['-k', 'key.file', '-c', 'cert.file']);
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '-k',
+        'key.file',
+        '-c',
+        'cert.file',
+      ]);
     });
 
     it('without secure connection if option doSecure not passed', () => {
-      optionsParser.parse(['node', '/path/to/frontail', '-k', 'key.file', '-c', 'cert.file']);
+      optionsParser.parse([
+        'node',
+        '/path/to/frontail',
+        '-k',
+        'key.file',
+        '-c',
+        'cert.file',
+      ]);
 
       daemonize('script', optionsParser, {
-        doSecure: true
+        doSecure: true,
       });
 
-      daemon.daemon.lastCall.args[1].should.containDeep(['-k', 'key.file', '-c', 'cert.file']);
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '-k',
+        'key.file',
+        '-c',
+        'cert.file',
+      ]);
     });
 
     it('with url-path option', () => {
@@ -112,7 +160,10 @@ describe('daemonize', () => {
 
       daemonize('script', optionsParser);
 
-      daemon.daemon.lastCall.args[1].should.containDeep(['--url-path', '/test']);
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '--url-path',
+        '/test',
+      ]);
     });
 
     it('with hide-topbar option', () => {
@@ -145,12 +196,31 @@ describe('daemonize', () => {
         '/path/to/frontail',
         '--ui-highlight',
         '--ui-highlight-preset',
-        'test.json'
+        'test.json',
       ]);
 
       daemonize('script', optionsParser);
 
-      daemon.daemon.lastCall.args[1].should.containDeep(['--ui-highlight-preset', 'test.json']);
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '--ui-highlight-preset',
+        'test.json',
+      ]);
+    });
+
+    it('with disable usage stats', () => {
+      optionsParser.parse([
+        'node',
+        '/path/to/frontail',
+        '--disable-usage-stats',
+        'test.json',
+      ]);
+
+      daemonize('script', optionsParser);
+
+      daemon.daemon.lastCall.args[1].should.containDeep([
+        '--disable-usage-stats',
+        'test.json',
+      ]);
     });
 
     it('with file to tail', () => {
@@ -163,7 +233,12 @@ describe('daemonize', () => {
   });
 
   it('should write pid to pidfile', () => {
-    optionsParser.parse(['node', '/path/to/frontail', '--pid-path', '/path/to/pid']);
+    optionsParser.parse([
+      'node',
+      '/path/to/frontail',
+      '--pid-path',
+      '/path/to/pid',
+    ]);
 
     daemonize('script', optionsParser);
 
@@ -172,7 +247,12 @@ describe('daemonize', () => {
   });
 
   it('should log to file', () => {
-    optionsParser.parse(['node', '/path/to/frontail', '--log-path', '/path/to/log']);
+    optionsParser.parse([
+      'node',
+      '/path/to/frontail',
+      '--log-path',
+      '/path/to/log',
+    ]);
     fs.openSync.returns('file');
 
     daemonize('script', optionsParser);
@@ -181,7 +261,7 @@ describe('daemonize', () => {
     fs.openSync.lastCall.args[1].should.equal('a');
     daemon.daemon.lastCall.args[2].should.eql({
       stdout: 'file',
-      stderr: 'file'
+      stderr: 'file',
     });
   });
 });

test/server_builder.js

@@ -31,9 +31,7 @@ describe('serverBuilder', () => {
     it('should build server accepting requests', () => {
       const callback = () => {};
 
-      serverBuilder()
-        .use(callback)
-        .build();
+      serverBuilder().use(callback).build();
 
       createServer.calledWith(callback).should.equal(true);
     });
@@ -45,9 +43,7 @@ describe('serverBuilder', () => {
     });
 
     it('should build server listening on specified port', () => {
-      serverBuilder()
-        .port(6666)
-        .build();
+      serverBuilder().port(6666).build();
 
       httpServer.listen.calledWith(6666).should.equal(true);
     });
@@ -59,9 +55,7 @@ describe('serverBuilder', () => {
     });
 
     it('should build server listening on specified host', () => {
-      serverBuilder()
-        .host('127.0.0.1')
-        .build();
+      serverBuilder().host('127.0.0.1').build();
 
       httpServer.listen.calledWith(9001, '127.0.0.1').should.equal(true);
     });
@@ -81,7 +75,9 @@ describe('serverBuilder', () => {
     beforeEach(() => {
       httpsServer = sinon.createStubInstance(https.Server);
       httpsServer.listen.returns(httpsServer);
-      createHttpsServer = sinon.stub(https, 'createServer').returns(httpsServer);
+      createHttpsServer = sinon
+        .stub(https, 'createServer')
+        .returns(httpsServer);
       readFileSyncStub = sinon.stub(fs, 'readFileSync');
       readFileSyncStub.withArgs('key.pem').returns('testkey');
       readFileSyncStub.withArgs('cert.pem').returns('testcert');
@@ -93,15 +89,13 @@ describe('serverBuilder', () => {
     });
 
     it('should build server', () => {
-      const server = serverBuilder()
-        .secure('key.pem', 'cert.pem')
-        .build();
+      const server = serverBuilder().secure('key.pem', 'cert.pem').build();
 
       server.should.be.an.instanceof(https.Server);
       createHttpsServer
         .calledWith({
           key: 'testkey',
-          cert: 'testcert'
+          cert: 'testcert',
         })
         .should.equal(true);
     });
@@ -109,16 +103,13 @@ describe('serverBuilder', () => {
     it('should build server accepting requests', () => {
       const callback = () => {};
 
-      serverBuilder()
-        .use(callback)
-        .secure('key.pem', 'cert.pem')
-        .build();
+      serverBuilder().use(callback).secure('key.pem', 'cert.pem').build();
 
       createHttpsServer
         .calledWith(
           {
             key: 'testkey',
-            cert: 'testcert'
+            cert: 'testcert',
           },
           callback
         )

test/tail.js

@@ -37,7 +37,7 @@ describe('tail', () => {
       writeLines(info.fd, 20);
 
       const tailer = tail(info.path, {
-        buffer: 2
+        buffer: 2,
       });
       setTimeout(() => {
         tailer.getBuffer().should.be.eql(['line18', 'line19']);

web/assets/app.js

@@ -27,6 +27,24 @@ window.App = (function app(window, document) {
    */
   var _filterValue = '';
 
+  /**
+   * @type {HTMLElement}
+   * @private
+   */
+  var _pauseBtn;
+
+  /**
+   * @type {boolean}
+   * @private
+   */
+  var _isPaused = false;
+
+  /**
+   * @type {number}
+   * @private
+   */
+  var _skipCounter = 0;
+
   /**
    * @type {HTMLElement}
    * @private
@@ -133,17 +151,6 @@ window.App = (function app(window, document) {
     window.history.replaceState(null, document.title, _url.toString());
   };
 
-  /**
-   * @return {Boolean}
-   * @private
-   */
-  var _isScrolledBottom = function() {
-    var currentScroll = document.documentElement.scrollTop || document.body.scrollTop;
-    var totalHeight = document.body.offsetHeight;
-    var clientHeight = document.documentElement.clientHeight; // eslint-disable-line
-    return totalHeight <= currentScroll + clientHeight;
-  };
-
   /**
    * @return void
    * @private
@@ -158,7 +165,7 @@ window.App = (function app(window, document) {
    * @private
    */
   var _updateFaviconCounter = function() {
-    if (_isWindowFocused) {
+    if (_isWindowFocused || _isPaused) {
       return;
     }
 
@@ -177,9 +184,9 @@ window.App = (function app(window, document) {
 
     if (_highlightConfig && _highlightConfig.words) {
       Object.keys(_highlightConfig.words).forEach((wordCheck) => {
-        output = line.replace(
+        output = output.replace(
           wordCheck,
-          '<span style="' + _highlightConfig.words[wordCheck] + '">' + wordCheck + '</span>'
+          '<span style="' + _highlightConfig.words[wordCheck] + '">' + wordCheck + '</span>',
         );
       });
     }
@@ -216,6 +223,7 @@ window.App = (function app(window, document) {
       _logContainer = opts.container;
       _filterInput = opts.filterInput;
       _filterInput.focus();
+      _pauseBtn = opts.pauseBtn;
       _topbar = opts.topbar;
       _body = opts.body;
 
@@ -234,13 +242,24 @@ window.App = (function app(window, document) {
         _filterLogs();
       });
 
+      // Pause button bind
+      _pauseBtn.addEventListener('mouseup', function() {
+        _isPaused = !_isPaused;
+        if (_isPaused) {
+          this.className += ' play';
+        } else {
+          _skipCounter = 0;
+          this.classList.remove('play');
+        }
+      });
+
       // Favicon counter bind
       window.addEventListener(
         'blur',
         function() {
           _isWindowFocused = false;
         },
-        true
+        true,
       );
       window.addEventListener(
         'focus',
@@ -248,7 +267,7 @@ window.App = (function app(window, document) {
           _isWindowFocused = true;
           _faviconReset();
         },
-        true
+        true,
       );
 
       // socket.io init
@@ -268,7 +287,12 @@ window.App = (function app(window, document) {
           _highlightConfig = highlightConfig;
         })
         .on('line', function(line) {
-          self.log(line);
+          if (_isPaused) {
+            _skipCounter += 1;
+            self.log('==> SKIPPED: ' + _skipCounter + ' <==', (_skipCounter > 1));
+          } else {
+            self.log(line);
+          }
         });
     },
 
@@ -277,8 +301,9 @@ window.App = (function app(window, document) {
      *
      * @param {string} data data to log
      */
-    log: function log(data) {
-      var wasScrolledBottom = _isScrolledBottom();
+    log: function log(data, replace = false) {
+      var wasScrolledBottom = window.innerHeight + Math.ceil(window.pageYOffset + 1)
+        >= document.body.offsetHeight;
       var div = document.createElement('div');
       var p = document.createElement('p');
       p.className = 'inner-line';
@@ -300,7 +325,11 @@ window.App = (function app(window, document) {
 
       div.appendChild(p);
       _filterElement(div);
-      _logContainer.appendChild(div);
+      if (replace) {
+        _logContainer.replaceChild(div, _logContainer.lastChild);
+      } else {
+        _logContainer.appendChild(div);
+      }
 
       if (_logContainer.children.length > _linesLimit) {
         _logContainer.removeChild(_logContainer.children[0]);
@@ -311,6 +340,6 @@ window.App = (function app(window, document) {
       }
 
       _updateFaviconCounter();
-    }
+    },
   };
 }(window, document));

web/assets/styles/dark.css

@@ -19,6 +19,17 @@ body {
   color: #999;
 }
 
+.btn-pause {
+    background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' fill='%237f8289' viewBox='0 0 8 8'><path d='M1 1v6h2v-6h-2zm4 0v6h2v-6h-2z'></path></svg>") no-repeat center center;
+    background-color: #2f3238;
+    border: 1px solid transparent;
+}
+
+.btn-pause.play {
+    background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' fill='%237f8289' viewBox='0 0 8 8'><path d='M1 1v6l6-3-6-3z'></path></svg>") no-repeat center center;
+    background-color: #2f3238;
+}
+
 .form-control {
   border: 0;
   color: #7f8289;

web/assets/styles/default.css

@@ -10,14 +10,34 @@ body {
 }
 
 .navbar-brand {
-  width: 100%;
   text-overflow: ellipsis;
   white-space: nowrap;
   overflow: hidden;
+  display: inline-block;
+  width: 100%;
+}
+
+.btn-pause {
+  margin: 8px 0 8px;
+  background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' fill='%23999' viewBox='0 0 8 8'><path d='M1 1v6h2v-6h-2zm4 0v6h2v-6h-2z'></path></svg>")
+    no-repeat center center;
+  background-color: #e2e6ea;
+  background-size: contain;
+  cursor: pointer;
+  display: inline-block;
+  height: 34px;
+  width: 34px;
+  border: 1px solid #ccc;
+}
+
+.btn-pause.play {
+  background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' fill='%23999' viewBox='0 0 8 8'><path d='M1 1v6l6-3-6-3z'></path></svg>")
+    no-repeat center center;
+  background-color: #e2e6ea;
 }
 
 .navbar-form-custom {
-  padding: 8px 12px 8px 0;
+  padding: 8px 0;
 }
 
 .no-horiz-padding {

web/index.html

@@ -13,10 +13,13 @@
     <nav class="topbar navbar navbar-inverse navbar-fixed-top" role="navigation">
         <div class="container-fluid">
             <div class="row">
-                <div class="col-sm-10">
-                    <span class="navbar-brand" title="__TITLE__">tail -f __TITLE__</span>
+                <div class="col-sm-8">
+                    <span class="navbar-brand text-overflow" title="__TITLE__">tail -f __TITLE__</span>
                 </div>
-                <div class="col-sm-2">
+                <div class="col-sm-1 text-right">
+                    <button type="button" class="btn btn-light btn-pause" data-toggle="button" aria-pressed="false" autocomplete="off"></button>
+                </div>
+                <div class="col-sm-3">
                     <form class="navbar-form-custom" role="search" onkeypress="return event.keyCode != 13;">
                         <input type="text" class="form-control query" placeholder="Filter" tabindex="1">
                     </form>
@@ -36,13 +39,15 @@
     <script src="__PATH__/app.js"></script>
     <script type="text/javascript">
         var socket = new io.connect('/__NAMESPACE__', {
-            path: '__PATH__/socket.io'
+            path: '__PATH__/socket.io',
+            transports: ['websocket']
         });
 
         window.load = App.init({
             socket: socket,
             container: document.getElementsByClassName('log')[0],
             filterInput: document.getElementsByClassName('query')[0],
+            pauseBtn: document.getElementsByClassName('btn-pause')[0],
             topbar: document.getElementsByClassName('topbar')[0],
             body: document.getElementsByTagName('body')[0]
         });