🧪 Create Cypress test for Roles of variables

app.py

@@ -614,6 +614,7 @@ def parse():
                 response['has_sleep'] = True
 
             response['variables'] = transpile_result.roles_of_variables
+            response['show_roles'] = utils.show_roles_of_variables() == "True"
         except Exception:
             pass
 
@@ -2953,6 +2954,7 @@ def on_offline_mode():
     env_defaults = dict(
         BASE_URL=f"http://localhost:{config['port']}/",
         ADMIN_USER="admin",
+        SHOW_ROLES="False",
     )
     for key, value in env_defaults.items():
         if key not in os.environ:

static/js/app.ts

@@ -601,7 +601,7 @@ export async function runit(level: number, lang: string, raw: boolean, disabled_
       program_data = theGlobalDebugger.get_program_data();
     }
 
-    runPythonProgram(program_data.Code, program_data.source_map, program_data.has_turtle, program_data.has_pressed, program_data.has_sleep, program_data.has_clear, program_data.has_music, program_data.Warning, program_data.variables, program_data.is_modified ,cb, run_type).catch(function(err: any) {
+    runPythonProgram(program_data.Code, program_data.source_map, program_data.has_turtle, program_data.has_pressed, program_data.has_sleep, program_data.has_clear, program_data.has_music, program_data.Warning, program_data.variables, program_data.show_roles, program_data.is_modified ,cb, run_type).catch(function(err: any) {
       // The err is null if we don't understand it -> don't show anything
       if (err != null) {
         error.show(ClientMessages['Execute_error'], err.message);
@@ -921,7 +921,7 @@ window.onerror = function reportClientException(message, source, line_number, co
   });
 }
 
-export function runPythonProgram(this: any, code: string, sourceMap: any, hasTurtle: boolean, hasPressed: boolean, hasSleep: number[], hasClear: boolean, hasMusic: boolean, hasWarnings: boolean, variables: any, isModified: boolean, cb: () => void, run_type: "run" | "debug" | "continue") {
+export function runPythonProgram(this: any, code: string, sourceMap: any, hasTurtle: boolean, hasPressed: boolean, hasSleep: number[], hasClear: boolean, hasMusic: boolean, hasWarnings: boolean, variables: any, showRoles: any, isModified: boolean, cb: () => void, run_type: "run" | "debug" | "continue") {
   // If we are in the Parsons problem -> use a different output
   let outputDiv = $('#output');
   let skip_faulty_found_errors = false;
@@ -1168,7 +1168,8 @@ export function runPythonProgram(this: any, code: string, sourceMap: any, hasTur
       has_clear: hasClear,
       has_music: hasMusic,
       Warning: hasWarnings,
-      variables: variables
+      variables: variables,
+      show_roles: showRoles
     });
 
     startDebug();

static/js/appbundle.js

@@ -103600,7 +103600,6 @@ def note_with_error(value, err):
   var theLanguage;
   var TRADUCTION2;
   var variable_view = true;
-  var showRoles = false;
   var step_debugger = false;
   var fullLineCommands = [
     "print",
@@ -103652,6 +103651,7 @@ def note_with_error(value, err):
         if (variables[i][1]) {
           const variableName = variables[i][0].replace(/^_/, "");
           const role = programData == null ? void 0 : programData.variables[variableName];
+          const showRoles = theGlobalDebugger.getProgramData().show_roles === "False";
           if (showRoles) {
             variableList.append(`<li style=color:${variables[i][2]}>${variableName}: ${variables[i][1]} (${role})</li>`);
           } else {
@@ -120115,7 +120115,7 @@ def note_with_error(value, err):
       } else {
         program_data = theGlobalDebugger.get_program_data();
       }
-      runPythonProgram(program_data.Code, program_data.source_map, program_data.has_turtle, program_data.has_pressed, program_data.has_sleep, program_data.has_clear, program_data.has_music, program_data.Warning, program_data.variables, program_data.is_modified, cb2, run_type).catch(function(err) {
+      runPythonProgram(program_data.Code, program_data.source_map, program_data.has_turtle, program_data.has_pressed, program_data.has_sleep, program_data.has_clear, program_data.has_music, program_data.Warning, program_data.variables, program_data.show_roles, program_data.is_modified, cb2, run_type).catch(function(err) {
         if (err != null) {
           error.show(ClientMessages["Execute_error"], err.message);
           reportClientError(level3, code, err.message);
@@ -120375,7 +120375,7 @@ def note_with_error(value, err):
       user_agent: navigator.userAgent
     });
   };
-  function runPythonProgram(code, sourceMap, hasTurtle, hasPressed, hasSleep, hasClear, hasMusic, hasWarnings, variables, isModified, cb2, run_type) {
+  function runPythonProgram(code, sourceMap, hasTurtle, hasPressed, hasSleep, hasClear, hasMusic, hasWarnings, variables, showRoles, isModified, cb2, run_type) {
     let outputDiv = $("#output");
     let skip_faulty_found_errors = false;
     let warning_box_shown = false;
@@ -120569,7 +120569,8 @@ def note_with_error(value, err):
         has_clear: hasClear,
         has_music: hasMusic,
         Warning: hasWarnings,
-        variables
+        variables,
+        show_roles: showRoles
       });
       startDebug();
       return theGlobalDebugger.startDebugger(() => Sk.importMainWithBody("<stdin>", false, code, true), theGlobalDebugger).then(function() {

static/js/debugging.ts

@@ -8,7 +8,7 @@ let TRADUCTION: Map<string,string>;
 
 //Feature flag for variable and values view
 let variable_view = true;
-let showRoles = false;
+//let showRoles = true;
 let step_debugger = false;
 const fullLineCommands = [
   'print',
@@ -79,6 +79,7 @@ export function load_variables(variables: any) {
       if (variables[i][1]) {
         const variableName = variables[i][0].replace(/^_/, '');
         const role = programData?.variables[variableName];
+        const showRoles = theGlobalDebugger.getProgramData().show_roles === "False";
         if (showRoles) {
           variableList.append(`<li style=color:${variables[i][2]}>${variableName}: ${variables[i][1]} (${role})</li>`);
         } else {

utils.py

@@ -99,6 +99,15 @@ def is_debug_mode():
     return DEBUG_MODE
 
 
+def show_roles_of_variables():
+    """Whether the roles of variables should be shown in the variable view.
+    (If not, only variable names and values will be shown in the list).
+    Checks the configuration in the environment variable $SHOW_ROLES    
+    """
+    can_show_roles = os.getenv("SHOW_ROLES", False)
+    return can_show_roles
+
+
 def is_offline_mode():
     """Return whether or not we're in offline mode.