Changeset 519

Timestamp:

03/15/14 01:00:23 (11 years ago)

Author:

hendrikvanantwerpen

Message:

• Support different environments with QED_ENV. If dev, run against qed-dev database, if production, run against qed database. The UI indicates if we are running in anything but production mode.
• Return undefined if we allow page leaves, because null is treated as a value.
• Changed format of design docs, so it can work for different databases.
• Use correct design documents in configCouch, so server now actually updates them when it starts.

Location:

Dev/trunk

Files:

• Gruntfile.js (modified) (4 diffs)
• src/client/index.html (modified) (1 diff)
• src/client/qed-client/app/Router.js (modified) (1 diff)
• src/client/qed-client/css/ui/topbar.less (modified) (1 diff)
• src/client/qed-client/index.js (modified) (1 diff)
• src/client/qed-client/pages/surveyRun.js (modified) (1 diff)
• src/server/app.js (modified) (5 diffs)
• src/server/bin/check-db.js (modified) (1 diff)
• src/server/bin/config-db-for-upgrade.js (modified) (1 diff)
• src/server/bin/config-db.js (modified) (1 diff)
• src/server/bin/heroku.js (modified) (1 diff)
• src/server/config/config-couchdb.js (modified) (2 diffs)
• src/server/config/couchdb-design-docs.js (modified) (6 diffs)
• src/server/config/couchdb-upgrade-design-docs.js (modified) (1 diff)
• src/server/env.js (modified) (1 diff)

Dev/trunk/Gruntfile.js

@@ -84 +84 @@
         { cwd: srcDir, ext: '.css' });
 
+    var mode = process.env.QED_ENV || 'dev';
+    var dbNames = {
+        dev: 'qed-dev',
+        production: 'qed'
+    };
+    if ( !( mode in dbNames ) ) {
+        throw new Error("Unknown mode "+mode+" specified.");
+    }
+
     // TASK CONFIG
 
     grunt.initConfig({
         localDbURL: "http://localhost:5984",
+        dbName: dbNames[mode],
         timestamp: "<%= grunt.template.today(\"UTC:yyyymmdd't'HHMMss'z'\") %>",
 
@@ -155 +165 @@
                     method: 'POST',
                     body: {
-                        source: "<%= herokuConfig.CLOUDANT_URL %>/qed",
-                        target: "qed-<%= timestamp %>",
+                        source: "<%= herokuConfig.CLOUDANT_URL %>/<%= dbName %>",
+                        target: "<%= dbName %>-<%= timestamp %>",
                         create_target: true
                     },
@@ -167 +177 @@
                     method: 'POST',
                     body: {
-                        source: "<%= herokuConfig.CLOUDANT_URL %>/qed",
-                        target: "qed"
+                        source: "<%= herokuConfig.CLOUDANT_URL %>/<%= dbName %>",
+                        target: "<%= dbName %>"
                     },
                     json: true
@@ -178 +188 @@
                     method: 'POST',
                     body: {
-                        source: "qed",
-                        target: "<%= herokuConfig.CLOUDANT_URL %>/qed"
+                        source: "<%= dbName %>",
+                        target: "<%= herokuConfig.CLOUDANT_URL %>/<%= dbName %>"
                     },
                     json: true

Dev/trunk/src/client/index.html

@@ -25 +25 @@
         <div id="content" class="page" data-dojo-type="dijit/layout/BorderContainer" data-dojo-props="region:'center'" style="width: 100%; height: 100%;">
             <div class="topbar" data-dojo-type="dijit/layout/ContentPane" data-dojo-props="region:'top'">
-                <a href="#!/"><h1>QED</h1></a>
+                <a href="#!/"><h1>QED</h1></a><span id="qedModeNode"></span>
                 <div id="menu"></div>
             </div>

Dev/trunk/src/client/qed-client/app/Router.js

@@ -29 +29 @@
             this._handleHashChange(hash());
             window.onbeforeunload = function(evt) {
-                var msg = Content.isDirty() ? 
-                        "Unsaved changes, leave anyway?" :
-                        null;
-                evt.returnValue = msg;
+                var msg;
+                if ( Content.isDirty() ) { 
+                    msg = "Unsaved changes, leave anyway?";
+                    evt.returnValue = msg;
+                }
                 return msg;
             };

Dev/trunk/src/client/qed-client/css/ui/topbar.less

@@ -6 +6 @@
         float: left;
         clear: left;
+    }
+    
+    #qedModeNode {
+        float: left;
+        margin-top: 28px;
     }
     

Dev/trunk/src/client/qed-client/index.js

@@ -5 +5 @@
     "./ui/MainMenu",
     "dojo/_base/array",
+    "dojo/_base/xhr",
+    "dojo/dom",
     "dojo/parser",
     "./stddeps",
     "dojo/domReady!"
