Add first-run setup screens

Author: knolleary

.cfignore

@@ -0,0 +1 @@
+node_modules

bluemix-settings.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2014, 2015 IBM Corp.
+ * Copyright 2014, 2017 IBM Corp.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,19 +16,20 @@
 
 var path = require("path");
 var when = require("when");
+var util = require("util");
 
 var cfenv = require("cfenv");
 var appEnv = cfenv.getAppEnv();
 
-var VCAP_APPLICATION = JSON.parse(process.env.VCAP_APPLICATION);
-var VCAP_SERVICES = JSON.parse(process.env.VCAP_SERVICES);
-
 var settings = module.exports = {
     uiPort: process.env.PORT || 1880,
     mqttReconnectTime: 15000,
-    serialReconnectTime: 15000,
     debugMaxLength: 1000,
 
+    userDir: path.join(__dirname,".node-red"),
+
+    flowFile: "flows.json",
+
     // Add the bluemix-specific nodes in
     nodesDir: path.join(__dirname,"nodes"),
 
@@ -47,46 +48,41 @@ var settings = module.exports = {
 
     functionGlobalContext: { },
 
-    storageModule: require("./couchstorage")
-}
-// You can set adminAuth yourself in this file, but it will look for the
-// the following environment variables and automatically enable adminAuth
-// if they have been set. That means you don't have to hardcode any
-// credentials in this file.
-if (process.env.NODE_RED_USERNAME && process.env.NODE_RED_PASSWORD) {
-    settings.adminAuth = {
-        type: "credentials",
-        users: function(username) {
-            if (process.env.NODE_RED_USERNAME == username) {
-                return when.resolve({username:username,permissions:"*"});
-            } else {
-                return when.resolve(null);
-            }
-        },
-        authenticate: function(username, password) {
-            if (process.env.NODE_RED_USERNAME == username &&
-                process.env.NODE_RED_PASSWORD == password) {
-                return when.resolve({username:username,permissions:"*"});
-            } else {
-                return when.resolve(null);
-            }
+    // Configure the logging output
+    logging: {
+        // Only console logging is currently supported
+        console: {
+            // Level of logging to be recorded. Options are:
+            // fatal - only those errors which make the application unusable should be recorded
+            // error - record errors which are deemed fatal for a particular request + fatal errors
+            // warn - record problems which are non fatal + errors + fatal errors
+            // info - record information about the general running of the application + warn + error + fatal errors
+            // debug - record information which is more verbose than info + info + warn + error + fatal errors
+            // trace - record very detailed logging + debug + info + warn + error + fatal errors
+            // off - turn off all logging (doesn't affect metrics or audit)
+            level: "info",
+            // Whether or not to include metric events in the log output
+            metrics: false,
+            // Whether or not to include audit events in the log output
+            audit: true
         }
     }
-}
-
-settings.couchAppname = VCAP_APPLICATION['application_name'];
+};
 
+// Look for the attached Cloudant instance to use for storage
+settings.couchAppname = appEnv.name;
 // NODE_RED_STORAGE_NAME is automatically set by this applications manifest.
 var storageServiceName = process.env.NODE_RED_STORAGE_NAME || new RegExp("^"+settings.couchAppname+".cloudantNoSQLDB");
 var couchService = appEnv.getService(storageServiceName);
 
 if (!couchService) {
-    console.log("Failed to find Cloudant service");
+    util.log("Failed to find Cloudant service: "+storageServiceName);
     if (process.env.NODE_RED_STORAGE_NAME) {
-        console.log(" - using NODE_RED_STORAGE_NAME environment variable: "+process.env.NODE_RED_STORAGE_NAME);
+        util.log(" - using NODE_RED_STORAGE_NAME environment variable: "+process.env.NODE_RED_STORAGE_NAME);
     }
-    throw new Error("No cloudant service found");
-}    
-settings.couchUrl = couchService.credentials.url;
-
-
+    //fall back to localfilesystem storage
+} else {
+    util.log("Using Cloudant service: "+storageServiceName);
+    settings.storageModule = require("./couchstorage");
+    settings.couchUrl = couchService.credentials.url;
+}

couchstorage.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2014 IBM Corp.
+ * Copyright 2014, 2017 IBM Corp.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,32 +37,33 @@ function prepopulateFlows(resolve) {
                 try {
                     var flow = fs.readFileSync(__dirname+"/defaults/flow.json","utf8");
                     var flows = JSON.parse(flow);
-                    console.log(">> Adding default flow");
+                    util.log("[couchstorage] Installing default flow");
                     promises.push(couchstorage.saveFlows(flows));
-                } catch(err) {
-                    console.log(">> Failed to save default flow");
-                    console.log(err);
+                } catch(err2) {
+                    util.log("[couchstorage] Failed to save default flow");
+                    util.log(err2);
                 }
             } else {
-                console.log(">> No default flow found");
+                util.log("[couchstorage] No default flow found");
             }
             if (fs.existsSync(__dirname+"/defaults/flow_cred.json")) {
                 try {
                     var cred = fs.readFileSync(__dirname+"/defaults/flow_cred.json","utf8");
                     var creds = JSON.parse(cred);
-                    console.log(">> Adding default credentials");
+                    util.log("[couchstorage] Installing default credentials");
                     promises.push(couchstorage.saveCredentials(creds));
-                } catch(err) {
-                    console.log(">> Failed to save default credentials");
-                    console.log(err);
+                } catch(err2) {
+                    util.log("[couchstorage] Failed to save default credentials");
+                    util.log(err2);
                 }
             } else {
-                console.log(">> No default credentials found");
+                util.log("[couchstorage] No default credentials found");
             }
             when.settle(promises).then(function() {
-                    resolve();
+                resolve();
             });
         } else {
+            // Flows already exist - leave them alone
             resolve();
         }
     });
