@mattduffy/banner 1.2.1 → 1.3.1

package/Readme.md

@@ -30,9 +30,11 @@ app.use(banner.use())
 /*
   Emits at the beginning of each client request.
   #################################################################
-  #      GET: https://dev.example.com/map/getToken?debug=verbose
-  #  Referer: https://dev.example.com/?debug=verbose
-  #  From IP: 192.168.1.254
+  #           GET: https://dev.example.com/map/getToken
+  #  Query Params: ?debug=verbose
+  #       Referer: https://dev.example.com/?debug=verbose
+  #       From IP: 192.168.1.254
+  #     Timestamp: 1/7/2026, 10:34:14 AM
   #################################################################
 */
 ```
@@ -43,36 +45,41 @@ the ```ctx.request.method``` property.  The supported request methods are ```GET
 
 ```
 // GET
-######################################################################
-#      GET: https://banner.test/a/really/long/url/to/a/special/page
-#  Referer: https://googoogle.com
-#  From IP: 192.168.1.250
-######################################################################
+##########################################################################
+#           GET: https://banner.test/a/really/long/url/to/a/special/page
+#  Query Params: ?param1=querty&param2=12345&param3=true
+#       Referer: https://googoogle.com
+#       From IP: 192.168.1.250
+#     Timestamp: 1/7/2026, 10:34:14 AM
+##########################################################################
 ```
 
 ```
 // PUT
 &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
-&      PUT: https://banner.test/a/really/long/url/to/a/special/page
-&  Referer: https://googoogle.com
-&  From IP: 192.168.1.250
+&        PUT: https://banner.test/a/really/long/url/to/a/special/page
+&    Referer: https://googoogle.com
+&    From IP: 192.168.1.250
+&  Timestamp: 1/7/2026, 10:34:14 AM
 &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
 ```
 
 ```
 // POST
 @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
-@     POST: https://banner.test/a/really/long/url/to/a/special/page
-@  Referer: https://googoogle.com
-@  From IP: 192.168.1.250
+@       POST: https://banner.test/a/really/long/url/to/a/special/page
+@    Referer: https://googoogle.com
+@    From IP: 192.168.1.250
+@  Timestamp: 1/7/2026, 10:34:14 AM
 @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
 ```
 
 ```
 // DELETE
 **********************************************************************
-*   DELETE: https://banner.test/a/really/long/url/to/a/special/page
-*  Referer: https://googoogle.com
-*  From IP: 192.168.1.250
+*     DELETE: https://banner.test/a/really/long/url/to/a/special/page
+*    Referer: https://googoogle.com
+*    From IP: 192.168.1.250
+*  Timestamp: 1/7/2026, 10:34:14 AM
 **********************************************************************
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattduffy/banner",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Displays server start-up information.",
   "author": "Matthew Duffy",
   "license": "ISC",

package/src/index.js

@@ -295,6 +295,7 @@ export class Banner {
             break
           case 'post':
             _g = gPOST
+            console.info(ctx.request.body)
             break
           case 'put':
             _g = gPUT
@@ -317,21 +318,66 @@ export class Banner {
         if (!ctx.request.url) {
           throw new Error('Missing required request url value.')
         }
+        const labels = []
+        const values = []
+        const lines = []
         const _urlLabel = `${ctx.request.method}:`
-        const _url = `${ctx.request.protocol}://${ctx.request.header.host}${ctx.request.url}`
+        let _url = `${ctx.request.protocol}://${ctx.request.header.host}${ctx.request.url}`
+        const _queryStringIndex = _url.indexOf('?')
+        const _queryStringLabel = 'Query Params:'
+        let _queryString = ''
+        let _queryStringLine = ''
+        if (_queryStringIndex !== -1) {
+          _queryString = _url.slice(_url.indexOf('?'))
+          _queryStringLine = `${_queryStringLabel} ${_queryString}`
+          labels.push(_queryStringLabel)
+          values.push(_queryString)
+          lines.push(_queryStringLine)
+          // console.log('adding query string to request banner')
+        }
+        _url = (_queryString.length > 0) ? _url.slice(0, _url.indexOf('?')) : _url
+        values.push(_url)
         let _urlLine = `${_urlLabel} ${_url}`
         const _refLabel = 'Referer:'
         const _ref = ctx.request.header.referer ?? '<emtpy header field>'
+        values.push(_ref)
         let _refLine = `${_refLabel} ${_ref}`
         const _ipLabel = 'From IP:'
         const _ip = ctx.request.ip
