@mattduffy/banner 1.1.1 → 1.2.1

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

@@ -3,11 +3,76 @@ This package exports a middleware function for Koajs app servers that displays u
 information.
 
 ```javascript
-import banner from '@mattduffy/banner'
+import Banner from '@mattduffy/banner'
 
 // to emit a startup banner in your app logs
+const banner = new Banner({
+  name: <your_app_name>,
+  local: <your_local_dev_host>,
+  localPort: <your_local_dev_port>, // optional
+  public: <your_public_domain_name>,
+})
 banner.print()
-
+/*
+  Emits to stdout (or where ever your logging goes).
+  #####################################################
+  #                                                   #
+  #  Starting up: <your_app_name>                     #
+  #        local: http://192.168.1.252:9876           #
+  #       public: https://example.com                 #
+  #      process: node v20.19.4 (Iron)                #
+  #         arch: x64 linux                           #
+  #                                                   #
+  #####################################################
+*/
 // To emit a banner at the start of each request
 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
+  #################################################################
+*/
+```
+
+The request banner uses a different ASCII text character depending on the value of 
+the ```ctx.request.method``` property.  The supported request methods are ```GET```, ```PUT```,
+```POST```, and ```DELETE```.
+
+```
+// GET
+######################################################################
+#      GET: https://banner.test/a/really/long/url/to/a/special/page
+#  Referer: https://googoogle.com
+#  From IP: 192.168.1.250
+######################################################################
+```
+
+```
+// PUT
+&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
+&      PUT: https://banner.test/a/really/long/url/to/a/special/page
+&  Referer: https://googoogle.com
+&  From IP: 192.168.1.250
+&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
+```
+
+```
+// POST
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@     POST: https://banner.test/a/really/long/url/to/a/special/page
+@  Referer: https://googoogle.com
+@  From IP: 192.168.1.250
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+```
+
+```
+// DELETE
+**********************************************************************
+*   DELETE: https://banner.test/a/really/long/url/to/a/special/page
+*  Referer: https://googoogle.com
+*  From IP: 192.168.1.250
+**********************************************************************
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattduffy/banner",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "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,33 +18,54 @@ 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.
-   * @param { string } strings.name - The name of the app starting up.
-   * @param { string } strings.public - The public web address the app is accesssible at.
+   * @param { string } [strings.ip] - The ip address of the request.
    * @param { string } strings.local - The local address the app is accessible at.
    * @param { Number } [strings.localPort] - The local address port, if provided.
+   * @param { string } strings.name - The name of the app starting up.
+   * @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
@@ -61,7 +82,8 @@ export class Banner {
       this.#appName = strings.name
       this.#borderGlyphGET = strings?.borderGlyph ?? this.#borderGlyphGET
       this.#localPort = strings?.localPort ?? null
-      this.#local = `${strings.local}${(this.#localPort) ? ':' + this.#localPort : ''}`
+      this.#ipAddress = strings?.ip ?? null
+      this.#local = `${strings.local}${(this.#localPort) ? `: ${this.#localPort}` : ''}`
       this.#public = strings.public
       this.#startingup = strings.name
     }
@@ -76,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`
   }
@@ -163,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()
     }
@@ -251,24 +272,24 @@ 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){
+    // const n = this.#appName
+    return async function banner(ctx, next = null) {
+      let _requestBanner
       try {
-        // const _g = (/post/i.test(ctx.request.method)) ? '@' : g
         let _g
-        switch(ctx.request.method.toLowerCase()) {
+        switch (ctx.request.method.toLowerCase()) {
           case 'get':
             _g = gGET
             break
@@ -284,43 +305,65 @@ export class Banner {
           default:
             _g = gGET
         }
-        _log('ctx.request.header.host', ctx.request.header.host)
-        const _urlLabel = `${ctx.request.method}:` 
+        if (!ctx) {
+          throw new Error('Missing required ctx object.')
+        }
+        if (!ctx.request.header.host) {
+          throw new Error('Missing required request header.host value.')
+        }
+        if (!ctx.request.method) {
+          throw new Error('Missing required request method value.')
+        }
+        if (!ctx.request.url) {
+          throw new Error('Missing required request url value.')
+        }
+        const _urlLabel = `${ctx.request.method}:`
         const _url = `${ctx.request.protocol}://${ctx.request.header.host}${ctx.request.url}`
         let _urlLine = `${_urlLabel} ${_url}`
         const _refLabel = 'Referer:'
         const _ref = ctx.request.header.referer ?? '<emtpy header field>'
         let _refLine = `${_refLabel} ${_ref}`
-        const _longestLabel = [_urlLabel, _refLabel].reduce((a, c) => {
+        const _ipLabel = 'From IP:'
+        const _ip = ctx.request.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)
         }, '')
         _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,
+          ' ',
         )
-        const _longestLine = [_urlLine, _refLine].reduce((a, c) => {
+        _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)
-        const _requestBanner = 
-          `${_g.padEnd(_longestLine + 5, _g)}\n`
+        _requestBanner = `${_g.padEnd(_longestLine + 5, _g)}\n`
           + `${_g} ${_urlLine}\n`
           + `${_g} ${_refLine}\n`
+          + `${_g} ${_ipLine}\n`
           + `${_g.padEnd(_longestLine + 5, _g)}`
         _log(_requestBanner)
-        await next()
-        return true
+        if (next) {
+          await next(ctx.request.method)
+        }
       } catch (e) {
-        _error('Failed after adding start-up banner.')
-        _error(e)
-        ctx.throw(500, 'Error after adding start-up banner.', e)
+        // _error('Failed after adding the request banner.')
+        // _error(e)
+        ctx.throw(500, e)
       }
