Leak tests suite

.github/workflows/leak-tests.yml

@@ -0,0 +1,36 @@
+name: Leak Tests
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+    - master
+    - release/*
+  pull_request:
+    branches:
+    - master
+    - release/*
+
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_CLI_TELEMETRY_OPTOUT: 1
+
+jobs:
+  leak-tests:
+    name: Leak Tests (Release)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        global-json-file: global.json
+    - name: Install workloads
+      run: dotnet workload install wasm-tools wasm-experimental
+    - name: Run Dock.Avalonia leak tests
+      run: dotnet test -c Release tests/Dock.Avalonia.LeakTests/Dock.Avalonia.LeakTests.csproj
+    - name: Run Dock.Model.Mvvm leak tests
+      run: dotnet test -c Release tests/Dock.Model.Mvvm.LeakTests/Dock.Model.Mvvm.LeakTests.csproj
+    - name: Run Dock.Model.ReactiveUI leak tests
+      run: dotnet test -c Release tests/Dock.Model.ReactiveUI.LeakTests/Dock.Model.ReactiveUI.LeakTests.csproj

Dock.slnx

@@ -99,6 +99,7 @@
   </Folder>
   <Folder Name="/tests/">
     <Project Path="tests/Dock.Avalonia.Diagnostics.UnitTests/Dock.Avalonia.Diagnostics.UnitTests.csproj" />
+    <Project Path="tests/Dock.Avalonia.LeakTests/Dock.Avalonia.LeakTests.csproj" />
     <Project Path="tests/Dock.Avalonia.HeadlessTests/Dock.Avalonia.HeadlessTests.csproj" />
     <Project Path="tests/Dock.Avalonia.Themes.UnitTests/Dock.Avalonia.Themes.UnitTests.csproj" />
     <Project Path="tests/Dock.Avalonia.UnitTests/Dock.Avalonia.UnitTests.csproj" />
@@ -107,9 +108,11 @@
     <Project Path="tests/Dock.MarkupExtension.UnitTests/Dock.MarkupExtension.UnitTests.csproj" />
     <Project Path="tests/Dock.Model.Avalonia.UnitTests/Dock.Model.Avalonia.UnitTests.csproj" />
     <Project Path="tests/Dock.Model.CaliburMicro.UnitTests/Dock.Model.CaliburMicro.UnitTests.csproj" />
+    <Project Path="tests/Dock.Model.Mvvm.LeakTests/Dock.Model.Mvvm.LeakTests.csproj" />
     <Project Path="tests/Dock.Model.Mvvm.UnitTests/Dock.Model.Mvvm.UnitTests.csproj" />
     <Project Path="tests/Dock.Model.Prism.UnitTests/Dock.Model.Prism.UnitTests.csproj" />
     <Project Path="tests/Dock.Model.ReactiveProperty.UnitTests/Dock.Model.ReactiveProperty.UnitTests.csproj" />
+    <Project Path="tests/Dock.Model.ReactiveUI.LeakTests/Dock.Model.ReactiveUI.LeakTests.csproj" />
     <Project Path="tests/Dock.Model.ReactiveUI.UnitTests/Dock.Model.ReactiveUI.UnitTests.csproj" />
     <Project Path="tests/Dock.Model.UnitTests/Dock.Model.UnitTests.csproj" />
     <Project Path="tests/Dock.Serializer.UnitTests/Dock.Serializer.UnitTests.csproj" />

samples/DockFigmaSample/Views/Documents/DesignCanvasView.axaml

@@ -34,8 +34,11 @@
 
         <Grid Grid.Row="1" ColumnDefinitions="2*,*" ColumnSpacing="32">
           <StackPanel Spacing="16">
-            <TextBlock Text="Design tools with
-real-time momentum" Classes="hero-title" />
+            <TextBlock Classes="hero-title">
+              <Run Text="Design tools with" />
+              <LineBreak />
+              <Run Text="real-time momentum" />
+            </TextBlock>
             <TextBlock Text="Build interactive flows faster with components, tokens, and smart docking." Classes="hero-body" />
             <StackPanel Orientation="Horizontal" Spacing="12">
               <Border Background="{DynamicResource AccentBrush}" CornerRadius="14" Padding="16,10">
@@ -85,7 +88,11 @@ real-time momentum" Classes="hero-title" />
             Padding="10,6"
             CornerRadius="12"
             Background="{DynamicResource CanvasOverlayBrush}">
-      <TextBlock Text="{Binding FrameName}  |  {Binding FrameSize}" Classes="muted" />
+      <TextBlock Classes="muted">
+        <Run Text="{Binding FrameName}" />
+        <Run Text="  |  " />
+        <Run Text="{Binding FrameSize}" />
+      </TextBlock>
     </Border>
   </Grid>
 </UserControl>

samples/DockReactiveUIWindowRelationsSample/Views/MainView.axaml

@@ -15,15 +15,16 @@
   <DockPanel>
     <StackPanel DockPanel.Dock="Top" Orientation="Horizontal" Margin="8" Spacing="8">
       <Button Content="Reset Layout" Command="{Binding ResetLayout}" />
-      <StackPanel DataContext="{Binding Layout}" Orientation="Horizontal" Spacing="8" x:DataType="dmc:IRootDock">
-        <Button Content="Show Windows" Command="{Binding ShowWindows}" />
-        <Button Content="Exit Windows" Command="{Binding ExitWindows}" />
+      <StackPanel DataContext="{Binding Layout}">
+        <StackPanel Orientation="Horizontal" Spacing="8" x:DataType="dmc:IRootDock">
+          <Button Content="Show Windows" Command="{Binding ShowWindows}" />
+          <Button Content="Exit Windows" Command="{Binding ExitWindows}" />
+        </StackPanel>
       </StackPanel>
     </StackPanel>
     <DockControl Layout="{Binding Layout}" Margin="8" />
-    <Border DockPanel.Dock="Bottom" Padding="8" Background="#1F000000">
-      <TextBlock DataContext="{Binding Layout}"
-                 Text="{Binding FocusedDockable, FallbackValue=''}"
+    <Border DockPanel.Dock="Bottom" Padding="8" Background="#1F000000" DataContext="{Binding Layout}">
+      <TextBlock Text="{Binding FocusedDockable, FallbackValue=''}"
                  x:DataType="dm:IDock" />
     </Border>
   </DockPanel>

src/Dock.Avalonia.Themes.Fluent/Controls/HostWindow.axaml

@@ -53,7 +53,7 @@
 
     <Setter Property="Content" Value="{Binding}" />
     <Setter Property="ContentTemplate">
-      <DataTemplate>
+      <DataTemplate x:DataType="controls:IRootDock">
         <Panel Margin="{Binding $parent[HostWindow].OffScreenMargin}">
           <Panel Margin="{Binding $parent[HostWindow].WindowDecorationMargin}">
             <OverlayHost VisualTreeLifecycleBehavior.IsEnabled="True">
@@ -107,7 +107,7 @@
 
       <Setter Property="Content" Value="{Binding}" />
       <Setter Property="ContentTemplate">
-        <DataTemplate>
+        <DataTemplate x:DataType="controls:IRootDock">
           <Panel Margin="{Binding $parent[HostWindow].OffScreenMargin}">
             <OverlayHost VisualTreeLifecycleBehavior.IsEnabled="True">
               <DockControl Layout="{Binding}" />

src/Dock.Avalonia/Controls/DockControl.axaml.cs

@@ -3,11 +3,8 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Runtime.CompilerServices;
 using Avalonia;
 using Avalonia.Controls;
-using Avalonia.Controls.Recycling;
-using Avalonia.Controls.Recycling.Model;
 using Avalonia.Controls.Metadata;
 using Avalonia.Controls.Primitives;
 using Avalonia.Controls.Templates;
@@ -21,6 +18,7 @@
 using Dock.Avalonia.Diagnostics;
 using Dock.Avalonia.Internal;
 using Dock.Avalonia.Selectors;
+using Dock.Avalonia.Services;
 using Dock.Model;
 using Dock.Model.Controls;
 using Dock.Model.Core;
@@ -38,10 +36,10 @@ namespace Dock.Avalonia.Controls;
 [TemplatePart("PART_ManagedWindowLayer", typeof(ManagedWindowLayer))]
 public class DockControl : TemplatedControl, IDockControl, IDockSelectorService
 {
-    private static readonly ConditionalWeakTable<IFactory, IControlRecycling> s_controlRecycling = new();
     private readonly DockManagerOptions _dockManagerOptions;
     private readonly DockManager _dockManager;
     private readonly DockControlState _dockControlState;
+    private readonly IDockControlFactoryService _factoryService;
     private bool _isInitialized;
     private ContentControl? _contentControl;
     private ManagedWindowLayer? _managedWindowLayer;
@@ -238,6 +236,7 @@ public DockControl()
         _dockManagerOptions = new DockManagerOptions();
         _dockManager = new DockManager(new DockService(), _dockManagerOptions);
         _dockControlState = new DockControlState(_dockManager, _dragOffsetCalculator);
+        _factoryService = new DockControlFactoryService();
         AddHandler(PointerPressedEvent, PressedHandler, RoutingStrategies.Direct | RoutingStrategies.Tunnel | RoutingStrategies.Bubble);
         AddHandler(PointerReleasedEvent, ReleasedHandler, RoutingStrategies.Direct | RoutingStrategies.Tunnel | RoutingStrategies.Bubble);
         AddHandler(PointerMovedEvent, MovedHandler, RoutingStrategies.Direct | RoutingStrategies.Tunnel | RoutingStrategies.Bubble);
@@ -259,7 +258,7 @@ protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
         _selectorOverlay = e.NameScope.Find<DockSelectorOverlay>("PART_SelectorOverlay");
         _managedWindowLayer = e.NameScope.Find<ManagedWindowLayer>("PART_ManagedWindowLayer");
 
-        InitializeControlRecycling();
+        _factoryService.InitializeControlRecycling(this);
 
         if (_contentControl is not null)
         {
@@ -270,57 +269,6 @@ protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
         InitializeCommandBars();
     }
 
-    private void InitializeControlRecycling()
-    {
-        if (Layout?.Factory is not { } factory)
-        {
-            return;
-        }
-
-        var controlRecycling = ControlRecyclingDataTemplate.GetControlRecycling(this);
-        if (controlRecycling is null)
-        {
-            return;
-        }
-
-        if (s_controlRecycling.TryGetValue(factory, out var shared))
-        {
-            if (ReferenceEquals(shared, controlRecycling))
-            {
-                return;
-            }
-
-            if (shared is ControlRecycling sharedRecycling && controlRecycling is ControlRecycling localRecycling)
-            {
-                if (sharedRecycling.TryToUseIdAsKey != localRecycling.TryToUseIdAsKey)
-                {
-                    sharedRecycling.TryToUseIdAsKey = localRecycling.TryToUseIdAsKey;
-                }
-
-                ControlRecyclingDataTemplate.SetControlRecycling(this, sharedRecycling);
-                return;
-            }
-
-            if (controlRecycling is ControlRecycling)
-            {
-                ControlRecyclingDataTemplate.SetControlRecycling(this, shared);
-            }
-
-            return;
-        }
-
-        if (controlRecycling is ControlRecycling defaultRecycling)
-        {
-            controlRecycling = new ControlRecycling
-            {
-                TryToUseIdAsKey = defaultRecycling.TryToUseIdAsKey
-            };
-            ControlRecyclingDataTemplate.SetControlRecycling(this, controlRecycling);
-        }
-
-        s_controlRecycling.Add(factory, controlRecycling);
-    }
-
     private void InitializeDefaultDataTemplates()
     {
         if (_contentControl?.DataTemplates is null)
@@ -386,38 +334,30 @@ private void Initialize(IDock? layout)
 
         layout.Factory.DockControls.Add(this);
 
-        InitializeControlRecycling();
+        _factoryService.InitializeControlRecycling(this);
         UpdateManagedWindowLayer(layout);
 
         if (InitializeFactory)
         {
             layout.Factory.ContextLocator ??= new Dictionary<string, Func<object?>>();
             layout.Factory.DockableLocator ??= new Dictionary<string, Func<IDockable?>>();
-            layout.Factory.DefaultContextLocator ??= GetContext;
-            layout.Factory.DefaultHostWindowLocator ??= GetHostWindow;
+            if (layout.Factory.DefaultContextLocator is null)
+            {
+                layout.Factory.DefaultContextLocator = ResolveDefaultContext;
+            }
 
-            if (layout.Factory.HostWindowLocator is null)
+            if (layout.Factory.DefaultHostWindowLocator is null)
             {
-                layout.Factory.HostWindowLocator = new Dictionary<string, Func<IHostWindow?>>
-                {
-                    [nameof(IDockWindow)] = GetHostWindow
-                };
+                layout.Factory.DefaultHostWindowLocator = ResolveDefaultHostWindow;
             }
 
-            IHostWindow GetHostWindow()
+            if (layout.Factory.HostWindowLocator is null)
             {
-                if (HostWindowFactory is { } factory)
+                layout.Factory.HostWindowLocator = new Dictionary<string, Func<IHostWindow?>>
                 {
-                    return factory();
-                }
-
-                var hostMode = DockSettings.ResolveFloatingWindowHostMode(layout as IRootDock);
-                return hostMode == DockFloatingWindowHostMode.Managed
-                    ? new ManagedHostWindow(_dockManagerOptions)
-                    : new HostWindow(_dockManagerOptions);
+                    [nameof(IDockWindow)] = ResolveDefaultHostWindow
+                };
             }
-
-            object? GetContext() => DefaultContext;
         }
 
         if (InitializeLayout)
@@ -446,6 +386,11 @@ private void DeInitialize(IDock? layout)
 
         layout.Factory.DockControls.Remove(this);
 
+        _activationOrder.Clear();
+        _activationCounter = 0;
+
+        _factoryService.CleanupFactory(this, layout);
+
         if (InitializeLayout)
         {
             if (layout.Close.CanExecute(null))
@@ -477,6 +422,21 @@ private void InitializeCommandBars()
         }
     }
 
+    internal object? ResolveDefaultContext() => DefaultContext;
+
+    internal IHostWindow? ResolveDefaultHostWindow()
+    {
+        if (HostWindowFactory is { } factory)
+        {
+            return factory();
+        }
+
+        var hostMode = DockSettings.ResolveFloatingWindowHostMode(Layout as IRootDock);
+        return hostMode == DockFloatingWindowHostMode.Managed
+            ? new ManagedHostWindow(_dockManagerOptions)
+            : new HostWindow(_dockManagerOptions);
+    }
+
     private void AttachFactoryEvents(IFactory? factory)
     {
         if (ReferenceEquals(_subscribedFactory, factory))

src/Dock.Avalonia/Controls/ManagedWindowLayer.cs

@@ -9,6 +9,7 @@
 using Avalonia.Controls.Metadata;
 using Avalonia.Controls.Primitives;
 using Avalonia.VisualTree;
+using Dock.Avalonia.Internal;
 using Dock.Avalonia.Mdi;
 using Dock.Model.Controls;
 using Dock.Model.Core;
@@ -78,6 +79,19 @@ protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs chang
         }
     }
 
+    /// <inheritdoc />
+    protected override void OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs e)
+    {
+        base.OnDetachedFromVisualTree(e);
+
+        DetachDock();
+
+        if (Dock?.Factory is { } factory)
+        {
+            ManagedWindowRegistry.UnregisterLayer(factory, this);
+        }
+    }
+
     /// <summary>
     /// Attempts to locate the managed window layer for a visual.
     /// </summary>