injecting envornment globals in debugger (#6872)

* injecting envornment globals in debugger * lint
microsoft · Apr 20, 2020 · cd97cd7 · cd97cd7
1 parent 3da41c4
commit cd97cd7
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 10 deletions.
diff --git a/localtypings/pxtparts.d.ts b/localtypings/pxtparts.d.ts
@@ -179,6 +179,7 @@ declare namespace pxsim {
     export interface DebuggerBreakpointMessage extends DebuggerMessage {
         breakpointId: number;
         globals: Variables;
+        environmentGlobals?: Variables;
         stackframes: StackFrameInfo[];
         exceptionMessage?: string;
         exceptionStack?: string;

diff --git a/pxtsim/debugger.ts b/pxtsim/debugger.ts
@@ -177,6 +177,17 @@ namespace pxsim {
         return stackFrame.retval;
     }
 
+    export function injectEnvironmentGlobals(msg: DebuggerBreakpointMessage, heap: Map<any>) {
+        const environmentGlobals = runtime.environmentGlobals;
+        const keys = Object.keys(environmentGlobals);
+        if (!keys.length)
+            return;
+
+        const envVars: Variables = msg.environmentGlobals = {};
+        Object.keys(environmentGlobals)
+            .forEach(n => envVars[n] = valToJSON(runtime.environmentGlobals[n], heap))
+    }
+
     export function getBreakpointMsg(s: pxsim.StackFrame, brkId: number, userGlobals?: string[]): { msg: DebuggerBreakpointMessage, heap: Map<any> } {
         const heap: pxsim.Map<any> = {};
 

diff --git a/pxtsim/runtime.ts b/pxtsim/runtime.ts
@@ -633,6 +633,7 @@ namespace pxsim {
         lastPauseTimestamp = 0;
         id: string;
         globals: any = {};
+        environmentGlobals: any = {};
         currFrame: StackFrame;
         otherFrames: StackFrame[] = [];
         entry: LabelFn;
@@ -1135,6 +1136,7 @@ namespace pxsim {
 
                 const { msg, heap } = getBreakpointMsg(s, brkId, userGlobals);
                 dbgHeap = heap;
+                injectEnvironmentGlobals(msg, heap);
                 Runtime.postMessage(msg)
                 breakpoints[0] = 0;
                 breakFrame = null;
@@ -1276,7 +1278,8 @@ namespace pxsim {
                         __this.errorHandler(e)
                     else {
                         console.error("Simulator crashed, no error handler", e.stack)
-                        const { msg } = getBreakpointMsg(p, p.lastBrkId, userGlobals)
+                        const { msg, heap } = getBreakpointMsg(p, p.lastBrkId, userGlobals)
+                        injectEnvironmentGlobals(msg, heap);
                         msg.exceptionMessage = e.message
                         msg.exceptionStack = e.stack
                         Runtime.postMessage(msg)

diff --git a/webapp/src/debuggerVariables.tsx b/webapp/src/debuggerVariables.tsx
@@ -19,7 +19,7 @@ interface Variable {
     children?: Variable[];
 }
 
-interface DebuggerVariablesProps  {
+interface DebuggerVariablesProps {
     apis: pxt.Map<pxtc.SymbolInfo>;
     sequence: number;
     breakpoint?: pxsim.DebuggerBreakpointMessage;
@@ -67,7 +67,7 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
     componentDidUpdate(prevProps: DebuggerVariablesProps) {
         if (this.props.breakpoint) {
             if (this.props.sequence != this.state.renderedSequence) {
-                this.updateVariables(this.props.breakpoint.globals, this.props.breakpoint.stackframes, this.props.filters);
+                this.updateVariables(this.props.breakpoint, this.props.filters);
             }
         }
         else if (!this.state.frozen) {
@@ -108,7 +108,7 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
         }
 
         return <DebuggerTable header={variableTableHeader} placeholderText={placeholderText}>
-            { tableRows }
+            {tableRows}
         </DebuggerTable>
     }
 
@@ -137,8 +137,12 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
         return result;
     }
 
-    updateVariables(globals: pxsim.Variables, stackFrames: pxsim.StackFrameInfo[], filters?: string[]) {
-        if (!globals) {
+    updateVariables(
+        breakpoint: pxsim.DebuggerBreakpointMessage,
+        filters?: string[]
+    ) {
+        const { globals, environmentGlobals, stackframes } = breakpoint;
+        if (!globals && !environmentGlobals) {
             // freeze the ui
             this.update(true)
             return;
@@ -150,14 +154,17 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
         if (filters) {
             updatedGlobals.variables = updatedGlobals.variables.filter(v => filters.indexOf(v.name) !== -1)
         }
+        // inject unfiltered environment variables
+        if (environmentGlobals)
+            updatedGlobals.variables = updatedGlobals.variables.concat(variablesToVariableList(environmentGlobals));
 
         assignVarIds(updatedGlobals.variables);
 
         let updatedFrames: ScopeVariables[];
-        if (stackFrames) {
+        if (stackframes) {
             const oldFrames = this.state.stackFrames;
 
-            updatedFrames = stackFrames.map((sf, index) => {
+            updatedFrames = stackframes.map((sf, index) => {
                 const key = sf.breakpointId + "_" + index;
 
                 for (const frame of oldFrames) {
@@ -219,7 +226,7 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
 
         return result;
 
-        function collectVariables(vars: Variable[])  {
+        function collectVariables(vars: Variable[]) {
             vars.forEach(v => {
                 result.push(v);
                 if (v.children) {
@@ -261,8 +268,16 @@ export class DebuggerVariables extends data.Component<DebuggerVariablesProps, De
     }
 }
 
+function variablesToVariableList(newVars: pxsim.Variables) {
+    const current = Object.keys(newVars).map(varName => ({
+        name: fixVarName(varName),
+        value: newVars[varName]
+    }));
+    return current;
+}
+
 function updateScope(lastScope: ScopeVariables, newVars: pxsim.Variables, params?: Variable[]): ScopeVariables {
-    let current = Object.keys(newVars).map(varName => ({ name: fixVarName(varName), value: newVars[varName] }));
+    let current = variablesToVariableList(newVars);
 
     if (params) {
         current = params.concat(current);