Fix threading issue output window

Author: Paul van Brenk

Nodejs/Product/Nodejs/SharedProject/OutputWindowWrapper.cs

@@ -24,41 +24,37 @@ public sealed class OutputPaneWrapper
         private SVsServiceProvider ServiceProvider { get; set; }
 
         private Dictionary<OutputWindowTarget, IVsOutputWindowPane> lazyOutputPaneCollection = new Dictionary<OutputWindowTarget, IVsOutputWindowPane>();
-        private IVsWindowFrame lazyOutputWindow;
 
-        private IVsOutputWindowPane GetOutputPane(OutputWindowTarget target)
+        public OutputPaneWrapper()
         {
-            if (this.lazyOutputPaneCollection.TryGetValue(target, out var lazyOutputPane))
-            {
-                return lazyOutputPane;
-            }
-            else
-            {
-                ThreadHelper.ThrowIfNotOnUIThread();
-                var (title, guid) = GetPaneInfo(target);
-                var outputWindow = (IVsOutputWindow)this.ServiceProvider.GetService(typeof(SVsOutputWindow));
+            //...
+        }
 
-                // Try to get the workspace pane if it has already been registered
-                var hr = outputWindow.GetPane(guid, out lazyOutputPane);
+        private void InitializeOutputPane(OutputWindowTarget target)
+        {
+            ThreadHelper.ThrowIfNotOnUIThread();
+            var (title, guid) = GetPaneInfo(target);
+            var outputWindow = (IVsOutputWindow)this.ServiceProvider.GetService(typeof(SVsOutputWindow));
 
-                // If the workspace pane has not been registered before, create it
-                if (lazyOutputPane == null || ErrorHandler.Failed(hr))
-                {
+            // Try to get the workspace pane if it has already been registered
+            var hr = outputWindow.GetPane(guid, out var lazyOutputPane);
 
-                    if (ErrorHandler.Failed(outputWindow.CreatePane(guid, title, fInitVisible: 1, fClearWithSolution: 1)) ||
-                        ErrorHandler.Failed(outputWindow.GetPane(guid, out lazyOutputPane)))
-                    {
-                        return null;
-                    }
+            // If the workspace pane has not been registered before, create it
+            if (lazyOutputPane == null || ErrorHandler.Failed(hr))
+            {
 
-                    // Must activate the workspace pane for it to show up in the output window
-                    lazyOutputPane.Activate();
+                if (ErrorHandler.Failed(outputWindow.CreatePane(guid, title, fInitVisible: 1, fClearWithSolution: 1)) ||
+                    ErrorHandler.Failed(outputWindow.GetPane(guid, out lazyOutputPane)))
+                {
+                    return;
                 }
 
-                this.lazyOutputPaneCollection.Add(target, lazyOutputPane);
-                return lazyOutputPane;
+                // Must activate the workspace pane for it to show up in the output window
+                lazyOutputPane.Activate();
             }
 
+            this.lazyOutputPaneCollection.Add(target, lazyOutputPane);
+
             (string title, Guid guid) GetPaneInfo(OutputWindowTarget pane)
             {
                 switch (pane)
@@ -73,39 +69,23 @@ private IVsOutputWindowPane GetOutputPane(OutputWindowTarget target)
             }
         }
 
-        private IVsWindowFrame OutputWindow
-        {
-            get
-            {
-                if (this.lazyOutputWindow == null && this.ServiceProvider.GetService(typeof(SVsUIShell)) is IVsUIShell shell)
-                {
-                    ThreadHelper.ThrowIfNotOnUIThread();
-
-                    var windowGuid = OutputWindowGuid;
-                    var hr = shell.FindToolWindow((int)__VSFINDTOOLWIN.FTW_fForceCreate, ref windowGuid, out this.lazyOutputWindow);
-                    Debug.Assert(ErrorHandler.Succeeded(hr));
-                }
-
-                return this.lazyOutputWindow;
-            }
-        }
-
         public void WriteLine(string message, OutputWindowTarget target = OutputWindowTarget.Npm)
         {
-            if (this.lazyOutputWindow == null)
+            if (!this.lazyOutputPaneCollection.TryGetValue(target, out var lazyOutputPane))
             {
-                throw new InvalidOperationException($"Ensure the output window is initialized by calling '{nameof(ShowWindow)}' first.");
+                throw new InvalidOperationException("You need to initialize the output panes before using them.");
             }
 
-            var hr = this.GetOutputPane(target).OutputStringThreadSafe(message + Environment.NewLine);
+            var hr = lazyOutputPane.OutputStringThreadSafe(message + Environment.NewLine);
             Debug.Assert(ErrorHandler.Succeeded(hr));
         }
 
-        public void ShowWindow()
+        public void InitializeOutputPanes()
         {
             ThreadHelper.ThrowIfNotOnUIThread();
-            var hr = this.OutputWindow?.ShowNoActivate() ?? VSConstants.E_FAIL;
-            Debug.Assert(ErrorHandler.Succeeded(hr));
+
+            InitializeOutputPane(OutputWindowTarget.Npm);
+            InitializeOutputPane(OutputWindowTarget.Tsc);
         }
     }
 

Nodejs/Product/Nodejs/Workspace/ContextMenuProvider.cs

@@ -75,7 +75,7 @@ public int Exec(List<WorkspaceVisualNodeBase> selection, Guid pguidCmdGroup, uin
 
                 if (pguidCmdGroup == Guids.NodeToolsWorkspaceCmdSet)
                 {
-                    this.outputPane.ShowWindow();
+                    this.outputPane.InitializeOutputPanes();
 
                     switch (nCmdID)
                     {

Nodejs/Product/Nodejs/Workspace/TypeScriptActionProviderFactory.cs

@@ -60,7 +60,7 @@ public async Task<IReadOnlyList<IFileContextAction>> GetActionsAsync(string file
             {
                 await this.workspaceContext.JTF.SwitchToMainThreadAsync();
 
-                this.outputPane.ShowWindow();
+                this.outputPane.InitializeOutputPanes();
 
                 var actions = new List<IFileContextAction>();