Enable debugging IW in vscode.web and add tests for IW on web #10297

DonJayamanne · 2022-06-03T04:35:30Z

I think we need this for the release:

Enable IW debugging for web
Enables IW (running cells) for Python files (currently only works if you open a desktop folder, & not for virtual files systems)

Changes/Fixes

Enables tests for IW on the web (required for this PR and for testing IW debugging)
Enables the code lenses to debug cells in IW (this was disabled)
Enables code lenses for running of cells in IW
Currently we only enable this for file schemes, i.e. if you open desktop files in web, meaning it will not work for other file systems like github or the like.
Adds a common set of tests for Web & desktop instead of having to create 3 files, ie one test file *.vscode.common.test.ts that will run in both places

DonJayamanne · 2022-06-03T04:36:06Z

.vscode/launch.json

@@ -206,7 +206,7 @@
                "VSC_JUPYTER_WEBVIEW_TEST_MIDDLEWARE": "true", // Initialize to create the webview test middleware
                "VSC_JUPYTER_LOAD_EXPERIMENTS_FROM_FILE": "true",
                // "TF_BUILD": "", // Set to anything to force full logging
-                "TEST_FILES_SUFFIX": "vscode.test",
+                "TEST_FILES_SUFFIX": "(*.vscode.test|*.vscode.common.test)",


Files with the extensions *.vscode.common.test will also run on the desktop.

DonJayamanne · 2022-06-03T04:36:24Z

src/interactive-window/editor-integration/codeLensFactory.ts

@@ -265,13 +258,9 @@ export class CodeLensFactory implements ICodeLensFactory {
                Commands.RunCellAndAllBelowPalette
            ];
        }
