UnGAC MSBuild Assemblies on Install or Update #5626
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,29 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <!-- Setup runs on net45 and may not have installed newer yet. --> | ||
| <TargetFramework>net45</TargetFramework> | ||
|
Contributor
There was a problem hiding this comment. Does that mean it doesn't work on mac/linux? Is there a way we can make it work on mac/linux?
Member
There was a problem hiding this comment. The GAC is a thing only on .NET Framework (on Windows). Things do not break because of the GAC on Mac/Linux, because there's no GAC. |
||
| <!-- Set as an exe because this project publishes its own output. --> | ||
| <OutputType>Exe</OutputType> | ||
| <!-- Forcing the 'vsix' output to be json output. Workaround for https://github.com/dotnet/arcade/issues/6120 --> | ||
| <TargetVsixContainerName>Microsoft.Build.UnGAC.exe</TargetVsixContainerName> | ||
| <!-- VS Insertion --> | ||
| <VisualStudioInsertionComponent>Microsoft.Build.UnGAC</VisualStudioInsertionComponent> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <_SwixArgs Include="PackageType=manifest"/> | ||
| <!-- If we don't set TargetExt to .json, arcade defaults to generating a .vsix --> | ||
| <_SwixArgs Include="TargetExt=.json"/> | ||
| </ItemGroup> | ||
|
|
||
| <!-- SwrProperty is an arcade concept. --> | ||
| <ItemGroup> | ||
| <!-- BinDir is set via SwrProperty to be passed to the swr compiler. OutDir is the path to the bin folder. See exe.swr to see how this is used. --> | ||
| <SwrProperty Include="BinDir=$(OutDir)" /> | ||
| <!-- Version must constantly update in order for our exe package to run on install and update. --> | ||
| <SwrProperty Include="Version=$(VsixVersion)" /> | ||
|
|
||
| <!-- our swr file must be picked up, this is how we set that. --> | ||
| <SwrFile Include="exe.swr" Condition=" '$(MSBuildRuntimeType)' == 'Full' " /> | ||
| </ItemGroup> | ||
| </Project> | ||
This file contains hidden or 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,22 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| namespace Microsoft.Build.UnGAC | ||
| { | ||
| // See: https://docs.microsoft.com/en-us/dotnet/framework/unmanaged-api/fusion/iassemblycache-interface | ||
| [ComImport, Guid("E707DCDE-D1CD-11D2-BAB9-00C04F8ECEAE"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] | ||
| internal interface IAssemblyCache | ||
| { | ||
| [PreserveSig] | ||
| uint UninstallAssembly(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pszAssemblyName, IntPtr pRefData, ref ulong pulDisposition); | ||
| } | ||
|
|
||
| public static class NativeMethods | ||
| { | ||
| [DllImport("fusion.dll")] | ||
| internal static extern uint CreateAssemblyCache(out IAssemblyCache ppAsmCache, int dwReserved); | ||
| } | ||
| } |
This file contains hidden or 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,53 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System; | ||
|
|
||
| namespace Microsoft.Build.UnGAC | ||
| { | ||
| /// <summary> | ||
| /// Original Issue: https://github.com/dotnet/msbuild/issues/5183 | ||
| /// This tool was created to help prevent customers from putting MSBuild assemblies in the Global Assembly Cache. | ||
| /// It runs at VS install-time as well as repair-time. | ||
| /// It is intended to run as best effort. Meaning that if it fails, we avoid throwing and instead log it. | ||
| /// </summary> | ||
| class Program | ||
|
|
||
| { | ||
| static void Main(string[] args) | ||
| { | ||
| try | ||
| { | ||
| string[] assembliesToUnGAC = | ||
| { | ||
| "Microsoft.Build, Version=15.1.0.0", | ||
|
Contributor
There was a problem hiding this comment. Are these the only versions people GAC?
Member
There was a problem hiding this comment. They're the only versions that we use, so they're the only ones that need to be removed from the GAC. Prior to VS 15, our assemblies were GACed by design; after they're not and they're all |
||
| "Microsoft.Build.Engine, Version=15.1.0.0", | ||
| "Microsoft.Build.Framework, Version=15.1.0.0", | ||
| "Microsoft.Build.Tasks.Core, Version=15.1.0.0", | ||
| "Microsoft.Build.Utilities.Core, Version=15.1.0.0", | ||
| "Microsoft.Build.Conversion.Core, Version=15.1.0.0" | ||
| }; | ||
|
|
||
| uint hresult = NativeMethods.CreateAssemblyCache(out IAssemblyCache assemblyCache, 0); | ||
|
|
||
| // Most significant bit is set, meaning there was an error in the Hresult. | ||
| if ((hresult >> 31) == 1) | ||
| { | ||
| Console.WriteLine($"Could not successfully call CreateAssemblyCache. HResult: {hresult}"); | ||
|
benvillalobos marked this conversation as resolved.
|
||
| Console.WriteLine("Exiting without removing assemblies from the GAC..."); | ||
| return; | ||
| } | ||
|
|
||
| foreach (string assembly in assembliesToUnGAC) | ||
| { | ||
| hresult = assemblyCache.UninstallAssembly(dwFlags: 0, pszAssemblyName: assembly, pRefData: IntPtr.Zero, pulDisposition: 0); | ||
|
|
||
| Console.WriteLine($"Tried to remove {assembly} from the GAC. HResult: 0x{hresult:X8}"); | ||
| } | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Console.WriteLine($"Caught an exception! We don't want to throw because we want MSBuild to install.\n" + e.ToString()); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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,19 @@ | ||
| use vs | ||
|
|
||
| package name=Microsoft.Build.UnGAC | ||
| version=$(Version) | ||
| vs.package.type=exe | ||
| vs.package.chip=neutral | ||
| vs.package.language=neutral | ||
|
|
||
| vs.installCommand fileName=[Payload] | ||
|
|
||
| vs.repairCommand fileName=[Payload] | ||
|
|
||
| vs.installSize | ||
| SystemDrive=0 | ||
| TargetDrive=0 | ||
| SharedDrive=0 | ||
|
|
||
| vs.payloads | ||
| vs.payload source=$(BinDir)Microsoft.Build.UnGAC.exe |
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.
I'm a little confused by this; do we not need to sign DevDivPackages*.nupkg anymore?
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.
We didn't sign it in the first place; this line was just in error.