Update notebook variable inheritance for variable changes

Author: znorman-harris

apps/client-e2e/src/tests/interactions/_interactions-runner.ts

@@ -38,6 +38,7 @@ import { NotebookProblemsTrackRight } from './notebooks/notebook-problems-track-
 import { NotebookCompletionBasic } from './notebooks/notebooks-completion-basic';
 import { NotebooksInteractRight } from './notebooks/notebooks-interact-right';
 import { NotebooksNoDuplicateRoutines } from './notebooks/notebooks-no-duplicate-routines';
+import { NotebooksNoUndefinedVars } from './notebooks/notebooks-no-undefined-vars';
 import { BasicSymbolicLinks } from './symbolic-links/basic-symbolic-links';
 import { BasicSymbolicLinksWithProblems } from './symbolic-links/basic-symbolic-links-with-problems';
 import { InteractionSymbolicLinkProblemReporting } from './symbolic-links/interaction-symbolic-links-problem-reporting';
@@ -221,6 +222,11 @@ INTERACTIONS_RUNNER.addTest({
   fn: NotebookImpliedPrintProblemReporting,
 });
 
+INTERACTIONS_RUNNER.addTest({
+  name: 'Notebooks properly inherit variables',
+  fn: NotebooksNoUndefinedVars,
+});
+
 INTERACTIONS_RUNNER.addTest({
   name: 'Detect duplicate globals from two PRO files',
   fn: DuplicateGlobals,

apps/client-e2e/src/tests/interactions/notebooks/notebooks-no-undefined-vars.ts

@@ -0,0 +1,29 @@
+import { GetExtensionPath, Sleep } from '@idl/shared';
+import { OpenNotebookInVSCode } from '@idl/vscode/shared';
+import expect from 'expect';
+import * as vscode from 'vscode';
+
+import { CLIENT_E2E_CONFIG } from '../../client-e2e-config.interface';
+import { RunnerFunction } from '../../runner.interface';
+
+/**
+ * Verifies our variables are defined
+ */
+export const NotebooksNoUndefinedVars: RunnerFunction = async (init) => {
+  const doc = await OpenNotebookInVSCode(
+    GetExtensionPath('idl/test/client-e2e/notebooks/no-undefined-vars.idlnb')
+  );
+
+  // short pause
+  await Sleep(CLIENT_E2E_CONFIG.DELAYS.PROBLEMS_NOTEBOOK);
+
+  //  no problems in first cell
+  expect(
+    vscode.languages.getDiagnostics(doc.cellAt(0).document.uri).length
+  ).toEqual(0);
+
+  // no problems in second cell
+  expect(
+    vscode.languages.getDiagnostics(doc.cellAt(1).document.uri).length
+  ).toEqual(0);
+};

idl/test/client-e2e/notebooks/no-undefined-vars.idlnb

@@ -0,0 +1,21 @@
+{
+  "version": "2.0.0",
+  "cells": [
+    {
+      "type": "code",
+      "content": [
+        "e = envi(/headless)"
+      ],
+      "metadata": {},
+      "outputs": []
+    },
+    {
+      "type": "code",
+      "content": [
+        "print, e.task_names, /implied_print"
+      ],
+      "metadata": {},
+      "outputs": []
+    }
+  ]
+}

libs/parsing/index/src/lib/helpers/populate-notebook-variables.ts

@@ -85,7 +85,9 @@ export function PopulateNotebookVariables(
          */
         const otherVarName = otherVars[j];
 
-        // inherit variable
+        /**
+         * Inherit variable that we detect
+         */
         if (otherVarName in ourMain) {
           /**
            * Check if we need to set the variable (it hasnt been processed already)
@@ -109,13 +111,18 @@ export function PopulateNotebookVariables(
             weSet[otherVarName] = undefined;
           }
 
-          // if we arent defined, inherit
+          // if we arent defined in our cell, inherit
           if (!ourMain[otherVarName].meta.isDefined) {
             ourMain[otherVarName].meta.isDefined =
               otherMain[otherVarName].meta.isDefined;
             ourMain[otherVarName].meta.type = otherMain[otherVarName].meta.type;
             ourMain[otherVarName].meta.isStaticClass =
               otherMain[otherVarName].meta.isStaticClass;
+
+            // if the other variable is defined, then set as we dont reset for post-processing
+            if (otherMain[otherVarName].meta.isDefined) {
+              ourMain[otherVarName].meta.canReset = false;
+            }
           }
         } else {
           // copy