Merge pull request #10761 from adobe/zaggino/domain-progress

abose · abose · commit 3348ab0a1fee · 2015-06-12T16:13:20.000+05:30
Implement progress callback so node domains are able to notify the Brackets before they finish
diff --git a/src/utils/NodeConnection.js b/src/utils/NodeConnection.js
@@ -486,6 +486,12 @@ define(function (require, exports, module) {
                 delete this._pendingCommandDeferreds[m.message.id];
             }
             break;
+        case "commandProgress":
+            responseDeferred = this._pendingCommandDeferreds[m.message.id];
+            if (responseDeferred) {
+                responseDeferred.notifyWith(this, [m.message.message]);
+            }
+            break;
         case "commandError":
             responseDeferred = this._pendingCommandDeferreds[m.message.id];
             if (responseDeferred) {
diff --git a/test/spec/NodeConnection-test-files/TestCommandsTwo.js b/test/spec/NodeConnection-test-files/TestCommandsTwo.js
@@ -48,6 +48,24 @@
         });
     }
     
+    /**
+     * @private
+     * Handler for test.reverseAsyncWithProgress command. Reverses the specified string
+     * and then returns the result asynconously, but launches progress event before that.
+     * @param {string} s String to reverse.
+     * @param {Function} cb Callback function of the form cb(err, response)
+     * @param {Function} pcb Progress callback function of the form pcb(message)
+     */
+    function cmdTestReverseAsyncWithProgress(s, cb, pcb) {
+        var result = s.split("").reverse().join("");
+        process.nextTick(function () {
+            pcb("progress");
+            process.nextTick(function () {
+                cb(null, result);
+            });
+        });
+    }
+
     /**
      * Initializes the test domain with an additional test command.
      * @param {DomainManager} DomainManager The DomainManager for the server
@@ -66,6 +84,15 @@
             [{name: "s", type: "string"}],
             [{name: "reversedString", type: "string"}]
         );
+        _domainManager.registerCommand(
+            "test",
+            "reverseAsyncWithProgress",
+            cmdTestReverseAsyncWithProgress,
+            true,
+            "reverses the specified string using an async call on the server and calls a progress event before",
+            [{name: "s", type: "string"}],
+            [{name: "reversedString", type: "string"}]
+        );
     }
     
     exports.init = init;
diff --git a/test/spec/NodeConnection-test.js b/test/spec/NodeConnection-test.js
@@ -192,6 +192,42 @@ define(function (require, exports, module) {
             });
         });
         
+        it("should receive progress events from asynchronous commands", function () {
+            var connection = createConnection();
+            var commandDeferred = null;
+            var result = null;
+            var progressMessage = null;
+            runConnectAndWait(connection, false);
+            runLoadDomainsAndWait(connection, ["TestCommandsTwo"], false);
+            runs(function () {
+                commandDeferred = connection.domains.test.reverseAsyncWithProgress("asdf");
+                commandDeferred.progress(function (message) {
+                    progressMessage = message;
+                });
+                commandDeferred.done(function (response) {
+                    result = response;
+                });
+            });
+            waitsFor(
+                function () {
+                    return commandDeferred && progressMessage !== null;
+                },
+                CONNECTION_TIMEOUT
+            );
+            waitsFor(
+                function () {
+                    return commandDeferred &&
+                        commandDeferred.state() === "resolved" &&
+                        result;
+                },
+                CONNECTION_TIMEOUT
+            );
+            runs(function () {
+                expect(progressMessage).toBe("progress");
+                expect(result).toBe("fdsa");
+            });
+        });
+
         it("should receive events", function () {
             var connection = createConnection();
             var spy = jasmine.createSpy();
