Fix T&G issues with updating state rapidly

Author: crokita

lib/js/src/manager/screen/_TextAndGraphicManagerBase.js

@@ -31,7 +31,6 @@
 */
 
 import { _SubManagerBase } from '../_SubManagerBase.js';
-import { _Task } from '../_Task.js';
 import { _TextAndGraphicUpdateOperation } from './_TextAndGraphicUpdateOperation.js';
 import { _TextAndGraphicState } from './_TextAndGraphicState.js';
 
@@ -139,17 +138,6 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
      * @param {function} listener - A function to invoke when the update task is complete once it runs
      */
     _sdlUpdate (supersedePreviousOperations, listener) {
-        if (this._updateOperation !== null && this._updateOperation.getState() === _Task.READY && supersedePreviousOperations) {
-            this._updateOperation.switchStates(_Task.CANCELED);
-            if (typeof this._currentOperationListener === 'function') {
-                this._currentOperationListener(false);
-            }
-        }
-
-        if (this._updateOperation !== null && this._updateOperation.getState() === _Task.IN_PROGRESS && supersedePreviousOperations) {
-            this._updateOperation.switchStates(_Task.CANCELED);
-        }
-
         this._currentOperationListener = listener;
 
         const currentScreenDataUpdateListener = (asyncListener) => {
@@ -158,8 +146,8 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
                     this._currentScreenData = newScreenData;
                     this._updatePendingOperationsWithNewScreenData();
                 }
-            }).catch((err) => {
-                this._resetFieldsToCurrentScreenData();
+            }).catch((errorState) => {
+                this._updatePendingOperationsWithFailedScreenState(errorState);
             });
         };
 
@@ -189,11 +177,27 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
         this._templateConfiguration = this._currentScreenData.getTemplateConfiguration();
     }
 
