GPII-4218: Add an event relay for changeSettingsReceived messages.

Currently we do not provide any special handling for these messags other 
than relaying into an event. However, this is a rough in implementation 
in case we require to wait for or in some other way respond to these 
confirmations.

Author: jobara

src/js/background/wsConnector.js

@@ -52,7 +52,8 @@ fluid.defaults("gpii.wsConnector", {
         onConnect: null,
         onConnectionSucceeded: null,
         onError: null,
-        onSettingsChange: null
+        onSettingsChange: null,
+        onSettingsReceived: null
     },
     listeners: {
         "onCreate.connect": "{wsConnector}.connect",
@@ -80,8 +81,11 @@ gpii.wsConnector.messageHandler = function (that, ev) {
         }
     } else if (msg.type === "onSettingsChanged") {
         that.events.onSettingsChange.fire(msg.payload ? msg.payload : undefined);
+    } else if (msg.type === "changeSettingsReceived") {
+        // confirms that settings sent back across the socket have been received by the server
+        that.events.onSettingsReceived.fire(msg.payload);
     } else {
-        fluid.log("Unrecognized event/message");
+        fluid.log("Unrecognized event/message", msg);
     }
 };
 

tests/node/wsConnectorTests.js

@@ -66,6 +66,10 @@ fluid.defaults("gpii.chrome.tests.wsConnector.server", {
         allowClient: {
             funcName: "gpii.chrome.tests.wsConnector.server.allowClient",
             args: ["{that}", "{arguments}.0"]
+        },
+        broadcastMessage: {
+            funcName: "gpii.chrome.tests.wsConnector.server.broadcastMessage",
+            args: ["{that}", "{arguments}.0", "{arguments}.1"]
         }
     },
     listeners: {
@@ -81,8 +85,8 @@ fluid.defaults("gpii.chrome.tests.wsConnector.server", {
     },
     modelListeners: {
         "settings": {
-            funcName: "gpii.chrome.tests.wsConnector.server.broadcastSettings",
-            args: ["{that}", "{change}.value"],
+            func: "{that}.broadcastMessage",
+            args: ["onSettingsChanged", "{change}.value"],
             namespace: "broadcastSettings",
             excludeSource: ["init"]
         }
@@ -136,9 +140,9 @@ gpii.chrome.tests.wsConnector.server.setupClient = function (that, client) {
     client.on("message", that.events.onMessage.fire);
 };
 
-gpii.chrome.tests.wsConnector.server.broadcastSettings = function (that, settings) {
+gpii.chrome.tests.wsConnector.server.broadcastMessage = function (that, type, settings) {
     var msg = {
-        type: "onSettingsChanged",
+        type: type,
         payload: settings
     };
     if (that.model.clientSocket) {
@@ -287,6 +291,17 @@ fluid.defaults("gpii.chrome.tests.wsConnector.tester", {
                 listener: "gpii.chrome.tests.wsConnector.checkSettings",
                 args: ["{arguments}.0"]
             }]
+        }, {
+            name: "Server sends changeSettingsReceived message",
+            expect: 1,
+            sequence: [{
+                func: "{server}.broadcastMessage",
+                args: ["changeSettingsReceived", "{that}.options.payloads.test1.settings"]
+            }, {
+                event: "{clientOne}.events.onSettingsReceived",
+                listener: "gpii.chrome.tests.wsConnector.checkSettings",
+                args: ["{arguments}.0", "{that}.options.payloads.test1.settings"]
+            }]
         }, {
             name: "Server disconnects client, client reconnects",
             expect: 2,