-        if (this.isWebExtension) {
-            commandsToBeDisabled.push(Commands.DebugCell);


Debugging cells in IW web is now enabled.

DonJayamanne · 2022-06-03T04:37:07Z

src/interactive-window/editor-integration/codelensprovider.ts

@@ -78,7 +78,7 @@ export class DataScienceCodeLensProvider implements IDataScienceCodeLensProvider
    // CodeLensProvider interface
    // Some implementation based on DonJayamanne's jupyter extension work
    public provideCodeLenses(document: vscode.TextDocument, _token: vscode.CancellationToken): vscode.CodeLens[] {
-        if (document.uri.scheme != PYTHON_FILE.scheme && document.uri.scheme !== PYTHON_UNTITLED.scheme) {
+        if ([NotebookCellScheme, InteractiveInputScheme].includes(document.uri.scheme)) {


Running cells doesn't work in IW on the web unless you open a local folder, i.e. if you open a github repo or any other file system it will not work, hence now enabling it for all except notebook cells & IW input cell.

DonJayamanne · 2022-06-03T04:37:22Z

src/platform/common/globalActivation.ts

@@ -53,10 +53,7 @@ export class GlobalActivation implements IExtensionSingleActivationService {
    public async activate(): Promise<void> {
        if (this.dataScienceCodeLensProvider) {
            this.extensionContext.subscriptions.push(
-                vscode.languages.registerCodeLensProvider(


Running cells doesn't work in IW on the web unless you open a local folder, i.e. if you open a github repo or any other file system it will not work, hence now enabling it for all except notebook cells & IW input cell.

DonJayamanne · 2022-06-03T04:38:41Z

src/test/common.node.ts

+            }
+            return { file: Uri.file(tempFile), dispose: () => swallowExceptions(() => fs.unlinkSync(tempFile)) };
+        },
+        async startJupyterServer(notebook?: NotebookDocument, useCert: boolean = false): Promise<any> {


We end up duplicating the test files because some functions like StartJupyter, createTempFile are specific to web vs desktop.
Created a common layer so that we call the common function and inject the actual implementation during runtime.
This way we don't need to duplicate files or the like. I.e. we can write some code that will run in all places (web & desktop tests)

DonJayamanne · 2022-06-03T04:39:14Z

src/test/datascience/helpers.node.ts

 export * from './helpers';

-// The default base set of data science settings to use
-export function defaultDataScienceSettings(): IJupyterSettings {


All of these are common (can work on web as wel)

DonJayamanne · 2022-06-03T04:41:46Z

src/test/datascience/notebook/ipywidget.vscode.common.test.ts

-    startJupyterServer: (notebook?: NotebookDocument) => Promise<void>
-) {
-    suite.timeout(120_000);
+suite('DataScience - VSCode Notebook - Standard', function () {


A single test file for both web and desktop.

DonJayamanne · 2022-06-03T04:41:59Z

src/test/datascience/notebook/kernelEvents.vscode.common.test.ts

-        startJupyterServer: (notebook?: NotebookDocument) => Promise<void>;
-    }
-) {
+suite('Kernel Event', function () {


Single test file for web & desktop

codecov-commenter · 2022-06-03T04:53:08Z

Codecov Report

Merging #10297 (5b84a21) into main (e09146f) will decrease coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           main   #10297   +/-   ##
=====================================
- Coverage    64%      64%   -1%     
=====================================
  Files       204      204           
  Lines      9295     9295           
  Branches   1505     1505           
=====================================
- Hits       5963     5957    -6     
- Misses     2864     2867    +3     
- Partials    468      471    +3

Impacted Files	Coverage Δ
src/platform/common/globalActivation.ts	`92% <100%> (ø)`
...c/platform/errors/kernelPortNotUsedTimeoutError.ts	`66% <0%> (-34%)`	⬇️
src/platform/common/cancellation.ts	`62% <0%> (-6%)`	⬇️
src/platform/api/kernelApi.ts	`71% <0%> (-2%)`	⬇️
src/platform/common/utils/misc.ts	`71% <0%> (+2%)`	⬆️

DonJayamanne · 2022-06-03T04:53:52Z

src/test/common.ts

+    startJupyterServer(notebook?: NotebookDocument, useCert?: boolean): Promise<void>;
+    stopJupyterServer?(): Promise<void>;
+    captureScreenShot?(fileNamePrefix: string): Promise<void>;
+    initialize(): Promise<IExtensionTestApi>;


These are the functions that are different on each platform, and if we had a common function for them, then we won't have to create two 3 seprate files for the tests, now that we have a common layer for these functions, we have just one single file (tests that run on web & desktop)

DonJayamanne · 2022-06-03T04:57:05Z

src/test/datascience/widgets/standard.vscode.common.test.ts

-    startJupyterServer: (notebook?: NotebookDocument) => Promise<void>,
-    handleTestFailure: (test: Mocha.Test) => Promise<void>
-) {
+suite('IPyWisdget Tests', function () {


Single file to test on web and desktop

DonJayamanne · 2022-06-03T07:00:57Z

src/test/datascience/jupyterServer.node.ts

        }
        if (this.availableSecondPort) {
-            await tcpPortUsed.waitUntilFree(this.availableSecondPort, 200, 5_000);
+            await tcpPortUsed.waitUntilFree(this.availableSecondPort, 200, 5_000).catch(noop);


These unhandled exceptions were causing the test runner to report false positives.

DonJayamanne · 2022-06-03T07:01:16Z

src/test/datascience/interactiveDebugging.vscode.common.ts

-            test('Update variables during stepping', async () => {
+            test('Update variables during stepping', async function () {
+                if (isWeb()) {
+                    return this.skip();


For some reason this isn't passing on the web, will fix seprately.

DonJayamanne · 2022-06-03T07:01:36Z

src/test/datascience/helpers.ts

@@ -5,6 +5,22 @@
 import * as vscode from 'vscode';
 import { getFilePath } from '../../platform/common/platform/fs-paths';
 import { traceInfo } from '../../platform/logging';
+import { noop } from 'lodash';


Moved all of this code from helpers.code.ts

DonJayamanne · 2022-06-03T07:02:44Z

src/test/datascience/interactiveWindow.vscode.common.test.ts

+import { sleep } from '../core';
+import { IPYTHON_VERSION_CODE } from '../constants';
+
+suite(`Interactive window`, async function () {


Interactive window tests for the web, very little work to enable this (once I enabled IW debugger tests for the web)

DonJayamanne · 2022-06-03T07:04:18Z

package.json

-        "testNativeNotebooksWithoutPythonInVSCode": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_JUPYTER_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=vscode.test* VSC_JUPYTER_FORCE_LOGGING=1 VSC_JUPYTER_LOAD_EXPERIMENTS_FROM_FILE=true VSC_JUPYTER_CI_TEST_GREP=non-python-kernel VSC_JUPYTER_CI_TEST_DO_NOT_INSTALL_PYTHON_EXT=true node ./out/test/testBootstrap.node.js ./out/test/standardTest.node.js",
-        "testNativeNotebooksAndWebviews": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_JUPYTER_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=vscode.test* VSC_JUPYTER_FORCE_LOGGING=1 VSC_JUPYTER_CI_TEST_GREP=webview-test VSC_JUPYTER_LOAD_EXPERIMENTS_FROM_FILE=true node ./out/test/testBootstrap.node.js ./out/test/standardTest.node.js",
+        "testNativeNotebooksWithoutPythonInVSCode": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_JUPYTER_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=*.vscode.test,*.vscode.common.test VSC_JUPYTER_FORCE_LOGGING=1 VSC_JUPYTER_LOAD_EXPERIMENTS_FROM_FILE=true VSC_JUPYTER_CI_TEST_GREP=non-python-kernel VSC_JUPYTER_CI_TEST_DO_NOT_INSTALL_PYTHON_EXT=true node ./out/test/testBootstrap.node.js ./out/test/standardTest.node.js",
+        "testNativeNotebooksAndWebviews": "cross-env CODE_TESTS_WORKSPACE=src/test/datascience VSC_JUPYTER_CI_TEST_VSC_CHANNEL=insiders TEST_FILES_SUFFIX=*.vscode.test,*.vscode.common.test VSC_JUPYTER_FORCE_LOGGING=1 VSC_JUPYTER_CI_TEST_GREP=webview-test VSC_JUPYTER_LOAD_EXPERIMENTS_FROM_FILE=true node ./out/test/testBootstrap.node.js ./out/test/standardTest.node.js",


New pattern to run *.vscode.test.ts and *.common.test.ts on desktop.
Unfortunately i cannot use a real glob patter like (*.vscode.test|*.common.test) as this breaks the npm script. Using ( and | in the npm scripts don't work.

DonJayamanne · 2022-06-03T07:04:47Z

src/kernels/raw/launcher/kernelProcess.node.ts

@@ -221,7 +221,7 @@ export class KernelProcess implements IKernelProcess {
                tcpPortUsed.waitUntilUsed(this.connection.shell_port, 200, timeout),
                tcpPortUsed.waitUntilUsed(this.connection.iopub_port, 200, timeout)
            ]).catch((ex) => {
-                if (cancelToken.isCancellationRequested) {
+                if (cancelToken.isCancellationRequested || deferred.rejected) {


No need to log errors if the other promise failed
This ensures we don't log errors unnecessarily (else we end up with false positives in the CI logs)

rchiodo · 2022-06-03T20:40:49Z

Uggh. We weren't going to submit this till I made the release branch.

I'll just create the release branch from one before this.

rchiodo · 2022-06-03T20:41:02Z

Then we have to cherry-pick Daniel's upcoming change.

DonJayamanne added 3 commits June 3, 2022 14:33

Enable debuggin IW in vscode.web and add tests

b332d00

Misc

4f33a75

oops

c353e89

DonJayamanne requested a review from a team as a code owner June 3, 2022 04:35

DonJayamanne commented Jun 3, 2022

View reviewed changes

DonJayamanne added 2 commits June 3, 2022 14:39

oops

f236045

oops

a8e8c78

DonJayamanne commented Jun 3, 2022

View reviewed changes

Misc

f9e3e2e

DonJayamanne commented Jun 3, 2022

View reviewed changes

Misc

4a160e6

DonJayamanne commented Jun 3, 2022

View reviewed changes

Tests

10ddaa1

DonJayamanne mentioned this pull request Jun 3, 2022

Add tests for IW on web #10296

Closed

DonJayamanne added 6 commits June 3, 2022 16:02

Fixes

3ed6117

IW tests

c3d969a

Oops

a059f54

oops

3900662

Misc

1b43926

oops

ab3bde4

DonJayamanne commented Jun 3, 2022

View reviewed changes

DonJayamanne changed the title ~~Enable debugging IW in vscode.web and add tests~~ Enable debugging IW in vscode.web and add tests for IW on web Jun 3, 2022

DonJayamanne added 4 commits June 3, 2022 17:17

Misc

3aaf2cf

oops

85ea958

oops

28d6d9c

oops

0bb7275

rchiodo approved these changes Jun 3, 2022

View reviewed changes

Merge remote-tracking branch 'origin/main' into enableIWDebuggingWeb

5b84a21

amunger mentioned this pull request Jun 3, 2022

removed node dependency from IW creation helper #10163

Closed

DonJayamanne merged commit 8de113e into main Jun 3, 2022

DonJayamanne deleted the enableIWDebuggingWeb branch June 3, 2022 20:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable debugging IW in vscode.web and add tests for IW on web #10297

Enable debugging IW in vscode.web and add tests for IW on web #10297

DonJayamanne commented Jun 3, 2022 •

edited

Loading

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

codecov-commenter commented Jun 3, 2022 •

edited

Loading

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

DonJayamanne Jun 3, 2022

rchiodo commented Jun 3, 2022

rchiodo commented Jun 3, 2022

Enable debugging IW in vscode.web and add tests for IW on web #10297

Enable debugging IW in vscode.web and add tests for IW on web #10297

Conversation

DonJayamanne commented Jun 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 3, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rchiodo commented Jun 3, 2022

rchiodo commented Jun 3, 2022

DonJayamanne commented Jun 3, 2022 •

edited

Loading

codecov-commenter commented Jun 3, 2022 •

edited

Loading