Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The AsyncLazy<T> does not release resources closed over by the factory delegate #256

Open
theodorzoulias opened this issue Jun 13, 2022 · 5 comments · May be fixed by #269
Open

The AsyncLazy<T> does not release resources closed over by the factory delegate #256

theodorzoulias opened this issue Jun 13, 2022 · 5 comments · May be fixed by #269

Comments

@theodorzoulias
Copy link

theodorzoulias commented Jun 13, 2022 •
edited
Loading

Description

Hi! I am reporting an issue that I discovered after reading a comment by Servy here. In case the factory delegate of an AsyncLazy<T> instance closes over some expensive resource, this resource will not be eligible for garbage collection after the completion of the delegate.

Reproduction Steps

public static async Task Main()
{
    Console.WriteLine($"TotalMemory: {GC.GetTotalMemory(true):#,0} bytes");
    var lazy = new Nito.AsyncEx.AsyncLazy<int>(GetFunction());
    Console.WriteLine($"AsyncLazy result: {await lazy:#,0}");
    await Task.Yield();
    GC.Collect();
    Console.WriteLine($"TotalMemory: {GC.GetTotalMemory(true):#,0} bytes");
    GC.KeepAlive(lazy);

    static Func<Task<int>> GetFunction()
    {
        byte[] bytes = new byte[20_000_000];
        return new Func<Task<int>>(async () =>
        {
            await Task.Delay(200);
            return bytes.Length;
        });
    }
}

Output:

TotalMemory: 86,192 bytes
AsyncLazy result: 20,000,000
TotalMemory: 20,133,704 bytes

Online demo.

Expected behavior

The GC.GetTotalMemory() after awaiting the AsyncLazy<T> should be roughly the same as before.

Actual behavior

The GC.GetTotalMemory() after awaiting the AsyncLazy<T> is around 20 MB more than before.

Configuration

  • .NET 6.0
  • Nito.AsyncEx 5.1.2
  • Console application
  • Release built

Other information

After switching to a simpler AsyncLazy<T> implementation like the one below, the problem is not reproduced:

private class AsyncLazySimple<T>
{
    private readonly Lazy<Task<T>> _lazyTask;
    public AsyncLazySimple(Func<Task<T>> factory) => _lazyTask = new(() => factory());
    public Task<T> Task => _lazyTask.Value;
    public TaskAwaiter<T> GetAwaiter() => Task.GetAwaiter();
}

Output:

TotalMemory: 86,192 bytes
AsyncLazy result: 20,000,000
TotalMemory: 133,728 bytes
@DaveVdE
Copy link

DaveVdE commented Dec 8, 2022

Does this reproduce the problem?

public static async Task Main()
{
    Console.WriteLine($"TotalMemory: {GC.GetTotalMemory(true):#,0} bytes");
    var lazy = new Nito.AsyncEx.AsyncLazy<int>(GetFunction);
    Console.WriteLine($"AsyncLazy result: {await lazy:#,0}");
    await Task.Yield();
    GC.Collect();
    Console.WriteLine($"TotalMemory: {GC.GetTotalMemory(true):#,0} bytes");
    GC.KeepAlive(lazy);

    static Task<int> GetFunction()
    {
        byte[] bytes = new byte[20_000_000];
        await Task.Delay(200);
        return bytes.Length;
    }
}

@theodorzoulias
Copy link
Author

@DaveVdE no, it doesn't. The new byte[20_000_000] in your example is not captured by a lambda, like in my example. Btw the GetFunction() in your example returns a Task, not a Func, so it's not properly named. It is also missing the async keyword.

@DaveVdE
Copy link

DaveVdE commented Jan 12, 2023

Sure, it's missing the async keyword, and I didn't change the name.

Oh I see, your point is that the function passed to the AsyncLazy constructor should be forgotten after the task has been complete.

@theodorzoulias
Copy link
Author

@DaveVdE yep, as it does the native Lazy<T> class.

@timcassell timcassell linked a pull request Jan 14, 2023 that will close this issue
Open
@timcassell
Copy link

I sent a fix #269.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Release the AsyncLazy delegate when the result has been obtained. timcassell/AsyncEx
3 participants
@DaveVdE @timcassell @theodorzoulias