Merge pull request #6 from pearlshare/master

refactoring and added custom logger

Author: pasupulaphani

README.md

@@ -1,8 +1,8 @@
-[![npm version](http://img.shields.io/npm/v/simple-redis-cache.svg)](https://npmjs.org/package/simple-redis-cache)
+[![npm version](http://img.shields.io/npm/v/simple-redis-cache.svg?style=flat-square)](https://npmjs.org/package/simple-redis-cache)
 [![Build Status](https://travis-ci.org/pasupulaphani/simple-redis-cache.svg?branch=master)](https://travis-ci.org/pasupulaphani/simple-redis-cache)
 [![Coverage Status](https://coveralls.io/repos/github/pasupulaphani/simple-redis-cache/badge.svg?branch=master)](https://coveralls.io/github/pasupulaphani/simple-redis-cache?branch=master)
-[![dependencies Status](https://david-dm.org/pasupulaphani/simple-redis-cache/status.svg)](https://david-dm.org/pasupulaphani/simple-redis-cache)
-[![Gratipay donate button](https://img.shields.io/badge/gratipay-donate-yellow.svg)](https://gratipay.com/simple-redis-store/)
+[![Dependency Status](https://www.versioneye.com/user/projects/583c520dd2d44d003fb603be/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/583c520dd2d44d003fb603be)
+[![Gratipay donate button](https://img.shields.io/badge/gratipay-donate-yellow.svg?style=flat-square)](https://gratipay.com/simple-redis-store/)
 
 # simple-redis-cache
 Redis cache ready to scale with node-pool support
@@ -13,7 +13,7 @@ Redis cache ready to scale with node-pool support
 
 ## Prerequisites
 
-This module requires nodejs v4 or above as it has dependencies on constious es6 components such as Map, Set, Promise etc.
+This module requires nodejs v4 or above as it has dependencies on es6 components such as Map, Set, Promise etc.
 
 ## Featuring
 - Out of the box default configuration (but fully configurable)
@@ -31,17 +31,56 @@ This module requires nodejs v4 or above as it has dependencies on constious es6
 
     npm install simple-redis-cache
 
-    var RedisCache = require("simple-redis-cache");
-    var cache = new RedisCache();
+    const RedisCache = require("simple-redis-cache");
+    const cache = new RedisCache();
 
     // set
     cache.set("key", "value");
 
+#### API
+
+- RedisCache([options])
+
+#### `options` object properties
+
+| Property  | Default   | Description |
+|-----------|-----------|-------------|
+| name      | Random unique string | Name your pool |
+| redisOptions      | ```{url: redis://127.0.0.1:6379}```      | opts from  https://github.com/NodeRedis/node_redis#options-object-properties |
+| poolOptions      | null      | opts from https://github.com/coopernurse/node-pool#createpool |
+| logger       | null      | Inject your custom logger |
+
 ### Run tests
 
     bash test.sh
- 
- 
-### Contributing
+
+## Contribute
+
+[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/pasupulaphani/simple-redis-cache/blob/master/CONTRIBUTING.md)
+
+## Backers
+
+### Maintainers
+
+These amazing people are maintaining this project:
+
+*   [Phani](https://github.com/pasupulaphani) — [view contributions](https://github.com/pasupulaphani/simple-redis-cache/commits?author=pasupulaphani)
+
+### Sponsors
+
+No sponsors yet! Will you be the first?
+
+[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](http://patreon.com/phaninder "Donate to this project using Patreon")
+[![Gratipay donate button](https://img.shields.io/badge/gratipay-donate-yellow.svg)](https://gratipay.com/~pasupulaphani/ "Donate weekly to this project using Gratipay")
+[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](https://flattr.com/profile/pasupulaphani "Donate to this project using Flattr")
+<!-- [![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://phaninder.com/paypal "Donate to this project using Paypal") -->
+<!-- [![Bitcoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://phaninder.com/bitcoin "Donate once-off to this project using Bitcoin") -->
+<!-- [![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](https://phaninder.com/wishlist "Buy an item on our wishlist for us") -->
+
+### Contributors
+
+These amazing people have contributed code to this project:
+
+*   [Oliver Brooks](https://github.com/oliverbrooks)
 
 Feel free to make changes. Please see the [Contributors' Guide](https://github.com/pasupulaphani/simple-redis-cache/blob/master/CONTRIBUTING.md) for more information on contributing to the documentation.

lib/logger.js

@@ -0,0 +1,12 @@
+module.exports = function (logger) {
+  if (!logger) {
+    logger = {};
+  }
+
+  return Object.assign({
+    log: function () {},
+    info: function () {},
+    warn: function () {},
+    error: function () {}
+  }, logger);
+};

lib/redis_cache.js

@@ -2,12 +2,18 @@ const RedisStore = require("./redis_store");
 
 const debug = require("debug")("simpleRedisCache");
 
-var RedisCache = module.exports = function (name, redisOptions, poolOptions) {
-
-  this.name = name;
-  this.redisOptions = redisOptions;
-  this.poolOptions = poolOptions;
-  this.store = new RedisStore(name, redisOptions, poolOptions);
+const RedisCache = module.exports = function (options) {
+
+  this.name = options.name || `redisCache-${Math.random().toString(36).substr(2, 10)}`;
+  this.redisOptions = options.redisOptions;
+  this.poolOptions = options.poolOptions;
+  this.logger = require("./logger")(options.logger);
+  this.store = new RedisStore({
+    name: this.name,
+    redisOptions: this.redisOptions,
+    poolOptions: this.poolOptions,
+    logger: this.logger
+  });
 };
 
 RedisCache.prototype.set = function (key, value, ttlInSeconds) {

lib/redis_pool.js

@@ -1,111 +1,151 @@
+"use strict";
+
 const genericPool = require("generic-pool");
+const retry = require("retry-as-promised");
 const redis = require("./redis");
 
 const debug = require("debug")("simpleRedisPool");
 
-var RedisPool = module.exports = function (name, redisOptions, poolOptions) {
+const create = function (redisOptions) {
+  return new Promise((resolve, reject) => {
+    const client = redis.createClient(redisOptions);
 
-  this.name = name;
-  this.redisOptions = redisOptions;
-  this.poolOptions = poolOptions;
-  this._redisDb = redisOptions.db || 0;
+    client.on("error", err => reject(err));
+    client.on("connect", () => resolve(client));
+  });
+};
 
-  const factory = {
-    create: () => {
-      return new Promise((resolve, reject) => {
+const selectDB = function (client, db) {
+  return new Promise((resolve, reject) => {
+    client.select(db, function (err) {
+      if (err) reject(err);
+      debug("DB selected: ", db);
+      resolve(client);
+    });
+  });
+};
 
-        const client = redis.createClient(redisOptions);
+const RedisPool = module.exports = function (options) {
 
-        if (["undefined", null, ""].indexOf(this._redisDb) !== -1) {
-          debug("Selected Redis DB: ", this._redisDb);
-          client.select(this._redisDb);
-        }
+  this.name = options.name || `redisPool-${Math.random().toString(36).substr(2, 10)}`;
+  this.redisOptions = options.redisOptions;
+  this.poolOptions = options.poolOptions;
+  this.logger = require("./logger")(options.logger);
+
+  // for retry
+  let createAttempts = 0;
+
+  const factory = {
+    create: () => {
 
-        // Register the authentication password if needed.
-        if (redisOptions.auth_pass) {
-          client.auth(redisOptions.auth_pass);
+      // this is due to the limitation of node-pool ATM
+      // https://github.com/coopernurse/node-pool/issues/161#issuecomment-261109882
+      return retry(function () {
+        createAttempts++;
+        if (createAttempts > 3) {
+          const err = new Error("CONN_FAILED");
+          debug("Max conn createAttempts reached: %s, resolving to error:", createAttempts, err);
+
+          // reset for next try
+          createAttempts = 0;
+          return Promise.resolve(err);
         }
 
-        client.on("error", err => reject(err));
-        client.on("connect", () => resolve(client));
+        return create(options.redisOptions);
+      }, {
+        max: 10,
+        name: "factory.create",
+        report: debug
       });
     },
     destroy: (client) => {
       return new Promise((resolve) => {
 
         try {
           // Flush when closing.
-          client.end(true);
-          debug("Client conn closed. Available count : %s. Pool size: %s", this.pool.availableObjectsCount(), this.pool.getPoolSize());
-          resolve();
+          client.end(true, () => resolve());
+          debug("Client conn closed. Available count : %s. Pool size: %s", this.availableObjectsCount(), this.getPoolSize());
+          this.logger.log("Client conn closed. Available count : %s. Pool size: %s", this.availableObjectsCount(), this.getPoolSize());
         } catch (err) {
-          throw new Error("error", "Error destroying redis client.");
+          throw err;
         }
       });
     }
   };
 
   // Now that the pool settings are ready create a pool instance.
-  this.pool = genericPool.createPool(factory, poolOptions);
+  this.pool = genericPool.createPool(factory, this.poolOptions);
 
   this.pool.on("factoryCreateError", e => {
-    debug("Errored connecting Redis", e);
+    debug("Errored while connecting Redis", e);
+    this.logger.error("Errored while connecting Redis", e);
   });
-
   this.pool.on("factoryDestroyError", e => {
-    debug("Errored destroying Redis conn", e);
+    debug("Errored while destroying Redis conn", e);
+    this.logger.error("Errored while destroying Redis conn", e);
   });
-
-  // test connectivity by acquiring a conn
-  // this.pool.acquire()
-  //   .then(client => this.pool.release(client));
 };
 
-// Acquire a database connection and use an optional priority.
-RedisPool.prototype.acquire = function (priority) {
-  return this.pool.acquire(priority);
+RedisPool.prototype.sendCommand = function (commandName, commandArgs) {
+  return this.pool.acquire()
+    .then(conn =>
+      conn.send_commandAsync(commandName, [].concat(commandArgs))
+        .then(result => {
+          this.pool.release(conn);
+          return result;
+        })
+        .catch(err => {
+          this.pool.release(conn);
+          throw err;
+        })
+    );
 };
 
-RedisPool.prototype.acquireDb = function (db, priority) {
+// Acquire a database connection and use an optional priority.
+RedisPool.prototype.acquire = function (priority, db) {
   return this.pool.acquire(priority)
     .then(client => {
-      if (client._db_selected !== db) {
-        client["_db_selected"] = db;
-        client.select(db);
+
+      if (client instanceof Error) {
+        debug("Couldn't acquire connection to %j", this.redisOptions);
+        this.logger.error("Couldn't acquire connection to %j", this.redisOptions);
+        throw client;
+      }
+
+      if (db) {
+        this.logger.info("select DB:", db);
+        return selectDB(client, db);
+      } else {
+        return client;
       }
-      debug("DB selected: ", client._db_selected);
     });
 };
 
 // Release a database connection to the pool.
 RedisPool.prototype.release = function (client) {
+  return this.pool.release(client);
+};
 
-  // Always reset the DB to the default. This prevents issues
-  // if a user used the select command to change the DB.
-  if (client._db_selected !== this._redisDb) {
-    debug("Releasing client. Reset the DB to the given: ", this._redisDb);
-    client.select(this._redisDb);
-  }
-  this.pool.release(client);
+RedisPool.prototype.destroy = function (client) {
+  return this.pool.destroy(client);
 };
 
 // Drains the connection pool and call the callback id provided.
-RedisPool.prototype.drain = (cb) => {
-  this.pool.drain(() => {
-    this.pool.destroyAllNow();
-    if (cb) {
-      cb();
-    }
-  });
+RedisPool.prototype.drain = function () {
+  return this.pool.drain(() => this.pool.clear());
 };
 
 // Returns factory.name for this pool
 RedisPool.prototype.getName = function () {
   return this.name;
 };
 
-RedisPool.prototype.getRedisDB = function () {
-  return this._redisDb;
+RedisPool.prototype.getRedisOptions = function () {
+  return this.redisOptions;
+};
+
+RedisPool.prototype.getPoolOptions = function () {
+  return this.poolOptions;
 };
 
 RedisPool.prototype.getPoolSize = function () {
@@ -124,8 +164,7 @@ RedisPool.prototype.status = function () {
   return {
     name: this.name,
     size: this.pool.size,
-    db: this._redisDb,
-    avail: this.pool.available,
+    available: this.pool.available,
     waiting: this.pool.pending
   };
 };