Ensure that Microsoft.TeamFoundation assemblies are loaded consistently

jcansdale · jcansdale · commit 18dd2f38c975 · 2017-05-02T15:32:06.000+01:00
Added a workaround related to #923 that gives our resolver a chance to run first. Be more specific about which assemblies might be resolved (include PublicKeyToken). They must start with "Microsoft.TeamFoundation." and end with ", PublicKeyToken=b03f5f7f11d50a3a".
diff --git a/src/GitHub.VisualStudio/TeamFoundation/TeamFoundationResolver.cs b/src/GitHub.VisualStudio/TeamFoundation/TeamFoundationResolver.cs
@@ -11,7 +11,8 @@ namespace GitHub.TeamFoundation
     public class TeamFoundationResolver : IDisposable
     {
         const string BindingPath = @"CommonExtensions\Microsoft\TeamFoundation\Team Explorer";
-        const string AssemblyPrefix = "Microsoft.TeamFoundation.";
+        const string AssemblyStartsWith = "Microsoft.TeamFoundation.";
+        const string AssemblyEndsWith = ", PublicKeyToken=b03f5f7f11d50a3a";
 
         internal static Type Resolve(Func<Type> func)
         {
@@ -31,7 +32,34 @@ internal static object Resolve(Func<object> func)
 
         internal TeamFoundationResolver()
         {
-            AppDomain.CurrentDomain.AssemblyResolve += CurrentDomain_AssemblyResolve;
+            TryAddPriorityAssemblyResolve(AppDomain.CurrentDomain, CurrentDomain_AssemblyResolve);
+        }
+
+        // NOTE: This is a workaround for https://github.com/github/VisualStudio/issues/923#issuecomment-287537118
+        // A consistent repro was to open Vsiaul Studio 2015 by double clicking on GitHubVS.sln.
+        // The `Microsoft.TeamFoundation.Controls.dll` assembly referenced by this solution would
+        // be copied to and loaded from the following location:
+        // C:\Users\<user>\AppData\Local\Microsoft\VisualStudio\14.0\ProjectAssemblies\ffp8wnnz01\Microsoft.TeamFoundation.Controls.dll
+        //
+        // This method ensures that our resolver has a chance to resolve it first.
+        static void TryAddPriorityAssemblyResolve(AppDomain domain, ResolveEventHandler handler)
+        {
+            try
+            {
+                var resolveField = typeof(AppDomain).GetField("_AssemblyResolve", BindingFlags.NonPublic | BindingFlags.Instance);
+                var assemblyResolve = (ResolveEventHandler)resolveField.GetValue(domain);
+                if (assemblyResolve != null)
+                {
+                    handler = (ResolveEventHandler)Delegate.Combine(handler, assemblyResolve);
+                }
+
+                resolveField.SetValue(domain, handler);
+            }
+            catch (Exception e)
+            {
+                Trace.WriteLine("Couldn't add priority AssemblyResolve handler (adding normal handler): " + e);
+                domain.AssemblyResolve += handler;
+            }
         }
 
         public void Dispose()
@@ -44,19 +72,19 @@ Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEventArgs args)
             try
             {
                 var name = args.Name;
-                if (name.StartsWith(AssemblyPrefix))
+                if (name.StartsWith(AssemblyStartsWith) && name.EndsWith(AssemblyEndsWith))
                 {
                     var assemblyName = new AssemblyName(name);
                     var path = GetTeamExplorerPath(assemblyName.Name);
-                    if(File.Exists(path))
+                    if (File.Exists(path))
                     {
                         return Assembly.LoadFrom(path);
                     }
                 }
             }
             catch (Exception e)
             {
-                Trace.WriteLine(e);
+                Trace.WriteLine("Couldn't resolve TeamFoundation assembly: " + e);
             }
 
             return null;

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ namespace GitHub.TeamFoundation`
`11`	`11`	`public class TeamFoundationResolver : IDisposable`
`12`	`12`	`{`
`13`	`13`	`const string BindingPath = @"CommonExtensions\Microsoft\TeamFoundation\Team Explorer";`
`14`		`- const string AssemblyPrefix = "Microsoft.TeamFoundation.";`
	`14`	`+ const string AssemblyStartsWith = "Microsoft.TeamFoundation.";`
	`15`	`+ const string AssemblyEndsWith = ", PublicKeyToken=b03f5f7f11d50a3a";`
`15`	`16`
`16`	`17`	`internal static Type Resolve(Func<Type> func)`
`17`	`18`	`{`
`@@ -31,7 +32,34 @@ internal static object Resolve(Func<object> func)`
`31`	`32`
`32`	`33`	`internal TeamFoundationResolver()`
`33`	`34`	`{`
`34`		`- AppDomain.CurrentDomain.AssemblyResolve += CurrentDomain_AssemblyResolve;`
	`35`	`+ TryAddPriorityAssemblyResolve(AppDomain.CurrentDomain, CurrentDomain_AssemblyResolve);`
	`36`	`+ }`
	`37`	`+`
	`38`	`+ // NOTE: This is a workaround for https://github.com/github/VisualStudio/issues/923#issuecomment-287537118`
	`39`	`+ // A consistent repro was to open Vsiaul Studio 2015 by double clicking on GitHubVS.sln.`
	`40`	+ // The `Microsoft.TeamFoundation.Controls.dll` assembly referenced by this solution would
	`41`	`+ // be copied to and loaded from the following location:`
	`42`	`+ // C:\Users\<user>\AppData\Local\Microsoft\VisualStudio\14.0\ProjectAssemblies\ffp8wnnz01\Microsoft.TeamFoundation.Controls.dll`
	`43`	`+ //`
	`44`	`+ // This method ensures that our resolver has a chance to resolve it first.`
	`45`	`+ static void TryAddPriorityAssemblyResolve(AppDomain domain, ResolveEventHandler handler)`
	`46`	`+ {`
	`47`	`+ try`
	`48`	`+ {`
	`49`	`+ var resolveField = typeof(AppDomain).GetField("_AssemblyResolve", BindingFlags.NonPublic \| BindingFlags.Instance);`
	`50`	`+ var assemblyResolve = (ResolveEventHandler)resolveField.GetValue(domain);`
	`51`	`+ if (assemblyResolve != null)`
	`52`	`+ {`
	`53`	`+ handler = (ResolveEventHandler)Delegate.Combine(handler, assemblyResolve);`
	`54`	`+ }`
	`55`	`+`
	`56`	`+ resolveField.SetValue(domain, handler);`
	`57`	`+ }`
	`58`	`+ catch (Exception e)`
	`59`	`+ {`
	`60`	`+ Trace.WriteLine("Couldn't add priority AssemblyResolve handler (adding normal handler): " + e);`
	`61`	`+ domain.AssemblyResolve += handler;`
	`62`	`+ }`
`35`	`63`	`}`
`36`	`64`
`37`	`65`	`public void Dispose()`
`@@ -44,19 +72,19 @@ Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEventArgs args)`
`44`	`72`	`try`
`45`	`73`	`{`
`46`	`74`	`var name = args.Name;`
`47`		`- if (name.StartsWith(AssemblyPrefix))`
	`75`	`+ if (name.StartsWith(AssemblyStartsWith) && name.EndsWith(AssemblyEndsWith))`
`48`	`76`	`{`
`49`	`77`	`var assemblyName = new AssemblyName(name);`
`50`	`78`	`var path = GetTeamExplorerPath(assemblyName.Name);`
`51`		`- if(File.Exists(path))`
	`79`	`+ if (File.Exists(path))`
`52`	`80`	`{`
`53`	`81`	`return Assembly.LoadFrom(path);`
`54`	`82`	`}`
`55`	`83`	`}`
`56`	`84`	`}`
`57`	`85`	`catch (Exception e)`
`58`	`86`	`{`
`59`		`- Trace.WriteLine(e);`
	`87`	`+ Trace.WriteLine("Couldn't resolve TeamFoundation assembly: " + e);`
`60`	`88`	`}`
`61`	`89`
`62`	`90`	`return null;`