@mattduffy/banner 1.2.0 → 1.3.0

package/.eslintrc.cjs

@@ -1,3 +1,5 @@
+const restrictedGlobals = require('eslint-restricted-globals')
+
 module.exports = {
   globals: {
     window: true,
@@ -15,9 +17,9 @@ module.exports = {
   extends: 'airbnb-base',
   overrides: [
     {
-      files: ["public/j/worker.js"],
+      files: ['public/j/worker.js'],
       rules: {
-        'no-restricted-globals': ['error', 'isFinite', 'isNaN'].concat(restrictedGlobals), 
+        'no-restricted-globals': ['error', 'isFinite', 'isNaN'].concat(restrictedGlobals),
       },
     },
   ],
@@ -31,7 +33,7 @@ module.exports = {
     'no-underscore-dangle': 'off',
     'import/extensions': 'off',
     'import/prefer-default-export': 'off',
-    'max-len': ['error', {"code": 100}],
+    'max-len': ['error', { code: 100 }],
     'new-cap': 'off',
   },
 }

package/Readme.md

@@ -31,7 +31,7 @@ app.use(banner.use())
   Emits at the beginning of each client request.
   #################################################################
   #      GET: https://dev.example.com/map/getToken?debug=verbose
-  #  Referer: https://dev.exaple.com/?debug=verbose
+  #  Referer: https://dev.example.com/?debug=verbose
   #  From IP: 192.168.1.254
   #################################################################
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattduffy/banner",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Displays server start-up information.",
   "author": "Matthew Duffy",
   "license": "ISC",
@@ -28,6 +28,7 @@
   },
   "keywords": [],
   "dependencies": {
-    "debug": "4.4.1"
+    "debug": "4.4.1",
+    "eslint-restricted-globals": "0.2.0"
   }
 }

package/src/index.js

@@ -7,8 +7,8 @@
 import Debug from 'debug'
 
 Debug.log = console.log.bind(console)
