Merge pull request #1105 from fabulous-dev/improve-disposable

Ensure old widgets are disposed when replaced by new ones

Author: TimLariviere

CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 _No unreleased changes_
 
+## [3.0.0-pre23] - 2025-06-05
+
+### Changed
+- Ensure old widgets are disposed when replaced by new ones by @TimLariviere in https://github.com/fabulous-dev/Fabulous/pull/1105
+
 ## [3.0.0-pre22] - 2025-05-18
 
 ### Changed
@@ -233,7 +238,8 @@ _No unreleased changes_
 ### Changed
 - Fabulous.XamarinForms & Fabulous.MauiControls have been moved been out of the Fabulous repository. Find them in their own repositories: [https://github.com/fabulous-dev/Fabulous.XamarinForms](https://github.com/fabulous-dev/Fabulous.XamarinForms) / [https://github.com/fabulous-dev/Fabulous.MauiControls](https://github.com/fabulous-dev/Fabulous.MauiControls)
 
-[unreleased]: https://github.com/fabulous-dev/Fabulous/compare/3.0.0-pre22...HEAD
+[unreleased]: https://github.com/fabulous-dev/Fabulous/compare/3.0.0-pre23...HEAD
+[3.0.0-pre23]: https://github.com/fabulous-dev/Fabulous/releases/tag/3.0.0-pre23
 [3.0.0-pre22]: https://github.com/fabulous-dev/Fabulous/releases/tag/3.0.0-pre22
 [3.0.0-pre21]: https://github.com/fabulous-dev/Fabulous/releases/tag/3.0.0-pre21
 [3.0.0-pre20]: https://github.com/fabulous-dev/Fabulous/releases/tag/3.0.0-pre20

src/Fabulous/Attributes.fs

@@ -193,12 +193,19 @@ module Attributes =
 
             childNode.ApplyDiff(&diff)
 
-        let updateNode _ (newValueOpt: Widget voption) (node: IViewNode) =
+        let updateNode (oldValueOpt: Widget voption) (newValueOpt: Widget voption) (node: IViewNode) =
+            if oldValueOpt.IsSome then
+                // Dispose the existing child if it exists
+                let childView = get node.Target
+
+                if not(isNull childView) then
+                    let childNode = node.TreeContext.GetViewNode(childView)
+                    childNode.Dispose()
+
             match newValueOpt with
             | ValueNone -> set node.Target null
             | ValueSome widget ->
                 let struct (_, view) = Helpers.createViewForWidget node widget
-
                 set node.Target (unbox view)
 
         defineWidget name applyDiff updateNode
@@ -255,8 +262,21 @@ module Attributes =
 
                 | _ -> ()
 
-        let updateNode _ (newValueOpt: ArraySlice<Widget> voption) (node: IViewNode) =
+        let updateNode (oldValueOpt: ArraySlice<Widget> voption) (newValueOpt: ArraySlice<Widget> voption) (node: IViewNode) =
             let targetColl = getCollection node.Target
+
+            if oldValueOpt.IsSome then
+                // Dispose the existing children if they exist
+                let oldWidgets = oldValueOpt.Value
+                let span = ArraySlice.toSpan oldWidgets
+
+                for index = 0 to span.Length do
+                    let childView = box targetColl[index]
+
+                    if not(isNull childView) then
+                        let childNode = node.TreeContext.GetViewNode(childView)
+                        childNode.Dispose()
+
             targetColl.Clear()
 
             match newValueOpt with

src/Fabulous/ViewNode.fs

@@ -81,12 +81,16 @@ type ViewNode =
     member inline private this.ApplyWidgetDiffs(diffs: WidgetChanges inref) =
         for diff in diffs do
             match diff with
-            | WidgetChange.Added newWidget
-            | WidgetChange.ReplacedBy newWidget ->
+            | WidgetChange.Added newWidget ->
                 let definition = (AttributeDefinitionStore.getWidget newWidget.Key)
 
                 definition.UpdateNode ValueNone (ValueSome newWidget.Value) (this :> IViewNode)
 
+            | WidgetChange.ReplacedBy(oldWidget, newWidget) ->
+                let definition = (AttributeDefinitionStore.getWidget newWidget.Key)
+
+                definition.UpdateNode (ValueSome oldWidget.Value) (ValueSome newWidget.Value) (this :> IViewNode)
+
             | WidgetChange.Removed removed ->
                 let definition = (AttributeDefinitionStore.getWidget removed.Key)
 

src/Fabulous/WidgetDiff.fs

@@ -83,7 +83,7 @@ and [<Struct; RequireQualifiedAccess>] WidgetChange =
     | Added of widget: WidgetAttribute
     | Removed of widget: WidgetAttribute
     | Updated of widget: WidgetAttribute * diff: WidgetDiff // updated * diff
-    | ReplacedBy of widget: WidgetAttribute
+    | ReplacedBy of oldWidget: WidgetAttribute * newWidget: WidgetAttribute
 
 and [<Struct; RequireQualifiedAccess>] WidgetCollectionChange =
     | Added of attr: WidgetCollectionAttribute
@@ -395,7 +395,7 @@ and [<Struct; IsByRefLike>] WidgetChangesEnumerator
 
                                         WidgetChange.Updated(nextAttr, diff)
                                     else
-                                        WidgetChange.ReplacedBy nextAttr
+                                        WidgetChange.ReplacedBy(prevAttr, nextAttr)
 
                                 e.current <- change
                                 res <- ValueSome true