@mattduffy/banner 1.3.1 → 1.4.0

package/Readme.md

@@ -83,3 +83,31 @@ the ```ctx.request.method``` property.  The supported request methods are ```GET
 *  Timestamp: 1/7/2026, 10:34:14 AM
 **********************************************************************
 ```
+
+Under the right conditions, the request banner can also include geo-location details
+about the client.  For each new request, Koajs creates a context object containing the
+request and response objects ```ctx.request``` and ```ctx.response```.  It is a common
+technique to add a state property to the ctx object, like ```ctx.state```.  If geo-location
+is available, save it to ```ctx.state``` like so:
+```javascript
+ctx.state.logEntry = {
+  geos: [
+    {
+      country: <client-country>,
+      city: <client-city>,
+      subdivision: <client-subdivision>, // the state in USA
+      coords: [<latitude>, <longitude>],
+    },
+  ],
+}
+
+###########################################################################################
+#        GET: https://banner.test/a/really/long/url/to/a/special/page
+#    Referer: https://googoogle.com
+#    From IP: 192.168.1.250
+#   Location: Country: United States, City: New York City, lat/lon: 40.775697, -73.971727
+#  Timestamp: 1/7/2026, 8:22:41 PM
+###########################################################################################
+```
+The geo-location details must be saved to the context state property before the 
+```app.use(banner.use())``` is executed for this to work.

package/package.json

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

package/src/index.js

@@ -279,7 +279,7 @@ export class Banner {
   use(Log = null, Error = null) {
     const _log = Log ?? console.log
     // const _error = Error ?? console.error
-    _log('adding request banner to the app.')
+    // _log('adding request banner to the app.')
     const gGET = this.#borderGlyphGET
     const gPUT = this.#borderGlyphPUT
     const gPOST = this.#borderGlyphPOST
@@ -322,6 +322,7 @@ export class Banner {
         const values = []
         const lines = []
         const _urlLabel = `${ctx.request.method}:`
+        labels.push(_urlLabel)
         let _url = `${ctx.request.protocol}://${ctx.request.header.host}${ctx.request.url}`
         const _queryStringIndex = _url.indexOf('?')
         const _queryStringLabel = 'Query Params:'
@@ -333,51 +334,65 @@ export class Banner {
           labels.push(_queryStringLabel)
           values.push(_queryString)
           lines.push(_queryStringLine)
-          // console.log('adding query string to request banner')
+          // _log('adding query string to request banner')
         }
         _url = (_queryString.length > 0) ? _url.slice(0, _url.indexOf('?')) : _url
         values.push(_url)
         let _urlLine = `${_urlLabel} ${_url}`
+        lines.push(_urlLine)
         const _refLabel = 'Referer:'
+        labels.push(_refLabel)
         const _ref = ctx.request.header.referer ?? '<emtpy header field>'
         values.push(_ref)
         let _refLine = `${_refLabel} ${_ref}`
+        lines.push(_refLine)
         const _ipLabel = 'From IP:'
+        labels.push(_ipLabel)
         const _ip = ctx.request.ip
         values.push(_ip)
         let _ipLine = `${_ipLabel} ${_ip}`
+        lines.push(_ipLine)
+        let _locationLine = ''
+        if (ctx?.state?.logEntry?.geos[0]) {
+          // _log('banner geolocation says what?', ctx?.state?.logEntry)
+          const l = ctx.state.logEntry.geos[0]
+          const _locationLabel = 'Location:'
+          labels.push(_locationLabel)
+          /* eslint-disable prefer-template */
+          const _location = `${(l.country) ? 'Country: ' + l.country + ', ' : ''}`
+            + `${(l.subdivision) ? 'Subdivision: ' + l.subdivision + ', ' : ''}`
+            + `${(l.city) ? 'City: ' + l.city + ', ' : ''}`
+            + `${(l.coords) ? 'lat/lon: ' + l.coords[0] + ', ' + l.coords[1] : ''}`
+          /* eslint-enable prefer-template */
+          values.push(_location)
+          _locationLine = `${_locationLabel} ${_location}`
+          lines.push(_locationLine)
+        }
         const _timestampLabel = 'Timestamp:'
+        labels.push(_timestampLabel)
         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)
+        lines.push(_timestampLine)
+        // _log(labels)
+        // _log(values)
+        // _log(lines)
         const _longestValue = values
           .reduce((a, c) => {
             if (a > c.length) return a
             return c.length
           }, '')
-        // console.log('longest value', _longestValue)
+        // _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)
+            // _log(a, c.indexOf(':') + 1)
             if (a > (c.indexOf(':') + 1)) {
               return a
             }
             return (c.indexOf(':') + 1)
           }, '')
