Merge branch 'custom-stores'

Author: mikermcneil

lib/hooks/session/index.js

@@ -4,6 +4,7 @@
 
 var util = require('sails-util'),
   uuid = require('node-uuid'),
+  path = require('path'),
   generateSecret = require('./generateSecret'),
   cookie = require('express/node_modules/cookie'),
   parseSignedCookie = require('express/node_modules/connect').utils.parseSignedCookie,
@@ -116,6 +117,15 @@ module.exports = function(sails) {
 
         sails.config.session.secret = generateSecret();
       }
+
+      // Backwards-compatibility / shorthand notation
+      // (allow mongo or redis session stores to be specified directly)
+      if (sails.config.session.adapter === 'redis') {
+        sails.config.session.adapter = 'connect-redis';
+      }
+      else if (sails.config.session.adapter === 'mongo') {
+        sails.config.session.adapter = 'connect-mongo';
+      }
     },
 
     /**
@@ -129,42 +139,75 @@ module.exports = function(sails) {
 
       // Intepret session adapter config and "new up" a session store
       if (util.isObject(sessionConfig) && !util.isObject(sessionConfig.store)) {
-        switch (sessionConfig.adapter) {
-
-          // Session explicitly disabled
-          case null:
-            // Do nothing...
-            break;
-
-            // Supported session adapters
-          case 'memory':
-            sessionConfig.store = new(require('express').session.MemoryStore)();
-            break;
-          case 'redis':
-            try {
-              sessionConfig.store = new(require('connect-redis')(require('express')))(sessionConfig);
-            } catch (e) {
-              return cb(new Error('Could not load session adapter :: ' + sessionConfig.adapter));
-            }
-            break;
-          case 'mongo':
-            try {
-              sessionConfig.store = new(require('connect-mongo')(require('express')))(sessionConfig);
-            } catch (e) {
-              return cb(new Error('Could not load session adapter :: ' + sessionConfig.adapter));
-            }
-            break;
 
-            // Unknown session adapter
-          default:
-            // try and load the adapter, catch and throw error
+        // Unless the session is explicitly disabled, require the appropriate adapter
+        if (sessionConfig.adapter) {
+
+          // 'memory' is a special case
+          if (sessionConfig.adapter === 'memory') {
+            var MemoryStore = require('express').session.MemoryStore;
+            sessionConfig.store = new MemoryStore();
+          }
+          // Try and load the specified adapter from the local sails project,
+          // or catch and return error:
+          else {
+
+            var COULD_NOT_REQUIRE_CONNECT_ADAPTER_ERR = function (adapter, packagejson, e) {
+              var errMsg;
+              if (e && typeof e === 'object' && e instanceof Error) {
+                errMsg = e.stack;
+              }
+              else {
+                errMsg = util.inspect(e);
+              }
+
+              var output = 'Could not load Connect session adapter :: ' + adapter + '\n';
+              if (packagejson && !packagejson.main) {
+                output+='(If this is your module, make sure that the module has a "main" configuration in its package.json file)';
+              }
+              output+='\nError from adapter:\n'+ errMsg+'\n\n';
+
+
+              // Recommend installation of the session adapter:
+              output += 'Do you have the Connect session adapter installed in this project?\n';
+              output += 'Try running the following command in your project\'s root directory:\n';
+              var installRecommendation = 'npm install ';
+              if (adapter === 'connect-redis') {
+                installRecommendation += 'connect-redis@1.4.5';
+                installRecommendation += '\n(Note that `connect-redis@1.5.0` introduced breaking changes- make sure you have v1.4.5 installed!)';
+              }
+              else {
+                installRecommendation += adapter;
+                installRecommendation +='\n(Note: Make sure the version of the Connet adapter you install is compatible with Express 3/Sails v0.10)';
+              }
+              installRecommendation += '\n';
+
+              output += installRecommendation;
+
+              return output;
+            };
+
             try {
-              sessionConfig.store = new(require(sessionConfig.adapter)(require('express')))(sessionConfig);
-              break;
+
+              // Determine the path to the adapter by using the "main" described in its package.json file:
+              var pathToAdapterDependency;
+              var pathToAdapterPackage = path.resolve(sails.config.appPath, 'node_modules', sessionConfig.adapter ,'package.json');
+              var adapterPackage;
+              try {
+                adapterPackage = require(pathToAdapterPackage);
+                pathToAdapterDependency = path.resolve(sails.config.appPath, 'node_modules', sessionConfig.adapter, adapterPackage.main);
+              }
+              catch (e) {
+                return cb(COULD_NOT_REQUIRE_CONNECT_ADAPTER_ERR(sessionConfig.adapter, adapterPackage, e));
+              }
+              var SessionAdapter = require(pathToAdapterDependency);
+              var CustomStore = SessionAdapter(require('express'));
+              sessionConfig.store = new CustomStore(sessionConfig);
             } catch (e) {
-              return cb(new Error('Could not load session adapter :: ' + sessionConfig.adapter));
+              // TODO: negotiate error
+              return cb(COULD_NOT_REQUIRE_CONNECT_ADAPTER_ERR(sessionConfig.adapter, adapterPackage, e));
             }
-
+          }
         }
       }
 

package.json

@@ -47,8 +47,6 @@
     "i18n": "~0.4.1",
     "sails-generate": "~0.10.2",
     "sails-build-dictionary": "~0.10.1",
-    "connect-redis": "~1.4.5",
-    "connect-mongo": "~0.4.0",
     "grunt-cli": "~0.1.11",
     "ejs": "~0.8.4",
     "sails-disk": "~0.10.0",