Only allow methods on classes as opposed to anonymous lambdas for Eve…

…nt Subscription (#512) * This is a workaround for Revit's order of operations when initializing * Fix event listening * Only allow methods on classes as opposed to anonymous lambdas * formatting * fix tests * weakreference found should remove subscription
specklesystems · Jan 22, 2025 · 9846817 · 9846817
1 parent c9ca1c0
commit 9846817
Show file tree

Hide file tree

Showing 25 changed files with 316 additions and 350 deletions.
diff --git a/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISSendBinding.cs b/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/ArcGISSendBinding.cs
@@ -90,14 +90,11 @@ ITopLevelExceptionHandler topLevelExceptionHandler
     Parent = parent;
     Commands = new SendBindingUICommands(parent);
     SubscribeToArcGISEvents();
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(_ =>
-      {
-        _sendConversionCache.ClearCache();
-      });
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
   }
 
+  private void OnDocumentStoreChangedEvent(object _) => _sendConversionCache.ClearCache();
+
   private void SubscribeToArcGISEvents()
   {
     LayersRemovedEvent.Subscribe(

diff --git a/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/BasicConnectorBinding.cs b/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Bindings/BasicConnectorBinding.cs
@@ -34,11 +34,11 @@ IEventAggregator eventAggregator
     Parent = parent;
     Commands = new BasicConnectorBindingCommands(parent);
 
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(async _ => await Commands.NotifyDocumentChanged().ConfigureAwait(false));
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
   }
 
+  private async Task OnDocumentStoreChangedEvent(object _) => await Commands.NotifyDocumentChanged();
+
   public string GetSourceApplicationName() => _speckleApplication.Slug;
 
   public string GetSourceApplicationVersion() => _speckleApplication.HostApplicationVersion;

diff --git a/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Utils/ArcGisDocumentStore.cs b/Connectors/ArcGIS/Speckle.Connectors.ArcGIS3/Utils/ArcGisDocumentStore.cs
@@ -51,7 +51,7 @@ public override async Task OnDocumentStoreInitialized()
     {
       IsDocumentInit = true;
       LoadState();
-      await _eventAggregator.GetEvent<DocumentChangedEvent>().PublishAsync(new object());
+      await _eventAggregator.GetEvent<DocumentStoreChangedEvent>().PublishAsync(new object());
     }
   }
 
@@ -85,7 +85,7 @@ private async void OnMapViewChanged(ActiveMapViewChangedEventArgs args)
 
     IsDocumentInit = true;
     LoadState();
-    await _eventAggregator.GetEvent<DocumentChangedEvent>().PublishAsync(new object());
+    await _eventAggregator.GetEvent<DocumentStoreChangedEvent>().PublishAsync(new object());
   }
 
   protected override void HostAppSaveState(string modelCardState) =>

diff --git a/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadBasicConnectorBinding.cs b/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadBasicConnectorBinding.cs
@@ -41,16 +41,13 @@ IThreadContext threadContext
     _accountManager = accountManager;
     _speckleApplication = speckleApplication;
     Commands = new BasicConnectorBindingCommands(parent);
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(async _ =>
-      {
-        await Commands.NotifyDocumentChanged();
-      });
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
     _logger = logger;
     _threadContext = threadContext;
   }
 
+  private async Task OnDocumentStoreChangedEvent(object _) => await Commands.NotifyDocumentChanged();
+
   public string GetConnectorVersion() => _speckleApplication.SpeckleVersion;
 
   public string GetSourceApplicationName() => _speckleApplication.Slug;

diff --git a/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadSendBaseBinding.cs b/Connectors/Autocad/Speckle.Connectors.AutocadShared/Bindings/AutocadSendBaseBinding.cs
@@ -90,9 +90,11 @@ IEventAggregator eventAggregator
     }
     // Since ids of the objects generates from same seed, we should clear the cache always whenever doc swapped.
 
-    eventAggregator.GetEvent<DocumentChangedEvent>().Subscribe(_ => _sendConversionCache.ClearCache());
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
   }
 
+  private void OnDocumentStoreChangedEvent(object _) => _sendConversionCache.ClearCache();
+
   private readonly List<string> _docSubsTracker = new();
 
   private void SubscribeToObjectChanges(Document doc)

diff --git a/Connectors/Autocad/Speckle.Connectors.AutocadShared/HostApp/AutocadDocumentModelStore.cs b/Connectors/Autocad/Speckle.Connectors.AutocadShared/HostApp/AutocadDocumentModelStore.cs
@@ -52,7 +52,7 @@ private async void OnDocChangeInternal(Document? doc)
 
     _previousDocName = currentDocName;
     LoadState();
-    await _eventAggregator.GetEvent<DocumentChangedEvent>().PublishAsync(new object());
+    await _eventAggregator.GetEvent<DocumentStoreChangedEvent>().PublishAsync(new object());
   }
 
   protected override void LoadState()

