DUI3-448 both model card types need 2 clicks to actually cancel 1 to …

…stop operation and 1 to refresh progress bar (#3538) * Do not send any progress update if cancelled * Use cts instead ct --------- Co-authored-by: KatKatKateryna <[email protected]>
specklesystems · Jun 28, 2024 · cbe19c7 · cbe19c7
1 parent 0568a29
commit cbe19c7
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 44 deletions.
diff --git a/DUI3-DX/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISReceiveBinding.cs b/DUI3-DX/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISReceiveBinding.cs
@@ -58,7 +58,8 @@ public async Task Receive(string modelCardId)
           modelCard.ModelName.NotNull(),
           modelCard.SelectedVersionId.NotNull(),
           cts.Token,
-          (status, progress) => OnSendOperationProgress(modelCardId, status, progress)
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts)
         )
         .ConfigureAwait(false);
 
@@ -77,10 +78,5 @@ public async Task Receive(string modelCardId)
     }
   }
 
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
-
   public void CancelReceive(string modelCardId) => _cancellationManager.CancelOperation(modelCardId);
 }
diff --git a/DUI3-DX/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISSendBinding.cs b/DUI3-DX/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISSendBinding.cs
@@ -350,7 +350,8 @@ public async Task Send(string modelCardId)
             .Execute(
               mapMembers,
               sendInfo,
-              (status, progress) => OnSendOperationProgress(modelCardId, status, progress),
+              (status, progress) =>
+                Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts),
               cts.Token
             )
             .ConfigureAwait(false);
@@ -407,9 +408,4 @@ private void RunExpirationChecks(bool idsDeleted)
     Commands.SetModelsExpired(expiredSenderIds);
     ChangedObjectIds = new HashSet<string>();
   }
-
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
 }
diff --git a/...-DX/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadReceiveBinding.cs b/...-DX/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadReceiveBinding.cs
@@ -65,7 +65,8 @@ public async Task Receive(string modelCardId)
           modelCard.ModelName.NotNull(),
           modelCard.SelectedVersionId.NotNull(),
           cts.Token,
-          onOperationProgressed: (status, progress) => OnSendOperationProgress(modelCardId, status, progress)
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts)
         )
         .ConfigureAwait(false);
 
@@ -83,9 +84,4 @@ public async Task Receive(string modelCardId)
       Application.DocumentManager.DocumentActivationEnabled = true;
     }
   }
-
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
 }
diff --git a/DUI3-DX/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadSendBinding.cs b/DUI3-DX/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadSendBinding.cs
@@ -167,7 +167,8 @@ private async Task SendInternal(string modelCardId)
         .Execute(
           autocadObjects,
           sendInfo,
-          (status, progress) => OnSendOperationProgress(modelCardId, status, progress),
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts),
           cts.Token
         )
         .ConfigureAwait(false);
@@ -191,10 +192,5 @@ private async Task SendInternal(string modelCardId)
     }
   }
 
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
-
   public void CancelSend(string modelCardId) => _cancellationManager.CancelOperation(modelCardId);
 }
diff --git a/DUI3-DX/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/RevitSendBinding.cs b/DUI3-DX/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/RevitSendBinding.cs
@@ -112,7 +112,8 @@ public async Task Send(string modelCardId)
         .Execute(
           revitObjects,
           sendInfo,
-          (status, progress) => OnSendOperationProgress(modelCardId, status, progress),
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts),
           cts.Token
         )
         .ConfigureAwait(false);
@@ -130,11 +131,6 @@ public async Task Send(string modelCardId)
     }
   }
 
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
-
   /// <summary>
   /// Keeps track of the changed element ids as well as checks if any of them need to trigger
   /// a filter refresh (e.g., views being added).

diff --git a/DUI3-DX/Connectors/Rhino/Speckle.Connectors.Rhino7/Bindings/RhinoReceiveBinding.cs b/DUI3-DX/Connectors/Rhino/Speckle.Connectors.Rhino7/Bindings/RhinoReceiveBinding.cs
@@ -60,7 +60,8 @@ public async Task Receive(string modelCardId)
           modelCard.ModelName.NotNull(),
           modelCard.SelectedVersionId.NotNull(),
           cts.Token,
-          (status, progress) => OnSendOperationProgress(modelCardId, status, progress)
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts)
         )
         .ConfigureAwait(false);
 
@@ -79,10 +80,5 @@ public async Task Receive(string modelCardId)
     }
   }
 
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
-
   public void CancelSend(string modelCardId) => _cancellationManager.CancelOperation(modelCardId);
 }
diff --git a/DUI3-DX/Connectors/Rhino/Speckle.Connectors.Rhino7/Bindings/RhinoSendBinding.cs b/DUI3-DX/Connectors/Rhino/Speckle.Connectors.Rhino7/Bindings/RhinoSendBinding.cs
@@ -174,7 +174,8 @@ public async Task Send(string modelCardId)
         .Execute(
           rhinoObjects,
           sendInfo,
-          (status, progress) => OnSendOperationProgress(modelCardId, status, progress),
+          (status, progress) =>
+            Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress), cts),
           cts.Token
         )
         .ConfigureAwait(false);
@@ -193,11 +194,6 @@ public async Task Send(string modelCardId)
     }
   }
 
-  private void OnSendOperationProgress(string modelCardId, string status, double? progress)
-  {
-    Commands.SetModelProgress(modelCardId, new ModelCardProgress(modelCardId, status, progress));
-  }
-
   public void CancelSend(string modelCardId) => _cancellationManager.CancelOperation(modelCardId);
 
   /// <summary>

diff --git a/DUI3-DX/DUI3/Speckle.Connectors.DUI/Bindings/IBasicConnectorBinding.cs b/DUI3-DX/DUI3/Speckle.Connectors.DUI/Bindings/IBasicConnectorBinding.cs
@@ -75,8 +75,16 @@ public void SetGlobalNotification(ToastNotificationType type, string title, stri
       }
     );
 
-  public void SetModelProgress(string modelCardId, ModelCardProgress progress) =>
-    Bridge.Send(SET_MODEL_PROGRESS_UI_COMMAND_NAME, new { modelCardId, progress });
+  public void SetModelProgress(string modelCardId, ModelCardProgress progress, CancellationTokenSource cts)
+  {
+    // NOTE: To prevent potential race condition
+    // After cancelling operation some parts could still send last progress update which was set progress on UI
+    // after it forced to be undefined. This is the safest way to prevent any case like this.
+    if (!cts.IsCancellationRequested)
+    {
+      Bridge.Send(SET_MODEL_PROGRESS_UI_COMMAND_NAME, new { modelCardId, progress });
+    }
+  }
 
   public void SetModelError(string modelCardId, Exception error) =>
     Bridge.Send(SET_MODEL_ERROR_UI_COMMAND_NAME, new { modelCardId, error = error.Message });