Skip to content

Refactor WebAssemblyHotReload to use the agent code from the SDK #32496

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.

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 1 commit into from
May 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Reflection;
using System.Reflection.Metadata;
using Microsoft.AspNetCore.Components.HotReload;

[assembly: AssemblyMetadata("ReceiveHotReloadDeltaNotification", "Microsoft.AspNetCore.Components.HotReload.HotReloadManager")]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unused. This was stop-gap until dotnet-watch was updated to support MetadataUpdateHandlerAttribute

[assembly: MetadataUpdateHandler(typeof(HotReloadManager))]

namespace Microsoft.AspNetCore.Components.HotReload
Expand All @@ -20,6 +18,6 @@ public static void DeltaApplied()
OnDeltaApplied?.Invoke();
}

public static void AfterUpdate(Type[]? _) => OnDeltaApplied?.Invoke();
public static void UpdateApplication(Type[]? _) => OnDeltaApplied?.Invoke();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

// Based on the implementation in https://raw.githubusercontent.com/dotnet/sdk/f67f46eba6d3bcf2b3054381851a975096652454/src/BuiltInTools/DotNetDeltaApplier/HotReloadAgent.cs

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;

namespace Microsoft.Extensions.HotReload
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty identical to the code in https://raw.githubusercontent.com/dotnet/sdk/f67f46eba6d3bcf2b3054381851a975096652454/src/BuiltInTools/DotNetDeltaApplier/HotReloadAgent.cs. There's some usings that are different. Also it no longer supports the BeforeUpdate and AfterUpdate methods that dotnet-watch temporarily supports.

