altd 0.0.2 → 0.0.4

package/README.md

@@ -1,16 +1,11 @@
-[![Build Status](https://travis-ci.org/freddiefujiwara/altd.svg?branch=master)](https://travis-ci.org/freddiefujiwara/altd)
-[![Build status](https://ci.appveyor.com/api/projects/status/f6wch68buqp93hc7/branch/master?svg=true)](https://ci.appveyor.com/project/freddiefujiwara/altd/branch/master)
-[![CircleCI](https://circleci.com/gh/freddiefujiwara/altd.svg?style=svg)](https://circleci.com/gh/freddiefujiwara/altd)
 [![npm version](https://badge.fury.io/js/altd.svg)](https://badge.fury.io/js/altd)
-[![codecov](https://codecov.io/gh/freddiefujiwara/altd/branch/master/graph/badge.svg)](https://codecov.io/gh/freddiefujiwara/altd)
-[![dependencies Status](https://david-dm.org/freddiefujiwara/altd/status.svg)](https://david-dm.org/freddiefujiwara/altd)
 
 # altd
-Web Server(like nginx..) Access log tail dispatcher
+Web server access log tail dispatcher for running whitelisted commands based on GET requests.
 
 ## Requirements
 
- - Node 7.6 or later
+- Node.js 18 or later
 
 ## Installation
 
@@ -18,26 +13,30 @@ Web Server(like nginx..) Access log tail dispatcher
 npm i -g altd
 ```
 
+## Build
+
+```bash
+npm run build
+```
+
 ## Usage
-```bash                                                                                     
-  Usage: altd <access_log.file> -w [commands]
-                                                                                                                               
-                                                                                                                               
-  Options:                                                                                                                     
-                                                                                                                               
-    -V, --version     output the version number
-    -h, --help        output usage information  
+
+```bash
+altd <access_log.file> -w [commands]
 ```
 
+### Options
+
+- `-V, --version` output the version number
+- `-h, --help` output usage information
+- `-w, --whitelist <commands>` comma-separated list of allowed commands
+
 ## Example
+
 ```bash
 altd /var/log/nginx/access_log -w ls,hostname
 ```
 
-## FAQ
-
-[FAQ](https://github.com/freddiefujiwara/altd/wiki/FAQ)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/freddiefujiwara/altd

package/dist/altd.js

@@ -0,0 +1,132 @@
+import {spawn} from 'child_process';
+import Tail from 'nodejs-tail';
+/**
+ ** main class of AccessLogTailDispatcher
+ */
+export default class AccessLogTailDispatcher {
+    /**
+     * @constructor
+     * @param {string} file access_log
+     * @param {Array} whitelist ['command1','command2'..]
+     */
+    constructor(file, whitelist) {
+        this.file = file;
+        this.whitelist = whitelist;
+        this.spawn = undefined;
+        this.tail = undefined;
+    }
+    /**
+     * Get the path from 'GET /path/to/dir HTTP'
+     * @param {string} line access_log
+     * @return {string} /path/to/dir
+     */
+    path(line) {
+        if (!(typeof line === 'string')) {
+            return '';
+        }
+        let match = line.match(
+            /GET\s((\/[a-z0-9-._~%!$&'()*+,;=:@?]+)+\/?)\sHTTP/i);
+        if (null !== match && match.length > 2) {
+            return match[1];
+        }
+        return '';
+    }
+
+    /**
+     * Extract command and args
+     * @param {string} path
+     * @return {Array} [command,arg1,arg2...]
+     */
+    commandWithArgs(path) {
+        if (!(typeof path === 'string')) {
+            return [];
+        }
+        let commands = path.split(/\//).map(function(element, index, array) {
+            let ret = "";
+            try{
+              ret = decodeURIComponent(element);
+            }catch(e){
+              console.error(e);
+            }
+            return ret;
+        });
+        commands.shift();
+        return commands;
+    }
+
+    /**
+     * Filter by whitelist
+     * @param {Array} commandWithArgs [command,arg1,arg2...]
+     * @param {Array} whitelist ['command1','command2'...]
+     * @return {Array} filtered commandWithArgs
+     */
+    filterByWhitelist(commandWithArgs, whitelist) {
+        if (!this.isArray(commandWithArgs) ||
+            !this.isArray(whitelist) ||
+            commandWithArgs.length == 0 ||
+            whitelist.indexOf(commandWithArgs[0]) == -1
+        ) {
+            return [];
+        }
+        return commandWithArgs;
+    }
+
+    /**
+     * Dispatch
+     * @param {Array} commandWithArgs [command,arg1,arg2...]
+     */
+    dispatch(commandWithArgs) {
+        if (commandWithArgs.length == 0) {
+            return;
+        }
+        let command = commandWithArgs.shift();
+        let proc = this.spawn(command, commandWithArgs);
+        proc.on('error', (err) => {
+            console.error(err);
+        });
+        proc.stdout.on('data', (data) => {
+            process.stdout.write(data.toString());
+        });
+    }
+
+    /**
+     * isArray
+     * @param {object} obj [command,arg1,arg2...]
+     * @return {boolean}
+     */
+    isArray(obj) {
+        return Object.prototype.toString.call(obj) === '[object Array]';
+    }
+
+    /**
+     * run
+     * @param {string} file
+     * @param {Array} whitelist ['command1','command2'...]
+     */
+    run(file, whitelist) {
+        if ( typeof file !== 'undefined') {
+            this.file = file;
+        }
+        if ( typeof whitelist !== 'undefined') {
+            this.whitelist = whitelist;
+        }
+        if ( typeof this.spawn === 'undefined') {
+            this.spawn = spawn;
+        }
+        if ( typeof this.tail === 'undefined') {
+            this.tail = new Tail(this.file,
+                {alwaysStat: true, ignoreInitial: true, persistent: true});
+        }
+        this.tail.on('line', (line) => {
+            this.dispatch(
+                this.filterByWhitelist(
+                    this.commandWithArgs(
+                        this.path(line)),
+                    this.whitelist));
+        });
+        this.tail.on('close', () => {
+            console.log('watching stopped');
+        });
+        this.tail.watch();
+    }
+}

package/dist/index.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import pkg from '../package.json' assert { type: 'json' };
+import AccessLogTailDispatcher from './altd.js';
+
+const program = new Command();
+
+program
+  .name('altd')
+  .version(pkg.version)
+  .description(pkg.description)
+  .argument('<file>')
+  .option(
+    '-w, --whitelist <commands>',
+    'Add commands to whitelist',
+    (commands) => commands.split(',')
+  )
+  .parse(process.argv);
+
+const fileValue = program.args[0];
+const { whitelist } = program.opts();
+
+if (!fileValue || !whitelist) {
+  console.log('altd <file> -w <commands...>');
+  process.exit(1);
+}
+
+const altd = new AccessLogTailDispatcher(fileValue, whitelist);
+altd.run();

package/index.js

@@ -1,24 +1,29 @@
 #!/usr/bin/env node
-let program = require('commander');
-let pkg = require('./package');
-let fileValue = undefined;
-let whitelist = undefined;
+import { Command } from 'commander';
+import pkg from './package.json' assert { type: 'json' };
+import AccessLogTailDispatcher from './src/altd.js';
+
+const program = new Command();
 
 program
-    .version(pkg.version)
-    .description(pkg.description)
-    .arguments('<file>')
-    .option('-w, --whitelist <commands>', 'Add commands to whitelist', (commands)=>commands.split(','))
-    .action(function(file){
-        fileValue = file;
-    });
-program.parse(process.argv);
-if(typeof fileValue === 'undefined' || 
-    typeof program.whitelist === 'undefined'){
-    console.log('altd <file> -w <commands...>');
-    process.exit(1);
+  .name('altd')
+  .version(pkg.version)
+  .description(pkg.description)
+  .argument('<file>')
+  .option(
+    '-w, --whitelist <commands>',
+    'Add commands to whitelist',
+    (commands) => commands.split(',')
+  )
+  .parse(process.argv);
+
+const fileValue = program.args[0];
+const { whitelist } = program.opts();
+
+if (!fileValue || !whitelist) {
+  console.log('altd <file> -w <commands...>');
+  process.exit(1);
 }
-let AccessLogTailDispatcher = require('./lib/altd');
 
-let altd = new AccessLogTailDispatcher(fileValue,program.whitelist);
+const altd = new AccessLogTailDispatcher(fileValue, whitelist);
 altd.run();

package/package.json

@@ -1,65 +1,70 @@
 {
-    "name": "altd",
-    "version": "0.0.2",
-    "description": "Access log tail dispatcher",
-    "scripts": {
-        "clean": "rimraf lib",
-        "test": "cross-env BABEL_ENV=commonjs mocha --require babel-core/register --require babel-polyfill --recursive",
-        "test:watch": "npm test -- --watch",
-        "lint": "eslint -c google src test",
-        "build": "cross-env BABEL_ENV=commonjs babel src --out-dir lib",
-        "codecov": "mkdir -p .nyc_output && nyc report --reporter=text-lcov > coverage.lcov && codecov -t 3e4320c7-d0e0-46a4-bb31-d5d8d2388bc4",
-        "coverage": "mkdir -p .nyc_output && nyc --reporter=lcov --reporter=text npm run test",
-        "prepublishOnly": "npm i && npm run clean && npm run lint && npm run coverage && npm run codecov && npm run build",
-        "requirements-check": "node check-version.js",
-        "postinstall": "npm run requirements-check"
-    },
-    "bin": {
-        "altd": "index.js"
-    },
-    "main": "lib/altd.js",
-    "files": [
-        "lib",
-        "index.js",
-        "check-version.js"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/freddiefujiwara/altd.git"
-    },
-    "keywords": [
-        "access log",
-        "httpd",
-        "log"
-    ],
-    "author": "Fumikazu Fujiwara <npm@ze.gs> (http://freddiefujiwara.com)",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/freddiefujiwara/altd/issues"
-    },
-    "homepage": "https://github.com/freddiefujiwara/altd#readme",
-    "devDependencies": {
-        "babel-cli": "^6.24.1",
-        "babel-core": "^6.25.0",
-        "babel-eslint": "^7.2.3",
-        "babel-plugin-add-module-exports": "^0.2.1",
-        "babel-preset-es2015": "^6.24.1",
-        "babel-register": "^6.24.1",
-        "chai": "^4.0.2",
-        "codecov": "^3.6.5",
-        "cross-env": "^5.0.1",
-        "eslint": "^4.1.1",
-        "eslint-config-google": "^0.9.1",
-        "mocha": "^7.1.1",
-        "nyc": "^15.0.1",
-        "rimraf": "^2.6.1"
-    },
-    "dependencies": {
-        "commander": "^2.20.3",
-        "nodejs-tail": "^1.1.0",
-        "semver": "^5.7.1"
-    },
-    "engines": {
-        "node": ">=7.6"
+  "name": "altd",
+  "version": "0.0.4",
+  "description": "Access log tail dispatcher",
+  "type": "module",
+  "bin": {
+    "altd": "./dist/index.js"
+  },
+  "main": "./dist/altd.js",
+  "exports": {
+    ".": "./dist/altd.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "index.js",
+    "scripts",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "node scripts/build.js",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/freddiefujiwara/altd.git"
+  },
+  "keywords": [
+    "access log",
+    "httpd",
+    "log"
+  ],
+  "author": "Fumikazu Fujiwara <npm@ze.gs> (http://freddiefujiwara.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/freddiefujiwara/altd/issues"
+  },
+  "homepage": "https://github.com/freddiefujiwara/altd#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "nodejs-tail": "^1.1.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.8",
+    "vitest": "^2.1.8"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "vitest": {
+    "coverage": {
+      "provider": "v8",
+      "reporter": [
+        "text",
+        "html",
+        "lcov"
+      ],
+      "exclude": [
+        "node_modules",
+        "test"
+      ]
     }
+  }
 }

package/scripts/build.js

@@ -0,0 +1,17 @@
+import { mkdir, readFile, writeFile, copyFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const rootDir = dirname(fileURLToPath(import.meta.url));
+const projectRoot = dirname(rootDir);
+const distDir = join(projectRoot, 'dist');
+
+await mkdir(distDir, { recursive: true });
+
+const indexSource = await readFile(join(projectRoot, 'index.js'), 'utf8');
+const indexOutput = indexSource
+  .replace('./src/altd.js', './altd.js')
+  .replace('./package.json', '../package.json');
+
+await writeFile(join(distDir, 'index.js'), indexOutput);
+await copyFile(join(projectRoot, 'src', 'altd.js'), join(distDir, 'altd.js'));

package/src/altd.js

@@ -0,0 +1,132 @@
+import {spawn} from 'child_process';
+import Tail from 'nodejs-tail';
+/**
+ ** main class of AccessLogTailDispatcher
+ */
+export default class AccessLogTailDispatcher {
+    /**
+     * @constructor
+     * @param {string} file access_log
+     * @param {Array} whitelist ['command1','command2'..]
+     */
+    constructor(file, whitelist) {
+        this.file = file;
+        this.whitelist = whitelist;
+        this.spawn = undefined;
+        this.tail = undefined;
+    }
+    /**
+     * Get the path from 'GET /path/to/dir HTTP'
+     * @param {string} line access_log
+     * @return {string} /path/to/dir
+     */
+    path(line) {
+        if (!(typeof line === 'string')) {
+            return '';
+        }
+        let match = line.match(
+            /GET\s((\/[a-z0-9-._~%!$&'()*+,;=:@?]+)+\/?)\sHTTP/i);
+        if (null !== match && match.length > 2) {
+            return match[1];
+        }
+        return '';
+    }
+
+    /**
+     * Extract command and args
+     * @param {string} path
+     * @return {Array} [command,arg1,arg2...]
+     */
+    commandWithArgs(path) {
+        if (!(typeof path === 'string')) {
+            return [];
+        }
+        let commands = path.split(/\//).map(function(element, index, array) {
+            let ret = "";
+            try{
+              ret = decodeURIComponent(element);
+            }catch(e){
+              console.error(e);
+            }
+            return ret;
+        });
+        commands.shift();
+        return commands;
+    }
+
+    /**
+     * Filter by whitelist
+     * @param {Array} commandWithArgs [command,arg1,arg2...]
+     * @param {Array} whitelist ['command1','command2'...]
+     * @return {Array} filtered commandWithArgs
+     */
+    filterByWhitelist(commandWithArgs, whitelist) {
+        if (!this.isArray(commandWithArgs) ||
+            !this.isArray(whitelist) ||
+            commandWithArgs.length == 0 ||
+            whitelist.indexOf(commandWithArgs[0]) == -1
+        ) {
+            return [];
+        }
+        return commandWithArgs;
+    }
+
+    /**
+     * Dispatch
+     * @param {Array} commandWithArgs [command,arg1,arg2...]
+     */
+    dispatch(commandWithArgs) {
+        if (commandWithArgs.length == 0) {
+            return;
+        }
+        let command = commandWithArgs.shift();
+        let proc = this.spawn(command, commandWithArgs);
+        proc.on('error', (err) => {
+            console.error(err);
+        });
+        proc.stdout.on('data', (data) => {
+            process.stdout.write(data.toString());
+        });
+    }
+
+    /**
+     * isArray
+     * @param {object} obj [command,arg1,arg2...]
+     * @return {boolean}
+     */
+    isArray(obj) {
+        return Object.prototype.toString.call(obj) === '[object Array]';
+    }
+
+    /**
+     * run
+     * @param {string} file
+     * @param {Array} whitelist ['command1','command2'...]
+     */
+    run(file, whitelist) {
+        if ( typeof file !== 'undefined') {
+            this.file = file;
+        }
+        if ( typeof whitelist !== 'undefined') {
+            this.whitelist = whitelist;
+        }
+        if ( typeof this.spawn === 'undefined') {
+            this.spawn = spawn;
+        }
+        if ( typeof this.tail === 'undefined') {
+            this.tail = new Tail(this.file,
+                {alwaysStat: true, ignoreInitial: true, persistent: true});
+        }
+        this.tail.on('line', (line) => {
+            this.dispatch(
+                this.filterByWhitelist(
+                    this.commandWithArgs(
+                        this.path(line)),
+                    this.whitelist));
+        });
+        this.tail.on('close', () => {
+            console.log('watching stopped');
+        });
+        this.tail.watch();
+    }
+}

package/check-version.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-var _semver = require('semver');
-
-var _semver2 = _interopRequireDefault(_semver);
-
-var _package = require('./package');
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var version = _package.engines.node;
-if (!_semver2.default.satisfies(process.version, version)) {
-  var warn = 'Required node version ' + version + ' ';
-  warn += 'not satisfied with current version ' + process.version + '.';
-  console.log(warn);
-  process.exit(1);
-}
-

package/lib/altd.js

@@ -1,161 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
-var _child_process = require('child_process');
-
-var _nodejsTail = require('nodejs-tail');
-
-var _nodejsTail2 = _interopRequireDefault(_nodejsTail);
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-/**
- ** main class of AccessLogTailDispatcher
- */
-var AccessLogTailDispatcher = function () {
-    /**
-     * @constructor
-     * @param {string} file access_log
-     * @param {Array} whitelist ['command1','command2'..]
-     */
-    function AccessLogTailDispatcher(file, whitelist) {
-        _classCallCheck(this, AccessLogTailDispatcher);
-
-        this.file = file;
-        this.whitelist = whitelist;
-        this.spawn = undefined;
-        this.tail = undefined;
-    }
-    /**
-     * Get the path from 'GET /path/to/dir HTTP'
-     * @param {string} line access_log
-     * @return {string} /path/to/dir
-     */
-
-
-    _createClass(AccessLogTailDispatcher, [{
-        key: 'path',
-        value: function path(line) {
-            if (!(typeof line === 'string')) {
-                return '';
-            }
-            var match = line.match(/GET\s((\/[a-z0-9-._~%!$&'()*+,;=:@?]+)+\/?)\sHTTP/i);
-            if (null !== match && match.length > 2) {
-                return match[1];
-            }
-            return '';
-        }
-
-        /**
-         * Extract command and args
-         * @param {string} path
-         * @return {Array} [command,arg1,arg2...]
-         */
-
-    }, {
-        key: 'commandWithArgs',
-        value: function commandWithArgs(path) {
-            if (!(typeof path === 'string')) {
-                return [];
-            }
-            var commands = path.split(/\//).map(function (element, index, array) {
-                var ret = "";
-                try {
-                    ret = decodeURIComponent(element);
-                } catch (e) {
-                    console.error(e);
-                }
-                return ret;
-            });
-            commands.shift();
-            return commands;
-        }
-
-        /**
-         * Filter by whitelist
-         * @param {Array} commandWithArgs [command,arg1,arg2...]
-         * @param {Array} whitelist ['command1','command2'...]
-         * @return {Array} filtered commandWithArgs
-         */
-
-    }, {
-        key: 'filterByWhitelist',
-        value: function filterByWhitelist(commandWithArgs, whitelist) {
-            if (!this.isArray(commandWithArgs) || !this.isArray(whitelist) || commandWithArgs.length == 0 || whitelist.indexOf(commandWithArgs[0]) == -1) {
-                return [];
-            }
-            return commandWithArgs;
-        }
-
-        /**
-         * Dispatch
-         * @param {Array} commandWithArgs [command,arg1,arg2...]
-         */
-
-    }, {
-        key: 'dispatch',
-        value: function dispatch(commandWithArgs) {
-            if (commandWithArgs.length == 0) {
-                return;
-            }
-            var command = commandWithArgs.shift();
-            var proc = this.spawn(command, commandWithArgs);
-            proc.on('error', function (err) {
-                console.error(err);
-            });
-            proc.stdout.on('data', function (data) {
-                process.stdout.write(data.toString());
-            });
-        }
-
-        /**
-         * isArray
-         * @param {object} obj [command,arg1,arg2...]
-         * @return {boolean}
-         */
-
-    }, {
-        key: 'isArray',
-        value: function isArray(obj) {
-            return Object.prototype.toString.call(obj) === '[object Array]';
-        }
-
-        /**
-         * run
-         * @param {string} file
-         * @param {Array} whitelist ['command1','command2'...]
-         */
-
-    }, {
-        key: 'run',
-        value: function run(file, whitelist) {
-            var _this = this;
-
-            if (typeof this.spawn === 'undefined') {
-                this.spawn = _child_process.spawn;
-            }
-            if (typeof this.tail === 'undefined') {
-                this.tail = new _nodejsTail2.default(this.file, { alwaysStat: true, ignoreInitial: true, persistent: true });
-            }
-            this.tail.on('line', function (line) {
-                _this.dispatch(_this.filterByWhitelist(_this.commandWithArgs(_this.path(line)), _this.whitelist));
-            });
-            this.tail.on('close', function () {
-                console.log('watching stopped');
-            });
-            this.tail.watch();
-        }
-    }]);
-
-    return AccessLogTailDispatcher;
-}();
-
-exports.default = AccessLogTailDispatcher;
-module.exports = exports['default'];