-], function(Router, routes, session, MainMenu, array, parser) {
+], function(Router, routes, session, MainMenu, array, xhr, dom, parser) {
 
     parser.parse();
 
     new MainMenu({},"menu").startup();
+
+    xhr("GET", {
+        url: 'api/mode',
+        handleAs: 'json'
+    }).then(function(result){
+        var node = dom.byId('qedModeNode');
+        if ( result.mode !== 'production' ) {
+            node.innerHTML = "Running in "+result.mode+" mode";
+        }
+    });
 
     array.forEach(routes,function(route){

Dev/trunk/src/client/qed-client/pages/surveyRun.js

@@ -47 +47 @@
             .then(lang.hitch(this,function(allResponses){
                 array.forEach(allResponses, function(response){
-                    var actions = {
-                        view: {
-                            callback: function(){},
+                    var actions = {};
+                    if ( !response.publicationDate ) {
+                        actions.Delete = {
+                            callback: function(){
+                                responses.remove(response)
+                                .then(function(){
+                                    w.destroy();
+                                });
+                            },
                             properties: {
-                                title: "View response"
-                            }
-                        }
-                    };
-                    if ( !response.publicationDate ) {
-                        actions.remove = {
-                            callback: function(){},
-                            properties: {
-                                title: "Remove response"
+                                icon: 'Delete',
+                                title: "Delete response"
                             }
                         };

Dev/trunk/src/server/app.js

@@ -14 +14 @@
   ;
 
-function assertSetting(name, settings, validate) {
-    if ( typeof settings[name] === 'undefined' ) {
-        throw new Error("Required setting '"+name+"' undefined.");
-    }
-    if ( _.isFunction(validate) && !validate(settings[name]) ) {
-        throw new Error("Setting '"+name+"' with value '"+settings[name]+"' is invalid.");
-    }
-}
-
-exports.App = function(settings) {
-
-    assertSetting("couchServerURL", settings, _.isString);
-    assertSetting("dbName", settings, _.isString);
-    var couch = new CouchDB(settings.couchServerURL,settings.dbName);
+exports.App = function(env) {
+
+    assertSetting("couchServerURL", env, _.isString);
+    assertSetting("dbName", env, _.isString);
+    assertSetting("mode", env, _.isString);
+    var couch = new CouchDB(env.couchServerURL,env.dbName);
     
     var schema = require("./config/couchdb-schema.json");
@@ -35 +27 @@
             throw new Error(msg);
         }
-        return configureApp(settings,couch,schema);
+        return configureApp(env,couch,schema);
     });
 
 };
 
-function configureApp(settings,couch,schema) {
+function configureApp(env,couch,schema) {
 
     function clientPath(relativePath) {
@@ -46 +38 @@
     }
 
-    passport.use(new passportLocal.Strategy(function(username, password, done){
-        if ( username === "igor" && password === "mayer" ) {
-            done(null,{ username: "igor" });
-        } else {
-            done(null,false,{ message: 'Invalid credentials.' });
-        }
-    }));
+    passport.use(
+        new passportLocal.Strategy(
+            function(username, password, done){
+                if ( username === "igor" && password === "mayer" ) {
+                    done(null,{ username: "igor" });
+                } else {
+                    done(null,false,{ message: 'Invalid credentials.' });
+                }
+            }));
     passport.serializeUser(function(user, done) {
         done(null, user.username);
@@ -952 +946 @@
         });
 
+    app.get('/api/mode',
+        ensureMIME(JSON_MIME),
+        function(req,res){
+            res.send({mode:env.mode});
+        });
+
+
     return app;
 }
@@ -991 +992 @@
     return result;
 }
+
+function assertSetting(name, settings, validate) {
+    if ( typeof settings[name] === 'undefined' ) {
+        throw new Error("Required setting '"+name+"' undefined.");
+    }
+    if ( _.isFunction(validate) && !validate(settings[name]) ) {
+        throw new Error("Setting '"+name+"' with value '"+settings[name]+"' is invalid.");
+    }
+}

Dev/trunk/src/server/bin/check-db.js

@@ -2 +2 @@
   , checkCouch = require('../config/check-couchdb')
   ;
+console.log("Running on",env.couchServerURL+env.dbName);
 checkCouch(env.couchServerURL,env.dbName)
 .then(function(res){

Dev/trunk/src/server/bin/config-db-for-upgrade.js

@@ -3 +3 @@
   , designDocs = require('../config/couchdb-upgrade-design-docs')
   ;
+console.log("Running on",env.couchServerURL+env.dbName);
 configCouch(env.couchServerURL,env.dbName,designDocs)
 .then(function(res){

Dev/trunk/src/server/bin/config-db.js

@@ -3 +3 @@
   , designDocs = require('../config/couchdb-design-docs')
   ;
+console.log("Running on",env.couchServerURL+env.dbName);
 configCouch(env.couchServerURL,env.dbName,designDocs)
 .then(function(res){

Dev/trunk/src/server/bin/heroku.js

@@ -1 +1 @@
 var env = require('../env')
   , configCouch = require('../config/config-couchdb')
-  , designDocs = require('../config/config-couchdb')
+  , designDocs = require('../config/couchdb-design-docs')
   ;
 
-console.log("Running on",env.couchServerURL);
+console.log("Running on",env.couchServerURL+env.dbName);
 
-require('../app').App({
-    couchServerURL: env.couchServerURL,
-    dbName: env.dbName
-}).then(function(app){
+require('../app').App(env)
+.then(function(app){
     configCouch(env.couchServerURL,env.dbName,designDocs);
     return app;

Dev/trunk/src/server/config/config-couchdb.js

@@ -20 +20 @@
         }
     }).then(function(res){
-        console.log("Checking database 'qed'");
-        return server.get('qed')
+        console.log("Checking database '"+dbName+"'");
+        return server.get(dbName)
         .then(function(db){
-            console.log("Database 'qed' found.");
+            console.log("Database found.");
         },function(err){
-            console.log("Creating database 'qed'");
-            return server.put('qed');
+            console.log("Creating database.");
+            return server.put(dbName);
         });
     }).then(function(){
@@ -34 +34 @@
                 var configAction = doc.__configAction || "replace";
                 delete doc.__configAction;
+                docUrl = dbName+'/'+docUrl;
                 switch (configAction) {
                 case "ignore":

Dev/trunk/src/server/config/couchdb-design-docs.js

@@ -1 +1 @@
 module.exports = {
 
-    "_users/qed_admin": {
-        __configAction: "ignore",
-        _id: "org.couchdb.user:qed_admin",
-        name: "qed_admin",
-        password: "Welkom01",
-        roles: [ "qed_admin" ],
-        type: "user"
-    },
-
-    "qed/schemaInfo": {
+    "schemaInfo": {
+        _id: "schemaInfo",
         version: "4"
     },
 
-    "qed/_security": {
-        __configAction: "ignore",
-        admins: {
-            names: [],
-            roles: ["qed_admin"]
-        },
-        readers: {
-            names: [],
-            roles: ["qed_user"]
-        }
-    },
-
-    "qed/_design/protectPublished": {
+    "_design/protectPublished": {
         __configAction: "replace",
-        _id: "_design/protectPublished",
         language: "javascript",
         validate_doc_update: function(newDoc, oldDoc, userCtx, secObj) {
@@ -37 +16 @@
     },
 
-    "qed/_design/default": {
+    "_design/default": {
         __configAction: "replace",
-        _id: "_design/default",
         language: "javascript",
         views: {
@@ -57 +35 @@
     },
 
-    "qed/_design/questions": {
+    "_design/questions": {
         __configAction: "replace",
-        _id: "_design/questions",
         language: "javascript",
         views: {
@@ -117 +94 @@
     },
 
-    "qed/_design/surveys": {
+    "_design/surveys": {
         __configAction: "replace",
-        _id: "_design/surveys",
         language: "javascript",
         views: {
@@ -137 +113 @@
     },
 
-    "qed/_design/surveyRuns": {
+    "_design/surveyRuns": {
         __configAction: "replace",
-        _id: "_design/surveys",
         language: "javascript",
         views: {
@@ -153 +128 @@
     },
 
-    "qed/_design/responses": {
+    "_design/responses": {
         __configAction: "replace",
-        _id: "_design/responses",
         language: "javascript",
         views: {

Dev/trunk/src/server/config/couchdb-upgrade-design-docs.js

@@ -1 +1 @@
 module.exports = {
 
-    "qed/schemaInfo": {
+    "schemaInfo": {
         version: "-1"
     },
 
-    "qed/_design/protectPublished": {
-        __configAction: "replace",
-        _id: "_design/protectPublished"
+    "_design/protectPublished": {
+        __configAction: "replace"
     }
 

Dev/trunk/src/server/env.js

@@ -1 @@
-var couchServerURL = (process.env.CLOUDANT_URL || 'http://localhost:5984')+'/';
+var dbNames = {
+    dev: 'qed-dev',
+    production: 'qed'
+};
+var mode = process.env.QED_ENV || 'dev';
+if ( !( mode in dbNames ) ) {
+    throw new Error("Unknown environment "+mode);
+}
 module.exports = {
     port: process.env.PORT || 5000,
-    couchServerURL: couchServerURL,
-    dbName: 'qed'
+    couchServerURL: (process.env.CLOUDANT_URL || 'http://localhost:5984')+'/',
+    dbName: dbNames[mode],
+    mode: mode
 };