prevent multiple queued follow-up messages of same type

Author: fquirin

www/scripts/sepiaFW.assistant.js

@@ -247,7 +247,7 @@ function sepiaFW_build_assistant(){
 	 * Wait for the right opportunity (e.g. idle time) and let the assistant say a text
 	 * loaded from server.
 	 */
-	Assistant.waitForOpportunityAndSay = function(dialogTagOrText, fallbackAction, minWait, maxWait){
+	Assistant.waitForOpportunityAndSay = function(dialogTagOrText, fallbackAction, minWait, maxWait, doneCallback){
 		if (!minWait) minWait = 2000;
 		if (!maxWait) maxWait = 30000;
 		if (!dialogTagOrText) dialogTagOrText = "<error_client_control_0a>";
@@ -259,6 +259,7 @@ function sepiaFW_build_assistant(){
 				newReceiver: SepiaFW.assistant.id
 			};
 			SepiaFW.client.sendCommand(dataset, options);
+			if (doneCallback) doneCallback();
 		}, minWait, maxWait, function(){
 			//Fallback, e.g.: SepiaFW.ui.showInfo(SepiaFW.local.g('no_client_support'));
 			if (fallbackAction) fallbackAction();

www/scripts/sepiaFW.client.controls.js

@@ -15,14 +15,36 @@ function sepiaFW_build_client_controls(){
     }
 
     //Wait for opportunity and send a message (e.g. "some text" or "<error_client_control_0a>") and optionally show info fallback.
-    function sendFollowUpMessage(msgOrAnswerTag, info){
+    function sendFollowUpMessage(msgOrAnswerTag, info, deliveredCallback, fallbackCallback, sourceTag, blockIfScheduled){
+        var minWait = 2000;
+        var maxWait = 30000;
+        if (sourceTag && blockIfScheduled){
+            if (followUpsRunning[sourceTag] && (new Date().getTime() - followUpsRunning[sourceTag]) <= maxWait){
+                //block
+                return;
+            }else{
+                //prepare block
+                followUpsRunning[sourceTag] = new Date().getTime();
+            }
+        }
         SepiaFW.assistant.waitForOpportunityAndSay(msgOrAnswerTag, function(){
             //Fallback after max-wait:
             if (info){
                 SepiaFW.ui.showInfo(info);
             }
-        }, 2000, 30000);    //min-wait, max-wait
+            if (fallbackCallback) fallbackCallback();
+            if (sourceTag && blockIfScheduled){
+                delete followUpsRunning[sourceTag];
+            }
+        }, minWait, maxWait, function(){
+            //Done (success):
+            if (deliveredCallback) deliveredCallback();
+            if (sourceTag && blockIfScheduled){
+                delete followUpsRunning[sourceTag];
+            }
+        });    
     }
+    var followUpsRunning = {};
 
     //Open/close settings menu
     Controls.settings = function(controlData){
@@ -145,7 +167,12 @@ function sepiaFW_build_client_controls(){
                 //TODO: we could use a Mesh-Node and the sendMessage API in Windows
                 if (!isInternalPlayerStreaming && !sentAdditionalEvent && !controlData.skipFollowUp){
                     //The user has probably tried to stop an external app but that was not possible
-                    sendFollowUpMessage(SepiaFW.local.g("tried_but_not_sure"), SepiaFW.local.g('result_unclear') + "Media: STOP");     //"<default_under_construction_0b>"
+                    var blockMultiple = true;
+                    var source = "controls.media.stop";
+                    sendFollowUpMessage(
+                        SepiaFW.local.g("tried_but_not_sure"), SepiaFW.local.g('result_unclear') + " Media: STOP", //"<default_under_construction_0b>"
+                        undefined, undefined, source, blockMultiple
+                    );
                 }
 
             //RESUME
@@ -175,7 +202,12 @@ function sepiaFW_build_client_controls(){
                 //TODO: we could use a Mesh-Node and the sendMessage API in Windows
                 if (!isInternalPlayerStreaming && !sentAdditionalEvent && !controlData.skipFollowUp){
                     //The user has probably tried to resume an external app but that was not possible
-                    sendFollowUpMessage(SepiaFW.local.g("tried_but_not_sure"), SepiaFW.local.g('result_unclear') + "Media: RESUME");     //"<default_under_construction_0b>"
+                    var blockMultiple = true;
+                    var source = "controls.media.resume";
+                    sendFollowUpMessage(
+                        SepiaFW.local.g("tried_but_not_sure"), SepiaFW.local.g('result_unclear') + " Media: RESUME", //"<default_under_construction_0b>"
+                        undefined, undefined, source, blockMultiple
+                    );
                 }
 
             //NEXT
@@ -199,19 +231,34 @@ function sepiaFW_build_client_controls(){
 
                     //Out of options ... for now
                     }else if (!controlData.skipFollowUp){
-                        sendFollowUpMessage("<default_under_construction_0b>", SepiaFW.local.g('no_client_support'));
+                        var blockMultiple = true;
+                        var source = "controls.media.next";
+                        sendFollowUpMessage(
+                            "<default_under_construction_0b>", SepiaFW.local.g('no_client_support') + " Media: NEXT",
+                            undefined, undefined, source, blockMultiple
+                        );
                         SepiaFW.debug.error("Client controls - Unsupported action in 'media': " + controlData.action);
                     }
                     //TODO: add iOS and Windows?
                     //TODO: we could use a Mesh-Node and the sendMessage API in Windows
                 });
 
             }else{
-                sendFollowUpMessage("<default_under_construction_0b>", SepiaFW.local.g('no_client_support'));
+                var blockMultiple = true;
+                var source = "controls.media.unsupported";
+                sendFollowUpMessage(
+                    "<default_under_construction_0b>", SepiaFW.local.g('no_client_support') + " Media: " + controlData.action,
+                    undefined, undefined, source, blockMultiple
+                );
                 SepiaFW.debug.error("Client controls - Unsupported action in 'media': " + controlData.action);
             }
         }else{
-            sendFollowUpMessage("<error_client_control_0a>", SepiaFW.local.g('cant_execute'));
+            var blockMultiple = true;
+            var source = "controls.media.error";
+            sendFollowUpMessage(
+                "<error_client_control_0a>", SepiaFW.local.g('cant_execute'),
+                undefined, undefined, source, blockMultiple
+            );
             SepiaFW.debug.error("Client controls - Missing 'controlData' for 'media'!");
         }
     }