Changeset 464

Timestamp:

06/23/13 21:46:11 (12 years ago)

Author:

hendrikvanantwerpen

Message:

Working deployment to Heroku.

Location:

Dev/trunk

Files:

• Gruntfile.js (modified) (5 diffs)
• README.md (moved) (moved from Dev/trunk/README.txt) (2 diffs)
• package.json (modified) (1 diff)
• src/.jshintrc (modified) (1 diff)
• src/client/qed-client/store/request.js (modified) (1 diff)
• src/package.json (modified) (1 diff)
• src/server/app.js (modified) (2 diffs)
• src/server/config/config-couchdb.js (modified) (1 diff)
• src/server/config/couchdb-design-docs.js (modified) (7 diffs)
• src/server/heroku.js (modified) (1 diff)
• src/server/simple-http-proxy.js (added)
• src/server/standalone.js (modified) (2 diffs)

Dev/trunk/Gruntfile.js

@@ -1 @@
-/***************************************
- * This Gruntfile is organized with two phases,
- * compile and build. Compile will lint HTML,
- * JavaScript and compile LESS. The build phase
- * creates an optimized stand-alone build that
- * can be distributed.
+/** Gruntfile - control build and deploy tasks
  */
 
 module.exports = function(grunt) {
 
+    var srcDir   = 'src/';
     var buildDir = 'build/';
-    var srcDir   = 'src/';
+    var developmentDir = buildDir+'development/';
+    var productionDir = buildDir+'production/';
 
     grunt.initConfig({
         clean: {
-            build: {
-                src: [buildDir]
+            development: {
+                src: [developmentDir]
+            },
+            production: {
+                src: [productionDir]
             }
         },
@@ -27 +27 @@
                     cwd: srcDir,
                     src: ['client/qed-client/**/*.coffee', 'server/**/*.coffee'],
-                    dest: buildDir,
+                    dest: developmentDir,
                     ext: '.js'
                 }]
@@ -33 +33 @@
         },
         copy: {
+            'client-deps': {
+                files: [{
+                    expand: true,
+                    cwd: srcDir,
+                    src: ['client/dojo/**', 'client/dijit/**', 'client/dojox/**', 'client/util/**'],
+                    dest: developmentDir
+                }]
+            },
+            'server-deps': {
+                files: [{
+                    expand: true,
+                    cwd: srcDir,
+                    src: ['node_modules/**'],
+                    dest: developmentDir
+                }]
+            },
             compile: {
                 files: [{
-                    src: [srcDir+'**', '!**/*.coffee' ],
-                    dest: buildDir
+                    expand: true,
+                    cwd: srcDir,
+                    src: ['**', '!**/*.coffee', '!**/*.less', '!node_modules/**', '!client/dojo/**', '!client/dijit/**', '!client/dojox/**', '!client/util/**' ],
+                    dest: developmentDir
+                }]
+            },
+            deploy: {
+                files: [{
+                    expand: true,
+                    cwd: developmentDir,
+                    src: ['**', '!client/*/**' ],
+                    dest: productionDir
                 }]
             }
         },
         dojo: {
-            options: {
-                dojo: srcDir+'client/dojo/dojo.js'
-            },
-            build: {
+            deploy: {
                 options: {
-                    profile: srcDir+'client/client.profile.js',
-                    releaseDir: buildDir
+                    dojo: developmentDir+'client/dojo/dojo.js',
+                    profile: developmentDir+'client/client.profile.js',
+                    releaseDir: '../../../'+productionDir
                 }
             }
@@ -85 +109 @@
                     cwd: srcDir,
                     src: ['client/qed-client/css/qed.less'],
-                    dest: buildDir,
+                    dest: developmentDir,
                     ext: '.css'
                 }]
@@ -97 +121 @@
     grunt.loadNpmTasks('grunt-contrib-jshint');
     grunt.loadNpmTasks('grunt-contrib-less');
-    grunt.loadNpmTasks('grunt-curl');
     grunt.loadNpmTasks('grunt-dojo');
     grunt.loadNpmTasks('grunt-htmlhint');
-    grunt.loadNpmTasks('grunt-zip');
 
+    // development tasks
+    grunt.registerTask('install-deps', ['copy:server-deps', 'copy:client-deps']);
     grunt.registerTask('compile', ['less:compile', 'jshint:compile', 'htmlhint:compile', 'coffee:compile', 'copy:compile']);
-    grunt.registerTask('build', ['clean:build', 'compile', 'dojo:build']);
-    grunt.registerTask('deploy', []);
+    grunt.registerTask('build', ['clean:development', 'install-deps', 'compile']);
+
+    // production tasks
+    grunt.registerTask('deploy', ['clean:production', 'copy:deploy', 'dojo:deploy']);
+
+    // default task is quick compile
     grunt.registerTask('default', ['compile']);
 

Dev/trunk/README.md

@@ -1 @@
-===
-QED
-===
+# QED
 
-Install
--------
+This document describes how to develop this code base and the source
+code organisation.
 
-- Install CouchDB
-- Install Node.js
-- 
+## Development, Install and Deploy
 
+Source files are located in `src`. Build and deployment is managed
+with _Grunt_, a node based task runner.
+
+First make sure _node_, _npm_ and _couchdb_ are installed. Then
+install all dependencies by running `npm install`. To run _grunt_,
+you'll have to install the commandline client with `npm install -g
+grunt-cli`.
+
+From source to a deployable version goes in few steps.
+ 1. Develop in `src`.
+ 1. Create a development version with `grunt build`. This will put a
+    complete uncompressed version in `build/development`.
+ 1. Run the development version with `node server/standalone.js` or
+    `foreman start`. For the last option, you have to have the Heroku
+    chain installed.
+ 1. When editing more files, you can skip copying the fixed
+    dependencies and only process our own source files by running
+    `grunt compile`. If dependencies change (e.g. you installed node
+    modules) or you have the feeling something is weird, just do a
+    clean build by running `grunt build` again. Don't forget to
+    restart the server.
+ 1. When you feel your changes are production ready, create a
+    production version by running `grunt deploy`. This will do a
+    _Dojo_ build on the client, creating compressed CSS and
+    Javascript.
+ 1. You can test this version with the same commands as the
+    development version, but now from the `build/production`
+    directory. You can distribute the content is this directory as a
+    release.
+ 1. If you want to deploy to Heroku, do the following:
+    ```sh
+    $ git clone git@heroku.com:quod-erat.git build/quod-erat
+    $ cd build/quod-erat
+    $ rm -rf *
+    cp -r ../production/* .
+    git add .
+    git commit -a -m "Something informative goes here..."
+    git push
+    ```
 
 File organisation
 -----------------
+
+ * _/_ Project root
+   * _build/_ Builds go here
+     * _development/_ Uncompressed build
+     * _production/_ Minified build
+   * _docs/_ Project documentation, design documents etc
+   * _src/_ Source code
+     * _client/_ Dojo web client
+     * _server/_ Node/Express server
+     * _Procfile_ Heroku process description
+
+```
 client/
   The web application for QED.
@@ -66 +113 @@
       Contains general widgets that are used in our application but do
       not depend on our model.
-  rx/
-    Rx.JS reactive framework for Javascript
-    rx.dojo.js
-      Custom file to integrate Rx with Dojo.
   util/
     Dojo utils (e.g. build infrastructure)
+```

Dev/trunk/package.json

@@ -12 +12 @@
     "grunt-htmlhint": "~0.4.0",
     "grunt-contrib-clean": "~0.4.1",
-    "grunt-zip": "~0.9.0",
-    "grunt-curl": "~1.1.0",
-    "grunt-contrib-coffee": "~0.7.0"
+    "grunt-contrib-coffee": "~0.7.0",
+    "underscore": "~1.4.4"
   }
 }

Dev/trunk/src/.jshintrc

@@ -11 +11 @@
     "unused": false,
     "strict": false,
+    "laxcomma": true,
 
     "loopfunc": true,

Dev/trunk/src/client/qed-client/store/request.js

@@ -10 +10 @@
         var dfd = new Deferred();
         if ( authenticated ) {
-            request(url,options).response.then(function(response){
-                console.log(response);
-            }, function(error){
+            var req = request(url,options);
+
+            // forward successfull response
+            req.then(function(data){
+                dfd.resolve(data);
+            });
+            
+            req.response.then(function(response){
+                // if we are recovering, launch other requests
+            }, function(error) {
                 if ( error.response.status === 401 ) {
                     queue.push({

Dev/trunk/src/package.json

@@ -4 +4 @@
   "description": "QED Server",
   "dependencies": {
-    "simple-http-proxy": "~0.5.2",
     "express": "~3.2.3",
     "underscore": "~1.4.4",
     "passport": "~0.1.17",
-    "passport-local": "~0.1.6"
+    "passport-local": "~0.1.6",
+    "q": "~0.9.6",
+    "q-io": "~1.9.1"
   },
   "engines": {

Dev/trunk/src/server/app.js

@@ -4 +4 @@
 var fs = require("fs");
 var path = require("path");
-var proxy = require("simple-http-proxy");
+var proxy = require("./simple-http-proxy");
 var _ = require("underscore");
 
@@ -58 +58 @@
     // url to login (might work on others as well?)
     // you should then have a session to work with
-    app.post('/api/login', passport.authenticate('local'));
+    app.post('/api/login');
 
     // forward to couch
-    app.use('/data/couch', passport.authenticate('local'), proxy(settings.couchDbURL));
+    app.use('/data/couch', proxy(settings.couchDbURL));
 
     return app;

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

@@ -1 +1 @@
 var q = require('q');
-var http = require('q-io/http');
-var fs = require('q-io/fs');
+var HTTP = require('q-io/http');
+var URL = require('url');
 var _ = require('underscore');
+var util = require('util');
 
-var dbURL = "http://localhost:5984/";
 var designDocs = require('./couchdb-design-docs');
 
-function stringifyFunctions(value) {
-    if ( value === null ) {
-        return null;
-    } else if ( _.isArray(value) ) {
-        return value;
-    } else if ( _.isFunction(value) ) {
-        return value.toString();
-    } else if ( _.isObject(value) ) {
-        value = _.clone(value);
-        _.each(value, function(propValue, propName){
-            value[propName] = stringifyFunctions(propValue);
+module.exports = function(couchDbURL) {
+
+    function stringifyFunctions(value) {
+        if ( value === null ) {
+            return null;
+        } else if ( _.isArray(value) ) {
+            return value;
+        } else if ( _.isFunction(value) ) {
+            return value.toString();
+        } else if ( _.isObject(value) ) {
+            value = _.clone(value);
+            _.each(value, function(propValue, propName){
+                value[propName] = stringifyFunctions(propValue);
+            });
+            return value;
+        } else {
+            return value;
+        }
+    }
+
+    function request(method,path,content) {
+        var url = couchDbURL+path;
+        var parsedURL = URL.parse(url);
+        var options = {
+            url: url,
+            method: method,
+            headers: {
+                'content-type': 'application/json; charset=utf-8',
+                'accept': 'application/json'
+            },
+            body: {
+                forEach: function(callback) {
+                    callback(JSON.stringify(content || {}));
+                }
+            }
+        };
+        // because q-io doesn't support auth properly, we have to
+        // build the f*ing wheel again.
+        if ( parsedURL.auth ) {
+            var auth = new Buffer(parsedURL.auth).toString("base64");
+            options.headers.authorization = 'Basic '+auth;
+        }
+        return HTTP.request(options)
+        .then(function(res){
+            return res.body.read().then(function(content){
+                return JSON.parse(content.toString() || "{}");
+            });
+        },function(res){
+            return res.body.read().then(function(error){
+                console.warn(error); // q.all doesn't do errors, so let's show them here
+                return JSON.parse(error.toString() || "{}");
+            });
         });
-        return value;
-    } else {
-        return value;
     }
-}
 
-function request(method,path,content) {
-    var url = dbURL+path;
-    return http.request({
-        url: url,
-        method: method,
-        headers: {
-            'content-type': 'application/json; charset=utf-8',
-            'accept': 'application/json'
-        },
-        body: {
-            forEach: function(callback) {
-                callback(JSON.stringify(content || {}));
-            }
+    console.log("Configuring CouchDB for QED");
+    console.log("Checking CouchDB version");
+    return request('GET','')
+    .then(function(res){
+        if (res.version !== "1.2.0" ) {
+            console.log("Found "+res.version+", only tested with CouchDB 1.2.0");
+        } else {
+            console.log("CouchDB 1.2.0 found");
         }
     }).then(function(res){
-        return res.body.read().then(function(content){
-            return JSON.parse(content);
+        console.log("Checking database 'qed'");
+        return request('GET','qed')
+        .then(function(res){
+            console.log("Database 'qed' found.");
+        },function(err){
+            console.log("Creating database 'qed'");
+            return request('PUT','qed');
         });
-    },function(res){
-        return res.body.read().then(function(error){
-            return JSON.parse(error);
-        });
+    }).then(function(){
+        console.log("Putting documents in database.");
+        designDocs = stringifyFunctions(designDocs);
+        return q.all(_.map(designDocs, function(doc,docUrl){
+            var configAction = doc.__configAction;
+            delete doc.__configAction;
+            switch (configAction) {
+                case "ignore":
+                    console.log(docUrl+" ignored.");
+                break;
+                case "update":
+                    console.log(docUrl+" updating.");
+                    return request('GET',docUrl)
+                    .then(function(oldDoc){
+                        _.extend(oldDoc,doc);
+                        return request('PUT',docUrl,oldDoc);
+                    },function(){
+                        return request('PUT',docUrl,doc);
+                    });
+                break;
+                case "replace":
+                default:
+                    console.log(docUrl+" replacing.");
+                    return request('GET',docUrl)
+                    .then(function(oldDoc){
+                        _.extend(doc,_.pick(oldDoc,'_id','_rev'));
+                        return request('PUT',docUrl,doc);
+                    },function(){
+                        return request('PUT',docUrl,doc);
+                    });
+                break;
+            }
+        }));
+    }).then(function(){
+        console.log("Done!");
+    },function(err){
+        console.error("ERROR",err,err.stack);
     });
-}
 
-console.log("Configuring CouchDB for QED");
-console.log("Checking CouchDB version");
-request('GET','')
-.then(function(res){
-    if (res.version !== "1.2.0" ) {
-        console.log("Found "+res.version+", only tested with CouchDB 1.2.0");
-    } else {
-        console.log("CouchDB 1.2.0 found");
-    }
-    console.log("Checking database 'qed'");
-}).then(function(res){
-    return request('GET','qed')
-    .then(function(res){
-        console.log("Database 'qed' found.");
-    },function(err){
-        console.log("Creating database 'qed'");
-        return request('PUT','qed');
-    });
-}).then(function(){
-    console.log("Putting documents in database.");
-    designDocs = stringifyFunctions(designDocs);
-    return q.all(_.map(designDocs, function(doc,docUrl){
-        var configAction = doc.__configAction;
-        delete doc.__configAction;
-        switch (configAction) {
-            case "ignore":
-                console.log(docUrl+" ignored.");
-            case "update":
-                console.log(docUrl+" updating.");
-                return request('GET',docUrl)
-                .then(function(oldDoc){
-                    _.extend(oldDoc,doc);
-                    return request('PUT',docUrl,oldDoc);
-                },function(){
-                    return request('PUT',docUrl,doc);
-                });
-            case "replace":
-            default:
-                console.log(docUrl+" replacing.");
-                return request('GET',docUrl)
-                .then(function(oldDoc){
-                    _.extend(doc,_.pick(oldDoc,'_id','_rev'));
-                    return request('PUT',docUrl,doc);
-                },function(){
-                    return request('PUT',docUrl,doc);
-                });
-        }
-    }));
-}).then(function(){
-    console.log("Done!");
-},function(err){
-    console.error("ERROR",err);
-});
+};

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

@@ -1 +1 @@
 module.exports = {
+
     "_users/qed_admin": {
         __configAction: "ignore",
@@ -8 +9 @@
         type: "user"
     },
+
     "qed/_security": {
         __configAction: "ignore",
@@ -19 +21 @@
         }
     },
+
     "qed/_design/default": {
         __configAction: "replace",
@@ -34 +37 @@
         }
     },
+
     "qed/_design/questions": {
         __configAction: "replace",
@@ -81 +85 @@
         }
     },
+
     "qed/_design/surveys": {
         __configAction: "replace",
@@ -100 +105 @@
         }
     },
+
     "qed/_design/responses": {
         __configAction: "replace",
@@ -113 +119 @@
         }
     }
+
 };

Dev/trunk/src/server/heroku.js

@@ -1 @@
-var app = require('./app').App({
-    couchDbURL: 'http://localhost:5984/qed'
+var port = process.env.PORT || 5000;
+var couchDbURL = (process.env.CLOUDANT_URL || 'http://localhost:5984')+'/';
+
+var configCouch = require('./config/config-couchdb');
+
+configCouch(couchDbURL)
+.then(function(){
+    var app = require('./app').App({
+        couchDbURL: couchDbURL+'qed'
+    });
+
+    app.listen(port, function() {
+        console.log('Listening on port',port);
+    });
 });
-
-var port = process.env.PORT || 5000;
-app.listen(port, function() {
-    console.log('Listening on port',port);
-});

Dev/trunk/src/server/standalone.js

@@ -2 +2 @@
 var https = require("https");
 var os = require("os");
-var path = require("path");
 var _ = require("underscore");
 
@@ -10 +9 @@
 
 var httpsOptions = {
-    key: fs.readFileSync(path.resolve('../qed-server.key')),
-    cert: fs.readFileSync(path.resolve('../qed-server.pem'))
+    key: fs.readFileSync(__dirname+'/../qed-server.key'),
+    cert: fs.readFileSync(__dirname+'/../qed-server.pem')
 };