Merge pull request #83 from PowerShell/daviwil/fix-debug-output

Fix missing OutputEvents in DebugAdapter

Author: daviwil

CHANGELOG.md

@@ -1,5 +1,10 @@
 # PowerShell Editor Services Release History
 
+## 0.3.1
+### Thursday, December 17, 2015
+
+- Fixed issue PowerShell/vscode-powershell#49, Debug Console does not receive script output
+
 ## 0.3.0
 ### Tuesday, December 15, 2015
 

appveyor.yml

@@ -4,7 +4,7 @@ configuration: Release
 clone_depth: 10
 
 environment:
-  core_version: '0.3.0'
+  core_version: '0.3.1'
   prerelease_name: '-beta'
 
 branches:

src/PowerShellEditorServices.Protocol/Server/DebugAdapter.cs

@@ -29,6 +29,7 @@ public DebugAdapter(ChannelBase serverChannel) : base(serverChannel)
             this.editorSession = new EditorSession();
             this.editorSession.StartSession();
             this.editorSession.DebugService.DebuggerStopped += this.DebugService_DebuggerStopped;
+            this.editorSession.PowerShellContext.OutputWritten += this.powerShellContext_OutputWritten;
         }
 
         protected override void Initialize()
@@ -356,6 +357,17 @@ await this.SendEvent(
                 });
         }
 
+        async void powerShellContext_OutputWritten(object sender, OutputWrittenEventArgs e)
+        {
+            await this.SendEvent(
+                OutputEvent.Type,
+                new OutputEventBody
+                {
+                    Output = e.OutputText + (e.IncludeNewLine ? "\r\n" : string.Empty),
+                    Category = (e.OutputType == OutputType.Error) ? "stderr" : "stdout"
+                });
+        }
+
         #endregion
     }
 }

test/PowerShellEditorServices.Test.Host/DebugAdapterTests.cs

@@ -59,7 +59,7 @@ await this.SendRequest(
                     {
                         Path = DebugScriptPath
                     },
-                    Lines = new int[] { 5, 9 }
+                    Lines = new int[] { 5, 7 }
                 });
 
             Task<StoppedEventBody> breakEventTask = this.WaitForEvent(StoppedEvent.Type);
@@ -74,7 +74,24 @@ await this.SendRequest(
             await this.SendRequest(ContinueRequest.Type, new object());
             stoppedDetails = await breakEventTask;
             Assert.Equal(DebugScriptPath, stoppedDetails.Source.Path);
-            Assert.Equal(9, stoppedDetails.Line);
+            Assert.Equal(7, stoppedDetails.Line);
+
+            // Abort script execution
+            Task terminatedEvent = this.WaitForEvent(TerminatedEvent.Type);
+            await this.SendRequest(DisconnectRequest.Type, new object());
+            await terminatedEvent;
+        }
+
+        [Fact]
+        public async Task DebugAdapterReceivesOutputEvents()
+        {
+            Task<OutputEventBody> outputEventTask = this.WaitForEvent(OutputEvent.Type);
+            await this.LaunchScript(DebugScriptPath);
+
+            // Wait for an output event
+            OutputEventBody outputDetails = await outputEventTask;
+            Assert.Equal("Output 1", outputDetails.Output);
+            Assert.Equal("stdout", outputDetails.Category);
 
             // Abort script execution
             Task terminatedEvent = this.WaitForEvent(TerminatedEvent.Type);
@@ -113,7 +130,11 @@ private Task<TParams> WaitForEvent<TParams>(EventType<TParams> eventType)
                 eventType,
                 (p, ctx) =>
                 {
-                    eventTask.SetResult(p);
+                    if (!eventTask.Task.IsCompleted)
+                    {
+                        eventTask.SetResult(p);
+                    }
+
                     return Task.FromResult(true);
                 },
                 true);  // Override any existing handler

test/PowerShellEditorServices.Test.Shared/Debugging/DebugTest.ps1

@@ -1,6 +1,4 @@
-Get-Process -bla
-
-$i = 1
+$i = 1
 
 while ($i -le 500000)
 {

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -103,7 +103,7 @@ public async Task DebuggerStopsOnBreakpoints()
             BreakpointDetails[] breakpoints =
                 await this.debugService.SetBreakpoints(
                     this.debugScriptFile, 
-                    new int[] { 5, 9 });
+                    new int[] { 5, 7 });
             await this.AssertStateChange(PowerShellContextState.Ready);
 
             Task executeTask =
@@ -114,7 +114,7 @@ await this.debugService.SetBreakpoints(
             await this.AssertDebuggerStopped(this.debugScriptFile.FilePath, 5);
             this.debugService.Continue();
 
-            await this.AssertDebuggerStopped(this.debugScriptFile.FilePath, 9);
+            await this.AssertDebuggerStopped(this.debugScriptFile.FilePath, 7);
 
             // Abort script execution early and wait for completion
             this.debugService.Abort();