@63klabs/cache-data 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -8,6 +8,16 @@ Report all vulnerabilities under the [Security menu](https://github.com/63Klabs/
 
 > Note: This project is still in beta. Even though changes are tested and breaking changes are avoided, things may break.
 
+## 1.3.2 (2025-09-12)
+
+### Enhancements
+
+- `DebugAndLog`: The environment variable `AWS_LAMBDA_LOG_LEVEL` is now checked as well for setting logging level. `LOG_LEVEL` has priority.
+
+### Fixes
+
+- `DebugAndLog`: Environment and Logging Level value checks are fixed
+
 ## 1.3.0 (2025-07-16)
 
 ### Enhancements

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2025 Chad Kluck
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@63klabs/cache-data",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Cache data from an API endpoint or application process using AWS S3 and DynamoDb",
   "author": "Chad Leigh Kluck (https://chadkluck.me)",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "@aws-sdk/client-s3": "3.x",
     "@aws-sdk/client-ssm": "3.x",
     "@aws-sdk/lib-dynamodb": "3.x",
-    "chai": "^5.2.0",
+    "chai": "^6.0.1",
     "chai-http": "^5.1.2",
     "mocha": "^11.7.1",
     "sinon": "^21.0.0"

package/src/lib/tools/DebugAndLog.class.js

@@ -1,153 +1,230 @@
 const { sanitize } = require("./utils");
 const util = require('util');
 
+const _getNodeEnv = function() {
+	return process.env?.NODE_ENV === "development" ? "development" : "production";
+};
+
+"use strict"
+
 /**
  * A simple Debug and Logging class.
  */
 class DebugAndLog {
 
 	static #logLevel = -1;
-	static #expiration = -1;
+	static #environment = null;
+	static #initialNodeEnv = _getNodeEnv();
+	static #nodeEnvChangeWarnCount = 0;
+
+	// in priority order
+	static ALLOWED_ENV_TYPE_VAR_NAMES = ["CACHE_DATA_ENV", "DEPLOY_ENVIRONMENT", "DEPLOY_ENV", "ENV_TYPE", "deploy_environment",  "ENV", "env", "deployEnvironment", "ENVIRONMENT", "environment"];
+	static ALLOWED_LOG_VAR_NAMES = ["CACHE_DATA_LOG_LEVEL", "LOG_LEVEL", "log_level", "detailedLogs", "logLevel", "AWS_LAMBDA_LOG_LEVEL"]
 
 	static PROD = "PROD";
 	static TEST = "TEST";
 	static DEV = "DEV";
 
-	static ENVIRONMENTS = [DebugAndLog.PROD, DebugAndLog.TEST, DebugAndLog.DEV];
+	static ENVIRONMENTS = ["PROD", "TEST", "DEV"];//[DebugAndLog.PROD, DebugAndLog.TEST, DebugAndLog.DEV];
+
+	static LOG = "LOG";
+	static ERROR = "ERROR";
+	static WARN = "WARN";
+	static INFO = "INFO";
+	static MSG = "MSG";
+	static DIAG = "DIAG";
+	static DEBUG = "DEBUG";
+
+	static LOG_LEVEL_NUM = 0;
+	static ERROR_LEVEL_NUM = 0;
+	static WARN_LEVEL_NUM = 1;
+	static INFO_LEVEL_NUM = 2;
+	static MSG_LEVEL_NUM = 3;
+	static DIAG_LEVEL_NUM = 4;
+	static DEBUG_LEVEL_NUM = 5;
 
-	static ERROR = "ERROR"; // 0
-	static WARN = "WARN"; // 0
-	static LOG = "LOG"; // 0
-	static MSG = "MSG"; // 1
-	static DIAG = "DIAG"; // 3
-	static DEBUG = "DEBUG"; // 5
+	static PROD_DEFAULT_LEVEL_NUM = 2;
 
 	constructor() {
 	};
 
 	/**
 	 * Set the log level.
+	 * Deprecated. Set Lambda Environment variable CACHE_DATA_LOG_LEVEL, LOG_LEVEL, or AWS_LAMBDA_LOG_LEVEL instead.
 	 * @param {number} logLevel 0 - 5
-	 * @param {*} expiration YYYY-MM-DD HH:MM:SS format. Only set to specified level until this date
+	 * @param {*} expiration Deprecated - no effect
 	 */
 	static setLogLevel(logLevel = -1, expiration = -1) {
-
-		if ( process.env.NODE_ENV === "production" && this.#logLevel > -1 ) {
-			DebugAndLog.warn("LogLevel already set, cannot reset. Ignoring call to DebugAndLog.setLogLevel("+logLevel+")");
-		} else {
-			if ( expiration !== -1 ) {
-				let time = new Date( expiration );
-				this.#expiration = time.toISOString();
-			} else {
-				this.#expiration = -1;
-			}            
-			
-			if ( logLevel === -1 || this.nonDefaultLogLevelExpired()) {
-				this.#logLevel = this.getDefaultLogLevel();
+		DebugAndLog.warn(`DebugAndLog.setLogLevel(${logLevel}, ${expiration}) is deprecated. Use CACHE_DATA_LOG_LEVEL, LOG_LEVEL, or AWS_LAMBDA_LOG_LEVEL environment variable instead.`);
+		
+		if (DebugAndLog.isProduction()) {
+			if (Number.isFinite(Number(logLevel)) && Number(logLevel) <= DebugAndLog.PROD_DEFAULT_LEVEL_NUM) {
+				this.#logLevel = Number(logLevel);
 			} else {
-				if ( logLevel > 0 && DebugAndLog.isProduction() ) {
-					DebugAndLog.warn("DebugAndLog: Production environment. Cannot set logLevel higher than 0. Ignoring call to DebugAndLog.setLogLevel("+logLevel+"). Default LogLevel override code should be removed before production");
-					this.#logLevel = this.getDefaultLogLevel();
-				} else {
-					this.#logLevel = logLevel;
-					DebugAndLog.msg("DebugAndLog: Override of log level default set: "+logLevel+". Default LogLevel override code should be removed before production");
-					if ( this.#expiration === -1 ) {
-						DebugAndLog.warn("DebugAndLog: Override of log level default set WITHOUT EXPIRATION. An expiration is recommended.");
-					}
-				}
-			} 
-		}
-
-	};
-
-	static nonDefaultLogLevelExpired() {
-		let r = false;
-
-		if ( this.#expiration !== -1 ) {
-			let now = new Date();
-			if ( now.toISOString() > this.#expiration ) {
-				DebugAndLog.warn("DebugAndLog: Override of log level default expired. Call to DebugAndLog.setLogLevel() should be commented out or removed");
-				r = true;
+				this.#logLevel = DebugAndLog.PROD_DEFAULT_LEVEL_NUM;
 			}
+		} else if (Number.isFinite(Number(logLevel))) {
+			this.#logLevel = Number(logLevel);
 		}
 
-		return r;
-	}
-
-	/**
-	 * 
-	 * @returns {string} The expiration date of the set log level
-	 */
-	static getExpiration() {
-		return this.#expiration;
-	}
+		return this.#logLevel;
+	};
 
 	/**
 	 * 
 	 * @returns {number} The current log level
 	 */
 	static getLogLevel() {
-		if ( this.#logLevel === -1 ) {
-			this.setLogLevel();
+
+		if ( this.#logLevel < 0 || DebugAndLog.nodeEnvIsDevelopment() || DebugAndLog.nodeEnvHasChanged() ) {
+			this.#logLevel = this.getDefaultLogLevel();
 		}
 
 		return this.#logLevel;
 
 	}
 
+	/**
+	 * Alias for getEnvType()
+	 */
+	static getEnv() {
+		return DebugAndLog.getEnvType();
+	};
+
 	/**
 	 * Check process.env for an environment variable named
 	 * env, deployEnvironment, environment, or stage. If they
 	 * are not set it will return DebugAndLog.PROD which 
 	 * is considered safe (most restrictive)
 	 * Note: This is the application environment, not the NODE_ENV
-	 * @returns {string} The current environment.
+	 * @returns {string} PROD|TEST|DEV - The current environment.
 	 */
-	static getEnv() {
-		var possibleVars = ["env", "deployEnvironment", "environment", "stage, deploy_environment"]; // this is the application env, not the NODE_ENV
-		var env = (process.env?.NODE_ENV === "development" ? DebugAndLog.DEV : DebugAndLog.PROD); // if env or deployEnvironment not set, fail to safe
-
-		if ( "env" in process ) {
-			for (let i in possibleVars) {
-				let e = possibleVars[i];
-				let uE = possibleVars[i].toUpperCase();
-				if (e in process.env && process.env[e] !== "" && process.env[e] !== null) {
-					env = process.env[e].toUpperCase();
-					break; // break out of the for loop
-				} else if (uE in process.env && process.env[uE] !== "" && process.env[uE] !== null) {
-					env = process.env[uE].toUpperCase();
-					break; // break out of the for loop
-				}
-			};
+	static getEnvType() {
+		// We can switch if NODE_ENV is set to "development"
+		if ( this.#environment === null || DebugAndLog.nodeEnvIsDevelopment() || DebugAndLog.nodeEnvHasChanged) {
+			const  nodeEnvType = (DebugAndLog.nodeEnvIsDevelopment() ? DebugAndLog.DEV : DebugAndLog.PROD); // if env or deployEnvironment not set, fail to safe
+			const envType = DebugAndLog.getEnvTypeFromEnvVar();
+
+			this.#environment = (DebugAndLog.ENVIRONMENTS.includes(envType) ? envType : nodeEnvType);
 		}
-		return (DebugAndLog.ENVIRONMENTS.includes(env) ? env : DebugAndLog.PROD);
-	};
+
+		return this.#environment;
+	}
+	/**
+	 * 
+	 * @returns {string} PROD|TEST|DEV|NONE based upon first environment variable from DebugAndLog.ALLOWED_ENV_TYPE_VAR_NAMES found
+	 */
+	static getEnvTypeFromEnvVar() {
+		let environmentType = "none";
+		const possibleVars = DebugAndLog.ALLOWED_ENV_TYPE_VAR_NAMES; // - this is the application env, not the NODE_ENV
+
+		for (let i in possibleVars) {
+			let e = possibleVars[i];
+			if (e in process.env && process.env[e] !== "" && process.env[e] !== null && DebugAndLog.ENVIRONMENTS.includes(process.env[e].toUpperCase())) {
+				environmentType = process.env[e].toUpperCase();
+				break; // break out of the for loop
+			}
+		};
+
+		return environmentType;
+	}
+
+	/**
+	 * Is Environment Variable NODE_ENV set to "development"?
+	 */
+	static nodeEnvIsDevelopment() {
+		return DebugAndLog.getNodeEnv() === "development";
+	}
+
+	/**
+	 * Is Environment Variable NODE_ENV set to "production" or "" or undefined?
+	 */
+	static nodeEnvIsProduction() {
+		return !this.nodeEnvIsDevelopment();
+	}
+
+	/**
+	 * Get the current NODE_ENV (returns "production" if not set or if NODE_ENV is set to anything other than "development")
+	 * Calls DebugAndLog.nodeEnvHasChanged() to log a warning if the value has changed since initialization. Should only change during testing.
+	 * @returns {string} development|production
+	 */
+	static getNodeEnv() {
+		DebugAndLog.nodeEnvHasChanged();
+		return _getNodeEnv();
+	}
+
+	/**
+	 * Checks to see if the current NODE_ENV environment variable has changed since DebugAndLog was initialized.
+	 * The only time this should happen is while running tests. This should never happen in a production application.
+	 * If these warnings are triggered as you application is running, something is modifying process.env.NODE_ENV during execution.
+	 * @returns {boolean}
+	 */
+	static nodeEnvHasChanged() {
+		const hasChanged = _getNodeEnv() !== this.#initialNodeEnv;
+		if (hasChanged && this.#logLevel > -1) {
+			this.#nodeEnvChangeWarnCount++;
+			// if this.#nodeEnvChangeWarnCount == 1 or is divisible by 25
+			if (this.#nodeEnvChangeWarnCount === 1 || this.#nodeEnvChangeWarnCount % 100 === 0) {
+				DebugAndLog.warn(`DebugAndLog: NODE_ENV changed from initial value of '${this.#initialNodeEnv}' to '${_getNodeEnv()}' during execution. This is not recommended outside of tests.`);
+			}
+		} else {
+			this.#nodeEnvChangeWarnCount = 0;
+		}
+
+		return hasChanged;
+	}
 
 	/**
 	 * 
 	 * @returns {number} log level
 	 */
 	static getDefaultLogLevel() {
-		var possibleVars = ["detailedLogs", "logLevel"];
-		var logLevel = 0;
-
-		if ( DebugAndLog.isNotProduction() ) { // PROD is always at logLevel 0. Always.
-
-			if ( "env" in process ) {
-				for (let i in possibleVars) {
-					let lev = possibleVars[i];
-					let uLEV = possibleVars[i].toUpperCase();
-					if (lev in process.env  && !(Number.isNaN(process.env[lev])) && process.env[lev] !== "" && process.env[lev] !== null) {
-						logLevel = Number(process.env[lev]);
-						break; // break out of the for loop
-					} else if (uLEV in process.env && !(Number.isNaN(process.env[uLEV])) && process.env[uLEV] !== "" && process.env[uLEV] !== null) {
-						logLevel = Number(process.env[uLEV]);
-						break; // break out of the for loop
+		let possibleVars = DebugAndLog.ALLOWED_LOG_VAR_NAMES; // in priority order and we want to evaluate AWS_LAMBDA_LOG_LEVEL as upper
+		let logLevel = DebugAndLog.PROD_DEFAULT_LEVEL_NUM;
+		let found = false;
+
+		for (let i in possibleVars) {
+			let lev = possibleVars[i];
+			if (lev in process.env && process.env[lev] !== "" && process.env[lev] !== null) {
+				if (lev === "AWS_LAMBDA_LOG_LEVEL") {
+
+					switch (process.env.AWS_LAMBDA_LOG_LEVEL) {
+						case "DEBUG":
+							logLevel = DebugAndLog.DEBUG_LEVEL_NUM;
+							found = true;
+							break;
+						case "INFO":
+							logLevel = DebugAndLog.INFO_LEVEL_NUM;
+							found = true;
+							break;
+						case "WARN":
+							logLevel = DebugAndLog.WARN_LEVEL_NUM;
+							found = true;
+							break;
+						case "ERROR":
+							logLevel = DebugAndLog.ERROR_LEVEL_NUM;
+							found = true;
+							break;
+						default: // invalid
+							break;
 					}
-				};
-			}
 
-		}
+				} else if (Number.isFinite(Number(process.env[lev]))) {
+					logLevel = Number(process.env[lev]);
+					found = true;
+				}
+
+				if (found) {
+					if (DebugAndLog.isProduction()) {
+						if (logLevel > DebugAndLog.PROD_DEFAULT_LEVEL_NUM) {
+							DebugAndLog.warn(`DebugAndLog: ${lev} set to ${logLevel} in production environment. Only 0-2 is allowed in production. Setting to ${DebugAndLog.PROD_DEFAULT_LEVEL_NUM}`);
+							logLevel = DebugAndLog.PROD_DEFAULT_LEVEL_NUM;
+						}
+					}
+					break; // break out of the for loop
+				}
+			}
+		};
 
 		return logLevel;
 	};
@@ -205,44 +282,6 @@ class DebugAndLog {
 		const FORMAT_WITH_OBJ = '[%s] %s | %s';
 		const FORMAT_WITHOUT_OBJ = '[%s] %s';
 
-		// const baseLog = function(level, tag, message, obj = null) {
-		// 	// Validate inputs
-		// 	if (typeof level !== 'string') {
-		// 		throw new TypeError('Log level must be a string');
-		// 	}
-			
-		// 	// Ensure tag and message are strings
-		// 	const safeTag = String(tag || '');
-		// 	const safeMessage = String(message || '');
-			
-		// 	// Validate log level is allowed
-		// 	if (!Object.prototype.hasOwnProperty.call(logLevels, level)) {
-		// 		level = 'info'; // Default to info if invalid level
-		// 	}
-			
-		// 	const logFn = logLevels[level];
-			
-		// 	try {
-		// 		let formattedMessage;
-		// 		if (obj !== null) {
-		// 			formattedMessage = util.format(
-		// 				'[%s] %s | %s',
-		// 				safeTag,
-		// 				safeMessage,
-		// 				util.inspect(sanitize(obj), { depth: null })
-		// 			);
-		// 		} else {
-		// 			formattedMessage = util.format(
-		// 				'[%s] %s',
-		// 				safeTag,
-		// 				safeMessage
-		// 			);
-		// 		}
-		// 		logFn(formattedMessage);
-		// 	} catch (error) {
-		// 		console.error('Logging failed:', error);
-		// 	}
-		// };
 		const baseLog = function(level, tag, message, obj = null) {
 			// Early return for invalid input
 			if (typeof level !== 'string') {
@@ -288,33 +327,29 @@ class DebugAndLog {
 		const info = (tag, message, obj) => baseLog('info', tag, message, obj);
 		const debug = (tag, message, obj) => baseLog('debug', tag, message, obj);
 		
-		let lvl = DebugAndLog.getLogLevel();
-		tag = tag.toUpperCase();
+		// let lvl = (this.#logLevel > -1) ? DebugAndLog.getLogLevel() : DebugAndLog.MSG_LEVEL_NUM; 
+		let lvl = (this.#logLevel > -1) ? this.#logLevel : DebugAndLog.INFO_LEVEL_NUM; 
 
-		// if ( obj !== null ) {
-		// 	let msgObj = obj;
-		// 	if ( Array.isArray(msgObj)) { msgObj = { array: msgObj};}
-		// 	if ( ""+msgObj === "[object Object]" || ""+msgObj === "[object Array]") {
-		// 		msgObj = JSON.stringify(sanitize(msgObj));
-		// 	}
-		// 	message += " | "+msgObj;
-		// }
+		tag = tag.toUpperCase();
 
 		switch (tag) {
 			case DebugAndLog.ERROR:
 				error(tag, message, obj);
 				break;
 			case DebugAndLog.WARN:
-				warn(tag, message, obj);
+				if (lvl >= DebugAndLog.WARN_LEVEL_NUM) { warn(tag, message, obj); }
 				break;
+			case DebugAndLog.INFO:
+				if (lvl >= DebugAndLog.INFO_LEVEL_NUM) { info(tag, message, obj); }
+				break; 
 			case DebugAndLog.MSG:
-				if (lvl >= 1) { info(tag, message, obj); } // 1
+				if (lvl >= DebugAndLog.MSG_LEVEL_NUM) { info(tag, message, obj); }
 				break; 
 			case DebugAndLog.DIAG:
-				if (lvl >= 3) { debug(tag, message, obj); } //3
+				if (lvl >= DebugAndLog.DIAG_LEVEL_NUM) { debug(tag, message, obj); }
 				break; 
 			case DebugAndLog.DEBUG:
-				if (lvl >= 5) { debug(tag, message, obj); } //5
+				if (lvl >= DebugAndLog.DEBUG_LEVEL_NUM) { debug(tag, message, obj); }
 				break; 
 			default: // log
 				log(tag, message, obj);
@@ -343,7 +378,7 @@ class DebugAndLog {
 	};
 
 	/**
-	 * Level 1 - Short messages and status
+	 * Level 2 - Short messages and status
 	 * @param {string} message 
 	 * @param {object} obj 
 	 */
@@ -352,7 +387,7 @@ class DebugAndLog {
 	};
 
 	/**
-	 * Level 1 - Short messages and status
+	 * Level 2 - Short messages and status
 	 * (same as DebugAndLog.msg() )
 	 * @param {string} message 
 	 * @param {object} obj 
@@ -361,6 +396,15 @@ class DebugAndLog {
 		return DebugAndLog.msg(message, obj);
 	};
 
+	/**
+	 * Level 1 - Short messages and status
+	 * @param {string} message 
+	 * @param {object} obj 
+	 */
+	static async info(message, obj = null) {
+		return DebugAndLog.writeLog(DebugAndLog.INFO, message, obj);
+	};
+
 	/**
 	 * Level 0 - Production worthy log entries that are not errors or warnings
 	 * These should be formatted in a consistent manner and typically only
@@ -413,4 +457,6 @@ class DebugAndLog {
 
 };
 
+DebugAndLog.getLogLevel();
+
 module.exports = DebugAndLog;