Merge remote-tracking branch 'origin/develop'

Author: znorman-harris

CHANGELOG.md

@@ -16,6 +16,42 @@ Document some advanced types so users may try them out and provide feedback. The
 
 - Read more in the extension documentation
 
+## 4.5.0 - May 2024
+
+New-and improved IDL Notebook user experience!
+
+- When compiling cells, we don't show you the output from compiling to focus on what runs
+
+- The paths for notebook cells have been cleaned up and are now easy to read (before they had IDs in the names of the paths)
+
+- Notebook cells now offer implied print! For main level programs (i.e. cells by default), we detect and automatically print variables, outputs from function calls, and expressions like "2 + 42". You can see some examples of this in our sample IDL Notebook included with the extension.
+
+- Variables that will be printed have a special semantic token highlighting applied to them to make it clear it is not being interpreted as a procedure. This depends on your VSCode theme, but should either look like other variables or stands out compared to procedure calls.
+
+- After running a notebook cell, we check to see if there is any output. If there is no output, we do not create notebook cell output. Previously we always added output to cells, even if there wasn't anything to track.
+
+Fixed an issue where we incorrectly reported an error when using the property index signature to retrieve a property. This affected statements of the form "struct.(0).(0)"
+
+Add icons for the languages that we contribute to the extension
+
+Add human-readable names for the languages that we contribute
+
+Fixed an edge case when reporting that a variable cannot be indexed with the `!null` type
+
+Type detection now properly handles the following cases:
+
+- Any statement using `&&` or `||` will return boolean type
+
+- Any statement using a logical operator should return the correct type (i.e. `eq`, `ne`, `le`). For example: `[1,2,3] eq 5` should give a type of `Array<Boolean>`. This supports lists, hashes, orderedhashes, and dictionaries.
+
+These type changes help fix scenarios where we were incorrectly reporting errors for extension users.
+
+The extension now automatically detects when you have code that is "standalone" which needs to be assigned to a value (or have a value assigned to it).
+
+When running IDL through the debug console, we now properly catch stops/breakpoints that aren't a result of manually sending commands to IDL. This supports use cases where widget/UI applications are running and hit a stop or breakpoint in a callback routine.
+
+Moved the following features out of `preview` since there have been no reported issues:
+
 Added the ability to convert a notebook to a PDF! This requires an additional extension called ":"Markdown PDF", which you will be prompted to install. This includes:
 
 - A new sidebar entry for PDF generation and a button in the top-right of the notebook to generate a PDF

README.md

@@ -32,7 +32,7 @@
 
 <div  align="center">
   <video controls autoplay loop muted playsinline style="max-width: 720px; width: 100%">
-    <source src="https://l3harrisgeospatial-webcontent.s3.amazonaws.com/vscode-idl/vscode-tiny.mp4" type="video/mp4">
+    <source src="https://vis-webcontent.s3.amazonaws.com/vscode-idl/vscode-tiny.mp4" type="video/mp4">
   </video>
 </div>
 

apps/client-e2e/src/main.ts

@@ -9,7 +9,7 @@ import { performance } from 'perf_hooks';
 import * as vscode from 'vscode';
 
 import { ResetSettingsForTests } from './tests/helpers/reset-settings-for-tests';
-import { TestRunner } from './tests/runner';
+import { TestRunner } from './tests/test-runner';
 
 /**
  * Value returned from activating our extension

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

@@ -15,6 +15,7 @@ import { RigorousAlwaysReturn } from './rigorous-always-return';
 import { RunFile } from './run-file';
 import { StartDebugging } from './start';
 import { SyntaxErrorTracking } from './syntax_error_tracking';
+import { TimerStop } from './timer-stop';
 import { VariableReplacement } from './variable-replacement';
 
 /**
@@ -76,6 +77,11 @@ DEBUGGING_RUNNER.addTest({
   fn: BreakpointSetBeforeStart,
 });
 
+DEBUGGING_RUNNER.addTest({
+  name: 'Detect stops not from manually running code',
+  fn: TimerStop,
+});
+
 DEBUGGING_RUNNER.addTest({
   name: 'Compile file and open the file we compiled',
   fn: Compile,

apps/client-e2e/src/tests/debugging/timer-stop.ts

@@ -0,0 +1,64 @@
+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 runs a test and makes sure debugging stops and detects the line we are on
+ */
+export const TimerStop: 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/timer_stop.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();
+
+  // sleep and wait for our timer callback to get hit
+  await Sleep(1500);
+
+  // 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: 12, file },
+    { line: 19, file },
+  ]);
+
+  // return - IDL bug/behavior where we need to do it twice
+  await init.debug.adapter.evaluate('retall');
+
+  // sleep and wait for our timer callback to get hit
+  await Sleep(500);
+
+  // return again to work around windows bug
+  await init.debug.adapter.evaluate('retall');
+};

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

@@ -17,6 +17,7 @@ import { IDLDisableIndividualsFromSettingsForNotebook } from './idl-disable-indi
 import { IDLJSONInteractRight } from './idl-json-interact-right';
 import { IndexIDLFolderRightAndOpenEditClose } from './index-idl-folder-right-and-open-edit-close';
 import { MigrateCodeDL30, MigrateCodeDL30_2 } from './migrate-code-dl-3.0';
