simple-http-bin 0.1.0 → 0.1.1

package/README.md

@@ -2,6 +2,10 @@
 
 A tiny local httpbin-like utility.
 
+Requests are logged to the console.
+Use `-v` or `--verbose` for more detail. Repeat `-v` for extra detail.
+Colored output is enabled when the terminal supports it.
+
 ## Install
 
 ```bash
@@ -25,6 +29,8 @@ npx simple-http-bin
 ```bash
 simple-http-bin --port 8080
 simple-http-bin -p 8080
+simple-http-bin -v
+simple-http-bin -vv
 PORT=8080 simple-http-bin
 HOST=0.0.0.0 simple-http-bin
 ```

package/cli.js

@@ -1,14 +1,52 @@
 #!/usr/bin/env node
 
 const http = require('node:http');
+const chalk = require('chalk');
 
 const DEFAULT_PORT = 51234;
 const args = process.argv.slice(2);
-const portFlagIndex = args.findIndex((arg) => arg === '--port' || arg === '-p');
-const cliPort = portFlagIndex >= 0 ? Number(args[portFlagIndex + 1]) : Number(args[0]);
+let cliPort;
+let verbosity = 0;
+
+for (let i = 0; i < args.length; i += 1) {
+  const arg = args[i];
+
+  if (arg === '--port' || arg === '-p') {
+    cliPort = Number(args[i + 1]);
+    i += 1;
+    continue;
+  }
+
+  if (arg === '--verbose') {
+    verbosity += 1;
+    continue;
+  }
+
+  if (/^-v+$/.test(arg)) {
+    verbosity += arg.length - 1;
+    continue;
+  }
+
+  if (cliPort === undefined && !arg.startsWith('-')) {
+    cliPort = Number(arg);
+  }
+}
+
 const envPort = Number(process.env.PORT);
 const port = Number.isInteger(cliPort) && cliPort > 0 ? cliPort : Number.isInteger(envPort) && envPort > 0 ? envPort : DEFAULT_PORT;
 const host = process.env.HOST || '127.0.0.1';
+const logLevel = Math.max(1, verbosity + 1);
+
+const colors = {
+  method: chalk.cyan.bold,
+  path: chalk.white,
+  statusOk: chalk.green.bold,
+  statusWarn: chalk.yellow.bold,
+  statusError: chalk.red.bold,
+  meta: chalk.gray,
+  dim: chalk.dim,
+  title: chalk.green.bold,
+};
 
 function sendJson(res, statusCode, payload) {
   const body = JSON.stringify(payload, null, 2);
@@ -28,12 +66,43 @@ function readBody(req) {
   });
 }
 
+function logRequest(req, res, path, startedAt, details = {}) {
+  res.on('finish', () => {
+    const durationMs = Date.now() - startedAt;
+    const remoteAddress = req.socket.remoteAddress || 'unknown';
+    const remotePort = req.socket.remotePort || 'unknown';
+    const userAgent = req.headers['user-agent'] || 'unknown';
+    const statusColor = res.statusCode >= 500 ? colors.statusError : res.statusCode >= 400 ? colors.statusWarn : colors.statusOk;
+    const statusText = statusColor(res.statusCode);
+    const baseLine = `${colors.method(req.method)} ${colors.path(path)} ${colors.meta('->')} ${statusText} ${colors.dim(`(${durationMs}ms)`)}`;
+
+    if (logLevel === 1) {
+      console.log(baseLine);
+      return;
+    }
+
+    if (logLevel === 2) {
+      console.log(`${baseLine} ${colors.meta('from')} ${colors.meta(`${remoteAddress}:${remotePort}`)} ${colors.meta('ua=')}${chalk.white(JSON.stringify(userAgent))}`);
+      return;
+    }
+
+    console.log([
+      `${baseLine} ${colors.meta('from')} ${colors.meta(`${remoteAddress}:${remotePort}`)}`,
+      `${colors.meta('ua=')}${chalk.white(JSON.stringify(userAgent))}`,
+      `${colors.meta('headers=')}${chalk.white(JSON.stringify(req.headers, null, 2))}`,
+      details.bodyBytes !== undefined ? `${colors.meta('bodyBytes=')}${chalk.white(details.bodyBytes)}` : null,
+    ].filter(Boolean).join('\n'));
+  });
+}
+
 function helpText(baseUrl) {
   return [
-    'simple-http-bin',
+    colors.title('simple-http-bin'),
     '',
-    `Running at: ${baseUrl}`,
+    `${colors.meta('Running at:')} ${chalk.white(baseUrl)}`,
     `Port: ${port} (use --port <n> or PORT=<n>)`,
+    'Requests are logged to the console.',
+    'Use -v or --verbose for more detail; repeat -v for even more.',
     '',
     'Endpoints:',
     '  GET /           Show this help text',
@@ -49,21 +118,25 @@ function helpText(baseUrl) {
 }
 
 const server = http.createServer(async (req, res) => {
+  const startedAt = Date.now();
   const url = new URL(req.url, `http://${req.headers.host || `${host}:${port}`}`);
   const path = url.pathname;
 
   if (req.method === 'GET' && path === '/') {
+    logRequest(req, res, `${path}${url.search}`, startedAt);
     res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
     res.end(helpText(`http://${host}:${port}`));
     return;
   }
 
   if (path === '/headers') {
+    logRequest(req, res, `${path}${url.search}`, startedAt);
     sendJson(res, 200, { headers: req.headers });
     return;
   }
 
   if (path.startsWith('/status/')) {
+    logRequest(req, res, `${path}${url.search}`, startedAt);
     const code = Number(path.split('/')[2]);
     res.writeHead(Number.isInteger(code) ? code : 400, { 'Content-Type': 'text/plain; charset=utf-8' });
     res.end(`status ${Number.isInteger(code) ? code : 400}`);
@@ -72,6 +145,7 @@ const server = http.createServer(async (req, res) => {
 
   if (path === '/anything') {
     const body = await readBody(req);
+    logRequest(req, res, `${path}${url.search}`, startedAt, { bodyBytes: Buffer.byteLength(body) });
     sendJson(res, 200, {
       method: req.method,
       path,
@@ -82,6 +156,7 @@ const server = http.createServer(async (req, res) => {
     return;
   }
 
+  logRequest(req, res, `${path}${url.search}`, startedAt);
   res.writeHead(404, { 'Content-Type': 'text/plain; charset=utf-8' });
   res.end('not found');
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-http-bin",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A tiny local httpbin-like utility",
   "license": "MIT",
   "keywords": [
@@ -16,6 +16,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "chalk": "^4.1.2"
+  },
   "bin": {
     "simple-http-bin": "cli.js"
   },