-        // console.log('longest label', _longestLabel)
+        // _log('longest label', _longestLabel)
         _refLine = _refLine.padStart(
           (_longestLabel - _refLine.indexOf(':')) + _refLine.length,
           ' ',
@@ -396,6 +411,12 @@ export class Banner {
           (_longestLabel - _ipLine.indexOf(':')) + _ipLine.length,
           ' ',
         )
+        if (_locationLine.length > 0) {
+          _locationLine = _locationLine.padStart(
+            (_longestLabel - _locationLine.indexOf(':')) + _locationLine.length,
+            ' ',
+          )
+        }
         _timestampLine = _timestampLine.padStart(
           (_longestLabel - _timestampLine.indexOf(':')) + _timestampLine.length,
           ' ',
@@ -403,11 +424,11 @@ export class Banner {
         const _longestLine = _longestLabel + _longestValue
         // const _longestLine = lines
         //   .reduce((a, c) => {
-        //     // console.log(a, c.length)
+        //     // _log(a, c.length)
         //     if (a > c.length) return a
         //     return c.length
         //   }, '')
-        // console.log('longest line', _longestLine)
+        // _log('longest line', _longestLine)
         /* eslint-disable prefer-template */
         const endDangler = 6
         _requestBanner = `${_g.padEnd(_longestLine + endDangler, _g)}\n`
@@ -415,6 +436,7 @@ export class Banner {
           + `${(_queryStringLine.length > 0) ? _g + ' ' + _queryStringLine + '\n' : ''}`
           + `${_g} ${_refLine}\n`
           + `${_g} ${_ipLine}\n`
+          + `${(_locationLine.length > 0) ? _g + ' ' + _locationLine + '\n' : ''}`
           + `${_g} ${_timestampLine}\n`
           + `${_g.padEnd(_longestLine + endDangler, _g)}`
         /* eslint-enable prefer-template */

package/test/test.js

@@ -45,6 +45,7 @@ describe('First test suite for banner package', async () => {
       return localIpAddress
     }
     ctx = {
+      state: {},
       request: {
         ip: getLocalIpAddress(),
         protocol: 'https',
@@ -109,6 +110,31 @@ describe('First test suite for banner package', async () => {
     assert(await get.use()(ctx_GET, next))
   })
 
+  it('Should work as a koajs middleware function - GET method, check for geos.', async () => {
+    // ctx_GET = Object.assign({}, ctx)
+    ctx_GET = { ...ctx }
+    ctx_GET.request.method = 'GET'
+    ctx_GET.throw = (code, err) => {
+      throw new Error(`${code}, ${err}`)
+    }
+    ctx_GET.state.logEntry = {
+      geos: [
+        {
+          ip: '10.20.30.40',
+          country: 'United States',
+          city: 'New York City',
+          coords: [40.775697, -73.971727],
+        },
+      ],
+    }
+    console.log(ctx_GET)
+    assert(ctx_GET.state.logEntry.geos[0].coords.length === 2)
+    const get = new Banner(ctx_GET)
+    const banner = await get.use()(ctx_GET, next)
+    assert(/40\.775697/m.test(banner))
+    delete ctx_GET.state.logEntry
+  })
+
   it('Should work as a koajs middleware function - PUT method.', async () => {
     // ctx_PUT = Object.assign({}, ctx)
     ctx_PUT = { ...ctx }