@akc42/server-utils 1.4.1 → 2.0.0

package/README.md

@@ -1,13 +1,9 @@
 # server-utils
 A Set of Utilities that I generally use on SPA projects for the server side of the project
 
-It consists of 4 separate packages.  
+It consists of 4 separate packages 6 entry points.
 
-`database` is a module to open (creating it if it doesn't yet exist from a `database.sql` file).  It uses two environment 
-variables to locate the database DATABASE_DB_DIR and DATABASE_DB are the directory and filename respectively of the sqlite3 
-database. It also used DATABASE_DB_BUSY for the busy timeout.  DATABASE_DB_DIR can either be an absolute value, or relative 
-from the project root (see npm module `app-root-path`). If the database file does not exist, it attempt to create it from the script
-read from file named by DATABASE_INIT_FILE.  The path can be relative to project root or an absolute value.
+The packages are:-
 
 `logger` provides a logging service for the app.  It is controlled by three environment variables LOG_NONE prevents it from logging anything.
 This is designed to be used during testing of the server side of the app so that nothing is logged.  LOG_NO_DATE omits the date and time from
@@ -23,22 +19,28 @@ with `new Responder(response);` and the resultant object has three methods;
   promise which resolves when any blockage is cleared.
 - `end` signifies the end of stream.  Any attempt to call the other two methods after this has been called will throw an error.
 
-`version` provides a promise that ultimately resolves to an object which has two
+`Version` provides an async function with a single parameter, the path to you
+project root) that ultimately resolves to an object which has two
 fields.  `version` which is the version string and `year` which is the copyright
