Added didDeploy hook, and make activate hook add activatedRevisionKey to context.

The didDeploy hook works with a configurable `didDeployMessage` which is output
when the hook runs.

Author: lukemelia

index.js

@@ -102,10 +102,25 @@ module.exports = {
 
         return _beginActivateMessage(ui, revisionKey)
           .then(redis.activate.bind(redis, config.keyPrefix, revisionKey))
+          .then(function(){
+            context.activatedRevisionKey = revisionKey;
+          })
           .then(_activationSuccessMessage.bind(this, ui, revisionKey))
           .catch(_errorMessage.bind(this, ui));
       },
 
+      didDeploy: function(context){
+        var deployment  = context.deployment;
+        var ui          = deployment.ui;
+        var config      = deployment.config[this.name] || {};
+        var didDeployMessage = this._resolveConfigValue('didDeployMessage', config, context);
+        if (didDeployMessage) {
+          ui.write(blue('|      '));
+          ui.write(blue(didDeployMessage + '`\n'));
+        }
+        return Promise.resolve();
+      },
+
       _resolvePipelineData: function(config, context) {
         config.revisionKey = config.revisionKey || function(context) {
           return context.deployment.commandLineArgs.revisionKey || context.revisionKey;

lib/utilities/validate-config.js

@@ -8,6 +8,9 @@ function applyDefaultConfigIfNecessary(config, prop, defaultConfig, ui){
   if (!config[prop]) {
     var value = defaultConfig[prop];
     config[prop] = value;
+    if (typeof value === "function") {
+      value = "[Function]";
+    }
     ui.write(blue('|    '));
     ui.writeLine(yellow('- Missing config: `' + prop + '`, using default: `' + value + '`'));
   }
@@ -21,15 +24,22 @@ module.exports = function(ui, config, projectName) {
     host: 'localhost',
     port: 6379,
     filePattern: 'dist/index.html',
-    keyPrefix: projectName + ':index'
+    keyPrefix: projectName + ':index',
+    didDeployMessage: function(context){
+      if (context.revisionKey && !context.activatedRevisionKey) {
+        return "Deployed but did not activate revision " + context.revisionKey + ". "
+             + "To activate, run: "
+             + "ember activate " + context.revisionKey + " --environment=" + context.deployment.deployEnvironment + "\n";
+      }
+    }
   };
 
   if (!config.url) {
     ['host', 'port'].forEach(function(prop) {
       applyDefaultConfigIfNecessary(config, prop, defaultConfig, ui);
     });
   }
-  ['filePattern', 'keyPrefix'].forEach(function(configKey){
+  ['filePattern', 'keyPrefix', 'didDeployMessage'].forEach(function(configKey){
     applyDefaultConfigIfNecessary(config, configKey, defaultConfig, ui);
   });
 

tests/unit/index-nodetest.js

@@ -37,8 +37,8 @@ describe('redis plugin', function() {
       name: 'test-plugin'
     });
 
-    assert.equal(hooks(plugin).length, 3);
-    assert.sameMembers(hooks(plugin), ['configure', 'upload', 'activate']);
+    assert.equal(hooks(plugin).length, 4);
+    assert.sameMembers(hooks(plugin), ['configure', 'upload', 'activate', 'didDeploy']);
   });
 
   describe('configure hook', function() {
@@ -223,6 +223,7 @@ describe('redis plugin', function() {
       return assert.isFulfilled(plugin.activate.call(plugin, context))
         .then(function() {
           assert.ok(activateCalled);
+          assert.equal(context.activatedRevisionKey, '123abc');
         });
     });
 
@@ -257,4 +258,45 @@ describe('redis plugin', function() {
         });
     });
   });
+  describe('didDeploy hook', function() {
+    it('prints default message about lack of activation when revision has not been activated', function() {
+      var messageOutput = "";
+
+      var plugin = subject.createDeployPlugin({
+        name: 'redis'
+      });
+      plugin.upload = function(){};
+      plugin.activate = function(){};
+
+      var context = {
+        deployment: {
+          deployEnvironment: 'qa',
+          ui: {
+            write: function(message){
+              messageOutput = messageOutput + message;
+            },
+            writeLine: function(message){
+              messageOutput = messageOutput + message + "\n";
+            }
+          },
+          project: stubProject,
+          config: {
+            redis: {
+              revisionKey: '123abc',
+              activatedRevisionKey: null
+            }
+          }
+        },
+        revisionKey: '123abc',
+      };
+
+      return assert.isFulfilled(plugin.configure.call(plugin, context)).then(function(){
+        return assert.isFulfilled(plugin.didDeploy.call(plugin, context));
+      }).then(function() {
+        assert.match(messageOutput, /Deployed but did not activate revision 123abc./);
+        assert.match(messageOutput, /To activate, run/);
+        assert.match(messageOutput, /ember activate 123abc --environment=qa/);
+      });
+    });
+  });
 });

tests/unit/lib/utilities/validate-config-nodetest.js

@@ -34,7 +34,7 @@ describe('validate-config', function() {
 
             return previous;
           }, []);
-          assert.equal(messages.length, 4);
+          assert.equal(messages.length, 5);
         });
     });
 
@@ -44,6 +44,7 @@ describe('validate-config', function() {
           assert.isDefined(config.host);
           assert.isDefined(config.port);
           assert.isDefined(config.keyPrefix);
+          assert.isDefined(config.didDeployMessage);
         });
     });
 
@@ -69,7 +70,7 @@ describe('validate-config', function() {
             return previous;
           }, []);
 
-          assert.equal(messages.length, 3);
+          assert.equal(messages.length, 4);
         });
     });
     it('does not add default config to the config object', function() {
@@ -78,6 +79,7 @@ describe('validate-config', function() {
           assert.isDefined(config.host);
           assert.isDefined(config.port);
           assert.isDefined(config.filePattern);
+          assert.isDefined(config.didDeployMessage);
           assert.equal(config.keyPrefix, 'proj:home');
         });
     });
@@ -89,7 +91,7 @@ describe('validate-config', function() {
         url: 'redis://localhost:6379'
       };
     });
-    it('warns about missing optional filePattern and keyPrefix only', function() {
+    it('warns about missing optional filePattern, keyPrefix and didDeployMessage only', function() {
       return assert.isFulfilled(subject(mockUi, config, projectName))
         .then(function() {
           var messages = mockUi.messages.reduce(function(previous, current) {
@@ -100,7 +102,7 @@ describe('validate-config', function() {
             return previous;
           }, []);
 
-          assert.equal(messages.length, 2);
+          assert.equal(messages.length, 3);
         });
     });
 
@@ -110,6 +112,7 @@ describe('validate-config', function() {
           assert.isUndefined(config.host);
           assert.isUndefined(config.port);
           assert.isDefined(config.filePattern);
+          assert.isDefined(config.didDeployMessage);
         });
     });