Skip to content

Resolve change token leak in Blazor hot reload #53750

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

Merged
merged 6 commits into from
Feb 1, 2024
Merged

Resolve change token leak in Blazor hot reload #53750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2e5813c
Dispose of ChangeToken
captainsafia Jan 31, 2024
361b308
Attempted fix of razor hotreload leak. This disposes the
jacdavis Jan 31, 2024
6e30d43
Remove unused disposable method from endpoint data source
jacdavis Jan 31, 2024
4deaf27
Switch to using the ClearCache event from
jacdavis Jan 31, 2024
18a67ac
Make the disposable change token thread-safe
jacdavis Feb 1, 2024
974f85e
PR feedback
jacdavis Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/Components/Endpoints/src/Builder/RazorComponentEndpointDataSource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ internal class RazorComponentEndpointDataSource<[DynamicallyAccessedMembers(Comp
private List<Endpoint>? _endpoints;
private CancellationTokenSource _cancellationTokenSource;
private IChangeToken _changeToken;
private IDisposable? _disposable; // THREADING: protected by _lock

// Internal for testing.
internal ComponentApplicationBuilder Builder => _builder;
Expand All @@ -45,6 +46,7 @@ public RazorComponentEndpointDataSource(
_renderModeEndpointProviders = renderModeEndpointProviders.ToArray();
_factory = factory;
_hotReloadService = hotReloadService;
HotReloadService.ClearCacheEvent += OnHotReloadClearCache;
DefaultBuilder = new RazorComponentsEndpointConventionBuilder(
_lock,
builder,
Expand Down Expand Up @@ -139,12 +141,23 @@ private void UpdateEndpoints()
_cancellationTokenSource = new CancellationTokenSource();
_changeToken = new CancellationChangeToken(_cancellationTokenSource.Token);
oldCancellationTokenSource?.Cancel();
oldCancellationTokenSource?.Dispose();
if (_hotReloadService is { MetadataUpdateSupported : true })
{
ChangeToken.OnChange(_hotReloadService.GetChangeToken, UpdateEndpoints);
_disposable?.Dispose();
_disposable = ChangeToken.OnChange(_hotReloadService.GetChangeToken, UpdateEndpoints);
}
}
}

public void OnHotReloadClearCache(Type[]? types)
{
lock (_lock)
{
_disposable?.Dispose();
_disposable = null;
}
}

public override IChangeToken GetChangeToken()
{
Expand Down
7 changes: 7 additions & 0 deletions src/Components/Endpoints/src/DependencyInjection/HotReloadService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public HotReloadService()

private CancellationTokenSource _tokenSource = new();
private static event Action<Type[]?>? UpdateApplicationEvent;
internal static event Action<Type[]?>? ClearCacheEvent;

public bool MetadataUpdateSupported { get; internal set; }

Expand All @@ -27,11 +28,17 @@ public static void UpdateApplication(Type[]? changedTypes)
{
UpdateApplicationEvent?.Invoke(changedTypes);
}

public static void ClearCache(Type[]? types)
{
ClearCacheEvent?.Invoke(types);
}

private void NotifyUpdateApplication(Type[]? changedTypes)
{
var current = Interlocked.Exchange(ref _tokenSource, new CancellationTokenSource());
current.Cancel();
current.Dispose();
}

public void Dispose()
Expand Down