Merge branch 'develop'

Author: znorman-harris

CHANGELOG.md

@@ -16,6 +16,26 @@ Document some advanced types so users may try them out and provide feedback. The
 
 - Read more in the extension documentation
 
+## 4.5.1 - May 2024
+
+Continuing with our story of IDL Notebook user experience, each session of notebook now gets it's own instance of IDL! This means a few things:
+
+- You can now run more than one IDL Notebook in parallel! This makes it easy to crank through data or multi-task to your heart's content.
+
+- Each session of IDL notebook is sand-boxed and a separate process. This means notebooks won't interact with each other.
+
+- When you close an IDL Notebook, the associated IDL Kernel is automatically stopped
+
+- A new sidebar entry in the Notebook section, allows you to stop all IDL Notebook Kernels
+
+Remove a false error report when you stop IDL (terminate the process) while it is running
+
+Fixed an error where we were not automatically returning from the main level when you compiled a main level program.
+
+Fixed an issue in IDL Notebooks where, once ENVI is started, a notebook no longer can embed multiple graphics in a single notebook cell.
+
+When ENVI is started, as long as the UI is not present, we now embed direct graphics. If the ENVI UI is open, we dont embed direct graphics.
+
 ## 4.5.0 - May 2024
 
 New-and improved IDL Notebook user experience!

apps/client-e2e/src/tests/debugging/_debugging-runner.ts

@@ -22,7 +22,7 @@ import { VariableReplacement } from './variable-replacement';
  * Logger to be used for tests related to debugging
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-function
-export const DEBUG_TEST_LOGGER = new Logger('tests-debug', false, () => {});
+export const DEBUG_TEST_LOGGER = new Logger('debugging-tests', false, () => {});
 
 /**
  * Test runner for debugging

apps/client-e2e/src/tests/debugging/return-from-main.ts

@@ -0,0 +1,69 @@
+import { GetExtensionPath, IDL_COMMANDS, Sleep } from '@idl/shared';
+import { OpenFileInVSCode } from '@idl/vscode/shared';
+import expect from 'expect';
+import * as vscode from 'vscode';
+
+import { RunnerFunction } from '../runner.interface';
+
+/**
+ * Function that makes sure we return from main on compiling main
+ */
+export const ReturnFromMain: RunnerFunction = async (init) => {
+  /**
+   * Start IDL
+   */
+  const started = await vscode.commands.executeCommand(
+    IDL_COMMANDS.DEBUG.START
+  );
+
+  // verify we started
+  expect(started).toBeTruthy();
+
+  // close
+  await vscode.commands.executeCommand('workbench.action.closeAllEditors');
+
+  /** Get the file with timer callback */
+  const file = GetExtensionPath(
+    'idl/test/client-e2e/debug/return_from_main.pro'
+  );
+
+  // open file
+  await OpenFileInVSCode(file, true);
+
+  // short pause
+  await Sleep(100);
+
+  // run
+  const res = await vscode.commands.executeCommand(IDL_COMMANDS.DEBUG.RUN);
+
+  // make sure that we could run
+  expect(res).toBeTruthy();
+
+  // get call stack
+  const stack = (await init.debug.adapter._runtime.getCallStack()).frames.map(
+    (item) => {
+      return { line: item.line, file: item.file };
+    }
+  );
+
+  // make sure our call stack matches
+  expect(stack).toEqual([{ line: 3, file }]);
+
+  // compile
+  const recompile = await vscode.commands.executeCommand(
+    IDL_COMMANDS.DEBUG.COMPILE
+  );
+
+  // make sure that we could run
+  expect(recompile).toBeTruthy();
+
+  // get call stack
+  const stack2 = (await init.debug.adapter._runtime.getCallStack()).frames.map(
+    (item) => {
+      return { line: item.line, file: item.file };
+    }
+  );
+
+  // make sure our call stack matches
+  expect(stack2).toEqual([{ line: 1, file }]);
+};

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