-    }
-  }
+      return _requestBanner
+    } // end async closure function, Banner.use.banner()
+  } // end Banner.use()
 }

package/test/test.js

@@ -8,8 +8,10 @@ import {
 } from 'node:test'
 import assert from 'node:assert/strict'
 import fs from 'node:fs/promises'
+import os from 'node:os'
 import { Banner } from '../src/index.js'
 const skip = { skip: true }
+console.log(skip)
 let cfg
 let ctx
 let ctx_POST
@@ -17,11 +19,30 @@ let ctx_GET
 let ctx_PUT
 let ctx_DEL
 let next
-console.log(skip)
 describe('First test suite for banner package', async () => {
   before(() => {
+    function getLocalIpAddress() {
+      const networkInterfaces = os.networkInterfaces();
+      let localIpAddress = null;
+    
+      for (const interfaceName in networkInterfaces) {
+        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
+          }
+        }
+        if (localIpAddress) {
+          break; // Found a suitable IPv4 address, exit outer loop
+        }
+      }
+      return localIpAddress;
+    }
     ctx = {
       request: {
+        ip: getLocalIpAddress(),
         protocol: 'https',
         method: '',
         url: '/a/really/long/url/to/a/special/page',
@@ -30,17 +51,10 @@ describe('First test suite for banner package', async () => {
           referer: 'https://googoogle.com',
         },
       },
-      throw: (code, msg) => {
-        throw new Error(`Error code ${code}: ${msg}`)
-      }
     }
-    ctx_DEL = { ...ctx }
-    ctx_PUT = { ...ctx }
-    ctx_POST = { ...ctx }
-    ctx_GET = { ...ctx }
-    next = async () => {
+    next = async (m) => {
       setTimeout(() => {
-        console.log('the next() function')
+        console.log(`the next(${m}) function`)
       }, 1000)
     }
     cfg = {
@@ -68,44 +82,64 @@ describe('First test suite for banner package', async () => {
   })
 
   it('Should work as a koajs middleware function - POST method.', async () => {
-    ctx_POST = Object.assign(ctx_POST, ctx)
+    ctx_POST = Object.assign({}, ctx)
     ctx_POST.request.method = 'POST'
+    ctx_POST.throw = (code, err, {} = null) => {
+      throw new Error(`${code}, ${msg}`)
+    }
     console.log(ctx_POST)
     const post = new Banner(ctx_POST)
-    assert(await post.use()(ctx, next))
+    assert(await post.use()(ctx_POST, next))
   })
 
   it('Should work as a koajs middleware function - GET method.', async () => {
-    ctx_GET = Object.assign(ctx_GET, ctx)
+    ctx_GET = Object.assign({}, ctx)
     ctx_GET.request.method = 'GET'
+    ctx_GET.throw = (code, err, {} = null) => {
+      throw new Error(`${code}, ${msg}`)
+    }
     console.log(ctx_GET)
     const get = new Banner(ctx_GET)
-    assert(await get.use()(ctx, next))
+    assert(await get.use()(ctx_GET, next))
   })
 
   it('Should work as a koajs middleware function - PUT method.', async () => {
-    ctx_PUT = Object.assign(ctx_PUT, ctx)
+    ctx_PUT = Object.assign({}, ctx)
     ctx_PUT.request.method = 'PUT'
+    ctx_PUT.throw = (code, err, {} = null) => {
+      throw new Error(`${code}, ${msg}`)
+    }
     console.log(ctx_PUT)
     const put = new Banner(ctx_PUT)
-    assert(await put.use()(ctx, next))
+    assert(await put.use()(ctx_PUT, next))
   })
 
   it('Should work as a koajs middleware function - DELETE method.', async () => {
-    ctx_DEL = Object.assign(ctx_DEL, ctx)
+    ctx_DEL = Object.assign({}, ctx)
     ctx_DEL.request.method = 'DELETE'
+    ctx_DEL.throw = (code, err, {} = null) => {
+      throw new Error(`${code}, ${msg}`)
+    }
     console.log(ctx_DEL)
     const del = new Banner(ctx_DEL)
-    assert(await del.use()(ctx, next))
+    assert(await del.use()(ctx_DEL, next))
   })
 
 it('Should fail as a koajs middleware function, missing input parameters.', async () => {
-    ctx.url= ''
-    ctx.request.header.host = undefined 
-    ctx.request.url = undefined 
+    ctx.request.header.host = null
+    ctx.request.url = null
+    ctx.throw = (code, err) => {
+      // console.log(err.message)
+      throw err 
+    }
     console.log(ctx)
-    const post = new Banner()
-    await post.use()(ctx, next)
-    // assert.throws(await post.use()(ctx, next))
+    const req = new Banner()
+    const use = await req.use()
+    assert.rejects(
+      async () => {
+        await use(ctx)
+      },
+      Error,
+    )
   })
 })