+    /**
+     * Updates all pending tasks in the queue with the failed screen state
+     * @param {_TextAndGraphicState} errorState - The _TextAndGraphicState when the error occured
+     * @private
+     */
+    _updatePendingOperationsWithFailedScreenState (errorState) {
+        for (const task of this._getTasks()) {
+            if (!(task instanceof _TextAndGraphicUpdateOperation)) {
+                continue;
+            }
+            if (errorState instanceof _TextAndGraphicState) { // check if a _TextAndGraphicState was passed in instead of an error object
+                task._updateTargetStateWithErrorState(errorState);
+            }
+        }
+    }
+
     /**
      * Updates all pending tasks in the queue with the current screen data
      */
     _updatePendingOperationsWithNewScreenData () {
-        for (const task in this._getTasks()) {
+        for (const task of this._getTasks()) {
             if (!(task instanceof _TextAndGraphicUpdateOperation)) {
                 continue;
             }

lib/js/src/manager/screen/_TextAndGraphicUpdateOperation.js

@@ -87,7 +87,7 @@ class _TextAndGraphicUpdateOperation extends _Task {
         this._fullShow = this._assembleLayout(this._fullShow);
 
         if (this._showRpcSupportsTemplateConfiguration()) {
-            this._updateGraphicsAndShow(this._fullShow);
+            await this._updateGraphicsAndShow(this._fullShow);
         } else {
             if (this._shouldUpdateTemplateConfig()) {
                 const success = await this._sendSetDisplayLayoutWithTemplateConfiguration(this._updatedState.getTemplateConfiguration());
@@ -96,9 +96,9 @@ class _TextAndGraphicUpdateOperation extends _Task {
                     this._finishOperation(false);
                     return;
                 }
-                this._updateGraphicsAndShow(this._fullShow);
+                await this._updateGraphicsAndShow(this._fullShow);
             } else {
-                this._updateGraphicsAndShow(this._fullShow);
+                await this._updateGraphicsAndShow(this._fullShow);
             }
         }
     }
@@ -146,7 +146,7 @@ class _TextAndGraphicUpdateOperation extends _Task {
             } else {
                 console.info('Text and Graphic Show failed');
                 this._currentScreenDataUpdateListener(async () => {
-                    throw new Error('Text and Graphic Show failed');
+                    throw this._updatedState; // send the errored state back to the manager
                 });
             }
             return response.getSuccess();
@@ -860,6 +860,59 @@ class _TextAndGraphicUpdateOperation extends _Task {
         }
         this.onFinished();
     }
+
+    /**
+     * Applies changes to the _TextAndGraphicState with that of the error state
+     * @private
+     * @param {_TextAndGraphicState} errorState - The _TextAndGraphicState when the error occured
+     */
+    _updateTargetStateWithErrorState (errorState) {
+        if (errorState.getTextField1() === this._updatedState.getTextField1()) {
+            this._updatedState.setTextField1(this._currentScreenData.getTextField1());
+        }
+        if (errorState.getTextField2() === this._updatedState.getTextField2()) {
+            this._updatedState.setTextField2(this._currentScreenData.getTextField2());
+        }
+        if (errorState.getTextField3() === this._updatedState.getTextField3()) {
+            this._updatedState.setTextField3(this._currentScreenData.getTextField3());
+        }
+        if (errorState.getTextField4() === this._updatedState.getTextField4()) {
+            this._updatedState.setTextField4(this._currentScreenData.getTextField4());
+        }
+        if (errorState.getMediaTrackTextField() === this._updatedState.getMediaTrackTextField()) {
+            this._updatedState.setMediaTrackTextField(this._currentScreenData.getMediaTrackTextField());
+        }
+        if (errorState.getTitle() === this._updatedState.getTitle()) {
+            this._updatedState.setTitle(this._currentScreenData.getTitle());
+        }
+        if ((errorState.getPrimaryGraphic() === null && this._updatedState.getPrimaryGraphic() === null)
+            || (errorState.getPrimaryGraphic() !== null && errorState.getPrimaryGraphic().equals(this._updatedState.getPrimaryGraphic()))) { // for safe null check
+            this._updatedState.setPrimaryGraphic(this._currentScreenData.getPrimaryGraphic());
+        }
+        if ((errorState.getSecondaryGraphic() === null && this._updatedState.getSecondaryGraphic() === null)
+            || (errorState.getSecondaryGraphic() !== null && errorState.getSecondaryGraphic().equals(this._updatedState.getSecondaryGraphic()))) { // for safe null check
+            this._updatedState.setSecondaryGraphic(this._currentScreenData.getSecondaryGraphic());
+        }
+        if (errorState.getTextAlignment() === this._updatedState.getTextAlignment()) {
+            this._updatedState.setTextAlignment(this._currentScreenData.getTextAlignment());
+        }
+        if (errorState.getTextField1Type() === this._updatedState.getTextField1Type()) {
+            this._updatedState.setTextField1Type(this._currentScreenData.getTextField1Type());
+        }
+        if (errorState.getTextField2Type() === this._updatedState.getTextField2Type()) {
+            this._updatedState.setTextField2Type(this._currentScreenData.getTextField2Type());
+        }
+        if (errorState.getTextField3Type() === this._updatedState.getTextField3Type()) {
+            this._updatedState.setTextField3Type(this._currentScreenData.getTextField3Type());
+        }
+        if (errorState.getTextField4Type() === this._updatedState.getTextField4Type()) {
+            this._updatedState.setTextField4Type(this._currentScreenData.getTextField4Type());
+        }
+        if ((errorState.getTemplateConfiguration() === null && this._updatedState.getTemplateConfiguration() === null)
+            || (errorState.getTemplateConfiguration() !== null && errorState.getTemplateConfiguration().getParameters() === this._updatedState.getTemplateConfiguration().getParameters())) { // for safe null check
+            this._updatedState.setTemplateConfiguration(this._currentScreenData.getTemplateConfiguration());
+        }
+    }
 }
 
 export { _TextAndGraphicUpdateOperation };