LeakDetector.Maui 1.0.4

LeakDetector.Maui

A lightweight memory leak detection library for .NET MAUI applications. Helps identify retained pages, view models, and long-lived objects using WeakReference.

🚀 Installation

dotnet add package LeakDetector.Maui

⚙️ Setup

Register the leak detector in your MAUI app:

builder.Services.AddLeakDetector();

Enable automatic tracking:

App.Current.UseLeakDetector();

📱 How It Works

The library automatically tracks:

• Pages (ContentPage, Shell, etc.)
• ViewModels (BindingContext)
• Object lifetime after navigation

No manual wiring required.

🔍 Example

public partial class MainPage : ContentPage
{
    public MainPage()
    {
        InitializeComponent();
    }
}

👉 Navigate to and from this page multiple times. If it is not garbage collected, it will be reported.

📊 Output

Leak detection results are written to the console:

❌ MainPage [Page] - Alive for 12s
❌ MainViewModel [VM] - Alive for 12s

🧪 Manual Tracking (Optional)

Track custom objects:

public class MyService
{
    public MyService(ILeakDetector detector)
    {
        detector.Track(this, "Service");
    }
}

⚙️ Configuration

builder.Services.AddLeakDetector(options =>
{
    options.EnableAutoTracking = true;
    options.CheckDelay = TimeSpan.FromSeconds(3);
});

🧠 What It Detects

• Pages not released after navigation
• ViewModels retained in memory
• Incorrect DI lifetimes (e.g., Singleton misuse)
• Long-living objects

⚠️ Limitations

• Does not identify exact root cause of leaks
• Does not detect native memory leaks
• For deep analysis, use tools like dotnet-dump

🔧 Recommended Workflow

1. Navigate between pages multiple times
2. Observe console output
3. Identify leaked objects
4. Fix references (events, static fields, DI lifetimes)

🧩 Architecture

• LeakDetector.Core → Core tracking engine
• LeakDetector.Maui → MAUI lifecycle integration

🛠️ Best Practices

• Use in debug/development builds only
• Disable in production environments
• Focus on navigation-heavy pages

📦 Versioning

• 1.0.1 → Initial release

• Upcoming features:

  • UI dashboard
  • Stack trace capture
  • Advanced diagnostics

🤝 Contributing

Contributions are welcome. Feel free to open issues or submit pull requests.

📄 License

MIT License