Merge pull request #1651 from github/fixes/1620-disable-in-blend

Disable MEF services that are derived from VS services when executing in Blend

Author: jcansdale

src/GitHub.Exports/Exports/ExportForProcess.cs renamed to src/GitHub.Exports/Exports/ExportForProcessAttribute.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.ComponentModel.Composition;
 
 namespace GitHub.Exports
@@ -11,24 +12,32 @@ namespace GitHub.Exports
     /// This attribute is used to mark exports that mustn't be loaded into Blend.
     /// See: https://github.com/github/VisualStudio/pull/1055
     /// </remarks>
+    [SuppressMessage("Microsoft.Performance", "CA1813:AvoidUnsealedAttributes", Justification = "Extended by ExportForVisualStudioProcessAttribute")]
     [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
-    public sealed class ExportForProcessAttribute : ExportAttribute
+    public class ExportForProcessAttribute : ExportAttribute
     {
+        // Unique name for exports that have been disabled
+        const string DisabledContractName = "GitHub.Disabled";
+
         /// <summary>
         /// Define an export that is only exposed in a specific named process.
         /// </summary>
-        /// <param name="contractType">The contract type to expose.</param>
         /// <param name="processName">Name of the process to expose export from (e.g. 'devenv').</param>
-        public ExportForProcessAttribute(Type contractType, string processName) : base(ExportForProcess(contractType, processName))
+        /// <param name="contractType">The contract type to expose.</param>
+        public ExportForProcessAttribute(string processName, Type contractType = null) :
+            base(ContractNameForProcess(processName), contractType)
         {
             ProcessName = processName;
         }
 
-        static Type ExportForProcess(Type contractType, string processName)
+        static string ContractNameForProcess(string processName)
         {
-            return Process.GetCurrentProcess().ProcessName == processName ? contractType : null;
+            var enabled = IsProcess(processName);
+            return enabled ? null : DisabledContractName;
         }
 
+        public static bool IsProcess(string processName) => Process.GetCurrentProcess().ProcessName == processName;
+
         /// <summary>
         /// The process name export will be exposed in.
         /// </summary>

src/GitHub.Exports/Exports/ExportForVisualStudioProcessAttribute.cs

@@ -0,0 +1,28 @@
+using System;
+
+namespace GitHub.Exports
+{
+    /// <summary>
+    /// Only expose export when executing in Visual Studio (devenv) process.
+    /// </summary>
+    /// <remarks>
+    /// This attribute is used to mark exports that mustn't be loaded into Blend.
+    /// See: https://github.com/github/VisualStudio/pull/1055
+    /// </remarks>
+    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
+    public sealed class ExportForVisualStudioProcessAttribute : ExportForProcessAttribute
+    {
+        const string VisualStudioProcessName = "devenv";
+
+        /// <summary>
+        /// Define an export that is only exposed in a Visual Studio (devenv) process.
+        /// </summary>
+        /// <param name="contractType">The contract type to expose.</param>
+        public ExportForVisualStudioProcessAttribute(Type contractType = null) :
+            base(VisualStudioProcessName, contractType)
+        {
+        }
+
+        public static bool IsVisualStudioProcess() => IsProcess(VisualStudioProcessName);
+    }
+}

src/GitHub.Exports/GitHub.Exports.csproj

@@ -159,7 +159,8 @@
     <Compile Include="Commands\IGoToSolutionOrPullRequestFileCommand.cs" />
     <Compile Include="Commands\IVsCommand.cs" />
     <Compile Include="Commands\IVsCommandBase.cs" />
-    <Compile Include="Exports\ExportForProcess.cs" />
+    <Compile Include="Exports\ExportForVisualStudioProcessAttribute.cs" />
+    <Compile Include="Exports\ExportForProcessAttribute.cs" />
     <Compile Include="Extensions\ConnectionManagerExtensions.cs" />
     <Compile Include="GitHubLogicException.cs" />
     <Compile Include="Models\CommitMessage.cs" />

src/GitHub.InlineReviews/InlineReviewsPackage.cs

@@ -2,12 +2,15 @@
 using System.ComponentModel.Design;
 using System.Runtime.InteropServices;
 using System.Threading;
+using GitHub.Exports;
+using GitHub.Logging;
 using GitHub.Commands;
 using GitHub.Services.Vssdk.Commands;
 using GitHub.VisualStudio;
 using Microsoft.VisualStudio.ComponentModelHost;
 using Microsoft.VisualStudio.Shell;
 using Microsoft.VisualStudio.Threading;
+using Serilog;
 using Task = System.Threading.Tasks.Task;
 
 namespace GitHub.InlineReviews
@@ -18,6 +21,8 @@ namespace GitHub.InlineReviews
     [ProvideMenuResource("Menus.ctmenu", 1)]
     public class InlineReviewsPackage : AsyncPackage
     {
+        static readonly ILogger log = LogManager.ForContext<InlineReviewsPackage>();
+
         protected override async Task InitializeAsync(
             CancellationToken cancellationToken,
             IProgress<ServiceProgressData> progress)
@@ -33,6 +38,12 @@ protected override async Task InitializeAsync(
 
         async Task InitializeMenus()
         {
+            if (!ExportForVisualStudioProcessAttribute.IsVisualStudioProcess())
+            {
+                log.Warning("Don't initialize menus for non-Visual Studio process");
+                return;
+            }
+
             var componentModel = (IComponentModel)(await GetServiceAsync(typeof(SComponentModel)));
             var exports = componentModel.DefaultExportProvider;
             var commands = new IVsCommandBase[]

src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs

@@ -138,7 +138,7 @@ void NotifyActiveRepo()
 
         void UpdateActiveRepo()
         {
-            // NOTE: gitService will be null in Expression Blend or Safe Mode
+            // NOTE: gitService might be null in Blend or Safe Mode
             var repo = gitService?.ActiveRepositories.FirstOrDefault();
 
             if (!Equals(repo, ActiveRepo))

src/GitHub.VisualStudio.UI/Resources.Designer.cs

@@ -425,6 +425,9 @@
   <data name="Options_EnableTraceLoggingText" xml:space="preserve">
     <value>Enable Trace Logging</value>
   </data>
+  <data name="BlendDialogText" xml:space="preserve">
+    <value>The GitHub extension is not available inside Blend</value>
+  </data>
   <data name="Options_ForkButtonLabel" xml:space="preserve">
     <value>Show Fork button in Team Explorer</value>
   </data>

src/GitHub.VisualStudio.UI/Resources.resx

@@ -0,0 +1,37 @@
+using System;
+using GitHub.Services.Vssdk.Commands;
+using Microsoft.VisualStudio;
+using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Shell.Interop;
+using Task = System.Threading.Tasks.Task;
+
+namespace GitHub.VisualStudio.Commands
+{
+    /// <summary>
+    /// Show an info message dialog when a command is executed.
+    /// </summary>
+    public class ShowMessageBoxCommand : VsCommand
+    {
+        readonly IServiceProvider serviceProvider;
+        readonly string message;
+
+        public ShowMessageBoxCommand(Guid commandSet, int commandId,
+            IServiceProvider serviceProvider, string message) : base(commandSet, commandId)
+        {
+            this.serviceProvider = serviceProvider;
+            this.message = message;
+        }
+
+        public override Task Execute()
+        {
+            ShowInfoMessage(message);
+            return Task.CompletedTask;
+        }
+
+        void ShowInfoMessage(string infoMessage)
+        {
+            ErrorHandler.ThrowOnFailure(VsShellUtilities.ShowMessageBox(serviceProvider, infoMessage, null,
+                OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST));
+        }
+    }
+}

src/GitHub.VisualStudio/Commands/ShowMessageBoxCommand.cs

@@ -1,8 +1,11 @@
 using System;
 using System.Threading;
 using System.Runtime.InteropServices;
-using Microsoft.VisualStudio.Shell;
+using GitHub.Exports;
+using GitHub.Logging;
 using GitHub.Services;
+using Microsoft.VisualStudio.Shell;
+using Serilog;
 using Task = System.Threading.Tasks.Task;
 
 namespace GitHub.VisualStudio
@@ -17,8 +20,16 @@ namespace GitHub.VisualStudio
     [ProvideAutoLoad(Guids.GitSccProviderId, PackageAutoLoadFlags.BackgroundLoad)]
     public class GitContextPackage : AsyncPackage
     {
+        static readonly ILogger log = LogManager.ForContext<GitContextPackage>();
+
         protected async override Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
         {
+            if (!ExportForVisualStudioProcessAttribute.IsVisualStudioProcess())
+            {
+                log.Warning("Don't activate 'UIContext_Git' for non-Visual Studio process");
+                return;
+            }
+
             var gitExt = (IVSGitExt)await GetServiceAsync(typeof(IVSGitExt));
             var context = UIContext.FromUIContextGuid(new Guid(Guids.UIContext_Git));
             RefreshContext(context, gitExt);

src/GitHub.VisualStudio/GitContextPackage.cs

@@ -316,6 +316,7 @@
     <Compile Include="AssemblyResolverPackage.cs" />
     <Compile Include="Commands\BlameLinkCommand.cs" />
     <Compile Include="Commands\CreateGistCommand.cs" />
+    <Compile Include="Commands\ShowMessageBoxCommand.cs" />
     <Compile Include="Commands\LinkCommandBase.cs" />
     <Compile Include="Commands\CopyLinkCommand.cs" />
     <Compile Include="Commands\OpenLinkCommand.cs" />