Microsoft.WinGet.Client custom assembly load context #3150
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // ----------------------------------------------------------------------------- | ||
| // <copyright file="ModuleInit.cs" company="Microsoft Corporation"> | ||
| // Copyright (c) Microsoft Corporation. Licensed under the MIT License. | ||
| // </copyright> | ||
| // ----------------------------------------------------------------------------- | ||
| #if !POWERSHELL_WINDOWS | ||
| namespace Microsoft.WinGet.Client.Acl | ||
| { | ||
| using System.Management.Automation; | ||
| using System.Runtime.Loader; | ||
|
|
||
| /// <summary> | ||
| /// Initialization class for this module. | ||
| /// </summary> | ||
| public class ModuleInit : IModuleAssemblyInitializer, IModuleAssemblyCleanup | ||
| { | ||
| /// <inheritdoc/> | ||
| public void OnImport() | ||
| { | ||
| AssemblyLoadContext.Default.Resolving += WinGetAssemblyLoadContext.ResolvingHandler; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void OnRemove(PSModuleInfo module) | ||
| { | ||
| AssemblyLoadContext.Default.Resolving -= WinGetAssemblyLoadContext.ResolvingHandler; | ||
| } | ||
| } | ||
| } | ||
| #endif | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // ----------------------------------------------------------------------------- | ||
| // <copyright file="WinGetAssemblyLoadContext.cs" company="Microsoft Corporation"> | ||
| // Copyright (c) Microsoft Corporation. Licensed under the MIT License. | ||
| // </copyright> | ||
| // ----------------------------------------------------------------------------- | ||
| #if !POWERSHELL_WINDOWS | ||
| namespace Microsoft.WinGet.Client.Acl | ||
| { | ||
| using System; | ||
| using System.IO; | ||
| using System.Reflection; | ||
| using System.Runtime.Loader; | ||
|
|
||
| /// <summary> | ||
| /// Custom assembly load context for this module. | ||
| /// This helps us load our dependencies without carrying about apps importing this module. | ||
| /// All dependencies except the Engine dll needs to be under a Dependencies directory. | ||
| /// </summary> | ||
| internal class WinGetAssemblyLoadContext : AssemblyLoadContext | ||
| { | ||
| private static readonly string SharedDependencyPath = Path.Combine( | ||
| Path.GetDirectoryName(typeof(WinGetAssemblyLoadContext).Assembly.Location), | ||
| "SharedDependencies"); | ||
|
|
||
| private static readonly string DirectDependencyPath = Path.Combine( | ||
| Path.GetDirectoryName(typeof(WinGetAssemblyLoadContext).Assembly.Location), | ||
|
There was a problem hiding this comment. It looks like you inverted the name suggestions that I used (completely, so functionally it should work). To me, the "shared" dependencies are the ones that might conflict (and so need to load from the ALC |
||
| "DirectDependencies"); | ||
|
|
||
| private static readonly WinGetAssemblyLoadContext WinGetAcl = new (); | ||
|
|
||
| private WinGetAssemblyLoadContext() | ||
| : base("WinGetAssemblyLoadContext", isCollectible: false) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Handler to resolve assemblies. | ||
| /// </summary> | ||
| /// <param name="context">Assembly load context.</param> | ||
| /// <param name="assemblyName">Assembly name.</param> | ||
| /// <returns>The assembly, null if not in our assembly location.</returns> | ||
| internal static Assembly ResolvingHandler(AssemblyLoadContext context, AssemblyName assemblyName) | ||
| { | ||
| string path = $"{Path.Combine(DirectDependencyPath, assemblyName.Name)}.dll"; | ||
| if (File.Exists(path)) | ||
| { | ||
| return WinGetAcl.LoadFromAssemblyName(assemblyName); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| protected override Assembly Load(AssemblyName assemblyName) | ||
| { | ||
| string path = $"{Path.Combine(SharedDependencyPath, assemblyName.Name)}.dll"; | ||
| if (File.Exists(path)) | ||
| { | ||
| return this.LoadFromAssemblyPath(path); | ||
| } | ||
|
|
||
| path = $"{Path.Combine(DirectDependencyPath, assemblyName.Name)}.dll"; | ||
| if (File.Exists(path)) | ||
| { | ||
| return this.LoadFromAssemblyPath(path); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| protected override IntPtr LoadUnmanagedDll(string unmanagedDllName) | ||
| { | ||
| string path = Path.Combine(SharedDependencyPath, unmanagedDllName); | ||
| if (File.Exists(path)) | ||
| { | ||
| return this.LoadUnmanagedDllFromPath(path); | ||
| } | ||
|
|
||
| return IntPtr.Zero; | ||
| } | ||
| } | ||
| } | ||
| #endif | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why aren't we able to create our own context and only use it when the assembly load is coming from this PS module?
My main worry is that if we change the default context, then we end up in a similar situation as without it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that my overall comment has more understanding than this one I made before reading the docs.