Make the Jupyter extension an optional dependency (#16422)

* Make Jupyter an optional dependency (#16267)

* News entry

* Move Jupyter to the optional dependencies step

* Update news/1 Enhancements/16102.md

Co-authored-by: Kartik Raj <[email protected]>

Co-authored-by: Kartik Raj <[email protected]>

* License wording update (#16278)

* Wording

* License wording

* Add a "Jupyter not installed" notification helper (#16321)

* Add telemetry info
* Use enum for the telemetry
* Add prompt as a standalone function
* Remove "Install" from the prompt
* Make it a class
* Register singleton
* Rename file to a long but descriptive name
* Unit tests
* Add to package.nls.json
* Use sinon for tests

* Use the same "Jupyter is not installed" message everywhere (#16372)

* rename to showJupyterNotInstalledPrompt

* Replace existing prompt with new prompt

* Remove Jupyter check from command manager

* Update the start page to use the prompt (#16417)

* Update copy

* Update origin key

* Show prompt if jupyter not installed & should show

* Add tests for this functionality only

* Update news entry

* Remove comments

* follow-up from the merge

* Add singletons for startpage functional tests

* Missing one symbol

* Update src/client/common/startPage/startPage.ts

Co-authored-by: Don Jayamanne <[email protected]>

* Add logging

Co-authored-by: Don Jayamanne <[email protected]>

Co-authored-by: Kartik Raj <[email protected]>
Co-authored-by: Don Jayamanne <[email protected]>

Author: 3 people

.github/actions/build-vsix/action.yml

@@ -44,11 +44,7 @@ runs:
       run: npm run updateBuildNumber -- --buildNumber $GITHUB_RUN_ID
       shell: bash
 
-    - name: Update extension dependencies
-      run: npm run addExtensionDependencies
-      shell: bash
-
-    - name: Update Optional extension dependencies
+    - name: Update optional extension dependencies
       run: npm run addExtensionPackDependencies
       shell: bash
 

build/license-header.txt

@@ -1,5 +1,9 @@
-PLEASE NOTE: This Python extension for Visual Studio Code has a hard dependency on the Jupyter extension for Visual Studio Code which is installed automatically alongside it. The Python extension for Visual Studio Code also holds an optional dependency on the Pylance extension for Visual Studio Code, which is also installed automatically but is separately licensed.
+PLEASE NOTE: This is the license for the Python extension for Visual Studio Code. The Python extension automatically installs other extensions as optional dependencies, which can be uninstalled at any time. These extensions have separate licenses:
 
-All the source code for the Python extension for Visual Studio Code is available under the MIT License (given below) as is the source code for the Jupyter extension for Visual Studio Code. But the optional Pylance extension for Visual Studio Code is only available in binary form and it is not licensed under the MIT License. The Pylance extension for Visual Studio Code is licensed under a Microsoft proprietary license, the terms of which are available here: https://marketplace.visualstudio.com/items/ms-python.vscode-pylance/license.
+ - The Jupyter extension is released under an MIT License:
+  https://marketplace.visualstudio.com/items/ms-toolsai.jupyter/license
+
+ - The Pylance extension is only available in binary form and is released under a Microsoft proprietary license, the terms of which are available here:
+  https://marketplace.visualstudio.com/items/ms-python.vscode-pylance/license
 
 ------------------------------------------------------------------------------

gulpfile.js

@@ -77,32 +77,17 @@ gulp.task('webpack', async () => {
     await buildWebPackForDevOrProduction('./build/webpack/webpack.extension.config.js', 'extension');
 });
 
-gulp.task('addExtensionDependencies', async () => {
-    await addExtensionDependencies();
-});
-
 gulp.task('addExtensionPackDependencies', async () => {
     await buildLicense();
     await addExtensionPackDependencies();
 });
 
-async function addExtensionDependencies() {
-    // Update the package.json to add extension dependencies at build time so that
-    // extension dependencies need not be installed during development
-    const packageJsonContents = await fsExtra.readFile('package.json', 'utf-8');
-    const packageJson = JSON.parse(packageJsonContents);
-    packageJson.extensionDependencies = ['ms-toolsai.jupyter'].concat(
-        packageJson.extensionDependencies ? packageJson.extensionDependencies : [],
-    );
-    await fsExtra.writeFile('package.json', JSON.stringify(packageJson, null, 4), 'utf-8');
-}
-
 async function addExtensionPackDependencies() {
     // Update the package.json to add extension pack dependencies at build time so that
     // extension dependencies need not be installed during development
     const packageJsonContents = await fsExtra.readFile('package.json', 'utf-8');
     const packageJson = JSON.parse(packageJsonContents);
-    packageJson.extensionPack = ['ms-python.vscode-pylance'].concat(
+    packageJson.extensionPack = ['ms-toolsai.jupyter', 'ms-python.vscode-pylance'].concat(
         packageJson.extensionPack ? packageJson.extensionPack : [],
     );
     await fsExtra.writeFile('package.json', JSON.stringify(packageJson, null, 4), 'utf-8');

news/1 Enhancements/16102.md

@@ -0,0 +1 @@
+Move the Jupyter extension from being a hard dependency to an optional one, and display an informational prompt if Jupyter commands try to be executed from the Start Page.

package.json

@@ -2086,7 +2086,6 @@
         "format-check": "prettier --check 'src/**/*.ts' 'src/**/*.tsx' 'build/**/*.js' '.github/**/*.yml' gulpfile.js",
         "format-fix": "prettier --write 'src/**/*.ts' 'src/**/*.tsx' 'build/**/*.js' '.github/**/*.yml' gulpfile.js",
         "clean": "gulp clean",
-        "addExtensionDependencies": "gulp addExtensionDependencies",
         "addExtensionPackDependencies": "gulp addExtensionPackDependencies",
         "updateBuildNumber": "gulp updateBuildNumber",
         "verifyBundle": "gulp verifyBundle",

package.nls.json

@@ -221,7 +221,7 @@
     "StartPage.createAPythonFile": "Create a Python File",
     "StartPage.pythonFileDescription": "- Create a <div class=\"link\" role=\"button\" onclick={0}>new file</div> with a .py extension",
     "StartPage.openInteractiveWindow": "Use the Interactive Window to develop Python Scripts",
-    "StartPage.interactiveWindowDesc": "- You can create cells on a Python file by typing \"#%%\" <br /> - Use \"<div class=\"italics\">Shift + Enter</div> \" to run a cell, the output will be shown in the interactive window",
+    "StartPage.interactiveWindowDesc": "- You can create cells on a Python file by typing \"#%%\". Make sure you have the Jupyter extension installed. <br /> - Use \"<div class=\"italics\">Shift + Enter</div> \" to run a cell, the output will be shown in the interactive window",
     "StartPage.releaseNotes": "Take a look at our <a class=\"link\" href={0}>Release Notes</a> to learn more about the latest features.",
     "StartPage.mailingList": "<a class=\"link\" href={0}>Sign up</a> for tips and tutorials through our mailing list.",
     "StartPage.tutorialAndDoc": "Explore more features in our <a class=\"link\" href={0}>Tutorials</a> or check <a class=\"link\" href={1}>Documentation</a> for tips and troubleshooting.",
@@ -232,6 +232,7 @@
     "StartPage.folderDesc": "- Open a <div class=\"link\" role=\"button\" onclick={0}>Folder</div><br /> - Open a <div class=\"link\" role=\"button\" onclick={1}>Workspace</div>",
     "StartPage.badWebPanelFormatString": "<html><body><h1>{0} is not a valid file name</h1></body></html>",
     "Jupyter.extensionRequired": "The Jupyter extension is required to perform that task. Click Yes to open the Jupyter extension installation page.",
+    "Jupyter.extensionNotInstalled": "This feature is available in the Jupyter extension, which isn't currently installed.",
     "TensorBoard.missingSourceFile": "We could not locate the requested source file on disk. Please manually specify the file.",
     "TensorBoard.selectMissingSourceFile": "Choose File",
     "TensorBoard.selectMissingSourceFileDescription": "The source file's contents may not match the original contents in the trace.",

src/client/common/application/commandManager.ts

@@ -1,17 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { inject, injectable } from 'inversify';
+import { injectable } from 'inversify';
 import { commands, Disposable, TextEditor, TextEditorEdit } from 'vscode';
 import { ICommandNameArgumentTypeMapping } from './commands';
-import { ICommandManager, IJupyterExtensionDependencyManager } from './types';
+import { ICommandManager } from './types';
 
 @injectable()
 export class CommandManager implements ICommandManager {
-    constructor(
-        @inject(IJupyterExtensionDependencyManager)
-        private jupyterExtensionDependencyManager: IJupyterExtensionDependencyManager,
-    ) {}
+    constructor() {}
 
     /**
      * Registers a command that can be invoked via a keyboard shortcut,
@@ -73,11 +70,7 @@ export class CommandManager implements ICommandManager {
         E extends keyof ICommandNameArgumentTypeMapping,
         U extends ICommandNameArgumentTypeMapping[E]
     >(command: E, ...rest: U): Thenable<T | undefined> {
-        if (command.includes('jupyter') && !this.jupyterExtensionDependencyManager.isJupyterExtensionInstalled) {
-            return this.jupyterExtensionDependencyManager.installJupyterExtension(this);
-        } else {
-            return commands.executeCommand<T>(command, ...rest);
-        }
+        return commands.executeCommand<T>(command, ...rest);
     }
 
     /**

src/client/common/application/types.ts

@@ -489,7 +489,6 @@ export interface ICommandManager {
 export const IJupyterExtensionDependencyManager = Symbol('IJupyterExtensionDependencyManager');
 export interface IJupyterExtensionDependencyManager {
     readonly isJupyterExtensionInstalled: boolean;
-    installJupyterExtension(commandManager: ICommandManager): Promise<undefined>;
 }
 
 export const IDocumentManager = Symbol('IDocumentManager');

src/client/common/serviceRegistry.ts

@@ -119,6 +119,8 @@ import {
 } from './types';
 import { IMultiStepInputFactory, MultiStepInputFactory } from './utils/multiStepInput';
 import { Random } from './utils/random';
+import { JupyterNotInstalledNotificationHelper } from '../jupyter/jupyterNotInstalledNotificationHelper';
+import { IJupyterNotInstalledNotificationHelper } from '../jupyter/types';
 
 export function registerTypes(serviceManager: IServiceManager) {
     serviceManager.addSingletonInstance<boolean>(IsWindows, IS_WINDOWS);
@@ -140,6 +142,10 @@ export function registerTypes(serviceManager: IServiceManager) {
         IJupyterExtensionDependencyManager,
         JupyterExtensionDependencyManager,
     );
+    serviceManager.addSingleton<IJupyterNotInstalledNotificationHelper>(
+        IJupyterNotInstalledNotificationHelper,
+        JupyterNotInstalledNotificationHelper,
+    );
     serviceManager.addSingleton<ICommandManager>(ICommandManager, CommandManager);
     serviceManager.addSingleton<IConfigurationService>(IConfigurationService, ConfigurationService);
     serviceManager.addSingleton<IWorkspaceService>(IWorkspaceService, WorkspaceService);

src/client/common/startPage/startPage.ts

@@ -3,24 +3,27 @@
 
 'use strict';
 
-import { inject, injectable } from 'inversify';
+import { inject, injectable, named } from 'inversify';
 import * as path from 'path';
 import { ConfigurationTarget, EventEmitter, UIKind, Uri, ViewColumn } from 'vscode';
 import { IExtensionSingleActivationService } from '../../activation/types';
 import { EXTENSION_ROOT_DIR } from '../../constants';
+import { IJupyterNotInstalledNotificationHelper, JupyterNotInstalledOrigin } from '../../jupyter/types';
 import { sendTelemetryEvent } from '../../telemetry';
 import {
     IApplicationEnvironment,
     IApplicationShell,
     ICommandManager,
     IDocumentManager,
+    IJupyterExtensionDependencyManager,
     IWebviewPanelProvider,
     IWorkspaceService,
 } from '../application/types';
-import { CommandSource } from '../constants';
+import { CommandSource, STANDARD_OUTPUT_CHANNEL } from '../constants';
 import { IFileSystem } from '../platform/types';
-import { IConfigurationService, IExtensionContext, Resource } from '../types';
+import { IConfigurationService, IExtensionContext, IOutputChannel, Resource } from '../types';
 import * as localize from '../utils/localize';
+import { Jupyter } from '../utils/localize';
 import { StopWatch } from '../utils/stopWatch';
 import { Telemetry } from './constants';
 import { StartPageMessageListener } from './startPageMessageListener';
@@ -62,6 +65,10 @@ export class StartPage extends WebviewPanelHost<IStartPageMapping>
         @inject(IApplicationShell) private appShell: IApplicationShell,
         @inject(IExtensionContext) private readonly context: IExtensionContext,
         @inject(IApplicationEnvironment) private appEnvironment: IApplicationEnvironment,
+        @inject(IJupyterNotInstalledNotificationHelper)
+        private notificationHelper: IJupyterNotInstalledNotificationHelper,
+        @inject(IJupyterExtensionDependencyManager) private depsManager: IJupyterExtensionDependencyManager,
+        @inject(IOutputChannel) @named(STANDARD_OUTPUT_CHANNEL) private readonly output: IOutputChannel,
     ) {
         super(
             configuration,
@@ -128,6 +135,9 @@ export class StartPage extends WebviewPanelHost<IStartPageMapping>
     }
 
     public async onMessage(message: string, payload: unknown): Promise<void> {
+        const shouldShowJupyterNotInstalledPrompt = await this.notificationHelper.shouldShowJupypterExtensionNotInstalledPrompt();
+        const isJupyterInstalled = this.depsManager.isJupyterExtensionInstalled;
+
         switch (message) {
             case StartPageMessages.Started:
                 this.webviewDidLoad = true;
@@ -140,19 +150,29 @@ export class StartPage extends WebviewPanelHost<IStartPageMapping>
                 break;
             }
             case StartPageMessages.OpenBlankNotebook: {
-                sendTelemetryEvent(Telemetry.StartPageOpenBlankNotebook);
-                this.setTelemetryFlags();
-
-                const savedVersion: string | undefined = this.context.globalState.get(EXTENSION_VERSION_MEMENTO);
-
-                if (savedVersion) {
-                    await this.commandManager.executeCommand(
-                        'jupyter.opennotebook',
-                        undefined,
-                        CommandSource.commandPalette,
-                    );
+                if (!isJupyterInstalled) {
+                    this.output.appendLine(Jupyter.jupyterExtensionNotInstalled());
+
+                    if (shouldShowJupyterNotInstalledPrompt) {
+                        await this.notificationHelper.showJupyterNotInstalledPrompt(
+                            JupyterNotInstalledOrigin.StartPageOpenBlankNotebook,
+                        );
+                    }
                 } else {
-                    this.openSampleNotebook().ignoreErrors();
+                    sendTelemetryEvent(Telemetry.StartPageOpenBlankNotebook);
+                    this.setTelemetryFlags();
+
+                    const savedVersion: string | undefined = this.context.globalState.get(EXTENSION_VERSION_MEMENTO);
+
+                    if (savedVersion) {
+                        await this.commandManager.executeCommand(
+                            'jupyter.opennotebook',
+                            undefined,
+                            CommandSource.commandPalette,
+                        );
+                    } else {
+                        this.openSampleNotebook().ignoreErrors();
+                    }
                 }
                 break;
             }
@@ -168,15 +188,25 @@ export class StartPage extends WebviewPanelHost<IStartPageMapping>
                 break;
             }
             case StartPageMessages.OpenInteractiveWindow: {
-                sendTelemetryEvent(Telemetry.StartPageOpenInteractiveWindow);
-                this.setTelemetryFlags();
-
-                const doc2 = await this.documentManager.openTextDocument({
-                    language: 'python',
-                    content: `#%%\nprint("${localize.StartPage.helloWorld()}")`,
-                });
-                await this.documentManager.showTextDocument(doc2, 1, true);
-                await this.commandManager.executeCommand('jupyter.runallcells', Uri.parse(''));
+                if (!isJupyterInstalled) {
+                    this.output.appendLine(Jupyter.jupyterExtensionNotInstalled());
+
+                    if (shouldShowJupyterNotInstalledPrompt) {
+                        await this.notificationHelper.showJupyterNotInstalledPrompt(
+                            JupyterNotInstalledOrigin.StartPageOpenInteractiveWindow,
+                        );
+                    }
+                } else {
+                    sendTelemetryEvent(Telemetry.StartPageOpenInteractiveWindow);
+                    this.setTelemetryFlags();
+
+                    const doc2 = await this.documentManager.openTextDocument({
+                        language: 'python',
+                        content: `#%%\nprint("${localize.StartPage.helloWorld()}")`,
+                    });
+                    await this.documentManager.showTextDocument(doc2, 1, true);
+                    await this.commandManager.executeCommand('jupyter.runallcells', doc2.uri);
+                }
                 break;
             }
             case StartPageMessages.OpenCommandPalette:
@@ -192,10 +222,20 @@ export class StartPage extends WebviewPanelHost<IStartPageMapping>
                 await this.commandManager.executeCommand('workbench.action.quickOpen', '>Create New Blank Notebook');
                 break;
             case StartPageMessages.OpenSampleNotebook:
-                sendTelemetryEvent(Telemetry.StartPageOpenSampleNotebook);
-                this.setTelemetryFlags();
+                if (!isJupyterInstalled) {
+                    this.output.appendLine(Jupyter.jupyterExtensionNotInstalled());
+
+                    if (shouldShowJupyterNotInstalledPrompt) {
+                        await this.notificationHelper.showJupyterNotInstalledPrompt(
+                            JupyterNotInstalledOrigin.StartPageOpenSampleNotebook,
+                        );
+                    }
+                } else {
+                    sendTelemetryEvent(Telemetry.StartPageOpenSampleNotebook);
+                    this.setTelemetryFlags();
 
-                this.openSampleNotebook().ignoreErrors();
+                    this.openSampleNotebook().ignoreErrors();
+                }
                 break;
             case StartPageMessages.OpenFileBrowser: {
                 sendTelemetryEvent(Telemetry.StartPageOpenFileBrowser);