First pass at normalizing the difference between a collection of variables in a scope versus a normal, expandable variable. This also implements support for locals per stack frame.

rkeithhill · rkeithhill · commit aa11be0b3aa3 · 2015-11-29T15:50:19.000-07:00
diff --git a/src/PowerShellEditorServices.Host/DebugAdapter.cs b/src/PowerShellEditorServices.Host/DebugAdapter.cs
@@ -276,7 +276,7 @@ protected async Task HandleStackTraceRequest(
                 newStackFrames.Add(
                     StackFrame.Create(
                         stackFrames[i], 
-                        i + 1));
+                        i));
             }
 
             await requestContext.SendResult(
@@ -310,7 +310,7 @@ protected async Task HandleVariablesRequest(
             EditorSession editorSession,
             RequestContext<VariablesResponseBody, object> requestContext)
         {
-            VariableDetails[] variables =
+            VariableDetailsBase[] variables =
                 editorSession.DebugService.GetVariables(
                     variablesParams.VariablesReference);
 
diff --git a/src/PowerShellEditorServices.Protocol/DebugAdapter/ScopesRequest.cs b/src/PowerShellEditorServices.Protocol/DebugAdapter/ScopesRequest.cs
@@ -3,6 +3,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using System.Diagnostics;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
 
 namespace Microsoft.PowerShell.EditorServices.Protocol.DebugAdapter
@@ -14,6 +15,7 @@ public static readonly
             RequestType<ScopesRequestArguments, ScopesResponseBody, object>.Create("scopes");
     }
 
+    [DebuggerDisplay("FrameId = {FrameId}")]
     public class ScopesRequestArguments
     {
         public int FrameId { get; set; }
diff --git a/src/PowerShellEditorServices.Protocol/DebugAdapter/StackTraceRequest.cs b/src/PowerShellEditorServices.Protocol/DebugAdapter/StackTraceRequest.cs
@@ -3,6 +3,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using System.Diagnostics;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
 
 namespace Microsoft.PowerShell.EditorServices.Protocol.DebugAdapter
@@ -14,6 +15,7 @@ public static readonly
             RequestType<StackTraceRequestArguments, StackTraceResponseBody, object>.Create("stackTrace");
     }
 
+    [DebuggerDisplay("ThreadId = {ThreadId}, Levels = {Levels}")]
     public class StackTraceRequestArguments
     {
         public int ThreadId { get; private set; }
@@ -27,4 +29,3 @@ public class StackTraceResponseBody
         public StackFrame[] StackFrames { get; set; }
     }
 }
-
diff --git a/src/PowerShellEditorServices.Protocol/DebugAdapter/Variable.cs b/src/PowerShellEditorServices.Protocol/DebugAdapter/Variable.cs
@@ -15,7 +15,7 @@ public class Variable
 		// /** If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest. */
         public int VariablesReference { get; set; }
 
