@akc42/server-utils 1.0.7 → 1.3.0

package/README.md

@@ -23,7 +23,16 @@ 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 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 `version` will ask git for the version and calculate the copyright year from the last git log entry) or wgere 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). 
+`version` provides a promise 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
+`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
 ```

package/logger.js

@@ -24,7 +24,7 @@
 (function() {
   'use strict';
 
-  const chalk = require('chalk');
+  const chalkPromise = import('chalk');
   const { isIP } = require('net');
   let cyrb53;
 
@@ -43,35 +43,43 @@
       return 4294967296 * (2097151 & h2) + (h1 >>> 0);
     };
   }
-  const COLOURS = {
-    app: chalk.magentaBright,
-    db: chalk.greenBright,
-    api: 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
-  };
+  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
+    });
+  });
 
-  function logger(client,level, ...messages) {
+
+  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(client) === 0 ) {
-        logcolor = client;
-        message = level + messages.join(' ');
-      } else {
-        logLine += COLOURS['api'](cyrb53(client) + ': ');
-        logcolor = level
-        message = messages.join(' ');
-      }
-      logLine += COLOURS[logcolor](message);
-      //eslint-disable-next-line no-console
-      console.log(logLine.trim());
+      COLOURPromise.then(COLOURS => {
+        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());
+      });
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akc42/server-utils",
-  "version": "1.0.7",
+  "version": "1.3.0",
   "description": "A Set of Utilities to use on the Server Side of a Project",
   "main": "utils.js",
   "scripts": {
@@ -22,8 +22,7 @@
   "homepage": "https://github.com/akc42/server-utils#readme",
   "dependencies": {
     "app-root-path": "^3.0.0",
-    "better-sqlite3": "^7.1.1",
-    "chalk": "^4.1.0",
-    "debug": "^4.2.0"
+    "chalk": "^5.0.0",
+    "debug": "^4.3.3"
   }
 }

package/version.js

@@ -24,6 +24,7 @@
   const child = require('child_process');
   const root = require('app-root-path').toString();
 
+
   function shCmd(cmd) {
     debug('About to execute Command ', cmd);
     return new Promise((resolve, reject) => {
@@ -48,21 +49,16 @@
       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
       try {
-        //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');
-        try {
-          vtime = await shCmd('git log -1 --format=%cd');
-        } catch (e) {
-          vtime = new Date(); //fake it;
-        }
+        vtime = await shCmd('git log -1 --format=%cd');
       } catch (e) {
-        //no commits yet so just make make it up
-        version = 'v0.0.1';
-        vtime = new Date();
+        vtime = new Date(); //fake it;
       }
     } catch (e) {
-      //no git, so we must look for a version file
+      //no git, or no tag, so we must look for a version file
       try {
         debug('Git approach failed, so look for release info');
         version = await fs.readFile(path.resolve(root, 'release.info'), 'utf8');
@@ -73,10 +69,22 @@
           vtime = new Date();
         }
       } catch(e) {
-        version = 'v1.0.0';
-        vtime = new Date();
+        //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();
+        }
       }
-
     } finally {
       const copyrightTime = new Date(vtime);
       debug('Resolving with Git copyright Year is ', copyrightTime.getUTCFullYear());

package/database.js

@@ -1,65 +0,0 @@
-/**
-@licence
-    Copyright (c) 2020 Alan Chandler, all rights reserved
-
-    This file is part of Meeting.
-
-    Meeting 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,
-    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/>.
-*/
-(()=>{
-  'use strict';
-  const path = require('path');
-  const fs = require('fs');
-
-  const debug = require('debug')('database');
-
-  const Database = require('better-sqlite3');
-  const root = require('app-root-path').toString(); 
-  const dbfilename = path.resolve(root,process.env.DATABASE_DB_DIR, process.env.DATABASE_DB);
-  let db;
-  try {
-    db = new Database(dbfilename, {fileMustExist:true, timeout: parseInt(process.env.DATABASE_DB_BUSY,10)});
-  } catch(e) {
-    if (e.code === 'SQLITE_CANTOPEN') {
-      //looks like database didn't exist, so we had better make if from scratch
-      try {
-        debug ('could not open database as it did not exist - so now going to create it');
-        db = new Database(dbfilename, { fileMustExist: false, timeout: parseInt(process.env.DATABASE_DB_BUSY,10) });
-        debug('Opened database - ready to start creating structure');
-        const database = fs.readFileSync(path.resolve(root, process.env.DATABASE_INIT_FILE), 'utf8');
-        db.exec(database);
-        if (process.env.DATABASE_DB_PIN === undefined) {
-          /*
-            Make ourselves a random, pin which I can use as a tokenKey and then write it into the database
-
-          */
-          const pin = 'T' + ('000000' + (Math.floor(Math.random() * 999999)).toString()).slice(-6); //make a new pin 
-          debug('going to use', pin, 'as our token key');
-          db.prepare(`UPDATE settings SET value = ? WHERE name = 'token_key'`).run(pin);
-        }
-        debug('Successfully updated blank database with script')
-      } catch (e) {
-        fs.unlinkSync(dbfilename); //failed to create it. so delete it so we can correct problem and try again.
-        throw new Error(`Encountered ${e.toString()} error when trying to create ${dbfilename}`)
-      }
-    } else {
-      throw new Error(`Encountered ${e.toString()} error when opening database`);
-    }
-  }
-
-  db.pragma('foreign_keys = ON');
-  
-  process.on('exit', () => db.close());
-  module.exports = db;
-})();