@akc42/server-utils 3.1.0 → 3.2.1

package/README.md

@@ -41,8 +41,7 @@ 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
 
-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.
+both `Debug` and `logger` have had their file logging removed as its causing more issues that its worth
 
 
 These are installed with as many of few of the items that you want like so:-

package/debug.js

@@ -17,16 +17,16 @@
     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 config = process.env.DEBUG || '';
 let cache = [];
 let cachelimit = 50;
   
 export function Debug (topic) {
     const t = topic;
     let timestamp = new Date().getTime();
-    return async function (...args) {
+    return function (...args) {
       let enabled = false;
       if (config) {
         const topics = config.split(':');
@@ -40,63 +40,31 @@ export function Debug (topic) {
       }, '');      
       const output = `${chalk.greenBright(topic)} ${chalk.cyan(message)} ${chalk.whiteBright(`(${gap}ms)`)}`
       if (enabled) {
-        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);
-          }
-        }    
+        //eslint-disable-next-line no-console
+        console.log(output);
       } 
       cache.push(output);
       if (cache.length > cachelimit) cache.splice(0,cache.length - cachelimit); //prevent it getting too big  
   }
 };
-export async function dumpDebugCache() {
+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) {
-    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);
-      }
-    }    
+    //eslint-disable-next-line no-console
+    console.log(line);
   }
   cache.reverse();
-  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);
-    }
-  }    
+  console.log(output);
 };
-export async function setDebugConfig(con, limit = 50) {
+export 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}"`)}`
-    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);
-      }
-    }    
+    //eslint-disable-next-line no-console
+    console.log(output);
   }
 };
 

package/logger.js

@@ -20,7 +20,6 @@
 
 import chalk from 'chalk';
 import { isIP } from 'node:net';
-import fs from 'node:fs/promises'
 
 const COLOURS = {
   app: chalk.rgb(255, 136, 0).bold, //orange,
@@ -47,7 +46,7 @@ function cyrb53 (str, seed = 0) {
     return 4294967296 * (2097151 & h2) + (h1 >>> 0);
 }
 
-export default async function logger(ip,level, ...messages) {
+export default function logger(ip,level, ...messages) {
   if (process.env.LOG_NONE === undefined) {
     let logLine = '';
     if (typeof process.env.LOG_NO_DATE === 'undefined') logLine += new Date().toISOString() + ': ';
@@ -63,16 +62,8 @@ export default async function logger(ip,level, ...messages) {
       message = messages.join(' ');
     }
     logLine += COLOURS[logcolor](message);
-    if (typeof process.env.LOG_FILE === 'undefined') {
-      //eslint-disable-next-line no-console
+    //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": "3.1.0",
+  "version": "3.2.1",
   "type": "module",
   "description": "A Set of Utilities to use on the Server Side of a Project",
   "main": "./utils.js",

package/version.js

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