refactor: 🔨 simplify the redis cache factory method

Author: simplymichael

src/component/connector/mongoose.js

@@ -74,7 +74,7 @@ module.exports = class MongooseStore {
       try {
         debug("Connecting to MongoDB...");
 
-        this.#db = await mongoose.createConnection(dsn, {}).asPromise();
+        this.#db = mongoose.createConnection(dsn, {});
 
         debug("MongoDB connection established");
 
@@ -113,16 +113,14 @@ module.exports = class MongooseStore {
   }
 
   connected() {
-    return this.#db?.readyState === MongooseStore.readyStates.connected;
-    //return mongoose.connection.readyState === MongooseStore.readyStates.connected;
+    return mongoose.connection.readyState === MongooseStore.readyStates.connected;
 
     // Ready states:
     // eady states being: 0: disconnected 1: connected 2: connecting 3: disconnecting
   }
 
   connecting() {
-    return this.#db?.readyState === MongooseStore.readyStates.connecting;
-    //return mongoose.connection.readyState === MongooseStore.readyStates.connecting;
+    return mongoose.connection.readyState === MongooseStore.readyStates.connecting;
   }
 
   getClient() {

src/factory/cache/index.js

@@ -36,7 +36,15 @@ module.exports = class CacheFactory {
       );
     }
 
-    if(driver === "redis") {
+    // We no longer test for redis config because we no longer use the
+    // config.credentials for redis. Instead, we have flattened everything in
+    // config.credentials into the config object itself.
+    // We don't test for host and/or port because redis tries to connect to
+    // localhost and default port (6379) when these are not specified.
+    // Also, since the default max attempts is 5,
+    // the connection will stop attempting to connect to the localhost redis server
+    // after 5 attempts if the user has not passed any config for the "redis" driver.
+    /*if(driver === "redis") {
       if(!is.object(config.connection) && !is.object(config.credentials)) {
         const expectedProps = [
           "connection",
@@ -49,7 +57,9 @@ module.exports = class CacheFactory {
           `one of either properties: ${expectedProps.join(", ")}.`
         );
       }
-    } else if(driver === "file" && !config.storagePath) {
+    } else*/
+
+    if(driver === "file" && !config.storagePath) {
       throw new Error(
         errorPrefix +
         "The `config` parameter for the 'file' driver expects an object with a " +

src/factory/cache/redis-cache.js

@@ -9,30 +9,33 @@ const RedisStore = require("../../component/connector/redis");
  *    An existing connection to a redis instance.
  *    If this passed, it is used to connect to the Redis server.
  *    Otherwise, we try to connect to a Redis server using the
- *    options.credentials.
+ *    other options.
  * @param {Object} [options.credentials] (optional):
  *    Credentials for establishing a connection to a Redis server.
- * @param {String} [options.credentials.host]: the server host
- * @param {Number} [options.credentials.port]: the server port
- * @param {String} [options.credentials.username]: the server username
- * @param {String} [options.credentials.password]: the server user password
- * @param {String} [options.credentials.db]: the database to connect to
- * @param {String} [options.credentials.url]: full DSN of the Redis server
- *   If the [options.credentials.url] is set, it is used instead
+ * @param {String} [options.host]: the server host
+ * @param {Number} [options.port]: the server port
+ * @param {String} [options.username]: the server username
+ * @param {String} [options.password]: the server user password
+ * @param {String} [options.db]: the database to connect to
+ * @param {String} [options.url]: full DSN of the Redis server
+ *   If the [options.url] is set, it is used instead
  *   and the other credential options are ignored.
+ * @param {Boolean} [options.autoConnect]
+ * @param {Boolean} [options.legacyMode]
+ * @param {Boolean} [options.exitOnConnectionFailure]
  * @param {Number} [options.maxConnectionAttempts]: The maximum number of times
  *   to attempt connecting before exiting.
  * @return {Object} with methods: set(), get(), unset(), contains(), and client().
  */
 module.exports = function createRedisStore(options) {
-  const { connection, credentials } = options || {};
+  const { connection, ...rest } = options || {};
 
   let store;
 
   if(connection && typeof connection === "object") {
     store = connection;
-  } else if(credentials && typeof credentials === "object") {
-    const redisStore = new RedisStore(credentials);
+  } else {
+    const redisStore = new RedisStore({ ...rest });
     store = redisStore.getClient();
 
     setTimeout(async function() {