-const log = Debug('banner')
-const error = log.extend('ERROR')
+// const log = Debug('banner')
+// const error = log.extend('ERROR')
 
 /**
  * A class to create and emit a start-up banner of Koajs based apps.
@@ -18,24 +18,43 @@ const error = log.extend('ERROR')
  */
 export class Banner {
   #appName
+
   #arch
+
   #bannerText
+
   #borderGlyphGET = '#'
+
   #borderGlyphPUT = '&'
+
   #borderGlyphPOST = '@'
+
   #borderGlyphDELETE = '*'
+
   #ipAddress
+
   #lineStarts = []
+
   #lines = []
+
   #local
+
   #localPort
+
   #nodejs
+
   #nodeLts
+
   #nodeName
+
   #nodeVersion
+
   #platform
+
   #public
+
   #startingup
+
   /**
    * Create an instance of the Banner class.
    * @param { object } [strings] - An object literal of strings to display in the banner.
@@ -46,7 +65,7 @@ export class Banner {
    * @param { string } strings.public - The public web address the app is accesssible at.
    * @returns { Banner}
    */
-  constructor(strings=null) {
+  constructor(strings = null) {
     this.#arch = process.arch
     this.#nodeLts = process.release?.lts ?? null
     this.#nodeName = process.release.name
@@ -64,7 +83,7 @@ export class Banner {
       this.#borderGlyphGET = strings?.borderGlyph ?? this.#borderGlyphGET
       this.#localPort = strings?.localPort ?? null
       this.#ipAddress = strings?.ip ?? null
-      this.#local = `${strings.local}${(this.#localPort) ? ':' + this.#localPort : ''}`
+      this.#local = `${strings.local}${(this.#localPort) ? `: ${this.#localPort}` : ''}`
       this.#public = strings.public
       this.#startingup = strings.name
     }
@@ -79,63 +98,62 @@ export class Banner {
    * @throws { Error } - Throws an exception if name, public, local values are missing.
    * @return { void }
    */
-  #compose () {
+  #compose() {
     if (!this.#appName || !this.#local || !this.#public) {
       throw new Error('Missing required inputs.')
     }
     this.startingupLine = `${this.startingupLabel}: ${this.#startingup}`
     this.#lineStarts.push(this.startingupLine)
     this.localLine = `${this.localLabel}: `
-      + `${/^https?:\/\//.test(this.#local) ? this.#local : 'http://' + this.#local}`
+      + `${/^https?:\/\//.test(this.#local) ? `${this.#local}` : `http://${this.#local}`}`
     this.#lineStarts.push(this.localLine)
     this.publicLine = `${this.publicLabel}: `
-      + `${/^https?:\/\//.test(this.#public) ? this.#public : 'https://' + this.#public}`
+      + `${/^https?:\/\//.test(this.#public) ? `${this.#public}` : `https://${this.#public}`}`
     this.#lineStarts.push(this.publicLine)
     this.archLine = `${this.archLabel}: ${this.#arch} ${this.#platform}`
     this.#lineStarts.push(this.archLine)
     this.nodejsLine = `${this.nodejsLabel}: ${this.#nodeName} ${this.#nodeVersion} `
-      + `${(this.#nodeLts) ? '(' + this.#nodeLts + ')' : ''}`
+      + `${(this.#nodeLts) ? `(${this.#nodeLts})` : ''}`
     this.#lineStarts.push(this.nodejsLine)
 
-    this.startingupLine = this.startingupLine.padStart(
-      (this.longestLabel - this.startingupLine.indexOf(':'))
-      + this.startingupLine.length, ' ')
+    this.startingupLine = this.startingupLine
+      .padStart((this.longestLabel - this.startingupLine.indexOf(':'))
+        + this.startingupLine.length, ' ')
     this.#lines[0] = this.startingupLine
 
-    this.localLine = this.localLine.padStart(
-      (this.longestLabel - this.localLine.indexOf(':'))
-      + this.localLine.length, ' ')
+    this.localLine = this.localLine
+      .padStart((this.longestLabel - this.localLine.indexOf(':'))
+        + this.localLine.length, ' ')
     this.#lines[1] = this.localLine
 
-    this.publicLine = this.publicLine.padStart(
-      (this.longestLabel - this.publicLine.indexOf(':'))
-      + this.publicLine.length, ' ')
+    this.publicLine = this.publicLine
+      .padStart((this.longestLabel - this.publicLine.indexOf(':'))
+        + this.publicLine.length, ' ')
     this.#lines[2] = this.publicLine
 
-    this.nodejsLine = this.nodejsLine.padStart(
-      (this.longestLabel - this.nodejsLine.indexOf(':'))
-      + this.nodejsLine.length, ' ')
+    this.nodejsLine = this.nodejsLine
+      .padStart((this.longestLabel - this.nodejsLine.indexOf(':'))
+        + this.nodejsLine.length, ' ')
     this.#lines[3] = this.nodejsLine
 
-    this.archLine = this.archLine.padStart(
-      (this.longestLabel - this.archLine.indexOf(':'))
-      + this.archLine.length, ' ')
+    this.archLine = this.archLine
+      .padStart((this.longestLabel - this.archLine.indexOf(':'))
+        + this.archLine.length, ' ')
     this.#lines[4] = this.archLine
 
     const g = this.#borderGlyphGET
-    this.#bannerText =
-      `${g}${g.padEnd(this.longestLine + 5, g)}${g}\n`
+    this.#bannerText = `${g}${g.padEnd(this.longestLine + 5, g)}${g}\n`
       + `${g}  ${' '.padEnd(this.longestLine + 2, ' ')} ${g}\n`
-      + `${g} ${this.startingupLine}${' '.padEnd(
-        (this.longestLine - this.startingupLine.length) + 3, ' ')} ${g}\n`
-      + `${g} ${this.localLine}${' '.padEnd(
-        (this.longestLine - this.localLine.length) + 3, ' ')} ${g}\n`
-      + `${g} ${this.publicLine}${' '.padEnd(
-        (this.longestLine - this.publicLine.length) + 3, ' ')} ${g}\n`
-      + `${g} ${this.nodejsLine}${' '.padEnd(
-        (this.longestLine - this.nodejsLine.length) + 3, ' ')} ${g}\n`
-      + `${g} ${this.archLine}${' '.padEnd(
-        (this.longestLine - this.archLine.length) + 3, ' ')} ${g}\n`
+      + `${g} ${this.startingupLine}${' '
+        .padEnd((this.longestLine - this.startingupLine.length) + 3, ' ')} ${g}\n`
+        + `${g} ${this.localLine}${' '
+          .padEnd((this.longestLine - this.localLine.length) + 3, ' ')} ${g}\n`
+          + `${g} ${this.publicLine}${' '
+            .padEnd((this.longestLine - this.publicLine.length) + 3, ' ')} ${g}\n`
+            + `${g} ${this.nodejsLine}${' '
+              .padEnd((this.longestLine - this.nodejsLine.length) + 3, ' ')} ${g}\n`
+              + `${g} ${this.archLine}${' '
+                .padEnd((this.longestLine - this.archLine.length) + 3, ' ')} ${g}\n`
       + `${g}  ${' '.padEnd(this.longestLine + 2, ' ')} ${g}\n`
       + `${g}${g.padEnd(this.longestLine + 5, g)}${g}\n`
   }
@@ -166,13 +184,13 @@ export class Banner {
     }
   }
 
-    /**
+  /**
    * Set the local address displayed in the banner.
    * @type { string }
    * @param { string } local - The local address displayed in the banner.
    */
   set local(local) {
-    this.#local = `${local}${(this.#localPort) ? ':' + this.#localPort : ''}`
+    this.#local = `${local}${(this.#localPort) ? `:${this.#localPort}` : ''}`
     if (this.#appName && this.#public) {
       this.#compose()
     }
@@ -254,29 +272,30 @@ export class Banner {
 
   /**
    * Create a middleware method that generates a banner for each request.
-   * @param { function } [log] - an optional reference to the app level logging function.
-   * @param { function } [error] - an optional reference to the app level error logging function.
+   * @param { function } [Log] - an optional reference to the app level logging function.
+   * @param { function } [Error] - an optional reference to the app level error logging function.
    * @returns { (ctx:object, next:function) => mixed } - Koa middleware function.
    */
-  use(log=null, error=null) {
-    const _log = log ?? console.log
-    const _error = error ?? console.error
+  use(Log = null, Error = null) {
+    const _log = Log ?? console.log
+    // const _error = Error ?? console.error
     _log('adding request banner to the app.')
     const gGET = this.#borderGlyphGET
     const gPUT = this.#borderGlyphPUT
     const gPOST = this.#borderGlyphPOST
     const gDEL = this.#borderGlyphDELETE
-    const n = this.#appName
-    return async function banner(ctx, next = null){
+    // const n = this.#appName
+    return async function banner(ctx, next = null) {
       let _requestBanner
       try {
         let _g
-        switch(ctx.request.method.toLowerCase()) {
+        switch (ctx.request.method.toLowerCase()) {
           case 'get':
             _g = gGET
             break
           case 'post':
             _g = gPOST
+            console.info(ctx.request.body)
             break
           case 'put':
             _g = gPUT
@@ -288,52 +307,117 @@ export class Banner {
             _g = gGET
         }
         if (!ctx) {
-          throw new Error('Missing required ctx object.')  
+          throw new Error('Missing required ctx object.')
         }
         if (!ctx.request.header.host) {
-          throw new Error('Missing required request header.host value.')  
+          throw new Error('Missing required request header.host value.')
         }
         if (!ctx.request.method) {
-          throw new Error('Missing required request method value.')  
+          throw new Error('Missing required request method value.')
         }
         if (!ctx.request.url) {
-          throw new Error('Missing required request url value.')  
+          throw new Error('Missing required request url value.')
+        }
+        const labels = []
+        const values = []
+        const lines = []
+        const _urlLabel = `${ctx.request.method}:`
+        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')
         }
-        const _urlLabel = `${ctx.request.method}:` 
-        const _url = `${ctx.request.protocol}://${ctx.request.header.host}${ctx.request.url}`
+        _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, ' '
+          (_longestLabel - _refLine.indexOf(':')) + _refLine.length,
+          ' ',
         )
         _urlLine = _urlLine.padStart(
-          (_longestLabel - _urlLine.indexOf(':')) + _urlLine.length, ' '
+          (_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, ' '
+          (_longestLabel - _ipLine.indexOf(':')) + _ipLine.length,
+          ' ',
+        )
+        _timestampLine = _timestampLine.padStart(
+          (_longestLabel - _timestampLine.indexOf(':')) + _timestampLine.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`
+        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()