Fix stack trace so it shows external code as "deemphasized". (#537)

Author: rkeithhill

src/PowerShellEditorServices.Protocol/DebugAdapter/Source.cs

@@ -12,6 +12,33 @@ public class Source
         public string Path { get; set; }
 
         public int? SourceReference { get; set; }
+
+        /// <summary>
+        /// Gets an optional hint for how to present the source in the UI. A value of 'deemphasize' 
+        /// can be used to indicate that the source is not available or that it is skipped on stepping.
+        /// </summary>
+        public string PresentationHint { get; set; }
+    }
+
+    /// <summary>
+    /// An optional hint for how to present source in the UI. 
+    /// </summary>
+    public enum SourcePresentationHint
+    {
+        /// <summary>
+        /// Dispays the source normally.
+        /// </summary>
+        Normal,
+
+        /// <summary>
+        /// Display the source emphasized.
+        /// </summary>
+        Emphasize,
+
+        /// <summary>
+        /// Display the source deemphasized.
+        /// </summary>
+        Deemphasize
     }
 }
 

src/PowerShellEditorServices.Protocol/DebugAdapter/StackFrame.cs

@@ -58,6 +58,9 @@ public static StackFrame Create(
             StackFrameDetails stackFrame,
             int id)
         {
+            var sourcePresentationHint = 
+                stackFrame.IsExternalCode ? SourcePresentationHint.Deemphasize : SourcePresentationHint.Normal;
+
             return new StackFrame
             {
                 Id = id,
@@ -66,13 +69,35 @@ public static StackFrame Create(
                 EndLine = stackFrame.EndLineNumber,
                 Column = stackFrame.StartColumnNumber,
                 EndColumn = stackFrame.EndColumnNumber,
-                PresentationHint = stackFrame.PresentationHint.ToString().ToLower(),
                 Source = new Source
                 {
-                    Path = stackFrame.ScriptPath
+                    Path = stackFrame.ScriptPath,
+                    PresentationHint = sourcePresentationHint.ToString().ToLower()
                 }
             };
         }
     }
+
+    /// <summary>
+    /// An optional hint for how to present a stack frame in the UI. 
+    /// </summary>
+    public enum StackFramePresentationHint
+    {
+        /// <summary>
+        /// Dispays the stack frame as a normal stack frame.
+        /// </summary>
+        Normal,
+
+        /// <summary>
+        /// Used to label an entry in the call stack that doesn't actually correspond to a stack frame.
+        /// This is typically used to label transitions to/from "external" code.
+        /// </summary>
+        Label,
+
+        /// <summary>
+        /// Displays the stack frame in a subtle way, typically used from loctaions outside of the current project or workspace.
+        /// </summary>
+        Subtle
+    }
 }
 

src/PowerShellEditorServices/Debugging/StackFrameDetails.cs

@@ -8,28 +8,6 @@
 
 namespace Microsoft.PowerShell.EditorServices
 {
-    /// <summary>
-    /// An optional hint for how to present a stack frame in the UI. 
-    /// </summary>
-    public enum StackFramePresentationHint
-    {
-        /// <summary>
-        /// Dispays the stack frame as a normal stack frame.
-        /// </summary>
-        Normal,
-
-        /// <summary>
-        /// Used to label an entry in the call stack that doesn't actually correspond to a stack frame.
-        /// This is typically used to label transitions to/from "external" code.
-        /// </summary>
-        Label,
-
-        /// <summary>
-        /// Displays the stack frame in a subtle way, typically used from loctaions outside of the current project or workspace.
-        /// </summary>
-        Subtle
-    }
-
     /// <summary>
     /// Contains details pertaining to a single stack frame in
     /// the current debugging session.
@@ -79,9 +57,10 @@ public class StackFrameDetails
         public int? EndColumnNumber { get; internal set; }
 
         /// <summary>
-        /// Gets a hint value that determines how the stack frame should be displayed.
+        /// Gets a boolean value indicating whether or not the stack frame is executing 
+        /// in script external to the current workspace root.
         /// </summary>
-        public StackFramePresentationHint PresentationHint { get; internal set; }
+        public bool IsExternalCode { get; internal set; }
 
         /// <summary>
         /// Gets or sets the VariableContainerDetails that contains the auto variables.
@@ -122,7 +101,7 @@ static internal StackFrameDetails Create(
             string workspaceRootPath = null)
         {
             string moduleId = string.Empty;
-            var presentationHint = StackFramePresentationHint.Normal;
+            var isExternal = false;
 
             var invocationInfo = callStackFrameObject.Properties["InvocationInfo"]?.Value as InvocationInfo;
             string scriptPath = (callStackFrameObject.Properties["ScriptName"].Value as string) ?? NoFileScriptPath;
@@ -132,7 +111,7 @@ static internal StackFrameDetails Create(
                 invocationInfo != null &&
                 !scriptPath.StartsWith(workspaceRootPath, StringComparison.OrdinalIgnoreCase))
             {
-                presentationHint = StackFramePresentationHint.Subtle;
+                isExternal = true;
             }
 
             return new StackFrameDetails
@@ -145,7 +124,7 @@ static internal StackFrameDetails Create(
                 EndColumnNumber = 0,
                 AutoVariables = autoVariables,
                 LocalVariables = localVariables,
-                PresentationHint = presentationHint
+                IsExternalCode = isExternal
             };
         }