+        values.push(_ip)
         let _ipLine = `${_ipLabel} ${_ip}`
-        const _longestLabel = [_urlLabel, _refLabel, _ipLabel].reduce((a, c) => {
-          if (a.length > (c.indexOf(':') + 1)) {
-            return a
-          }
-          return (c.indexOf(':') + 1)
-        }, '')
+        const _timestampLabel = 'Timestamp:'
+        const _timestamp = new Date().toLocaleString()
+        values.push(_timestamp)
+        let _timestampLine = `${_timestampLabel} ${_timestamp}`
+        labels.push(_urlLabel)
+        labels.push(_refLabel)
+        labels.push(_ipLabel)
+        labels.push(_timestampLabel)
+        // console.log(labels)
+
+        // console.log(values)
+        const _longestValue = values
+          .reduce((a, c) => {
+            if (a > c.length) return a
+            return c.length
+          }, '')
+        // console.log('longest value', _longestValue)
+
+        lines.push(_ipLine)
+        lines.push(_timestampLine)
+        lines.push(_urlLine)
+        lines.push(_refLine)
+        // console.log(lines)
+        const _longestLabel = labels
+          .reduce((a, c) => {
+            // console.log(a, c.indexOf(':') + 1)
+            if (a > (c.indexOf(':') + 1)) {
+              return a
+            }
+            return (c.indexOf(':') + 1)
+          }, '')
+        // console.log('longest label', _longestLabel)
         _refLine = _refLine.padStart(
           (_longestLabel - _refLine.indexOf(':')) + _refLine.length,
           ' ',
@@ -340,20 +386,38 @@ export class Banner {
           (_longestLabel - _urlLine.indexOf(':')) + _urlLine.length,
           ' ',
         )
+        if (_queryStringLine.length > 0) {
+          _queryStringLine = _queryStringLine.padStart(
+            (_longestLabel - _queryStringLine.indexOf(':')) + _queryStringLine.length,
+            ' ',
+          )
+        }
         _ipLine = _ipLine.padStart(
           (_longestLabel - _ipLine.indexOf(':')) + _ipLine.length,
           ' ',
         )
-        const _longestLine = [_urlLine, _refLine, _ipLine].reduce((a, c) => {
-          if (a > c.length) return a
-          return c.length
-        }, '')
-        // _log('request banner _longestLine', _longestLine)
-        _requestBanner = `${_g.padEnd(_longestLine + 5, _g)}\n`
+        _timestampLine = _timestampLine.padStart(
+          (_longestLabel - _timestampLine.indexOf(':')) + _timestampLine.length,
+          ' ',
+        )
+        const _longestLine = _longestLabel + _longestValue
+        // const _longestLine = lines
+        //   .reduce((a, c) => {
+        //     // console.log(a, c.length)
+        //     if (a > c.length) return a
+        //     return c.length
+        //   }, '')
+        // console.log('longest line', _longestLine)
+        /* eslint-disable prefer-template */
+        const endDangler = 6
+        _requestBanner = `${_g.padEnd(_longestLine + endDangler, _g)}\n`
           + `${_g} ${_urlLine}\n`
+          + `${(_queryStringLine.length > 0) ? _g + ' ' + _queryStringLine + '\n' : ''}`
           + `${_g} ${_refLine}\n`
           + `${_g} ${_ipLine}\n`
-          + `${_g.padEnd(_longestLine + 5, _g)}`
+          + `${_g} ${_timestampLine}\n`
+          + `${_g.padEnd(_longestLine + endDangler, _g)}`
+        /* eslint-enable prefer-template */
         _log(_requestBanner)
         if (next) {
           await next(ctx.request.method)

package/test/test.js

@@ -1,15 +1,17 @@
 // import path from 'node:path'
 // import { randomBytes } from 'node:crypto'
 import {
-  after,
+  // after,
   before,
   describe,
   it,
 } from 'node:test'
 import assert from 'node:assert/strict'
-import fs from 'node:fs/promises'
+// import fs from 'node:fs/promises'
 import os from 'node:os'
 import { Banner } from '../src/index.js'
+
+/* eslint-disable camelcase */
 const skip = { skip: true }
 console.log(skip)
 let cfg
@@ -22,23 +24,25 @@ let next
 describe('First test suite for banner package', async () => {
   before(() => {
     function getLocalIpAddress() {
-      const networkInterfaces = os.networkInterfaces();
-      let localIpAddress = null;
-    
+      const networkInterfaces = os.networkInterfaces()
+      let localIpAddress = null
+
+      /* eslint-disable no-restricted-syntax */
+      /* eslint-disable guard-for-in */
       for (const interfaceName in networkInterfaces) {
-        const networkInterface = networkInterfaces[interfaceName];
+        const networkInterface = networkInterfaces[interfaceName]
         for (const details of networkInterface) {
           // Check for IPv4, not internal (loopback), and a valid address
           if (details.family === 'IPv4' && !details.internal) {
-            localIpAddress = details.address;
-            break; // Found a suitable IPv4 address, exit inner loop
+            localIpAddress = details.address
+            break // Found a suitable IPv4 address, exit inner loop
           }
         }
         if (localIpAddress) {
-          break; // Found a suitable IPv4 address, exit outer loop
+          break // Found a suitable IPv4 address, exit outer loop
         }
       }
-      return localIpAddress;
+      return localIpAddress
     }
     ctx = {
       request: {
@@ -71,21 +75,22 @@ describe('First test suite for banner package', async () => {
   })
 
   it('Should create a start-up banner instance, with constructor param.', () => {
-    const banner = new Banner(cfg)  
+    const banner = new Banner(cfg)
     assert(banner.bannerText.length > 0)
     assert(typeof banner.bannerText === 'string')
   })
-  
+
   it('Should fail', () => {
     const banner = new Banner()
     assert(!banner.print())
   })
 
   it('Should work as a koajs middleware function - POST method.', async () => {
-    ctx_POST = Object.assign({}, ctx)
+    // ctx_POST = Object.assign({}, ctx)
+    ctx_POST = { ...ctx }
     ctx_POST.request.method = 'POST'
-    ctx_POST.throw = (code, err, {} = null) => {
-      throw new Error(`${code}, ${msg}`)
+    ctx_POST.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
     }
     console.log(ctx_POST)
     const post = new Banner(ctx_POST)
@@ -93,10 +98,11 @@ describe('First test suite for banner package', async () => {
   })
 
   it('Should work as a koajs middleware function - GET method.', async () => {
-    ctx_GET = Object.assign({}, ctx)
+    // ctx_GET = Object.assign({}, ctx)
+    ctx_GET = { ...ctx }
     ctx_GET.request.method = 'GET'
-    ctx_GET.throw = (code, err, {} = null) => {
-      throw new Error(`${code}, ${msg}`)
+    ctx_GET.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
     }
     console.log(ctx_GET)
     const get = new Banner(ctx_GET)
@@ -104,10 +110,11 @@ describe('First test suite for banner package', async () => {
   })
 
   it('Should work as a koajs middleware function - PUT method.', async () => {
-    ctx_PUT = Object.assign({}, ctx)
+    // ctx_PUT = Object.assign({}, ctx)
+    ctx_PUT = { ...ctx }
     ctx_PUT.request.method = 'PUT'
-    ctx_PUT.throw = (code, err, {} = null) => {
-      throw new Error(`${code}, ${msg}`)
+    ctx_PUT.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
     }
     console.log(ctx_PUT)
     const put = new Banner(ctx_PUT)
@@ -115,22 +122,36 @@ describe('First test suite for banner package', async () => {
   })
 
   it('Should work as a koajs middleware function - DELETE method.', async () => {
-    ctx_DEL = Object.assign({}, ctx)
+    // ctx_DEL = Object.assign({}, ctx)
+    ctx_DEL = { ...ctx }
     ctx_DEL.request.method = 'DELETE'
-    ctx_DEL.throw = (code, err, {} = null) => {
-      throw new Error(`${code}, ${msg}`)
+    ctx_DEL.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
     }
     console.log(ctx_DEL)
     const del = new Banner(ctx_DEL)
     assert(await del.use()(ctx_DEL, next))
   })
 
-it('Should fail as a koajs middleware function, missing input parameters.', async () => {
+  it('Should work as a koajs middleware function - GET method, with query string.', async () => {
+    // ctx_GET = Object.assign({}, ctx)
+    ctx_GET = { ...ctx }
+    ctx_GET.request.method = 'GET'
+    ctx_GET.request.url += '?param1=querty&param2=12345&param3=true'
+    ctx_GET.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
+    }
+    console.log(ctx_GET)
+    const get = new Banner(ctx_GET)
+    assert(await get.use()(ctx_GET, next))
+  })
+
+  it('Should fail as a koajs middleware function, missing input parameters.', async () => {
     ctx.request.header.host = null
     ctx.request.url = null
     ctx.throw = (code, err) => {
       // console.log(err.message)
-      throw err 
+      throw err
     }
     console.log(ctx)
     const req = new Banner()