@@ -75,7 +76,7 @@ var couchstorage = {
         var couchDb = nano(settings.couchUrl);
         appname = settings.couchAppname || require('os').hostname();
         var dbname = settings.couchDb||"nodered";
-        
+
         return when.promise(function(resolve,reject) {
             couchDb.db.get(dbname,function(err,body) {
                 if (err) {
@@ -127,19 +128,17 @@ var couchstorage = {
                 } else {
                     flowDb = couchDb.use(dbname);
                     prepopulateFlows(resolve);
-                    resolve();
                 }
             });
         });
     },
-    
-    
+
     getFlows: function() {
         var key = appname+"/"+"flow";
         return when.promise(function(resolve,reject) {
             flowDb.get(key,function(err,doc) {
                 if (err) {
-                    if (err.status_code != 404) {
+                    if (err.statusCode != 404) {
                         reject(err.toString());
                     } else {
                         resolve([]);
@@ -151,7 +150,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     saveFlows: function(flows) {
         var key = appname+"/"+"flow";
         return when.promise(function(resolve,reject) {
@@ -169,13 +168,13 @@ var couchstorage = {
             });
         });
     },
-    
+
     getCredentials: function() {
         var key = appname+"/"+"credential";
         return when.promise(function(resolve,reject) {
             flowDb.get(key,function(err,doc) {
                 if (err) {
-                    if (err.status_code != 404) {
+                    if (err.statusCode != 404) {
                         reject(err.toString());
                     } else {
                         resolve({});
@@ -187,7 +186,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     saveCredentials: function(credentials) {
         var key = appname+"/"+"credential";
         return when.promise(function(resolve,reject) {
@@ -205,13 +204,13 @@ var couchstorage = {
             });
         });
     },
-    
+
     getSettings: function() {
         var key = appname+"/"+"settings";
         return when.promise(function(resolve,reject) {
             flowDb.get(key,function(err,doc) {
                 if (err) {
-                    if (err.status_code != 404) {
+                    if (err.statusCode != 404) {
                         reject(err.toString());
                     } else {
                         resolve({});
@@ -223,7 +222,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     saveSettings: function(settings) {
         var key = appname+"/"+"settings";
         return when.promise(function(resolve,reject) {
@@ -241,7 +240,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     getAllFlows: function() {
         var key = [appname,"flow"];
         return when.promise(function(resolve,reject) {
@@ -268,7 +267,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     getFlow: function(fn) {
         if (fn.substr(0) != "/") {
             fn = "/"+fn;
@@ -284,7 +283,7 @@ var couchstorage = {
             });
         });
     },
-    
+
     saveFlow: function(fn,data) {
         if (fn.substr(0) != "/") {
             fn = "/"+fn;
@@ -304,10 +303,10 @@ var couchstorage = {
                     }
                 });
             });
-                
+
         });
     },
-    
+
     getLibraryEntry: function(type,path) {
         var key = appname+"/lib/"+type+(path.substr(0)!="/"?"/":"")+path;
         if (libraryCache[key]) {
@@ -374,7 +373,7 @@ var couchstorage = {
                     }
                 });
             });
-                
+
         });
     }
 };