chore: initial commit

Author: fcoury

.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    "es2015",
+    "stage-2"
+  ]
+}

.eslintignore

@@ -0,0 +1 @@
+**/*{.,-}min.js

.eslintrc

@@ -0,0 +1,53 @@
+{
+    "parserOptions": {
+      "ecmaVersion": 6,
+      "sourceType": "module",
+      "ecmaFeatures": {
+        "forOf": true,
+        "jsx": true,
+        "es6": true,
+        "experimentalObjectRestSpread" : true
+      }
+    },
+    "env": {
+      "browser": true,
+      "es6": true,
+      "mocha": true
+    },
+    "rules": {
+      "camelcase": [2, { "properties": "never" }],
+      "comma-dangle": [2, "always-multiline"],
+      "eqeqeq": 2, // requires === and !===
+      "jsx-quotes": [2, "prefer-double"],
+      "quotes": [2, "single", { "allowTemplateLiterals": true }],
+      "no-eval": 2,
+      "no-irregular-whitespace": 2,
+      "no-trailing-spaces": 2,
+      "no-unsafe-finally": 2,
+      "no-console": 2,
+      "no-const-assign": 2,
+      "prefer-const": 2,
+      "no-undef": 2,
+      "no-unused-vars": [2, { "argsIgnorePattern": "^_", "varsIgnorePattern": "(^_|React)" } ],
+      "semi": [2, "always"],
+      "eol-last": 1,
+      "mocha/no-exclusive-tests": "error"
+    },
+    "plugins": [
+      "import",
+      "mocha"
+    ],
+    "globals": {
+      "__DEVSERVER__": true,
+      "__DEVCLIENT__": true,
+      "Buffer": true,
+      "process": true,
+      "global": true,
+      "expect": true,
+      "module": true,
+      "require": true,
+      "describe": true,
+      "sinon": true,
+      "logger": true
+    }
+}

.gitignore

@@ -0,0 +1,11 @@
+node_modules
+npm-debug.log
+.tmp
+.idea
+public
+compiled
+.swp
+.vscode
+.env
+.DS_Store
+coverage

package.json

@@ -0,0 +1,43 @@
+{
+  "name": "jv",
+  "version": "0.1.0",
+  "description": "JSON Log Viewer",
+  "main": "index.js",
+  "scripts": {
+    "start": "babel-node --presets es2015,stage-2 -- src/index.js",
+    "test": "NODE_ENV=test ./node_modules/.bin/mocha --compilers js:babel-core/register --timeout 5000 --require test/support/test-helper.js test/*.test.js test/**/*.test.js",
+    "test:watch": "NODE_ENV=test ./node_modules/.bin/mocha --watch --compilers js:babel-core/register --timeout 5000 --require test/support/test-helper.js test/*.test.js test/**/*.test.js"
+  },
+  "author": "Felipe Coury",
+  "license": "MIT",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "dependencies": {
+    "babel-cli": "^6.26.0",
+    "babel-core": "^6.26.0",
+    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-stage-2": "^6.24.1",
+    "blessed": "^0.1.81",
+    "blessed-contrib": "^4.8.5",
+    "lodash": "^4.17.4"
+  },
+  "devDependencies": {
+    "chai": "3.5.0",
+    "chai-as-promised": "7.0.0",
+    "eslint": "3.16.0",
+    "eslint-plugin-import": "2.2.0",
+    "eslint-plugin-mocha": "^4.11.0",
+    "istanbul": "0.4.5",
+    "karma": "1.5.0",
+    "karma-chai": "0.1.0",
+    "karma-mocha": "1.3.0",
+    "karma-sinon": "1.0.5",
+    "mocha": "https://github.com/gistia/mocha.git",
+    "mocha-istanbul": "0.3.0",
+    "nodemon": "1.11.0",
+    "sinon": "2.3.5",
+    "sinon-chai": "2.11.0",
+    "timekeeper": "1.0.0"
+  }
+}

src/browser.js

@@ -0,0 +1,54 @@
+import blessed from 'blessed';
+import contrib from 'blessed-contrib';
+import _ from 'lodash';
+
+export const newBrowser = (rawData) => {
+  const def = parseData(rawData);
+
+  const table = contrib.table({
+    keys: true,
+    fg: 'white',
+    selectedFg: 'white',
+    selectedBg: 'blue',
+    interactive: true,
+    label: 'Logs',
+    width: '100%',
+    height: '100%',
+    border: { type: 'line', fg: 'cyan' },
+    columnSpacing: 3,
+    columnWidth: def.columnWidth,
+  });
+
+  table.setData({ headers: def.headers, data: def.data });
+
+  return table;
+};
+
+const levelColors = {
+  debug: s => `{cyan-fg}${s}{/cyan-fg}`,
+  info: s => `{#ffff94-fg}{bold}${s}{/bold}{/#ffff94-fg}`,
+  warn: s => `{orange-fg}${s}{/orange-fg}`,
+  error: s => `{red-fg}${s}{/red-fg}`,
+};
+
+const formatLevel = (level) => blessed.parseTags(levelColors[level](level));
+
+const fixLevels = (data) => data.map(d => [d[0], formatLevel(d[1]), d[2]]);
+
+const formatRow = (row) => {
+  return [
+    row.timestamp,
+    row.level,
+    row.message,
+  ];
+};
+
+export const parseData = (rawData) => {
+  const headers = ['Timestamp', 'Level', 'Message'];
+  const data = rawData.map(formatRow);
+  const columnWidth = data.reduce((arr, value) => {
+    return arr.map((v, index) => Math.max(value[index].length, v));
+  }, [0, 0, 0]);
+
+  return { columnWidth, headers, data: fixLevels(data), rawData };
+};

