@akc42/server-utils 2.0.3 → 3.1.0

package/README.md

@@ -7,8 +7,8 @@ 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
-the logged output.  This is generally used when another logger (e.g PM2 log output) is also adding date/time.  Finally LOG_NO_ENCODE is used
-to say don't try and anonomise client ip addresses (see below).  `logger` is called so `logger([clientip,] level, ...messages);`.  
+the logged output.  This is generally used when another logger (e.g PM2 log output) is also adding date/time.  Finally LOG_HIDDEN_IP is used
+to say  to try and anonomise client ip addresses (see below).  `logger` is called so `logger([clientip,] level, ...messages);`.  
 
 `Responder` is a class to provide the ability to stream JSON responses to a node js http request. It is instanciated
 with `new Responder(response);` and the resultant object has three methods;
@@ -39,8 +39,13 @@ 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`
 
+Breaking change as of 3.0.0  logger is now an async function returning a promise fulfilled when (if set) a log file entry is made
 
-Thise are installed with as many of few of the items that you want like so:-
+both `Debug` and `logger` bit now support LOG_FILE environment variable. When set points to a log file rather than the
+console. If it is not undefined these two modules will write to the log file rather than the console.
+
+
+These are installed with as many of few of the items that you want like so:-
 ```
 import {logger,Responder,Debug} from '@akc42/server-utils';
 ```

package/debug.js

@@ -17,7 +17,7 @@
     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 fs from 'node:fs/promises';
 import chalk from 'chalk';
 let config = '';
 let cache = [];
@@ -26,7 +26,7 @@ let cachelimit = 50;
 export function Debug (topic) {
     const t = topic;
     let timestamp = new Date().getTime();
-    return function (...args) {
+    return async function (...args) {
       let enabled = false;
       if (config) {
         const topics = config.split(':');
@@ -40,27 +40,63 @@ export function Debug (topic) {
       }, '');      
       const output = `${chalk.greenBright(topic)} ${chalk.cyan(message)} ${chalk.whiteBright(`(${gap}ms)`)}`
       if (enabled) {
-        console.log(output);
+        if (typeof process.env.LOG_FILE === 'undefined') {
+          //eslint-disable-next-line no-console
+          console.log(output);
+        } else {
+          try {
+            await fs.appendFile(process.env.LOG_FILE, output + '\n',{flush: true})
+          } catch(err) {
+            console.warn('Failed to write following message to log file', output);
+          }
+        }    
       } 
       cache.push(output);
       if (cache.length > cachelimit) cache.splice(0,cache.length - cachelimit); //prevent it getting too big  
   }
 };
-export function dumpDebugCache() {
+export async 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);
+    if (typeof process.env.LOG_FILE === 'undefined') {
+      //eslint-disable-next-line no-console
+      console.log(line);
+    } else {
+      try {
+        await fs.appendFile(process.env.LOG_FILE, line + '\n',{flush: true});
+      } catch (err) {
+        console.warn('Failed to write following message to log file', line);
+      }
+    }    
   }
   cache.reverse();
-  console.log(output);
+  if (typeof process.env.LOG_FILE === 'undefined') {
+    //eslint-disable-next-line no-console
+    console.log(output);
+  } else {
+    try {
+      await fs.appendFile(process.env.LOG_FILE, output + '\n',{flush: true});
+    } catch(err) {
+      console.warn('Failed to write following message to log file', output);
+    }
+  }    
 };
-export function setDebugConfig(con, limit = 50) {
+export async function setDebugConfig(con, limit = 50) {
   cachelimit = limit;
   if (con !== config) {
     config = con;
     const output = `${chalk.greenBright('debug server config')} ${chalk.redBright(`new server config "${config}"`)}`
-    console.log(output);
+    if (typeof process.env.LOG_FILE === 'undefined') {
+      //eslint-disable-next-line no-console
+      console.log(output);
+    } else {
+      try {
+        await fs.appendFile(process.env.LOG_FILE, output + '\n',{flush: true})
+      } catch (err) {
+        console.warn('Failed to write following message to log file', output);
+      }
+    }    
   }
 };
 

package/logger.js

@@ -19,7 +19,8 @@
 */
 
 import chalk from 'chalk';
-import { isIP } from 'net';
+import { isIP } from 'node:net';
+import fs from 'node:fs/promises'
 
 const COLOURS = {
   app: chalk.rgb(255, 136, 0).bold, //orange,
@@ -34,11 +35,7 @@ const COLOURS = {
   error: chalk.white.bgRed
 
 };
-let cyrb53;
-if (process.env.LOG_NO_ENCODE) {
-  cyrb53 = (str, seed = 0) => {return str;};
-} else {
-  cyrb53 = (str, seed = 0) => {
+function cyrb53 (str, seed = 0) {
     let h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
     for (let i = 0, ch; i < str.length; i++) {
       ch = str.charCodeAt(i);
@@ -48,27 +45,34 @@ if (process.env.LOG_NO_ENCODE) {
     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 function logger(ip,level, ...messages) {
+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() + ': ';
+    if (typeof 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;
+      const client = typeof 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());     
+    if (typeof process.env.LOG_FILE === 'undefined') {
+      //eslint-disable-next-line no-console
+      console.log(logLine.trim());
+    } else {
+      try {
+        await fs.appendFile(process.env.LOG_FILE, logLine.trim() + '\n',{flush: true})
+      } catch(err) {
+        console.warn('Error writing log file:',err,'message being logged', logLine.trim());
+      }
+    }     
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akc42/server-utils",
-  "version": "2.0.3",
+  "version": "3.1.0",
   "type": "module",
   "description": "A Set of Utilities to use on the Server Side of a Project",
   "main": "./utils.js",
@@ -22,9 +22,6 @@
   },
   "homepage": "https://github.com/akc42/server-utils#readme",
   "dependencies": {
-    "app-root-path": "^3.1.0",
-    "chalk": "^5.3.0",
-    "debug": "^4.3.4"
+    "chalk": "^5.3.0"
   }
-
 }

package/version.js

@@ -25,16 +25,16 @@ import { exec } from 'node:child_process';
 
 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) => {
+async function shCmd(cmd, root) {
+  await debug('About to execute Command ', cmd);
+  return new Promise(async (accept, reject) => {
+    exec(cmd, { cwd: root }, async (err, stdout, stderr) => {
       if (stderr) {
-        debug('Command ', cmd, 'about to fail with ', err);
+        await debug('Command ', cmd, 'about to fail with ', err);
         reject(err);
       } else {
         const out = stdout.trim();
-        debug('Command ', cmd, 'Success with ', out);
+        await debug('Command ', cmd, 'Success with ', out);
         accept(out);
       }
     });
@@ -46,9 +46,9 @@ export default async function(root) {
   let vtime;
 
   try {
-    debug('Look for git')
+    await debug('Look for git')
     await access(resolve(root, '.git'));
-    debug('Git found, so use it to get data')
+    await 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
@@ -60,7 +60,7 @@ export default async function(root) {
   } catch (e) {
     //no git, or no tag, so we must look for a version file
     try {
-      debug('Git approach failed, so look for release info');
+      await debug('Git approach failed, so look for release info');
       version = await readFile(resolve(root, 'release.info'), 'utf8');
       try {
         const { mtime } = await stat(resolve(root, 'release.info'));
@@ -88,7 +88,7 @@ export default async function(root) {
   } 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());
+    await debug('Resolving with Git copyright Year is ', copyrightTime.getUTCFullYear());
     return({ version: finalversion, year: copyrightTime.getUTCFullYear() });
   }
 };