diff --git a/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/BasicConnectorBindingRevit.cs b/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/BasicConnectorBindingRevit.cs
@@ -38,15 +38,11 @@ IEventAggregator eventAggregator
     _speckleApplication = speckleApplication;
     Commands = new BasicConnectorBindingCommands(parent);
 
-    // POC: event binding?
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(async _ =>
-      {
-        await Commands.NotifyDocumentChanged();
-      });
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
   }
 
+  private async Task OnDocumentStoreChangedEvent(object _) => await Commands.NotifyDocumentChanged();
+
   public string GetConnectorVersion() => _speckleApplication.SpeckleVersion;
 
   public string GetSourceApplicationName() => _speckleApplication.Slug;

diff --git a/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/RevitSendBinding.cs b/Connectors/Revit/Speckle.Connectors.RevitShared/Bindings/RevitSendBinding.cs
@@ -83,14 +83,11 @@ ITopLevelExceptionHandler topLevelExceptionHandler
 
     revitContext.UIApplication.NotNull().Application.DocumentChanged += (_, e) =>
       topLevelExceptionHandler.CatchUnhandled(() => DocChangeHandler(e));
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(async _ =>
-      {
-        await OnDocumentChanged().ConfigureAwait(false);
-      });
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
   }
 
+  private async Task OnDocumentStoreChangedEvent(object _) => await Commands.NotifyDocumentChanged();
+
   public List<ISendFilter> GetSendFilters() =>
     [
       new RevitSelectionFilter() { IsDefault = true },

diff --git a/Connectors/Revit/Speckle.Connectors.RevitShared/HostApp/RevitDocumentStore.cs b/Connectors/Revit/Speckle.Connectors.RevitShared/HostApp/RevitDocumentStore.cs
@@ -56,7 +56,7 @@ ITopLevelExceptionHandler topLevelExceptionHandler
   }
 
   public override Task OnDocumentStoreInitialized() =>
-    _eventAggregator.GetEvent<DocumentChangedEvent>().PublishAsync(new object());
+    _eventAggregator.GetEvent<DocumentStoreChangedEvent>().PublishAsync(new object());
 
   /// <summary>
   /// This is the place where we track document switch for new document -> Responsible to Read from new doc
@@ -80,7 +80,7 @@ private void OnViewActivated(object? _, ViewActivatedEventArgs e)
       async () =>
       {
         LoadState();
-        await _eventAggregator.GetEvent<DocumentChangedEvent>().PublishAsync(new object());
+        await _eventAggregator.GetEvent<DocumentStoreChangedEvent>().PublishAsync(new object());
       }
     );
   }

diff --git a/Connectors/Rhino/Speckle.Connectors.RhinoShared/Bindings/RhinoBasicConnectorBinding.cs b/Connectors/Rhino/Speckle.Connectors.RhinoShared/Bindings/RhinoBasicConnectorBinding.cs
@@ -37,14 +37,14 @@ IEventAggregator eventAggregator
     _speckleApplication = speckleApplication;
     Commands = new BasicConnectorBindingCommands(parent);
 
-    eventAggregator
-      .GetEvent<DocumentChangedEvent>()
-      .Subscribe(async _ =>
-      {
-        await Commands.NotifyDocumentChanged();
-        // Note: this prevents scaling issues when copy-pasting from one rhino doc to another in the same session.
-        _sendConversionCache.ClearCache();
-      });
+    eventAggregator.GetEvent<DocumentStoreChangedEvent>().Subscribe(OnDocumentStoreChangedEvent);
+  }
+
+  private async Task OnDocumentStoreChangedEvent(object _)
+  {
+    await Commands.NotifyDocumentChanged();
+    // Note: this prevents scaling issues when copy-pasting from one rhino doc to another in the same session.
+    _sendConversionCache.ClearCache();
   }
 
   public string GetConnectorVersion() => _speckleApplication.SpeckleVersion;

diff --git a/Connectors/Rhino/Speckle.Connectors.RhinoShared/Bindings/RhinoSelectionBinding.cs b/Connectors/Rhino/Speckle.Connectors.RhinoShared/Bindings/RhinoSelectionBinding.cs
@@ -25,9 +25,9 @@ public RhinoSelectionBinding(IBrowserBridge parent, IEventAggregator eventAggreg
   }
 
   private void OnSelectionChange(EventArgs eventArgs) =>
-    _eventAggregator.GetEvent<IdleEvent>().OneTimeSubscribe(nameof(RhinoSelectionBinding), _ => UpdateSelection());
+    _eventAggregator.GetEvent<IdleEvent>().OneTimeSubscribe(nameof(RhinoSelectionBinding), UpdateSelection);
 
-  private void UpdateSelection()
+  private void UpdateSelection(object _)
   {
     SelectionInfo selInfo = GetSelection();
     Parent.Send(SELECTION_EVENT, selInfo);