hello-lights 0.3.8 → 0.3.10

package/README.md

@@ -109,10 +109,10 @@ The `serve` command starts an HTTP server that exposes the Commander interface a
 
 | Endpoint | Method | Body | Response |
 |---|---|---|---|
-| `/run` | POST | Command string (plain text) | 202 Accepted |
-| `/run?reset=true` | POST | Command string (plain text) | 202 Accepted (resets lights first) |
+| `/run` | POST | Command string (plain text) | 202 Accepted, or 400 if malformed |
+| `/run?reset=true` | POST | Command string (plain text) | 202 Accepted (resets lights first), or 400 if malformed |
 | `/cancel` | POST | — | 200 OK |
-| `/definitions` | POST | Definition string (plain text) | 202 Accepted |
+| `/definitions` | POST | Definition string (plain text) | 202 Accepted, or 400 if malformed |
 | `/commands` | GET | — | 200 + JSON array of command names |
 | `/commands/:name` | GET | — | 200 + help text (`text/x-ansi`) or 404 |
 | `/info` | GET | — | 200 + JSON array of `{ serialNum, status }` |

package/lib/cli/serve/index.js

@@ -1,11 +1,23 @@
 /////////////////////////////////////////////////////////////////
 
 const path = require('path');
+const chalk = require('chalk');
 const commanderOptions = require('../commander-options');
 
 /////////////////////////////////////////////////////////////////
 
-function createApp(commander) {
+const now = () => chalk.gray(`[${new Date().toISOString()}]`);
+
+const logger = {
+  log: (...args) =>
+    console.log(now(), '[INFO]', ...args),
+  error: (...args) =>
+    console.error(now(), chalk.red('[ERROR]'), chalk.red(...args))
+};
+
+/////////////////////////////////////////////////////////////////
+
+function createApp(commander, {logger: log = logger} = {}) {
   const express = require('express');
   const app = express();
 
@@ -13,8 +25,17 @@ function createApp(commander) {
   app.use(express.text({type: '*/*'}));
 
   app.post('/run', (req, res) => {
+    let body = req.body || '';
+    log.log('POST /run:', body);
+    try {
+      commander.interpreter.process(body);
+    } catch (e) {
+      log.error('POST /run: malformed:', e.message);
+      res.status(400).send(e.message);
+      return;
+    }
     let reset = req.query.reset === 'true';
-    commander.run(req.body || '', reset);
+    commander.run(body, reset);
     res.sendStatus(202);
   });
 
@@ -24,7 +45,16 @@ function createApp(commander) {
   });
 
   app.post('/definitions', (req, res) => {
-    commander.runDefinitions(req.body || '');
+    let body = req.body || '';
+    log.log('POST /definitions:', body);
+    try {
+      commander.interpreter.process(body);
+    } catch (e) {
+      log.error('POST /definitions: malformed:', e.message);
+      res.status(400).send(e.message);
+      return;
+    }
+    commander.runDefinitions(body);
     res.sendStatus(202);
   });
 
@@ -56,12 +86,12 @@ function createApp(commander) {
 function serve(options) {
   const commander = commanderOptions.resolveCommander(options);
   const app = createApp(commander);
-  const server = app.listen(options.port, () => console.log(`Server listening on port ${options.port}`));
+  const server = app.listen(options.port, () => logger.log(`Server listening on port ${options.port}`));
   server.on('error', err => {
     if (err.code === 'EADDRINUSE') {
-      console.error(`Error: port ${options.port} is already in use`);
+      logger.error(`port ${options.port} is already in use`);
     } else {
-      console.error(`Error: ${err.message}`);
+      logger.error(err.message);
     }
     process.exit(1);
   });

package/lib/rest-commander.js

@@ -57,7 +57,10 @@ class RestCommander {
    */
   async run(command, reset = false) {
     let path = reset ? '/run?reset=true' : '/run';
-    await request(this.host, 'POST', path, command);
+    let res = await request(this.host, 'POST', path, command);
+    if (res.statusCode === 400) {
+      this.logger.error(res.body);
+    }
   }
 
   /**
@@ -72,7 +75,10 @@ class RestCommander {
    * @param {string} command - Command with definitions to execute.
    */
   async runDefinitions(command) {
-    await request(this.host, 'POST', '/definitions', command);
+    let res = await request(this.host, 'POST', '/definitions', command);
+    if (res.statusCode === 400) {
+      this.logger.error(res.body);
+    }
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hello-lights",
-  "version": "0.3.8",
+  "version": "0.3.10",
   "description": "Commands to control a traffic light",
   "main": "index.js",
   "bin": {
@@ -16,7 +16,7 @@
     "build:doc": "jsdoc src -c jsdoc.json",
     "build:web": "npm run peg && npm run browserify && npm run build:doc",
     "doc": "npm run build:doc && open-cli web/doc/index.html",
-    "lint": "coffeelint -f coffeelint.json test && eslint src web dev",
+    "lint": "coffeelint -f coffeelint.json test && eslint src web",
     "peg": "pegjs -o src/commands/peg-parser.js src/commands/grammar.pegjs && pegjs -o src/commands/doc-peg-parser.js src/commands/doc-grammar.pegjs && pegjs -o src/commands/formatter-peg-parser.js src/commands/formatter-grammar.pegjs",
     "mocha-solo": "mocha --require coffeescript/register",
     "mocha-grep": "mocha --require coffeescript/register \"test/**/*.coffee\" --grep",
@@ -31,23 +31,22 @@
     "web": "open-cli web/index.html",
     "cpy-lib": "cpy \"**/*.*\" \"!*.pegjs\" ../lib/ --cwd=src --parents",
     "prepublishOnly": "npm run cpy-lib",
-    "dev:install": "cd dev && npm install",
     "precli": "npm run cpy-lib",
     "cli": "node cli.js"
   },
   "devDependencies": {
-    "browserify": "^16.5.2",
+    "browserify": "^17.0.1",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-string": "^1.5.0",
     "coffeelint": "^2.1.0",
     "coffeescript": "^2.5.1",
-    "cpy-cli": "^3.1.1",
+    "cpy-cli": "^7.0.0",
     "docdash": "^1.2.0",
     "eslint": "^6.8.0",
     "jsdoc": "^3.6.6",
-    "mocha": "^7.2.0",
-    "nyc": "^15.1.0",
+    "mocha": "^11.7.5",
+    "nyc": "^17.1.0",
     "open-cli": "^6.0.1",
     "pegjs": "^0.10.0",
     "sinon": "^9.2.4"