+import { NotebookImpliedPrintProblemReporting } from './notebook-implied-print-problem-reporting';
 import { NotebookProblemsTrackRight } from './notebook-problems-track-right';
 import { NotebookCompletionBasic } from './notebooks-completion-basic';
 import { NotebooksInteractRight } from './notebooks-interact-right';
@@ -158,3 +159,8 @@ INTERACTIONS_RUNNER.addTest({
   name: 'Notebook problems track right',
   fn: NotebookProblemsTrackRight,
 });
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Notebooks report problems right for implied print and standalone expressions',
+  fn: NotebookImpliedPrintProblemReporting,
+});

apps/client-e2e/src/tests/interactions/notebook-implied-print-problem-reporting.ts

@@ -0,0 +1,37 @@
+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';
+
+/**
+ * Function that verifies problems reported for implied print
+ */
+export const NotebookImpliedPrintProblemReporting: RunnerFunction = async (
+  init
+) => {
+  // open our notebook
+  const nb = await OpenNotebookInVSCode(
+    GetExtensionPath(
+      'idl/test/client-e2e/notebooks/problems/implied-print.idlnb'
+    ),
+    true
+  );
+
+  // short pause
+  await Sleep(CLIENT_E2E_CONFIG.DELAYS.PROBLEMS_NOTEBOOK);
+
+  /** Get current cells */
+  const cells = nb.getCells();
+
+  /**
+   * Verify no problems
+   */
+  expect(
+    cells.map(
+      (cell) => vscode.languages.getDiagnostics(cell.document.uri).length
+    )
+  ).toEqual([0, 1, 0]);
+};

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

@@ -13,6 +13,9 @@ import { RunNotebookStop } from './notebook-stop';
 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';
+import { NotebooksReplaceCellPathsForError } from './notebooks-replace-cell-paths-for-error';
+import { NotebooksReplaceCellPathsOnStop } from './notebooks-replace-cell-paths-on-stop';
+import { NotebooksVerifyImpliedPrint } from './notebooks-verify-implied-print';
 import { OpenENVINotebookExample } from './open-envi-notebook-example';
 import { OpenIDLNotebookExample } from './open-idl-notebook-example';
 import { ResetNotebookExamples } from './reset-notebook-examples';
@@ -174,6 +177,26 @@ NOTEBOOK_RUNNER.addTest({
   fn: NotebookCallStackDecorationsNoDecorations,
 });
 
+NOTEBOOK_RUNNER.addTest({
+  name: 'Stack trace decorations dont show for normal execution',
+  fn: NotebookCallStackDecorationsNoDecorations,
+});
+
+NOTEBOOK_RUNNER.addTest({
+  name: 'Replace cell paths for stops',
+  fn: NotebooksReplaceCellPathsOnStop,
+});
+
+NOTEBOOK_RUNNER.addTest({
+  name: 'Replace cell paths for errors',
+  fn: NotebooksReplaceCellPathsForError,
+});
+
+NOTEBOOK_RUNNER.addTest({
+  name: 'Implied print does the right thing',
+  fn: NotebooksVerifyImpliedPrint,
+});
+
 // reset goes first
 NOTEBOOK_RUNNER.addTest({
   name: 'Reset does the right thing',

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

@@ -65,7 +65,7 @@ export async function CompareCellOutputs(
 /**
  * Compares cells and outputs to make sure they match what we expect them to be
  */
-export function CompareCellsAndOutputs(
+export function CompareCellKindsAndOutputs(
   nb: vscode.NotebookDocument,
   cellsAndOutput: ICompareCellAndOutputs[]
 ) {

apps/client-e2e/src/tests/notebooks/helpers/compare-notebook-json-outputs.ts

@@ -0,0 +1,52 @@
+import {
+  IDLRawNotebook,
+  IDLRawNotebookVersion_2_0_0,
+} from '@idl/types/notebooks';
+import expect from 'expect';
+import { readFileSync } from 'fs';
+
+/**
+ * gets outputs that we can compare
+ */
+function GetOutputs(data: IDLRawNotebook<IDLRawNotebookVersion_2_0_0>) {
+  return data.cells
+    .map((cell) =>
+      (cell.outputs || [])
+        .map((output) =>
+          output.items
+            .map((item) =>
+              Array.isArray(item.content)
+                ? item.content.join('\n').trimEnd().split(/\n/gim)
+                : [item.content.trimEnd()]
+            )
+            .flat()
+        )
+        .flat()
+    )
+    .flat();
+}
+
+/**
+ * Compares the JSON text content of two notebook files on disk
+ */
+export async function CompareNotebookJSONOutputs(
+  referenceUri: string,
+  actualUri: string
+) {
+  /**
+   * Get reference notebook
+   */
+  const refData: IDLRawNotebook<IDLRawNotebookVersion_2_0_0> = JSON.parse(
+    readFileSync(referenceUri, 'utf-8')
+  );
+
+  /**
+   * Get actual notebook
+   */
+  const actualData: IDLRawNotebook<IDLRawNotebookVersion_2_0_0> = JSON.parse(
+    readFileSync(actualUri, 'utf-8')
+  );
+
+  // compare
+  expect(GetOutputs(refData)).toEqual(GetOutputs(actualData));
+}