@@ -33,7 +33,7 @@ import { TasksInteractRight } from './tasks-interact-right';
  * Logger to be used for tests related to debugging
  */
 export const INTERACTIONS_TEST_LOGGER = new Logger(
-  'tests-interaction',
+  'interaction-tests',
   false,
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   () => {}

apps/client-e2e/src/tests/notebooks/_notebook-runner.ts

@@ -10,6 +10,7 @@ import { NotebookFormats_1_0_0 } from './notebook-formats-1.0.0';
 import { NotebookFormats_2_0_0 } from './notebook-formats-2.0.0';
 import { RunNotebookReset } from './notebook-reset';
 import { RunNotebookStop } from './notebook-stop';
+import { RunNotebookStopAll } from './notebook-stop-all';
 import { NotebookToProCodeAllCells } from './notebook-to-pro-code-all-cells';
 import { NotebookToProCodeAllCells2 } from './notebook-to-pro-code-all-cells-2';
 import { NotebookToProCodeOnlyCode } from './notebook-to-pro-code-only-code';
@@ -20,6 +21,8 @@ import { OpenENVINotebookExample } from './open-envi-notebook-example';
 import { OpenIDLNotebookExample } from './open-idl-notebook-example';
 import { ResetNotebookExamples } from './reset-notebook-examples';
 import { RunENVIMessageListenerTestNotebook } from './run-envi-message-listener-test-notebook';
+import { RunENVIMultiPlotNotebook } from './run-envi-multi-plot-notebook';
+import { RunPlotRegressionNotebook } from './run-plot-regression-notebook';
 import { RunProblemNotebooks } from './run-problem-notebooks';
 import { RunTestENVIMapNotebook } from './run-test-envi-map-notebook';
 import { RunTestENVINotebook } from './run-test-envi-notebook';
@@ -32,7 +35,7 @@ import { VerifyQuietNotebookSetting } from './verify-quiet-notebook-setting';
  * Logger to be used for tests related to debugging
  */
 export const NOTEBOOK_TEST_LOGGER = new Logger(
-  'tests-notebook',
+  'notebook-tests',
   false,
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   () => {}
@@ -162,8 +165,25 @@ NOTEBOOK_RUNNER.addTest({
   ],
 });
 
+// can get multiple graphics when ENVI has started
 NOTEBOOK_RUNNER.addTest({
-  name: 'Stack trace decorations on execution halted 1',
+  name: 'Notebooks can display more than one plot when ENVI has started',
+  fn: RunENVIMultiPlotNotebook,
+  excludeOS: [
+    {
+      os: ['darwin'],
+      architecture: ['arm', 'arm64'],
+    },
+  ],
+});
+
+NOTEBOOK_RUNNER.addTest({
+  name: 'Regression test to re-embed graphics on property changes',
+  fn: RunPlotRegressionNotebook,
+});
+
+NOTEBOOK_RUNNER.addTest({
+  name: 'Stack trace decorations on execution halted #1',
   fn: NotebookCallStackDecorationsOnExecutionHalted1,
 });
 
@@ -204,6 +224,13 @@ NOTEBOOK_RUNNER.addTest({
   critical: true,
 });
 
+// stop all notebooks
+NOTEBOOK_RUNNER.addTest({
+  name: 'Stop all does the right thing',
+  fn: RunNotebookStopAll,
+  critical: true,
+});
+
 // stop at the end to make sure the process exits
 NOTEBOOK_RUNNER.addTest({
   name: 'Stop does the right thing',

apps/client-e2e/src/tests/notebooks/helpers/run-notebook-and-check-call-stack-decorations.ts

@@ -52,7 +52,7 @@ export async function RunNotebookAndCheckCallStackDecorations(
   await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
 
   // make sure launched
-  expect(controller.isStarted()).toBeTruthy();
+  expect(controller.isStarted(nb)).toBeTruthy();
 
   // short pause based on the number of cells we have
   // sometimes the rendering takes too long to register (like complex maps)

apps/client-e2e/src/tests/notebooks/helpers/run-notebook-and-compare-cells.ts

@@ -49,7 +49,7 @@ export async function RunNotebookAndCompareCells(
   await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
 
   // make sure launched
-  expect(controller.isStarted()).toBeTruthy();
+  expect(controller.isStarted(nb)).toBeTruthy();
 
   // short pause based on the number of cells we have
   // sometimes the rendering takes too long to register (like complex maps)

apps/client-e2e/src/tests/notebooks/notebook-reset.ts

@@ -39,7 +39,7 @@ export const RunNotebookReset: RunnerFunction = async (init) => {
   await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
 
   // make sure launched
-  expect(init.notebooks.controller.isStarted()).toBeTruthy();
+  expect(init.notebooks.controller.isStarted(nb)).toBeTruthy();
 
   // trigger a run
   vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
@@ -54,7 +54,7 @@ export const RunNotebookReset: RunnerFunction = async (init) => {
   await Sleep(100);
 
   // make sure stopped
-  expect(init.notebooks.controller.isStarted()).toBeTruthy();
+  expect(init.notebooks.controller.isStarted(nb)).toBeTruthy();
 
   // compare state
   CompareCellOutputs(nb, CELL_OUTPUT);

apps/client-e2e/src/tests/notebooks/notebook-stop-all.ts

@@ -0,0 +1,38 @@
+import { GetExtensionPath, IDL_COMMANDS, Sleep } from '@idl/shared';
+import { OpenNotebookInVSCode, VSCODE_COMMANDS } from '@idl/vscode/shared';
+import expect from 'expect';
+import * as vscode from 'vscode';
+
+import { RunnerFunction } from '../runner.interface';
+
+/**
+ * Stop all notebooks
+ */
+export const RunNotebookStopAll: RunnerFunction = async (init) => {
+  /**
+   * Get the file we are going to open
+   */
+  const file = GetExtensionPath(
+    'idl/test/client-e2e/notebooks/stop-notebook.idlnb'
+  );
+
+  /**
+   * Open the notebook
+   */
+  const nb = await OpenNotebookInVSCode(file);
+
+  // trigger a run to start IDL
+  await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
+
+  // make sure launched
+  expect(init.notebooks.controller.isStarted(nb)).toBeTruthy();
+
+  // stop all notebooks
+  await vscode.commands.executeCommand(IDL_COMMANDS.NOTEBOOKS.STOP_ALL_KERNELS);
+
+  // short pause
+  await Sleep(500);
+
+  // make sure stopped
+  expect(init.notebooks.controller.isStarted(nb)).toBeFalsy();
+};

apps/client-e2e/src/tests/notebooks/notebook-stop.ts

@@ -39,7 +39,7 @@ export const RunNotebookStop: RunnerFunction = async (init) => {
   await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
 
   // make sure launched
-  expect(init.notebooks.controller.isStarted()).toBeTruthy();
+  expect(init.notebooks.controller.isStarted(nb)).toBeTruthy();
 
   // trigger a run
   vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
@@ -54,7 +54,7 @@ export const RunNotebookStop: RunnerFunction = async (init) => {
   await Sleep(100);
 
   // make sure stopped
-  expect(init.notebooks.controller.isStarted()).toBeFalsy();
+  expect(init.notebooks.controller.isStarted(nb)).toBeFalsy();
 
   // compare state
   CompareCellOutputs(nb, CELL_OUTPUT);