Add more logging around jupyter server death (microsoft#4663)

For #4573, #4497

Add more logging around server death and connection problems. Make kernel spec connection problems not cause server crash

Also adjust the version of 'ws' in use.

<!--
  If an item below does not apply to you, then go ahead and check it off as "done" and strikethrough the text, e.g.:
    - [x] ~Has unit tests & system/integration tests~
-->
- [ ] Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
- [x] Title summarizes what is changing
- [x] Has a [news entry](https://github.com/Microsoft/vscode-python/tree/master/news) file (remember to thank yourself!)
- [ ] Has sufficient logging.
- [ ] Has telemetry for enhancements.
- [ ] Unit tests & system/integration tests are added/updated
- [ ] [Test plan](https://github.com/Microsoft/vscode-python/blob/master/.github/test_plan.md) is updated as appropriate
- [x] [`package-lock.json`](https://github.com/Microsoft/vscode-python/blob/master/package-lock.json) has been regenerated by running `npm install` (if dependencies have changed)
- [ ] The wiki is updated with any design decisions/details.

Author: rchiodo

news/3 Code Health/4497.md

@@ -0,0 +1 @@
+Force WS to at least 6.2 to alleviate security concerns.

news/3 Code Health/4573.md

@@ -0,0 +1 @@
+Add more logging for ECONNREFUSED errors and Jupyter server crashes

package-lock.json

@@ -2168,7 +2168,7 @@
         "updateBuildNumber": "gulp updateBuildNumber"
     },
     "dependencies": {
-        "@jupyterlab/services": "^3.1.4",
+        "@jupyterlab/services": "^3.2.1",
         "arch": "^2.1.0",
         "azure-storage": "^2.10.1",
         "diff-match-patch": "^1.0.0",
@@ -2207,6 +2207,7 @@
         "vscode-languageserver-protocol": "^3.10.3",
         "vsls": "^0.3.1291",
         "winreg": "^1.2.4",
+        "ws": "^6.2.0",
         "xml2js": "^0.4.19"
     },
     "devDependencies": {

package.json

@@ -97,8 +97,9 @@
     "DataScience.notebookCheckForImportTitle": "Do you want to import the Jupyter Notebook into Python code?",
     "DataScience.jupyterNotSupported": "Running cells requires Jupyter notebooks to be installed.",
     "DataScience.jupyterNbConvertNotSupported": "Importing notebooks requires Jupyter nbconvert to be installed.",
-    "DataScience.jupyterLaunchTimedOut": "The Jupyter notebook server failed to launch in time",
     "DataScience.jupyterLaunchNoURL": "Failed to find the URL of the launched Jupyter notebook server",
+    "DataScience.jupyterLaunchTimedOut": "The Jupyter notebook server failed to launch in time",
+    "DataScience.jupyterServerCrashed": "Jupyter server crashed. Unable to connect. \r\nError code from jupyter: {0}",
     "DataScience.pythonInteractiveHelpLink": "Get more help",
     "DataScience.importingFormat": "Importing {0}",
     "DataScience.startingJupyter": "Starting Jupyter server",

package.nls.json

@@ -0,0 +1,25 @@
+# This file can mimic juypter running. Useful for testing jupyter crash handling
+
+import sys
+import argparse
+import time
+
+def main():
+    print('hello from dummy jupyter')
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--version', type=bool, default=False, const=True, nargs='?')
+    parser.add_argument('notebook', type=bool, default=False, const=True, nargs='?')
+    parser.add_argument('--no-browser', type=bool, default=False, const=True, nargs='?')
+    parser.add_argument('--notebook-dir', default='')
+    parser.add_argument('--config', default='')
+    results = parser.parse_args()
+    if (results.version):
+        print('1.1.dummy')
+    else:
+        print('http://localhost:8888/?token=012f08663a68e279fe0a5335e0b5dfe44759ddcccf0b3a56')
+        time.sleep(5)
+        raise Exception('Dummy is dead')
+
+
+if __name__ == '__main__':
+    main()

pythonFiles/datascience/dummyJupyter.py

@@ -851,6 +851,11 @@ export interface IWebPanel {
      * Sends a message to the hosted html page
      */
     postMessage(message: WebPanelMessage): void;
+
+    /**
+     * Attempts to close the panel if it's visible
+     */
+    close(): void;
 }
 
 // Wraps the VS Code api for creating a web panel

src/client/common/application/types.ts

@@ -51,6 +51,12 @@ export class WebPanel implements IWebPanel {
         }
     }
 
+    public close() {
+        if (this.panel) {
+            this.panel.dispose();
+        }
+    }
+
     public isVisible() : boolean {
         return this.panel ? this.panel.visible : false;
     }

src/client/common/application/webPanel.ts

@@ -1,11 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-
 'use strict';
-
 import { inject, injectable } from 'inversify';
+
 import { IServiceContainer } from '../../ioc/types';
-import { IWebPanelMessageListener, IWebPanelProvider } from './types';
+import { IWebPanel, IWebPanelMessageListener, IWebPanelProvider } from './types';
 import { WebPanel } from './webPanel';
 
 @injectable()
@@ -14,7 +13,7 @@ export class WebPanelProvider implements IWebPanelProvider {
     }
 
     // tslint:disable-next-line:no-any
-    public create(listener: IWebPanelMessageListener, title: string, mainScriptPath: string, embeddedCss?: string, settings?: any) {
+    public create(listener: IWebPanelMessageListener, title: string, mainScriptPath: string, embeddedCss?: string, settings?: any) : IWebPanel {
         return new WebPanel(this.serviceContainer, listener, title, mainScriptPath, embeddedCss, settings);
     }
 }

src/client/common/application/webPanelProvider.ts

@@ -113,6 +113,7 @@ export namespace DataScience {
     export const jupyterSelectURIInvalidURI = localize('DataScience.jupyterSelectURIInvalidURI', 'Invalid URI specified');
     export const jupyterNotebookFailure = localize('DataScience.jupyterNotebookFailure', 'Jupyter notebook failed to launch. \r\n{0}');
     export const jupyterNotebookConnectFailed = localize('DataScience.jupyterNotebookConnectFailed', 'Failed to connect to Jupyter notebook. \r\n{0}\r\n{1}');
+    export const jupyterServerCrashed = localize('DataScience.jupyterServerCrashed', 'Jupyter server crashed. Unable to connect. \r\nError code from jupyter: {0}');
     export const notebookVersionFormat = localize('DataScience.notebookVersionFormat', 'Jupyter Notebook Version: {0}');
     //tslint:disable-next-line:no-multiline-string
     export const jupyterKernelNotSupportedOnActive = localize('DataScience.jupyterKernelNotSupportedOnActive', `iPython kernel cannot be started from '{0}'. Using closest match {1} instead.`);