Make storage.init return a promise to async initialisation

part of #62

red/library.js

@@ -19,7 +19,7 @@ var storage = null;
 
 function init() {
     redApp = require("./server").app;
-    storage = require("./storage").storage;
+    storage = require("./storage");
     
     // -------- Flow Library --------
     redApp.post(new RegExp("/library/flows\/(.*)"), function(req,res) {

red/nodes.js

@@ -277,7 +277,7 @@ module.exports.setConfig = function(conf) {
     
     if (!storage) {
         // Do this lazily to ensure the storage provider as been initialised
-        storage = require("./storage").storage;
+        storage = require("./storage");
     }
     storage.getCredentials().then(function(creds) {
         credentials = creds;

red/server.js

@@ -20,12 +20,13 @@ var redNodes = require("./nodes");
 
 var app = null;
 var server = null;
+var settings = null;
+var storage = null;
 
-function createServer(_server,settings) {
+function createServer(_server,_settings) {
     server = _server;
-    
+    settings = _settings;
-    storage = require("./storage").init(settings);
+    storage = require("./storage");
-    
     app = createUI(settings);
     
     flowfile = settings.flowFile || 'flows_'+require('os').hostname()+'.json';
@@ -61,6 +62,7 @@ function createServer(_server,settings) {
 }
 
 function start() {
+    storage.init(settings).then(function() {
         console.log("\nWelcome to Node-RED\n===================\n");
         util.log("[red] Loading palette nodes");
         util.log("------------------------------------------");
@@ -81,6 +83,7 @@ function start() {
         }).otherwise(function(err) {
                 util.log("[red] Error loading flows : "+err);
         });
+    });
 }
 
 function stop() {

red/storage/index.js

@@ -15,19 +15,9 @@
  **/
  
  
-var settings;
+var settings = require('../red').settings;
-var storage;
-
-module.exports = {
-    init: function(_settings) {
-        settings = _settings;
 
 var storageType = settings.storageModule || "localfilesystem";
 
-        storage = require("./"+storageType).init(settings);
+module.exports = require("./"+storageType);
-        return storage;
-    },
-};
-
-module.exports.__defineGetter__("storage", function() { return storage; });
 

red/storage/localfilesystem.js

@@ -160,7 +160,9 @@ var localfilesystem = {
         if (!fs.existsSync(libFlowsDir)) {
             fs.mkdirSync(libFlowsDir);
         }
-        return this;
+        var defer = when.defer();
+        defer.resolve();
+        return defer.promise;
     },
     getFlows: function() {
         var defer = when.defer();

test/storage_localfilesystem_spec.js

@@ -18,13 +18,14 @@ describe('LocalFileSystem', function() {
     });
 
     it('should initialise the user directory',function() {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             fs.existsSync(path.join(userDir,"lib")).should.be.true;
             fs.existsSync(path.join(userDir,"lib",'flows')).should.be.true;
         });
+    });
     
     it('should handle missing flow file',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             var flowFile = 'flows_'+require('os').hostname()+'.json';
             var flowFilePath = path.join(userDir,flowFile);
             fs.existsSync(flowFilePath).should.be.false;
@@ -34,11 +35,11 @@ describe('LocalFileSystem', function() {
             }).otherwise(function(err) {
                 done(err);
             });
-
+        });
     });
     
     it('should save flows to the default file',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             var flowFile = 'flows_'+require('os').hostname()+'.json';
             var flowFilePath = path.join(userDir,flowFile);
             fs.existsSync(flowFilePath).should.be.false;
@@ -54,6 +55,7 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should save flows to the specified file',function(done) {
         var defaultFlowFile = 'flows_'+require('os').hostname()+'.json';
@@ -61,8 +63,7 @@ describe('LocalFileSystem', function() {
         var flowFile = 'test.json';
         var flowFilePath = path.join(userDir,flowFile);
 
-        localfilesystem.init({userDir:userDir, flowFile:flowFilePath});
+        localfilesystem.init({userDir:userDir, flowFile:flowFilePath}).then(function() {
-
             fs.existsSync(defaultFlowFilePath).should.be.false;
             fs.existsSync(flowFilePath).should.be.false;
             
@@ -79,10 +80,11 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should handle missing credentials', function(done) {
         var credFile = path.join(userDir,"credentials.json");
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             fs.existsSync(credFile).should.be.false;
             
             localfilesystem.getCredentials().then(function(creds) {
@@ -92,11 +94,12 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should handle credentials', function(done) {
         var credFile = path.join(userDir,"credentials.json");
 
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             
             fs.existsSync(credFile).should.be.false;
             
@@ -114,9 +117,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should return an empty list of library flows',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             localfilesystem.getAllFlows().then(function(flows) {
                 flows.should.eql({});
                 done();
@@ -124,9 +128,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should return a valid list of library flows',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             var flowLib = path.join(userDir,"lib","flows");
             fs.closeSync(fs.openSync(path.join(flowLib,"A.json"),"w"));
             fs.closeSync(fs.openSync(path.join(flowLib,"B.json"),"w"));
@@ -141,9 +146,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should fail a non-existent flow', function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             localfilesystem.getFlow("a/b/c.json").then(function(flow) {
                 should.fail(flow,"No flow","Flow found");
             }).otherwise(function(err) {
@@ -151,9 +157,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should return a flow',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             var testflowString = JSON.stringify(testFlow);
             localfilesystem.saveFlow("a/b/c/d.json",testflowString).then(function() {
                 localfilesystem.getFlow("a/b/c/d.json").then(function(flow) {
@@ -166,9 +173,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should return an empty list of library objects',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             localfilesystem.getLibraryEntry('object','').then(function(flows) {
                 flows.should.eql({});
                 done();
@@ -176,9 +184,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
 
     it('should return an error for a non-existent library object',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             localfilesystem.getLibraryEntry('object','A/B').then(function(flows) {
                 should.fail(null,null,"non-existent flow");
             }).otherwise(function(err) {
@@ -186,6 +195,7 @@ describe('LocalFileSystem', function() {
                 done();
             });
         });
+    });
 
     function createObjectLibrary() {
         var objLib = path.join(userDir,"lib","object");
@@ -198,7 +208,7 @@ describe('LocalFileSystem', function() {
     }
     
     it('should return a directory listing of library objects',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             createObjectLibrary();
             
             localfilesystem.getLibraryEntry('object','').then(function(flows) {
@@ -218,9 +228,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
             
     it('should return a library object',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             createObjectLibrary();
             localfilesystem.getLibraryEntry('object','B/file2.js').then(function(body) {
                 body.should.eql("// not a metaline \n\n Hi");
@@ -229,9 +240,10 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
     it('should return a newly saved library object',function(done) {
-        localfilesystem.init({userDir:userDir});
+        localfilesystem.init({userDir:userDir}).then(function() {
             createObjectLibrary();
             localfilesystem.getLibraryEntry('object','B').then(function(flows) {
                 flows.should.eql([ 'C', { ghi: 'jkl', fn: 'file2.js' } ]);
@@ -254,5 +266,6 @@ describe('LocalFileSystem', function() {
                 done(err);
             });
         });
+    });
     
 });