Add ability to retry starting a session when starting a session fails (#9227)

For #9187

When starting a new session fails (e.g. due to bunked kernel or the like), allow user to recover by starting a new session with a different kernel.

* Add ability to start retry starting sessions with different kernel
* Fix message
* Fixes
* Address code review comments
* Fix tests
* Update labels

Author: DonJayamanne

package.json

@@ -54,6 +54,7 @@
         "onCommand:python.viewLanguageServerOutput",
         "onCommand:python.viewTestOutput",
         "onCommand:python.viewOutput",
+        "onCommand:python.datascience.viewJupyterOutput",
         "onCommand:python.selectAndRunTestMethod",
         "onCommand:python.selectAndDebugTestMethod",
         "onCommand:python.selectAndRunTestFile",
@@ -238,6 +239,11 @@
                     "dark": "resources/dark/repl.svg"
                 }
             },
+            {
+                "command": "python.datascience.viewJupyterOutput",
+                "title": "%python.command.python.datascience.viewJupyterOutput.title%",
+                "category": "Python"
+            },
             {
                 "command": "python.viewLanguageServerOutput",
                 "title": "%python.command.python.viewLanguageServerOutput.title%",

package.nls.json

@@ -14,6 +14,7 @@
     "python.command.python.refactorExtractMethod.title": "Extract Method",
     "python.command.python.viewOutput.title": "Show Output",
     "python.command.python.viewTestOutput.title": "Show Test Output",
+    "python.command.python.datascience.viewJupyterOutput.title": "Show Jupyter Output",
     "python.command.python.viewLanguageServerOutput.title": "Show Language Server Output",
     "python.command.python.selectAndRunTestMethod.title": "Run Test Method ...",
     "python.command.python.selectAndDebugTestMethod.title": "Debug Test Method ...",
@@ -221,6 +222,7 @@
     "DataScience.exportingFormat": "Exporting {0}",
     "DataScience.exportCancel": "Cancel",
     "Common.canceled": "Canceled",
+    "Common.cancel": "Cancel",
     "DataScience.importChangeDirectoryComment": "{0} Change working directory from the workspace root to the ipynb file location. Turn this addition off with the DataScience.changeDirOnImportExport setting",
     "DataScience.exportChangeDirectoryComment": "# Change directory to VSCode workspace root so that relative path loads work correctly. Turn this addition off with the DataScience.changeDirOnImportExport setting",
     "DataScience.interruptKernelStatus": "Interrupting IPython Kernel",
@@ -397,6 +399,8 @@
     "DataScience.fallBackToRegisterAndUseActiveInterpeterAsKernel": "Couldn't find kernel '{0}' that the notebook was created with. Registering a new kernel using the current interpreter.",
     "DataScience.fallBackToPromptToUseActiveInterpreterOrSelectAKernel": "Couldn't find kernel '{0}' that the notebook was created with.",
     "DataScience.selectKernel": "Select a Kernel",
+    "DataScience.selectDifferentKernel": "Select a different Kernel",
     "products.installingModule": "Installing {0}",
-    "DataScience.switchingKernelProgress": "Switching kernel to '{0}'"
+    "DataScience.switchingKernelProgress": "Switching kernel to '{0}'",
+    "DataScience.sessionStartFailedWithKernel": "Failed to start a session for the Kernel '{0}'. \nView Jupyter [log](command:{1}) for further details."
 }

src/client/common/application/commands.ts

@@ -137,4 +137,5 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     [DSCommands.DebugContinue]: [];
     [DSCommands.RunCurrentCellAndAddBelow]: [string];
     [DSCommands.ScrollToCell]: [string, string];
+    [DSCommands.ViewJupyterOutput]: [];
 }

src/client/common/utils/localize.ts

