Merge pull request #130 from jkeen/add-didDeployMessage

Add support for didDeployMessage

Author: lukemelia

README.md

@@ -170,6 +170,22 @@ If you are using DigitalOcean spaces you need to set this setting to `false`.
 
 *Default:* `true`
 
+### didDeployMessage
+
+A message that will be displayed after the index file has been successfully uploaded to S3. By default this message will only display if the revision for `revisionData.revisionKey` of the deployment context has been activated.
+
+*Default:*
+
+```javascript
+if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionKey) {
+  return "Deployed but did not activate revision " + context.revisionData.revisionKey + ". "
+       + "To activate, run: "
+       + "ember deploy:activate " + context.revisionData.revisionKey + " --environment=" + context.deployEnvironment + "\n";
+}
+```
+
+
+
 ### How do I activate a revision?
 
 A user can activate a revision by either:

index.js

@@ -34,6 +34,15 @@ module.exports = {
         brotliCompressedFiles: function(context) {
           return context.brotliCompressedFiles || [];
         },
+        didDeployMessage: function(context){
+          var revisionKey = context.revisionData && context.revisionData.revisionKey;
+          var activatedRevisionKey = context.revisionData && context.revisionData.activatedRevisionKey;
+          if (revisionKey && !activatedRevisionKey) {
+            return "Deployed but did not activate revision " + revisionKey + ". "
+                 + "To activate, run: "
+                 + "ember deploy:activate " + context.deployTarget + " --revision=" + revisionKey + "\n";
+          }
+        },
         allowOverwrite: false
       },
 
@@ -103,7 +112,22 @@ module.exports = {
         this.log('preparing to activate `' + revisionKey + '`', { verbose: true });
 
         var s3 = new this.S3({ plugin: this });
-        return s3.activate(options);
+        return s3.activate(options).then(() => {
+          this.log(`✔ Activated revision \`${revisionKey}\``, {});
+
+          return {
+            revisionData: {
+              activatedRevisionKey: revisionKey
+            }
+          }
+        });
+      },
+
+      didDeploy: function(/* context */){
+        var didDeployMessage = this.readConfig('didDeployMessage');
+        if (didDeployMessage) {
+          this.log(didDeployMessage);
+        }
       },
 
       fetchRevisions: function(context) {

tests/unit/index-test.js

@@ -61,6 +61,7 @@ describe('s3-index plugin', function() {
     });
 
     context = {
+      deployTarget: "qa",
       ui: mockUi,
 
       project: stubProject,
@@ -262,6 +263,15 @@ describe('s3-index plugin', function() {
             assert.equal(Object.prototype.hasOwnProperty.call(s3Options, 'serverSideEncryption'), false, 'serverSideEncryption filtered correctly');
           });
       });
+
+      it('displays activation message when revision is activated', function() {
+        var promise = plugin.activate(context);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.match(mockUi.messages.join("\n"),  new RegExp(`✔ Activated revision \`${REVISION_KEY}\``));
+          });
+      })
     });
 
     describe('#fetchInitialRevisions', function() {
@@ -315,5 +325,21 @@ describe('s3-index plugin', function() {
           });
       });
     });
+
+    describe('#didDeploy', function() {
+      it("prints default message about lack of activation when revision has not been activated", function() {
+        plugin.upload = function() {};
+        plugin.activate = function() {};
+        plugin.beforeHook(context);
+        plugin.configure(context);
+        plugin.beforeHook(context);
+        plugin.didDeploy(context);
+
+        let message = mockUi.messages.join("\n")
+        assert.match(message, new RegExp(`Deployed but did not activate revision ${REVISION_KEY}`));
+        assert.match(message, /To activate, run/);
+        assert.match(message, new RegExp(`ember deploy:activate qa --revision=${REVISION_KEY}`));
+      });
+    });
   });
 });