-year.  It does this with the help of the npm module `app-root-path` read the
-instructions for that module if it doesn't give the right result for you. The
-project root is where either the `.git` directory exists (in which case
+year.  The project root is where either the `.git` directory exists (in which case
 `version` will ask git for the version and calculate the copyright year from the
 last git log entry) or where a `release.info` file is sitting (in which case
 `version` will expect that to contain a version string and have a modification
 time from which the copyright year can be derived).  If neither of those
 possibilities exist it will try to get the version info from the `package.json` file.
 
-These can either be installed all together
-```
-const {logger,database,version,Responder} = require('@akc42/server-utils');
-```
-or individually
+`Debug` module provides three entry points, `Debug`, `dumpDebugCache` and
+`setDebugConfig`. The `Debug` entry point is the main one, the user calls this a
+string representing the topic for the debug stream and we return a function that
+will allow him to call with string arguments which will be concatenated (with a
+space separator) to form a debug string.  If `setDebugConfig` has already been
+called to specify that the topic is to be logged (by providing a colon
+separated list of topics to be logged), then this is output. Regardless, all
+debug calls are stored in a 50 line cache, and will be output (newest first) on a call
+to `dumpDebugCache`
+
+
+Thise are installed with as many of few of the items that you want like so:-
 ```
-const logger = require('@akc42/server-utils/logger');
+import {logger,Responder,Debug} from '@akc42/server-utils';
 ```

package/debug.js

@@ -0,0 +1,68 @@
+/**
+@licence
+    Copyright (c) 2021 Alan Chandler, all rights reserved
+
+    This file is part of Server Utils.
+
+    Server Utils is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Server Utils is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Server Utils.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import chalk from 'chalk';
+let config = '';
+let cache = [];
+  
+export function Debug (topic) {
+    const t = topic;
+    let timestamp = new Date().getTime();
+    return function (...args) {
+      let enabled = false;
+      if (config) {
+        const topics = config.split(':');
+        if (topics.includes(t)) enabled = true;
+      }
+      const now = new Date().getTime();
+      const gap = now - timestamp;
+      timestamp = now;
+      const message = args.reduce((cum, arg) => {
+        return `${cum} ${arg}`.trim();
+      }, '');      
+      const output = `${chalk.greenBright(topic)} ${chalk.cyan(message)} ${chalk.whiteBright(`(${gap}ms)`)}`
+      if (enabled) {
+        console.log(output);
+      } 
+      cache.push(output);
+      cache.splice(0,cache.length - 50); //prevent it getting too big  
+  }
+};
+export function dumpDebugCache() {
+  const output = chalk.white.bgBlue('Above are all the debug calls (most recent first) which lead up to, and then followed on from, the error above');
+  cache.reverse();
+  for(const line of cache) {
+    console.log(line);
+  }
+  cache.reverse();
+  console.log(output);
+};
+export function setDebugConfig(con) {
+  if (con !== config) {
+    config = con;
+    const output = `${chalk.greenBright('debug server config')} ${chalk.redBright(`new server config "${config}"`)}`
+    console.log(output);
+  }
+};
+
+
+
+
+

package/logger.js

@@ -1,86 +1,76 @@
 /**
 @licence
-    Copyright (c) 2020 Alan Chandler, all rights reserved
+    Copyright (c) 2021 Alan Chandler, all rights reserved
 
-    This file is part of football-mobile.
+    This file is part of Server Utils.
 
-    football-mobile is free software: you can redistribute it and/or modify
+    Server Utils is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
-    football-mobile is distributed in the hope that it will be useful,
+    Server Utils is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with football-mobile.  If not, see <http://www.gnu.org/licenses/>.
+    along with Server Utils.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+import chalk from 'chalk';
+import { isIP } from 'net';
 
+const COLOURS = {
+  app: chalk.rgb(255, 136, 0).bold, //orange,
+  db: chalk.greenBright,
+  api: chalk.magentaBright,
+  client: chalk.redBright,
+  log: chalk.yellowBright,
+  mail: chalk.cyanBright,
+  //error like have backGround colouring
+  auth: chalk.black.bgCyan,
+  err: chalk.white.bgBlue,
+  error: chalk.white.bgRed
 
+};
+let cyrb53;
+if (process.env.LOG_NO_ENCODE) {
+  cyrb53 = (str, seed = 0) => {return str;};
+} else {
+  cyrb53 = (str, seed = 0) => {
+    let h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
+    for (let i = 0, ch; i < str.length; i++) {
+      ch = str.charCodeAt(i);
+      h1 = Math.imul(h1 ^ ch, 2654435761);
+      h2 = Math.imul(h2 ^ ch, 1597334677);
+    }
+    h1 = Math.imul(h1 ^ h1 >>> 16, 2246822507) ^ Math.imul(h2 ^ h2 >>> 13, 3266489909);
+    h2 = Math.imul(h2 ^ h2 >>> 16, 2246822507) ^ Math.imul(h1 ^ h1 >>> 13, 3266489909);
+    return 4294967296 * (2097151 & h2) + (h1 >>> 0);
+  };
+}
 
-(function() {
-  'use strict';
-
-  const chalkPromise = import('chalk');
-  const { isIP } = require('net');
-  let cyrb53;
-
-  if (process.env.LOG_NO_ENCODE) {
-    cyrb53 = (str, seed = 0) => {return str;};
-  } else {
-    cyrb53 = (str, seed = 0) => {
-      let h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
-      for (let i = 0, ch; i < str.length; i++) {
-        ch = str.charCodeAt(i);
-        h1 = Math.imul(h1 ^ ch, 2654435761);
-        h2 = Math.imul(h2 ^ ch, 1597334677);
-      }
-      h1 = Math.imul(h1 ^ h1 >>> 16, 2246822507) ^ Math.imul(h2 ^ h2 >>> 13, 3266489909);
-      h2 = Math.imul(h2 ^ h2 >>> 16, 2246822507) ^ Math.imul(h1 ^ h1 >>> 13, 3266489909);
-      return 4294967296 * (2097151 & h2) + (h1 >>> 0);
-    };
+export default async function logger(ip,level, ...messages) {
+  if (process.env.LOG_NONE === undefined) {
+    let logLine = '';
+    if (process.env.LOG_NO_DATE === undefined) logLine += new Date().toISOString() + ': ';
+    let message;
+    let logcolor;
+    if (isIP(ip) === 0 ) {
+      logcolor = ip;
+      message = level + messages.join(' ');
+    } else {
+      const client = process.env.LOG_IP_HIDDEN !== undefined ? cyrb53(ip): ip;
+      logLine += COLOURS.client(client + ': ');
+      logcolor = level
+      message = messages.join(' ');
+    }
+    logLine += COLOURS[logcolor](message);
+    //eslint-disable-next-line no-console
+    console.log(logLine.trim());     
   }
-  const COLOURPromise = new Promise(async accept => {
-    const {default: chalk} = await import('chalk');
-    accept({
-      app: chalk.rgb(255, 136, 0).bold, //orange,
-      db: chalk.greenBright,
-      api: chalk.magentaBright,
-      client: chalk.redBright,
-      log: chalk.yellowBright,
-      mail: chalk.cyanBright,
-      //error like have backGround colouring
-      auth: chalk.black.bgCyan,
-      err: chalk.white.bgBlue,
-      error: chalk.white.bgRed
-    });
-  });
+}
 
 
-  async function logger(ip,level, ...messages) {
-    if (process.env.LOG_NONE === undefined) {
-      COLOURS = await COLOURPromise;
-      let logLine = '';
-      if (process.env.LOG_NO_DATE === undefined) logLine += new Date().toISOString() + ': ';
-      let message;
-      let logcolor;
-      if (isIP(ip) === 0 ) {
-        logcolor = ip;
-        message = level + messages.join(' ');
-      } else {
-        const client = process.env.LOG_IP_HIDDEN !== undefined ? cyrb53(ip): ip;
-        logLine += COLOURS.client(client + ': ');
-        logcolor = level
-        message = messages.join(' ');
-      }
-      logLine += COLOURS[logcolor](message);
-      //eslint-disable-next-line no-console
-      console.log(logLine.trim());     
-    }
-  }
 
-  module.exports = logger;
-})();

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@akc42/server-utils",
-  "version": "1.4.1",
+  "version": "2.0.0",
+  "type": "module",
   "description": "A Set of Utilities to use on the Server Side of a Project",
-  "main": "utils.js",
+  "main": "./utils.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -21,8 +22,9 @@
   },
   "homepage": "https://github.com/akc42/server-utils#readme",
   "dependencies": {
-    "app-root-path": "^3.0.0",
-    "chalk": "^5.0.0",
-    "debug": "^4.3.3"
+    "app-root-path": "^3.1.0",
+    "chalk": "^5.1.2",
+    "debug": "^4.3.4"
   }
+
 }

package/responder.js

@@ -1,122 +1,121 @@
 /**
 @licence
-    Copyright (c) 2020 Alan Chandler, all rights reserved
+    Copyright (c) 2021 Alan Chandler, all rights reserved
 
-    This file is part of Meeting.
+    This file is part of Server Utils.
 
-    Meeting is free software: you can redistribute it and/or modify
+    Server Utils is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
-    Meeting is distributed in the hope that it will be useful,
+    Server Utils is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with Meeting.  If not, see <http://www.gnu.org/licenses/>.
+    along with Server Utils.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+ import Debug from 'debug';
 
-(function() {
-  'use strict';
 
-  const debug = require('debug')('responder');
+
+  const debug = Debug('responder');
   
-  class Responder {
-    constructor(response) {
-      debug('Starting responder');
-      this.response = response;
-      this.doneFirstRow = false;
-      this.doneFirstSection = false;
-      this.ended = false;
-      this.isArray = false;
-      this.awaitingDrain = false;
-    }
-    addSection(name, value) {
-      if (!this.ended) {
-        if (this.isArray) {
-          throw new Error('Cannot add section to an array');
-        }
-        if (this.doneFirstSection) {
-          //need to close previous one
-          if (this.inSection) {
-            this.response.write(']');
-          }
-          this.response.write(',"' + name + '": ');
-        } else {
-          this.response.write('{"' + name + '": ');
+export default  class Responder {
+  constructor(response) {
+    debug('Starting responder');
+    this.response = response;
+    this.doneFirstRow = false;
+    this.doneFirstSection = false;
+    this.ended = false;
+    this.isArray = false;
+    this.awaitingDrain = false;
+  }
+  addSection(name, value) {
+    if (!this.ended) {
+      if (this.isArray) {
+        throw new Error('Cannot add section to an array');
+      }
+      if (this.doneFirstSection) {
+        //need to close previous one
+        if (this.inSection) {
+          this.response.write(']');
         }
+        this.response.write(',"' + name + '": ');
+      } else {
+        this.response.write('{"' + name + '": ');
+      }
 
-        if (value !== undefined) {
-          this.response.write(JSON.stringify(value));
-          this.inSection = false;
-          debug('Value section %s',name);
-        } else {
-          this.response.write('[');
-          this.inSection = true;
-          debug('In section %s',name);
-        }
-        this.doneFirstSection = true;
-        this.doneFirstRow = false;
+      if (value !== undefined) {
+        this.response.write(JSON.stringify(value));
+        this.inSection = false;
+        debug('Value section %s',name);
+      } else {
+        this.response.write('[');
+        this.inSection = true;
+        debug('In section %s',name);
       }
+      this.doneFirstSection = true;
+      this.doneFirstRow = false;
     }
-    write(row) {
-      if (!this.ended) {
-        if (!this.doneFirstSection) {
-          this.isArray = true;
-          this.response.write('[');
-          this.doneFirstSection = true;
-          this.inSection = true;
-        }
-        if (!this.inSection) {
-          throw new Error('Cannot add rows after a value section without a new section header');
-        }
-        if (this.doneFirstRow) {
-          this.response.write(',');
-        }
-        this.doneFirstRow = true;
-        const JSONrow = JSON.stringify(row);
-        const reply = this.response.write(JSONrow);
-        if (reply) {
-          return Promise.resolve();
-        }
-        debug('False reply from write so need return the promise of a drain');
-        if (!this.awaitingDrain) {
-          this.awaitingDrain = true;
-          const self = this;
-          debug('create a drain promise as we do not have one');
-          this.drainPromise = new Promise(resolve => {
-            self.response.once('drain', () => {
-              self.awaitingDrain = false;
-              debug('drained so resolve promise of drain');
-              resolve();
-            });
+  }
+  write(row) {
+    if (!this.ended) {
+      if (!this.doneFirstSection) {
+        this.isArray = true;
+        this.response.write('[');
+        this.doneFirstSection = true;
+        this.inSection = true;
+      }
+      if (!this.inSection) {
+        throw new Error('Cannot add rows after a value section without a new section header');
+      }
+      if (this.doneFirstRow) {
+        this.response.write(',');
+      }
+      this.doneFirstRow = true;
+      const JSONrow = JSON.stringify(row);
+      const reply = this.response.write(JSONrow);
+      if (reply) {
+        return Promise.resolve();
+      }
+      debug('False reply from write so need return the promise of a drain');
+      if (!this.awaitingDrain) {
+        this.awaitingDrain = true;
+        const self = this;
+        debug('create a drain promise as we do not have one');
+        this.drainPromise = new Promise(resolve => {
+          self.response.once('drain', () => {
+            self.awaitingDrain = false;
+            debug('drained so resolve promise of drain');
+            resolve();
           });
-        }
-        return this.drainPromise;
+        });
       }
-      return Promise.reject(); //mark as blocked
+      return this.drainPromise;
     }
-    end() {
-      debug('End Responder');
-      if (!this.ended) {
-        if (this.inSection) {
-          this.response.write(']');
-        }
-        if (!this.isArray) {
-          if (this.doneFirstSection) {
-            this.response.end('}');
-          } else {
-            this.response.end('[]');
-          }
+    return Promise.reject(); //mark as blocked
+  }
+  end() {
+    debug('End Responder');
+    if (!this.ended) {
+      if (this.inSection) {
+        this.response.write(']');
+      }
+      if (!this.isArray) {
+        if (this.doneFirstSection) {
+          this.response.end('}');
         } else {
-          this.response.end();
+          this.response.end('[]');
         }
+      } else {
+        this.response.end();
       }
-      this.ended = true;
     }
+    this.ended = true;
   }
-  module.exports = Responder;
-})();
+}
+

package/utils.js

@@ -1,5 +1,35 @@
-module.exports = {
-  logger: require('./logger'),
-  Responder: require('./responder'),
-  version: require('./version')
-}
+/**
+@licence
+		Copyright (c) 2021 Alan Chandler, all rights reserved
+
+		This file is part of Server Utils.
+
+		Server Utils is free software: you can redistribute it and/or modify
+		it under the terms of the GNU General Public License as published by
+		the Free Software Foundation, either version 3 of the License, or
+		(at your option) any later version.
+
+		Server Utils is distributed in the hope that it will be useful,
+		but WITHOUT ANY WARRANTY; without even the implied warranty of
+		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+		GNU General Public License for more details.
+
+		You should have received a copy of the GNU General Public License
+		along with Server Utils.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+
+import logger from './logger.js';
+import Version from './version.js';
+import Responder from './responder.js';
+import { Debug, dumpDebugCache, setDebugConfig} from './debug.js';
+
+
+export {
+	logger,
+	Version,
+	Responder,
+	Debug,
+	dumpDebugCache,
+	setDebugConfig
+}

package/version.js

@@ -1,97 +1,95 @@
 /**
 @licence
-    Copyright (c) 2020 Alan Chandler, all rights reserved
+    Copyright (c) 2021 Alan Chandler, all rights reserved
 
-    This file is part of Meeting.
+    This file is part of Server Utils.
 
-    Meeting is free software: you can redistribute it and/or modify
+    Server Utils is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
-    Meeting is distributed in the hope that it will be useful,
+    Server Utils is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with Meeting.  If not, see <http://www.gnu.org/licenses/>.
+    along with Server Utils.  If not, see <http://www.gnu.org/licenses/>.
 */
-(() => {
-  const debug = require('debug')('version');
-  const fs = require('fs').promises;
-  const path = require('path');
-  const child = require('child_process');
-  const root = require('app-root-path').toString();
 
+import {Debug}  from './debug.js';
+import {access, readFile, stat} from 'node:fs/promises';
+import { resolve } from 'node:path';
+import { exec } from 'node:child_process';
 
-  function shCmd(cmd) {
-    debug('About to execute Command ', cmd);
-    return new Promise((resolve, reject) => {
-      child.exec(cmd, { cwd: root }, (err, stdout, stderr) => {
-        if (stderr) {
-          debug('Command ', cmd, 'about to fail with ', err);
-          reject(err);
-        } else {
-          const out = stdout.trim();
-          debug('Command ', cmd, 'Success with ', out);
-          resolve(out);
-        }
-      });
+const debug = Debug('version');
+
+function shCmd(cmd, root) {
+  debug('About to execute Command ', cmd);
+  return new Promise((accept, reject) => {
+    exec(cmd, { cwd: root }, (err, stdout, stderr) => {
+      if (stderr) {
+        debug('Command ', cmd, 'about to fail with ', err);
+        reject(err);
+      } else {
+        const out = stdout.trim();
+        debug('Command ', cmd, 'Success with ', out);
+        accept(out);
+      }
     });
-  }
+  });
+}
+export default async function(root) {
 
-  const releaseVersion = new Promise(async resolve => {
-    let version;
-    let vtime;
+  let version;
+  let vtime;
 
+  try {
+    debug('Look for git')
+    await access(resolve(root, '.git'));
+    debug('Git found, so use it to get data')
+    //we get here if there is a git directory, so we can look up version and latest commit from them
+    version = await shCmd('git describe --abbrev=0 --tags');
+    //git is installed and we found a tag
+    try {
+      vtime = await shCmd('git log -1 --format=%cd');
+    } catch (e) {
+      vtime = new Date(); //fake it;
+    }
+  } catch (e) {
+    //no git, or no tag, so we must look for a version file
     try {
-      debug('Look for git')
-      await fs.access(path.resolve(root, '.git'));
-      debug('Git found, so use it to get data')
-      //we get here if there is a git directory, so we can look up version and latest commit from them
-      version = await shCmd('git describe --abbrev=0 --tags');
-      //git is installed and we found a tag
+      debug('Git approach failed, so look for release info');
+      version = await readFile(resolve(root, 'release.info'), 'utf8');
       try {
-        vtime = await shCmd('git log -1 --format=%cd');
+        const { mtime } = await stat(resolve(root, 'release.info'));
+        vtime = mtime;
       } catch (e) {
-        vtime = new Date(); //fake it;
+        vtime = new Date();
       }
-    } catch (e) {
-      //no git, or no tag, so we must look for a version file
+    } catch(e) {
+      //no release info file, so use package.json
       try {
-        debug('Git approach failed, so look for release info');
-        version = await fs.readFile(path.resolve(root, 'release.info'), 'utf8');
+        const pjsonfile = resolve(root, 'package.json');
+        const pjson = await import(pjsonfile);
+        version = 'v'+ pjson.version;
         try {
-          const { mtime } = await fs.stat(path.resolve(root, 'release.info'));
+          const { mtime } = await stat(pjsonfile);
           vtime = mtime;
         } catch (e) {
           vtime = new Date();
         }
       } catch(e) {
-        //no release info file, so use package.json
-        try {
-          const pjsonfile = path.resolve(root, 'package.json');
-          const pjson = require(pjsonfile);
-          version = 'v'+ pjson.version;
-          try {
-            const { mtime } = await fs.stat(pjsonfile);
-            vtime = mtime;
-          } catch (e) {
-            vtime = new Date();
-          }
-        } catch(e) {
-          version = 'v1.0.0';
-          vtime = new Date();
-        }
+        version = 'v1.0.0';
+        vtime = new Date();
       }
-    } finally {
-      const finalversion = version.replace(/\s+/g, ' ').trim(); //trim out new lines and multiple spaces just one.
-      const copyrightTime = new Date(vtime);
-      debug('Resolving with Git copyright Year is ', copyrightTime.getUTCFullYear());
-      resolve({ version: finalversion, year: copyrightTime.getUTCFullYear() });
     }
-  });
-  module.exports = releaseVersion;
+  } finally {
+    const finalversion = version.replace(/\s+/g, ' ').trim(); //trim out new lines and multiple spaces just one.
+    const copyrightTime = new Date(vtime);
+    debug('Resolving with Git copyright Year is ', copyrightTime.getUTCFullYear());
+    return({ version: finalversion, year: copyrightTime.getUTCFullYear() });
+  }
+};
 
-})();