src/index.js

@@ -0,0 +1,17 @@
+import blessed from 'blessed';
+import _ from 'lodash';
+
+import { readLog } from './log';
+import { newBrowser } from './browser';
+
+const screen = blessed.screen({ smartCSR: true });
+
+const browser = newBrowser(readLog('/Users/fcoury/code/workflow-engine/logs/workflow-engine.log.2017-09-25'));
+browser.focus();
+
+screen.append(browser);
+screen.key(['escape', 'q', 'C-c'], function(_ch, _key) {
+  return process.exit(0);
+});
+
+screen.render();

src/log.js

@@ -0,0 +1,13 @@
+import fs from 'fs';
+import _ from 'lodash';
+
+export function readLog(file, reader=fs) {
+  const contents = reader.readFileSync(file).toString();
+  const lines = contents.split('\n').filter(line => line).map(line => JSON.parse(line));
+
+  return lines.map(line => {
+    const result = _.pick(line, ['timestamp', 'level', 'message']);
+    const data = _.omit(line, ['timestamp', 'level', 'message']);
+    return Object.assign({}, result, { data });
+  });
+};

test/browser.test.js

@@ -0,0 +1,52 @@
+import { parseFixture } from './support/fixtures';
+
+import { parseData } from '../src/browser';
+
+describe('formatData', () => {
+  let tableDef, data;
+
+  before(() => {
+    const contents = parseFixture('workflow-engine.log.2017-09-25');
+    tableDef = parseData(contents);
+    data = tableDef.data;
+  });
+
+  describe('headers', () => {
+    it('is set', () => {
+      expect(tableDef.headers).to.eql(['Timestamp', 'Level', 'Message']);
+    });
+  });
+
+  describe('columnWidth', () => {
+    it('sets to the maximum width', () => {
+      const { columnWidth } = tableDef;
+      expect(columnWidth[0]).to.eql(24);
+      expect(columnWidth[1]).to.eql(5);
+      expect(columnWidth[2]).to.eql(5325);
+    });
+  });
+
+  describe('data', () => {
+    it('has only 3 columns', () => {
+      expect(data[0].length).to.eql(3);
+    });
+
+    it('extracts timestamp', () => {
+      expect(data[0][0]).to.eql('2017-09-25T22:48:38.035Z');
+    });
+
+    it('extracts level', () => {
+      expect(data[0][1]).to.eql('{cyan-fg}debug{/cyan-fg}');
+    });
+
+    it('extracts message', () => {
+      expect(data[0][2]).to.eql('Updated instance \'hemo\' with attributes');
+    });
+  });
+
+  describe('rawData', () => {
+    it('keeps object', () => {
+      expect(tableDef.rawData[0].data.to.currentState).to.eql('resultPending');
+    });
+  });
+});

test/fixtures/workflow-engine.log.2017-09-25

@@ -0,0 +1,28 @@
+import { loadFixture } from './support/fixtures';
+import { readLog } from '../src/log';
+
+describe('readLog', () => {
+  let entries;
+
+  before(() => {
+    const contents = loadFixture('workflow-engine.log.2017-09-25');
+    const stubFS = { readFileSync: () => contents };
+    entries = readLog('', stubFS);
+  });
+
+  it('sets timestamp', () => {
+    expect(entries[0].timestamp).to.eql('2017-09-25T22:48:38.035Z');
+  });
+
+  it('sets level', () => {
+    expect(entries[0].level).to.eql('debug');
+  });
+
+  it('sets message', () => {
+    expect(entries[0].message).to.eql('Updated instance \'hemo\' with attributes');
+  });
+
+  it('sets data', () => {
+    expect(entries[0].data.to.type).to.eql('workflow-instance');
+  });
+});

test/log.test.js

@@ -0,0 +1,12 @@
+import fs from 'fs';
+import { readLog } from '../../src/log';
+
+export const loadFixture = (name) => {
+  return fs.readFileSync(`./test/fixtures/${name}`).toString();
+};
+
+export const parseFixture = (name) => {
+  const contents = loadFixture(name);
+  const stubFS = { readFileSync: () => contents };
+  return readLog('', stubFS);
+};

test/support/fixtures.js

@@ -0,0 +1,10 @@
+const chai = require('chai');
+const chaiAsPromised = require('chai-as-promised');
+const sinon = require('sinon');
+const sinonChai = require('sinon-chai');
+
+chai.use(sinonChai);
+chai.use(chaiAsPromised);
+
+global.expect = chai.expect;
+global.sinon = sinon;