change to operate in non-test cases (#5515)

IanMatthewHuff · web-flow · commit b741e1af6d53 · 2019-04-30T11:21:41.000-07:00
diff --git a/news/3 Code Health/5430.md b/news/3 Code Health/5430.md
@@ -0,0 +1 @@
+Increase timeout and retries in Jupyter wait for idle
diff --git a/package.json b/package.json
@@ -1149,6 +1149,12 @@
                     "description": "Amount of time (in ms) to wait for the Jupyter Notebook server to start.",
                     "scope": "resource"
                 },
+                "python.dataScience.jupyterLaunchRetries": {
+                    "type": "number",
+                    "default": 3,
+                    "description": "Number of times to attempt to connect to the Jupyter Notebook",
+                    "scope": "resource"
+                },
                 "python.dataScience.jupyterServerURI": {
                     "type": "string",
                     "default": "local",
diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -287,6 +287,7 @@ export interface IDataScienceSettings {
     enabled: boolean;
     jupyterInterruptTimeout: number;
     jupyterLaunchTimeout: number;
+    jupyterLaunchRetries: number;
     jupyterServerURI: string;
     notebookFileRoot: string;
     changeDirOnImportExport: boolean;
diff --git a/src/client/datascience/jupyter/jupyterExecution.ts b/src/client/datascience/jupyter/jupyterExecution.ts
@@ -135,9 +135,10 @@ export class JupyterExecutionBase implements IJupyterExecution {
             traceInfo(`Connecting to ${options ? options.purpose : 'unknown type of'} server`);
             const interpreter = await this.interpreterService.getActiveInterpreter();
 
-            // Try to connect to our jupyter process. Give it at most 2 tries.
+            // Try to connect to our jupyter process. Check our setting for the number of tries
             let tryCount = 0;
-            while (tryCount < 2) {
+            const maxTries = this.configuration.getSettings().datascience.jupyterLaunchRetries;
+            while (tryCount < maxTries) {
                 try {
                     // Start or connect to the process
                     startInfo = await this.startOrConnect(options, cancelToken);
@@ -167,7 +168,7 @@ export class JupyterExecutionBase implements IJupyterExecution {
                         traceInfo('Killing server because of error');
                         await result.dispose();
                     }
-                    if (err instanceof JupyterWaitForIdleError && tryCount < 2) {
+                    if (err instanceof JupyterWaitForIdleError && tryCount < maxTries) {
                         // Special case. This sometimes happens where jupyter doesn't ever connect. Cleanup after
                         // ourselves and propagate the failure outwards.
                         traceInfo('Retry because of wait for idle problem.');
diff --git a/src/client/datascience/jupyter/jupyterServer.ts b/src/client/datascience/jupyter/jupyterServer.ts
@@ -173,7 +173,8 @@ export class JupyterServerBase implements INotebookServer {
 
             // Wait for it to be ready
             traceInfo(`Waiting for idle ${this.id}`);
-            await this.session.waitForIdle(Number.MAX_SAFE_INTEGER);
+            const idleTimeout = this.configService.getSettings().datascience.jupyterLaunchTimeout;
+            await this.session.waitForIdle(idleTimeout);
 
             traceInfo(`Performing initial setup ${this.id}`);
             // Run our initial setup and plot magics
diff --git a/src/datascience-ui/react-common/settingsReactSide.ts b/src/datascience-ui/react-common/settingsReactSide.ts
@@ -34,6 +34,7 @@ function load() {
         loadedSettings = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 10,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/color.test.ts b/src/test/datascience/color.test.ts
@@ -51,6 +51,7 @@ suite('Theme colors', () => {
         settings.datascience = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 20000,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/dataScienceIocContainer.ts b/src/test/datascience/dataScienceIocContainer.ts
@@ -308,6 +308,7 @@ export class DataScienceIocContainer extends UnitTestIocContainer {
         this.pythonSettings.datascience = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 20000,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/editor-integration/codewatcher.unit.test.ts b/src/test/datascience/editor-integration/codewatcher.unit.test.ts
@@ -54,6 +54,7 @@ suite('DataScience Code Watcher Unit Tests', () => {
         pythonSettings.datascience = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 20000,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/execution.unit.test.ts b/src/test/datascience/execution.unit.test.ts
@@ -521,6 +521,7 @@ suite('Jupyter Execution', async () => {
         pythonSettings.datascience = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 10,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/historyCommandListener.unit.test.ts b/src/test/datascience/historyCommandListener.unit.test.ts
@@ -128,6 +128,7 @@ suite('History command listener', async () => {
         pythonSettings.datascience = {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 10,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: '',
             changeDirOnImportExport: true,
diff --git a/src/test/datascience/historyTestHelpers.tsx b/src/test/datascience/historyTestHelpers.tsx
@@ -292,6 +292,7 @@ export function defaultDataScienceSettings(): IDataScienceSettings {
     return {
         allowImportFromNotebook: true,
         jupyterLaunchTimeout: 10,
+        jupyterLaunchRetries: 3,
         enabled: true,
         jupyterServerURI: 'local',
         notebookFileRoot: 'WORKSPACE',
diff --git a/src/test/datascience/reactHelpers.ts b/src/test/datascience/reactHelpers.ts
@@ -96,6 +96,7 @@ export function setUpDomEnvironment() {
         return {
             allowImportFromNotebook: true,
             jupyterLaunchTimeout: 10,
+            jupyterLaunchRetries: 3,
             enabled: true,
             jupyterServerURI: 'local',
             notebookFileRoot: 'WORKSPACE',

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Increase timeout and retries in Jupyter wait for idle`