@63klabs/cache-data 1.2.3 → 1.2.6

package/src/lib/dao-cache.js

@@ -65,9 +65,16 @@ class S3Cache {
 	 * Initialize the S3 bucket for storing cached data.
 	 * @param {string} bucket The bucket name for storing cached data
 	 */
-	static init(bucket) {
-		if ( S3Cache.getBucket() === null) {
-			this.#bucket = bucket;
+
+	static init(bucket = null) {
+		if ( S3Cache.getBucket() === null ) {
+			bucket = (bucket === null) ? process.env?.CACHE_DATA_DYNAMO_DB_TABLE || null : bucket;
+			if (bucket === null || bucket === "") {
+				tools.DebugAndLog.error("Unable to initialize S3 Bucket for Cache. No bucket name provided.");
+				throw new Error("Unable to initialize S3 Cache. No bucket name provided. Please set the CACHE_DATA_S3_BUCKET environment variable or pass a bucket name to S3Cache.init().");
+			} else {
+				this.#bucket = bucket;
+			}
 		} else {
 			tools.DebugAndLog.error("S3Cache already initialized. Ignoring call to S3Cache.init()");
 		}
@@ -197,11 +204,17 @@ class DynamoDbCache {
 
 	/**
 	 * Initialize the DynamoDb settings for storing cached data
-	 * @param {string} table The table name to store cached data
+	 * @param {string|null} table The table name to store cached data
 	 */
-	static init(table) {
+	static init(table = null) {
 		if ( this.#table === null ) {
-			this.#table = table;
+			table = (table === null || table === "") ? process.env?.CACHE_DATA_DYNAMO_DB_TABLE || null : table;
+			if (table === null || table === "") {
+				tools.DebugAndLog.error("Unable to initialize DynamoDbCache. No table name provided.");
+				throw new Error("Unable to initialize DynamoDbCache. No table name provided. Please set the CACHE_DATA_DYNAMO_DB_TABLE environment variable or pass a table name to DynamoDbCache.init().");
+			} else {
+				this.#table = table;
+			}
 		} else {
 			tools.DebugAndLog.error("DynamoDbCache already initialized. Ignoring call to DynamoDbCache.init()");
 		}
@@ -328,18 +341,54 @@ class CacheData {
 		// if we don't have the key set, we don't have anything set
 		if ( this.#secureDataKey === null ) {
 
-			// TODO: Throw error if data is missing
+			// Throw error if no secureData key
+			if ( !("secureDataKey" in parameters) || parameters.secureDataKey === null ) {
+				tools.DebugAndLog.error("CacheData.init() requires a secureDataKey parameter.");
+				throw new Error("CacheData.init() requires a secureDataKey parameter.");
+			}
 
-			DynamoDbCache.init(parameters.dynamoDbTable);
-			S3Cache.init(parameters.s3Bucket);
+			// let DynamoDbCache and S3Cache know where to store the data, let them handle the Env variables
+			DynamoDbCache.init(parameters?.dynamoDbTable || null);
+			S3Cache.init(parameters?.s3Bucket || null);
 
-			// set other values
-			this.#secureDataAlgorithm = parameters.secureDataAlgorithm;
+			// secureDataKey can be a string, Buffer, or CachedParameterSecret
 			this.#secureDataKey = parameters.secureDataKey;
 
-			if ("DynamoDbMaxCacheSize_kb" in parameters ) { this.#dynamoDbMaxCacheSize_kb = parameters.DynamoDbMaxCacheSize_kb; }
-			if ("purgeExpiredCacheEntriesAfterXHours" in parameters ) { this.#purgeExpiredCacheEntriesAfterXHours = parameters.purgeExpiredCacheEntriesAfterXHours; }
-			if ("timeZoneForInterval" in parameters ) { this.#timeZoneForInterval = parameters.timeZoneForInterval; }
+			// set other values based on parameters or environment variables
+			this.#secureDataAlgorithm = parameters.secureDataAlgorithm || process.env.CACHE_DATA_SECURE_DATA_ALGORITHM || "aes-256-cbc";
+
+			// CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB
+			if ("DynamoDbMaxCacheSize_kb" in parameters ) { 
+				if (!Number.isInteger(parameters.DynamoDbMaxCacheSize_kb) || parameters.DynamoDbMaxCacheSize_kb <= 0) throw new Error("DynamoDbMaxCacheSize_kb must be a positive integer");
+				this.#dynamoDbMaxCacheSize_kb = parameters.DynamoDbMaxCacheSize_kb; 
+			} else if (process.env.CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB) { 
+				let val = parseInt(process.env.CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB);
+				if (isNaN(val) || val <= 0) throw new Error("CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB must be a positive integer");
+				this.#dynamoDbMaxCacheSize_kb = val; 
+			} else {
+				this.#dynamoDbMaxCacheSize_kb = 10; // default to 10KB
+			}
+			// CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS
+			if ("purgeExpiredCacheEntriesAfterXHours" in parameters ) { 
+				if (!Number.isInteger(parameters.purgeExpiredCacheEntriesAfterXHours) || parameters.purgeExpiredCacheEntriesAfterXHours <= 0) throw new Error("purgeExpiredCacheEntriesAfterXHours must be a positive integer");
+				this.#purgeExpiredCacheEntriesAfterXHours = parameters.purgeExpiredCacheEntriesAfterXHours; 
+			} else if (process.env.CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS) { 
+				let val = parseInt(process.env.CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS);
+				if (isNaN(val) || val <= 0) throw new Error("CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS must be a positive integer");
+				this.#purgeExpiredCacheEntriesAfterXHours = val; 
+			} else {
+				this.#purgeExpiredCacheEntriesAfterXHours = 24; // default to 24 hours
+			}
+			// CACHE_DATA_TIME_ZONE_FOR_INTERVAL
+			if ("timeZoneForInterval" in parameters ) { 
+				if (typeof parameters.timeZoneForInterval !== 'string' || parameters.timeZoneForInterval.trim() === '') throw new Error("timeZoneForInterval must be a non-empty string");
+				this.#timeZoneForInterval = parameters.timeZoneForInterval; 
+			} else if (process.env.CACHE_DATA_TIME_ZONE_FOR_INTERVAL) { 
+				if (process.env.CACHE_DATA_TIME_ZONE_FOR_INTERVAL.trim() === '') throw new Error("CACHE_DATA_TIME_ZONE_FOR_INTERVAL must be a non-empty string");
+				this.#timeZoneForInterval = process.env.CACHE_DATA_TIME_ZONE_FOR_INTERVAL; 
+			} else {
+				this.#timeZoneForInterval = "Etc/UTC"; // default to Etc/UTC
+			}
 
 			this._setOffsetInMinutes();
 
@@ -936,9 +985,6 @@ class CacheData {
 
 };
 
-
-
-
 /**
  * The Cache object handles reads and writes from the cache. 
  * It also acts as a proxy between the app and CacheData which is a private class.
@@ -971,7 +1017,7 @@ class Cache {
 	static STATUS_FORCED = "original:cache-update-forced";
 
 	static #idHashAlgorithm = null;
-	static #useToolsHash = false;
+	static #useToolsHash = null; // gets set in Cache.init()
 
 	#syncedNowTimestampInSeconds = 0; // consistent time base for calculations
 	#syncedLaterTimestampInSeconds = 0; // default expiration if not adjusted
@@ -1041,7 +1087,6 @@ class Cache {
 		this.#idHash = Cache.generateIdHash(connection);
 		this.#syncedNowTimestampInSeconds = CacheData.convertTimestampFromMilliToSeconds(Date.now());
 		this.#syncedLaterTimestampInSeconds = this.#syncedNowTimestampInSeconds + this.#defaultExpirationInSeconds; // now + default cache time
-
 	};
 
 	/**
@@ -1054,29 +1099,38 @@ class Cache {
 	 * Sample param object:
 	 * @example
 	 * cache.Cache.init({
-	 *		dynamoDbTable: process.env.CacheData_DynamoDbTable,
-	 *		s3Bucket: process.env.CacheData_S3Bucket,
-	 *		secureDataAlgorithm: process.env.CacheData_CryptSecureDataAlgorithm,
+	 *		dynamoDbTable: process.env.CACHE_DATA_DYNAMO_DB_TABLE,
+	 *		s3Bucket: process.env.CACHE_DATA_S3_BUCKET,
+	 *		secureDataAlgorithm: process.env.CACHE_DATA_SECURE_DATA_ALGORITHM,
 	 *		secureDataKey: Buffer.from(params.app.crypt_secureDataKey, cache.Cache.CRYPT_ENCODING),
-	 *		idHashAlgorithm: process.env.CacheData_CryptIdHashAlgorithm,
-	 *		DynamoDbMaxCacheSize_kb: parseInt(process.env.CacheData_DynamoDb_maxCacheSize_kb, 10),
-	 *		purgeExpiredCacheEntriesAfterXHours: parseInt(process.env.CacheData_PurgeExpiredCacheEntriesAfterXHours, 10),
-	 * 		timeZoneForInterval: process.env.CacheData_TimeZoneForInterval // if caching on interval, we need a timezone to account for calculating hours, days, and weeks. List: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+	 *		idHashAlgorithm: process.env.CACHE_DATA_ID_HASH_ALGORITHM, // sha1, sha256, sha512, etc.
+	 *		DynamoDbMaxCacheSize_kb: parseInt(process.env.CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB, 10),
+	 *		purgeExpiredCacheEntriesAfterXHours: parseInt(process.env.CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS, 10),
+	 * 		timeZoneForInterval: process.env.CACHE_DATA_TIME_ZONE_FOR_INTERVAL // if caching on interval, we need a timezone to account for calculating hours, days, and weeks. List: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 	 *	});
 	 * 
 	 * @param {Object} parameters
-	 * @param {string} parameters.dynamoDbTable
-	 * @param {string} parameters.s3Bucket
-	 * @param {string} parameters.secureDataAlgorithm
-	 * @param {string} parameters.secureDataKey
-	 * @param {number} parameters.DynamoDbMaxCacheSize_kb
-	 * @param {number} parameters.purgeExpiredCacheEntriesAfterXHours
-	 * @param {string} parameters.timeZoneForInterval
+	 * @param {string} parameters.dynamoDbTable Can also be set with environment variable CACHE_DATA_DYNAMO_DB_TABLE
+	 * @param {string} parameters.s3Bucket Can also be set with environment variable CACHE_DATA_S3_BUCKET
+	 * @param {string} parameters.secureDataAlgorithm Can also be set with environment variable CACHE_DATA_SECURE_DATA_ALGORITHM
+	 * @param {string|Buffer|tools.Secret|tools.CachedSSMParameter|tools.CachedSecret} parameters.secureDataKey Must be passed, will not accept an environment variable for security reasons.
+	 * @param {number} parameters.DynamoDbMaxCacheSize_kb Can also be set with environment variable CACHE_DATA_DYNAMO_DB_MAX_CACHE_SIZE_KB
+	 * @param {number} parameters.purgeExpiredCacheEntriesAfterXHours Can also be set with environment variable CACHE_DATA_PURGE_EXPIRED_CACHE_ENTRIES_AFTER_X_HRS
+	 * @param {string} parameters.timeZoneForInterval Can also be set with environment variable CACHE_DATA_TIME_ZONE_FOR_INTERVAL
 	 */
 	static init(parameters) {
-		if ( "idHashAlgorithm" in parameters ) { this.#idHashAlgorithm = parameters.idHashAlgorithm; } else { tools.DebugAndLog.error("parameters.idHashAlgorithm not set in Cache.init()")};
-		if ("useToolsHash" in parameters ) { this.#useToolsHash = Boolean(parameters.useToolsHash); }
+		// check if parameters is an object
+		if ( typeof parameters !== 'object' || parameters === null ) {
+			tools.DebugAndLog.error("Cache.init() parameters must be an object");
+			throw new Error("Cache.init() parameters must be an object");
+		}
+
+		// if parameters are set, use them, otherwise check for environment variables
+		this.#idHashAlgorithm = parameters.idHashAlgorithm || process.env.CACHE_DATA_ID_HASH_ALGORITHM || "RSA-SHA256";
+		this.#useToolsHash = ( "useToolsHash" in parameters ) ? Cache.bool(parameters.useToolsHash) : 
+			("CACHE_DATA_USE_TOOLS_HASH" in process.env ? Cache.bool(process.env.CACHE_DATA_USE_TOOLS_HASH_METHOD) : false);
 		
+		// Let CacheData handle the rest of the initialization
 		CacheData.init(parameters);
 	};
 

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

@@ -104,8 +104,8 @@ class DebugAndLog {
 	 * @returns {string} The current environment.
 	 */
 	static getEnv() {
-		var possibleVars = ["env", "deployEnvironment", "environment", "stage"]; // this is the application env, not the NODE_ENV
-		var env = DebugAndLog.PROD; // if env or deployEnvironment not set, fail to safe
+		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) {

package/src/lib/tools/index.js

@@ -249,18 +249,18 @@ class _ConfigSuperClass {
 	 * let params = await this._initParameters(
 	 *  [
 	 *      {
-	 *          "group": "appone", // so we can do params.app.authOSTActionsUsername later
-	 *          "path": process.env.paramStorePath, // Lambda environment variable
+	 *          "group": "appone", // so we can do params.app.authUsername later
+	 *          "path": process.env.PARAM_STORE_PATH, // Lambda environment variable
 	 *          "names": [
-	 *              "authOSTActionsUsername",
-	 *              "authOSTActionsPassword",
-	 *              "authExLibrisAPIkey",
+	 *              "authUsername",
+	 *              "authPassword",
+	 *              "authAPIkey",
 	 *              "crypt_secureDataKey"
 	 *          ]
 	 *      }, // OR get all under a single path
 	 *      {
-	 *          "group": "app", // so we can do params.app.authOSTActionsUsername later
-	 *          "path": process.env.paramStorePath // Lambda environment variable
+	 *          "group": "app", // so we can do params.app.authUsername later
+	 *          "path": process.env.PARAM_STORE_PATH // Lambda environment variable
 	 *      }
 	 *  ]
 	 * );