@@ -26,6 +26,7 @@ export namespace Diagnostics {
 
 export namespace Common {
     export const canceled = localize('Common.canceled', 'Canceled');
+    export const cancel = localize('Common.cancel', 'Cancel');
     export const gotIt = localize('Common.gotIt', 'Got it!');
     export const loadingExtension = localize('Common.loadingPythonExtension', 'Python extension loading...');
     export const openOutputPanel = localize('Common.openOutputPanel', 'Show output');
@@ -164,7 +165,7 @@ export namespace DataScience {
     export const restartingKernelStatus = localize('DataScience.restartingKernelStatus', 'Restarting IPython Kernel');
     export const restartingKernelFailed = localize('DataScience.restartingKernelFailed', 'Kernel restart failed. Jupyter server is hung. Please reload VS code.');
     export const interruptingKernelFailed = localize('DataScience.interruptingKernelFailed', 'Kernel interrupt failed. Jupyter server is hung. Please reload VS code.');
-
+    export const sessionStartFailedWithKernel = localize('DataScience.sessionStartFailedWithKernel', 'Failed to start a session for the Kernel \'{0}\'. \nView Jupyter [log](command:{1}) for further details.');
     export const executingCode = localize('DataScience.executingCode', 'Executing Cell');
     export const collapseAll = localize('DataScience.collapseAll', 'Collapse all cell inputs');
     export const expandAll = localize('DataScience.expandAll', 'Expand all cell inputs');
@@ -228,6 +229,7 @@ export namespace DataScience {
     export const jupyterServer = localize('DataScience.jupyterServer', 'Jupyter Server');
     export const noKernel = localize('DataScience.noKernel', 'No Kernel');
     export const selectKernel = localize('DataScience.selectKernel', 'Select a Kernel');
+    export const selectDifferentKernel = localize('DataScience.selectDifferentKernel', 'Select a different Kernel');
     export const localJupyterServer = localize('DataScience.localJupyterServer', 'local');
     export const pandasTooOldForViewingFormat = localize('DataScience.pandasTooOldForViewingFormat', 'Python package \'pandas\' is version {0}. Version 0.20 or greater is required for viewing data.');
     export const pandasRequiredForViewing = localize('DataScience.pandasRequiredForViewing', 'Python package \'pandas\' is required for viewing data.');

src/client/datascience/constants.ts

@@ -58,6 +58,7 @@ export namespace Commands {
     export const RunCurrentCellAndAddBelow = 'python.datascience.runcurrentcellandaddbelow';
     export const ScrollToCell = 'python.datascience.scrolltocell';
     export const CreateNewNotebook = 'python.datascience.createnewnotebook';
+    export const ViewJupyterOutput = 'python.datascience.viewJupyterOutput';
 }
 
 export namespace CodeLensCommands {
@@ -107,7 +108,6 @@ export namespace RegExpValues {
     export const SvgWidthRegex = /(\<svg.*width=\")(.*?)\"/;
     export const SvgSizeTagRegex = /\<svg.*tag=\"sizeTag=\{(.*),\s*(.*)\}\"/;
     export const StyleTagRegex = /\<style[\s\S]*\<\/style\>/m;
-
 }
 
 export enum Telemetry {
@@ -154,6 +154,7 @@ export enum Telemetry {
     ConnectRemoteJupyter = 'DATASCIENCE.CONNECTREMOTEJUPYTER',
     ConnectFailedJupyter = 'DATASCIENCE.CONNECTFAILEDJUPYTER',
     ConnectRemoteFailedJupyter = 'DATASCIENCE.CONNECTREMOTEFAILEDJUPYTER',
+    StartSessionFailedJupyter = 'DATASCIENCE.START_SESSION_FAILED_JUPYTER',
     ConnectRemoteSelfCertFailedJupyter = 'DATASCIENCE.CONNECTREMOTESELFCERTFAILEDJUPYTER',
     RegisterAndUseInterpreterAsKernel = 'DATASCIENCE.REGISTER_AND_USE_INTERPRETER_AS_KERNEL',
     UseInterpreterAsKernel = 'DATASCIENCE.USE_INTERPRETER_AS_KERNEL',

src/client/datascience/datascience.ts

@@ -17,6 +17,7 @@ import {
     IDisposableRegistry,
     IExtensionContext,
     IMemento,
+    IOutputChannel,
     IPythonExtensionBanner
 } from '../common/types';
 import { debounceAsync, swallowExceptions } from '../common/utils/decorators';
@@ -26,7 +27,7 @@ import { IServiceContainer } from '../ioc/types';
 import { captureTelemetry, sendTelemetryEvent } from '../telemetry';
 import { hasCells } from './cellFactory';
 import { getSavedUriList } from './common';
-import { Commands, EditorContexts, Settings, Telemetry } from './constants';
+import { Commands, EditorContexts, JUPYTER_OUTPUT_CHANNEL, Settings, Telemetry } from './constants';
 import { KernelSelector, KernelSpecInterpreter } from './jupyter/kernels/kernelSelector';
 import { LiveKernelModel } from './jupyter/kernels/types';
 import {
@@ -67,7 +68,8 @@ export class DataScience implements IDataScience {
         @inject(IMemento) @named(GLOBAL_MEMENTO) private globalState: vscode.Memento,
         @inject(IJupyterSessionManagerFactory) private jupyterSessionManagerFactory: IJupyterSessionManagerFactory,
         @inject(IMultiStepInputFactory) private readonly multiStepFactory: IMultiStepInputFactory,
-        @inject(KernelSelector) private kernelSelector: KernelSelector
+        @inject(KernelSelector) private kernelSelector: KernelSelector,
+        @inject(IOutputChannel) @named(JUPYTER_OUTPUT_CHANNEL) private jupyterOutput: IOutputChannel
     ) {
         this.dataScienceSurveyBanner = this.serviceContainer.get<IPythonExtensionBanner>(IPythonExtensionBanner, BANNER_NAME_DS_SURVEY);
     }
@@ -514,6 +516,7 @@ export class DataScience implements IDataScience {
         disposable = this.commandManager.registerCommand(Commands.DebugCurrentCellPalette, this.debugCurrentCellFromCursor, this);
         this.disposableRegistry.push(disposable);
         disposable = this.commandManager.registerCommand(Commands.CreateNewNotebook, this.createNewNotebook, this);
+        disposable = this.commandManager.registerCommand(Commands.ViewJupyterOutput, this.viewJupyterOutput, this);
         this.disposableRegistry.push(disposable);
         if (this.commandListeners) {
             this.commandListeners.forEach((listener: IDataScienceCommandListener) => {
@@ -568,4 +571,7 @@ export class DataScience implements IDataScience {
     private async createNewNotebook(): Promise<void> {
         await this.notebookProvider.createNew();
     }
+    private viewJupyterOutput() {
+        this.jupyterOutput.show(true);
+    }
 }

src/client/datascience/interactive-common/interactiveBase.ts

@@ -33,7 +33,7 @@ import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
 import { generateCellRangesFromDocument } from '../cellFactory';
 import { CellMatcher } from '../cellMatcher';
 import { addToUriList } from '../common';
-import { Identifiers, Settings, Telemetry } from '../constants';
+import { Commands, Identifiers, Settings, Telemetry } from '../constants';
 import { ColumnWarningSize } from '../data-viewing/types';
 import { DataScience } from '../datascience';
 import {
@@ -50,6 +50,7 @@ import {
 } from '../interactive-common/interactiveWindowTypes';
 import { JupyterInstallError } from '../jupyter/jupyterInstallError';
 import { JupyterSelfCertsError } from '../jupyter/jupyterSelfCertsError';
+import { JupyterSessionStartError } from '../jupyter/jupyterSession';
 import { JupyterKernelPromiseFailedError } from '../jupyter/kernels/jupyterKernelPromiseFailedError';
 import { KernelSpecInterpreter } from '../jupyter/kernels/kernelSelector';
 import { CssMessages } from '../messages';
@@ -1307,8 +1308,8 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
         const settings = this.configuration.getSettings();
 
         let kernel: KernelSpecInterpreter | undefined;
-
-        if (settings.datascience.jupyterServerURI.toLowerCase() === Settings.JupyterServerLocalLaunch) {
+        const isLocalConnection = this.notebook?.server.getConnectionInfo()?.localLaunch ?? settings.datascience.jupyterServerURI.toLowerCase() === Settings.JupyterServerLocalLaunch;
+        if (isLocalConnection) {
             kernel = await this.dataScience.selectLocalJupyterKernel(this.notebook?.getKernelSpec());
         } else if (this.notebook) {
             const connInfo = this.notebook.server.getConnectionInfo();
@@ -1319,28 +1320,66 @@ export abstract class InteractiveBase extends WebViewHost<IInteractiveWindowMapp
         }
 
         if (kernel && (kernel.kernelSpec || kernel.kernelModel) && this.notebook) {
-            const switchKernel = async (newKernel: KernelSpecInterpreter) => {
-                if (newKernel.interpreter) {
-                    this.notebook!.setInterpreter(newKernel.interpreter);
+            await this.switchKernelWithRetry(kernel);
+        }
+    }
+    private async switchKernelWithRetry(kernel: KernelSpecInterpreter){
+        const settings = this.configuration.getSettings();
+        const isLocalConnection = this.notebook?.server.getConnectionInfo()?.localLaunch ?? settings.datascience.jupyterServerURI.toLowerCase() === Settings.JupyterServerLocalLaunch;
+        if (!isLocalConnection){
+            return this.switchKernel(kernel);
+        }
+
+        // Keep retrying, until it works or user cancels.
+        // Sometimes if a bad kernel is selected, starting a session can fail.
+        // In such cases we need to let the user know about this and prompt them to select another kernel.
+        // tslint:disable-next-line: no-constant-condition
+        while (true) {
+            try {
+                await this.switchKernel(kernel);
+            } catch (ex) {
+                if (ex instanceof JupyterSessionStartError && isLocalConnection) {
+                    // Looks like we were unable to start a session for the local connection.
+                    // Possibly something wrong with the kernel.
+                    // At this point we have a valid jupyter server.
+                    const displayName = kernel.kernelSpec?.display_name || kernel.kernelModel?.display_name || kernel.kernelSpec?.name || kernel.kernelModel?.name || '';
+                    const message = localize.DataScience.sessionStartFailedWithKernel().format(displayName, Commands.ViewJupyterOutput);
+                    const selectKernel = localize.DataScience.selectDifferentKernel();
+                    const cancel = localize.Common.cancel();
+                    const selection = await this.applicationShell.showErrorMessage(message, selectKernel, cancel);
+                    if (selection === selectKernel) {
+                        kernel = await this.dataScience.selectLocalJupyterKernel(kernel.kernelSpec || kernel.kernelModel);
+                        if (Object.keys(kernel).length > 0){
+                            continue;
+                        }
+                    }
                 }
+                throw ex;
+            }
+        }
+    }
+    private async switchKernel(kernel: KernelSpecInterpreter): Promise<void> {
+        const switchKernel = async (newKernel: KernelSpecInterpreter) => {
+            // Change the kernel. A status update should fire that changes our display
+            await this.notebook!.setKernelSpec(newKernel.kernelSpec || newKernel.kernelModel!, this.configService.getSettings().datascience.jupyterLaunchTimeout);
 
-                // Change the kernel. A status update should fire that changes our display
-                await this.notebook!.setKernelSpec(newKernel.kernelSpec || newKernel.kernelModel!, this.configService.getSettings().datascience.jupyterLaunchTimeout);
+            if (newKernel.interpreter) {
+                this.notebook!.setInterpreter(newKernel.interpreter);
+            }
 
-                // Add in a new sys info
-                await this.addSysInfo(SysInfoReason.New);
-            };
+            // Add in a new sys info
+            await this.addSysInfo(SysInfoReason.New);
+        };
 
-            const kernelDisplayName = kernel.kernelSpec?.display_name || kernel.kernelModel?.display_name;
-            const kernelName = kernel.kernelSpec?.name || kernel.kernelModel?.name;
-            // One of them is bound to be non-empty.
-            const displayName = kernelDisplayName || kernelName || '';
-            const options: ProgressOptions = {
-                location: ProgressLocation.Notification,
-                cancellable: false,
-                title: localize.DataScience.switchingKernelProgress().format(displayName)
-            };
-            await this.applicationShell.withProgress(options, async (_, __) => switchKernel(kernel!));
-        }
+        const kernelDisplayName = kernel.kernelSpec?.display_name || kernel.kernelModel?.display_name;
+        const kernelName = kernel.kernelSpec?.name || kernel.kernelModel?.name;
+        // One of them is bound to be non-empty.
+        const displayName = kernelDisplayName || kernelName || '';
+        const options: ProgressOptions = {
+            location: ProgressLocation.Notification,
+            cancellable: false,
+            title: localize.DataScience.switchingKernelProgress().format(displayName)
+        };
+        await this.applicationShell.withProgress(options, async (_, __) => switchKernel(kernel!));
     }
 }