{
internal sealed class HotReloadAgent : IDisposable
{
private readonly Action<string> _log;
private readonly AssemblyLoadEventHandler _assemblyLoad;
private readonly ConcurrentDictionary<Guid, IReadOnlyList<UpdateDelta>> _deltas = new();
private readonly ConcurrentDictionary<Assembly, Assembly> _appliedAssemblies = new();
private volatile UpdateHandlerActions? _handlerActions;

public HotReloadAgent(Action<string> log)
{
_log = log;
_assemblyLoad = OnAssemblyLoad;
AppDomain.CurrentDomain.AssemblyLoad += _assemblyLoad;
}

private void OnAssemblyLoad(object? _, AssemblyLoadEventArgs eventArgs)
{
_handlerActions = null;
var loadedAssembly = eventArgs.LoadedAssembly;
var moduleId = loadedAssembly.Modules.FirstOrDefault()?.ModuleVersionId;
if (moduleId is null)
{
return;
}

if (_deltas.TryGetValue(moduleId.Value, out var updateDeltas) && _appliedAssemblies.TryAdd(loadedAssembly, loadedAssembly))
{
// A delta for this specific Module exists and we haven't called ApplyUpdate on this instance of Assembly as yet.
ApplyDeltas(updateDeltas);
}
}

internal sealed class UpdateHandlerActions
{
public List<Action<Type[]?>> ClearCache { get; } = new();
public List<Action<Type[]?>> UpdateApplication { get; } = new();
}

private UpdateHandlerActions GetMetadataUpdateHandlerActions()
{
// We need to execute MetadataUpdateHandlers in a well-defined order. For v1, the strategy that is used is to topologically
// sort assemblies so that handlers in a dependency are executed before the dependent (e.g. the reflection cache action
// in System.Private.CoreLib is executed before System.Text.Json clears it's own cache.)
// This would ensure that caches and updates more lower in the application stack are up to date
// before ones higher in the stack are recomputed.
var sortedAssemblies = TopologicalSort(AppDomain.CurrentDomain.GetAssemblies());
var handlerActions = new UpdateHandlerActions();
foreach (var assembly in sortedAssemblies)
{
foreach (var attr in assembly.GetCustomAttributesData())
{
// Look up the attribute by name rather than by type. This would allow netstandard targeting libraries to
// define their own copy without having to cross-compile.
if (attr.AttributeType.FullName != "System.Reflection.Metadata.MetadataUpdateHandlerAttribute")
{
continue;
}

IList<CustomAttributeTypedArgument> ctorArgs = attr.ConstructorArguments;
if (ctorArgs.Count != 1 ||
ctorArgs[0].Value is not Type handlerType)
{
_log($"'{attr}' found with invalid arguments.");
continue;
}

GetHandlerActions(handlerActions, handlerType);
}
}

return handlerActions;
}

internal void GetHandlerActions(UpdateHandlerActions handlerActions, Type handlerType)
{
bool methodFound = false;

if (GetUpdateMethod(handlerType, "ClearCache") is MethodInfo clearCache)
{
handlerActions.ClearCache.Add(CreateAction(clearCache));
methodFound = true;
}

if (GetUpdateMethod(handlerType, "UpdateApplication") is MethodInfo updateApplication)
{
handlerActions.UpdateApplication.Add(CreateAction(updateApplication));
methodFound = true;
}

if (!methodFound)
{
_log($"No invokable methods found on metadata handler type '{handlerType}'. " +
$"Allowed methods are ClearCache, UpdateApplication");
}

Action<Type[]?> CreateAction(MethodInfo update)
{
Action<Type[]?> action = update.CreateDelegate<Action<Type[]?>>();
return types =>
{
try
{
action(types);
}
catch (Exception ex)
{
_log($"Exception from '{action}': {ex}");
}
};
}

MethodInfo? GetUpdateMethod(Type handlerType, string name)
{
if (handlerType.GetMethod(name, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static, new[] { typeof(Type[]) }) is MethodInfo updateMethod &&
updateMethod.ReturnType == typeof(void))
{
return updateMethod;
}

foreach (MethodInfo method in handlerType.GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance))
{
if (method.Name == name)
{
_log($"Type '{handlerType}' has method '{method}' that does not match the required signature.");
break;
}
}

return null;
}
}

internal static List<Assembly> TopologicalSort(Assembly[] assemblies)
{
var sortedAssemblies = new List<Assembly>(assemblies.Length);

var visited = new HashSet<string>(StringComparer.Ordinal);

foreach (var assembly in assemblies)
{
Visit(assemblies, assembly, sortedAssemblies, visited);
}

static void Visit(Assembly[] assemblies, Assembly assembly, List<Assembly> sortedAssemblies, HashSet<string> visited)
{
var assemblyIdentifier = assembly.GetName().Name!;
if (!visited.Add(assemblyIdentifier))
{
return;
}

foreach (var dependencyName in assembly.GetReferencedAssemblies())
{
var dependency = Array.Find(assemblies, a => a.GetName().Name == dependencyName.Name);
if (dependency is not null)
{
Visit(assemblies, dependency, sortedAssemblies, visited);
}
}

sortedAssemblies.Add(assembly);
}

return sortedAssemblies;
}

public void ApplyDeltas(IReadOnlyList<UpdateDelta> deltas)
{
try
{
// Defer discovering the receiving deltas until the first hot reload delta.
// This should give enough opportunity for AppDomain.GetAssemblies() to be sufficiently populated.
_handlerActions ??= GetMetadataUpdateHandlerActions();
var handlerActions = _handlerActions;

// TODO: Get types to pass in
Type[]? updatedTypes = null;

for (var i = 0; i < deltas.Count; i++)
{
var item = deltas[i];
var assembly = AppDomain.CurrentDomain.GetAssemblies().FirstOrDefault(a => a.Modules.FirstOrDefault() is Module m && m.ModuleVersionId == item.ModuleId);
if (assembly is not null)
{
System.Reflection.Metadata.AssemblyExtensions.ApplyUpdate(assembly, item.MetadataDelta, item.ILDelta, ReadOnlySpan<byte>.Empty);
}
}

handlerActions.ClearCache.ForEach(a => a(updatedTypes));
handlerActions.UpdateApplication.ForEach(a => a(updatedTypes));

_log("Deltas applied.");
}
catch (Exception ex)
{
_log(ex.ToString());
}
}

public void Dispose()
{
AppDomain.CurrentDomain.AssemblyLoad -= _assemblyLoad;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;

namespace Microsoft.Extensions.HotReload
{
internal sealed class UpdateDelta
{
public Guid ModuleId { get; set; }

public byte[] MetadataDelta { get; set; } = default!;

public byte[] ILDelta { get; set; } = default!;
}
}
Loading