-        public static Variable Create(VariableDetails variable)
+        public static Variable Create(VariableDetailsBase variable)
         {
             return new Variable
             {
diff --git a/src/PowerShellEditorServices.Protocol/DebugAdapter/VariablesRequest.cs b/src/PowerShellEditorServices.Protocol/DebugAdapter/VariablesRequest.cs
@@ -3,6 +3,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using System.Diagnostics;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
 
 namespace Microsoft.PowerShell.EditorServices.Protocol.DebugAdapter
@@ -14,6 +15,7 @@ public static readonly
             RequestType<VariablesRequestArguments, VariablesResponseBody, object>.Create("variables");
     }
 
+    [DebuggerDisplay("VariablesReference = {VariablesReference}")]
     public class VariablesRequestArguments
     {
         public int VariablesReference { get; set; }
diff --git a/src/PowerShellEditorServices/Debugging/DebugService.cs b/src/PowerShellEditorServices/Debugging/DebugService.cs
@@ -9,6 +9,7 @@
 using System.Linq;
 using System.Management.Automation;
 using System.Threading.Tasks;
+using Microsoft.PowerShell.EditorServices.Debugging;
 
 namespace Microsoft.PowerShell.EditorServices
 {
@@ -27,8 +28,10 @@ public class DebugService
             new Dictionary<string, List<Breakpoint>>();
 
         private int nextVariableId;
-        private List<VariableDetails> currentVariables;
-        private StackFrameDetails[] callStackFrames;
+        private List<VariableDetailsBase> variables;
+        private VariableContainerDetails globalScopeVariables;
+        private VariableContainerDetails scriptScopeVariables;
+        private StackFrameDetails[] stackFrameDetails;
 
         #endregion
 
@@ -155,38 +158,28 @@ public void Abort()
         /// </summary>
         /// <param name="variableReferenceId"></param>
         /// <returns>An array of VariableDetails instances which describe the requested variables.</returns>
-        public VariableDetails[] GetVariables(int variableReferenceId)
+        public VariableDetailsBase[] GetVariables(int variableReferenceId)
         {
-            VariableDetails[] childVariables = null;
+            VariableDetailsBase[] childVariables;
 
-            if (variableReferenceId >= VariableDetails.FirstVariableId)
+            VariableDetailsBase parentVariable = this.variables[variableReferenceId];
+            if (parentVariable.IsExpandable)
             {
-                int correctedId =
-                    (variableReferenceId - VariableDetails.FirstVariableId);
+                childVariables = parentVariable.GetChildren();
 
-                VariableDetails parentVariable = 
-                    this.currentVariables[correctedId];
-
-                if (parentVariable.IsExpandable)
+                foreach (var child in childVariables)
                 {
-                    childVariables = parentVariable.GetChildren();
-
-                    foreach (var child in childVariables)
+                    // Only add child if it hasn't already been added.
+                    if (child.Id < 0)
                     {
-                        this.currentVariables.Add(child);
-                        child.Id = this.nextVariableId;
-                        this.nextVariableId++;
+                        child.Id = this.nextVariableId++;
+                        this.variables.Add(child);
                     }
                 }
-                else
-                {
-                    childVariables = new VariableDetails[0];
-                }
             }
             else
             {
-                // TODO: Get variables for the desired scope ID
-                childVariables = this.currentVariables.ToArray();
+                childVariables = new VariableDetailsBase[0];
             }
 
             return childVariables;
@@ -200,13 +193,13 @@ public VariableDetails[] GetVariables(int variableReferenceId)
         /// <param name="variableExpression">The variable expression string to evaluate.</param>
         /// <param name="stackFrameId">The ID of the stack frame in which the expression should be evaluated.</param>
         /// <returns>A VariableDetails object containing the result.</returns>
-        public VariableDetails GetVariableFromExpression(string variableExpression, int stackFrameId)
+        public VariableDetailsBase GetVariableFromExpression(string variableExpression, int stackFrameId)
         {
             // Break up the variable path
             string[] variablePathParts = variableExpression.Split('.');
 
-            VariableDetails resolvedVariable = null;
-            IEnumerable<VariableDetails> variableList = this.currentVariables;
+            VariableDetailsBase resolvedVariable = null;
+            IEnumerable<VariableDetailsBase> variableList = this.variables;
 
             foreach (var variableName in variablePathParts)
             {
@@ -267,7 +260,7 @@ await this.powerShellContext.ExecuteScriptString(
         /// </returns>
         public StackFrameDetails[] GetStackFrames()
         {
-            return this.callStackFrames;
+            return this.stackFrameDetails;
         }
 
         /// <summary>
@@ -278,10 +271,11 @@ public StackFrameDetails[] GetStackFrames()
         /// <returns>The list of VariableScope instances which describe the available variable scopes.</returns>
         public VariableScope[] GetVariableScopes(int stackFrameId)
         {
-            // TODO: Return different scopes based on PowerShell scoping mechanics
             return new VariableScope[]
             {
-                new VariableScope(1, "Locals")
+                new VariableScope(this.stackFrameDetails[stackFrameId].LocalVariables.Id, "Local"),
+                new VariableScope(this.scriptScopeVariables.Id, "Script"),
+                new VariableScope(this.globalScopeVariables.Id, "Global"),  
             };
         }
 
@@ -310,25 +304,44 @@ private async Task ClearBreakpointsInFile(ScriptFile scriptFile)
             }
         }
 
-        private async Task FetchVariables()
+        private async Task FetchStackFramesAndVariables()
         {
-            this.nextVariableId = VariableDetails.FirstVariableId;
-            this.currentVariables = new List<VariableDetails>();
+            // Avoid using 0 as it indicates a variable node with no children.
+            this.nextVariableId = 1;
+            this.variables = new List<VariableDetailsBase>();
+
+            // Create a dummy variable for index 0, should never see this.
+            this.variables.Add(new VariableDetails("Dummy", null));
 
+            await FetchGlobalAndScriptVariables();
+            await FetchStackFrames();
+
+        }
+
+        private async Task FetchGlobalAndScriptVariables()
+        {
+            this.scriptScopeVariables = await FetchVariableContainer("Script");
+            this.globalScopeVariables = await FetchVariableContainer("Global");
+        }
+
+        private async Task<VariableContainerDetails> FetchVariableContainer(string scope)
+        {
             PSCommand psCommand = new PSCommand();
             psCommand.AddCommand("Get-Variable");
-            psCommand.AddParameter("Scope", "Local");
+            psCommand.AddParameter("Scope", scope);
 
-            var results = await this.powerShellContext.ExecuteCommand<PSVariable>(psCommand);
+            var variableContainerDetails = new VariableContainerDetails(this.nextVariableId++, "Scope: " + scope);
+            this.variables.Add(variableContainerDetails);
 
-            foreach (var variable in results)
+            var results = await this.powerShellContext.ExecuteCommand<PSVariable>(psCommand);
+            foreach (PSVariable variable in results)
             {
-                var details = new VariableDetails(variable);
-                details.Id = this.nextVariableId;
-                this.currentVariables.Add(details);
-
-                this.nextVariableId++;
+                var variableDetails = new VariableDetails(variable) { Id = this.nextVariableId++ };
+                this.variables.Add(variableDetails);
+                variableContainerDetails.Children.Add(variableDetails);
             }
+
+            return variableContainerDetails;
         }
 
         private async Task FetchStackFrames()
@@ -338,10 +351,14 @@ private async Task FetchStackFrames()
 
             var results = await this.powerShellContext.ExecuteCommand<CallStackFrame>(psCommand);
 
-            this.callStackFrames =
-                results
-                    .Select(StackFrameDetails.Create)
-                    .ToArray();
+            var callStackFrames = results.ToArray();
+            this.stackFrameDetails = new StackFrameDetails[callStackFrames.Length];
+
+            for (int i = 0; i < callStackFrames.Length; i++)
+            {
+                VariableContainerDetails localVariables = await FetchVariableContainer(i.ToString());
+                this.stackFrameDetails[i] = StackFrameDetails.Create(callStackFrames[i], localVariables);
+            }
         }
 
         #endregion
@@ -355,9 +372,8 @@ private async Task FetchStackFrames()
 
         private async void OnDebuggerStop(object sender, DebuggerStopEventArgs e)
         {
-            // Get the call stack and local variables
-            await this.FetchStackFrames();
-            await this.FetchVariables();
+            // Get call stack and variables.
+            await this.FetchStackFramesAndVariables();
 
             // Notify the host that the debugger is stopped
             if (this.DebuggerStopped != null)
diff --git a/src/PowerShellEditorServices/Debugging/StackFrameDetails.cs b/src/PowerShellEditorServices/Debugging/StackFrameDetails.cs
@@ -5,6 +5,7 @@
 
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.PowerShell.EditorServices.Debugging;
 
 namespace Microsoft.PowerShell.EditorServices
 {
@@ -34,26 +35,32 @@ public class StackFrameDetails
         /// </summary>
         public int ColumnNumber { get; private set; }
 
+        /// <summary>
+        /// Gets or sets the VariableContainerDetails that contains the local variables.
+        /// </summary>
+        public VariableContainerDetails LocalVariables { get; private set; }
+
         /// <summary>
         /// Creates an instance of the StackFrameDetails class from a
         /// CallStackFrame instance provided by the PowerShell engine.
         /// </summary>
         /// <param name="callStackFrame">
         /// The original CallStackFrame instance from which details will be obtained.
         /// </param>
+        /// <param name="localVariables">
+        /// A variable container with all the local variables for this stack frame.
         /// <returns>A new instance of the StackFrameDetails class.</returns>
         static internal StackFrameDetails Create(
-            CallStackFrame callStackFrame)
+            CallStackFrame callStackFrame,
+            VariableContainerDetails localVariables)
         {
-            Dictionary<string, PSVariable> localVariables =
-                callStackFrame.GetFrameVariables();
-
             return new StackFrameDetails
             {
                 ScriptPath = callStackFrame.ScriptName,
                 FunctionName = callStackFrame.FunctionName,
                 LineNumber = callStackFrame.Position.StartLineNumber,
-                ColumnNumber = callStackFrame.Position.StartColumnNumber
+                ColumnNumber = callStackFrame.Position.StartColumnNumber,
+                LocalVariables = localVariables
             };
         }
     }
diff --git a/src/PowerShellEditorServices/Debugging/VariableContainerDetails.cs b/src/PowerShellEditorServices/Debugging/VariableContainerDetails.cs
@@ -0,0 +1,59 @@
+﻿//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Collections.Generic;
+using System.Diagnostics;
+using Microsoft.PowerShell.EditorServices.Utility;
+
+namespace Microsoft.PowerShell.EditorServices.Debugging
+{
+    /// <summary>
+    /// Container for variables that is not itself a variable per se.  However given how
+    /// VSCode uses an integer variable reference id for every node under the "Variables" tool
+    /// window, it is useful to treat containers, typically scope containers, as a variable.
+    /// Note that these containers are not necessarily always a scope container. Consider a
+    /// container such as "Auto" or "My".  These aren't scope related but serve as just another
+    /// way to organize variables into a useful UI structure.
+    /// </summary>
+    [DebuggerDisplay("Name = {Name}, Id = {Id}, Count = {Children.Count}")]
+    public class VariableContainerDetails : VariableDetailsBase
+    {
+        private readonly List<VariableDetailsBase> children;
+
+        /// <summary>
+        /// Instantiates an instance of VariableScopeDetails.
+        /// </summary>
+        /// <param name="id">The variable reference id for this scope.</param>
+        /// <param name="name">The name of the variable scope.</param>
+        public VariableContainerDetails(int id, string name)
+        {
+            Validate.IsNotNull(name, "name");
+
+            this.Id = id;
+            this.Name = name;
+            this.IsExpandable = true;
+            this.ValueString = " "; // An empty string isn't enough due to a temporary bug in VS Code.
+
+            this.children = new List<VariableDetailsBase>();
+        }
+
+        /// <summary>
+        /// Gets the collection of child variables.
+        /// </summary>
+        public List<VariableDetailsBase> Children
+        {
+            get { return this.children; }
+        }
+
+        /// <summary>
+        /// Returns the details of the variable container's children.  If empty, returns an empty array.
+        /// </summary>
+        /// <returns></returns>
+        public override VariableDetailsBase[] GetChildren()
+        {
+            return this.children.ToArray();
+        }
+    }
+}
diff --git a/src/PowerShellEditorServices/Debugging/VariableDetails.cs b/src/PowerShellEditorServices/Debugging/VariableDetails.cs
diff --git a/src/PowerShellEditorServices/Debugging/VariableDetailsBase.cs b/src/PowerShellEditorServices/Debugging/VariableDetailsBase.cs
diff --git a/src/PowerShellEditorServices/PowerShellEditorServices.csproj b/src/PowerShellEditorServices/PowerShellEditorServices.csproj
diff --git a/test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs b/test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`// Licensed under the MIT license. See LICENSE file in the project root for full license information.`
`4`	`4`	`//`
`5`	`5`
	`6`	`+using System.Diagnostics;`
`6`	`7`	`using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;`
`7`	`8`
`8`	`9`	`namespace Microsoft.PowerShell.EditorServices.Protocol.DebugAdapter`
`@@ -14,6 +15,7 @@ public static readonly`
`14`	`15`	`RequestType<ScopesRequestArguments, ScopesResponseBody, object>.Create("scopes");`
`15`	`16`	`}`
`16`	`17`
	`18`	`+ [DebuggerDisplay("FrameId = {FrameId}")]`
`17`	`19`	`public class ScopesRequestArguments`
`18`	`20`	`{`
`19`	`21`	`public int FrameId { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class Variable`
`15`	`15`	`// /** If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest. */`
`16`	`16`	`public int VariablesReference { get; set; }`
`17`	`17`
`18`		`- public static Variable Create(VariableDetails variable)`
	`18`	`+ public static Variable Create(VariableDetailsBase variable)`
`19`	`19`	`{`
`20`	`20`	`return new Variable`
`21`	`21`	`{`