handle failure to load jmp dependency in jupyter

DonJayamanne · DonJayamanne · commit 4f543c95f384 · 2016-10-05T10:11:56.000+11:00
diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts
@@ -78,5 +78,6 @@ export namespace Documentation {
         export const GettingStarted = '/docs/jupyter_getting-started/';
         export const Examples = '/docs/jupyter_examples/';
         export const Setup = '/docs/jupyter_prerequisites/';
+        export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies'
     }
 }
diff --git a/src/client/common/errors.ts b/src/client/common/errors.ts
@@ -0,0 +1,8 @@
+
+export class JmpModuleLoadError extends Error {
+    constructor() {
+        const errorMessage = `Version incompatibility in Jupyter (Python extension). View 'Help' for further details.`;
+        super(errorMessage);
+        this.message = errorMessage;
+    }
+}
diff --git a/src/client/jupyter/kernel-manager.ts b/src/client/jupyter/kernel-manager.ts
@@ -11,6 +11,7 @@ import {Commands, Documentation} from '../common/constants';
 import {EventEmitter} from 'events';
 import {PythonSettings} from '../common/configSettings';
 import {formatErrorForLogging} from '../common/utils';
+import {JmpModuleLoadError} from '../common/errors';
 
 // Todo: Refactor the error handling and displaying of messages
 
@@ -98,9 +99,15 @@ export class KernelManagerImpl extends EventEmitter {
             return this.startKernel(kernelSpec, language);
         }).catch(reason => {
             let message = `No kernel for language '${language}' found. Ensure you have a Jupyter or IPython kernel installed for it.`;
+            let isCompatibilityIssue = false;
+            if (typeof reason === 'object' && reason instanceof JmpModuleLoadError) {
+                message = reason.message;
+                isCompatibilityIssue = true;
+            }
             vscode.window.showErrorMessage(message, 'Help').then(item => {
                 if (item === 'Help') {
-                    vscode.commands.executeCommand('python.displayHelp', Documentation.Jupyter.Setup);
+                    const helpPage = isCompatibilityIssue ? Documentation.Jupyter.VersionIncompatiblity : Documentation.Jupyter.Setup;
+                    vscode.commands.executeCommand('python.displayHelp', helpPage);
                 }
             });
             this.outputChannel.appendLine(formatErrorForLogging(reason));
diff --git a/src/client/jupyter/kernel.ts b/src/client/jupyter/kernel.ts
@@ -4,9 +4,6 @@ import * as vscode from 'vscode';
 import * as child_process from 'child_process';
 import * as path from 'path';
 import {KernelspecMetadata, KernelEvents} from './contracts';
-const jmp = require('jmp');
-const uuid = require('uuid');
-const zmq = jmp.zmq;
 
 export abstract class Kernel extends vscode.Disposable implements KernelEvents {
     private watchCallbacks: any[];
diff --git a/src/client/jupyter/zmq-kernel.ts b/src/client/jupyter/zmq-kernel.ts
@@ -4,9 +4,8 @@ import * as fs from 'fs';
 import {Kernel} from './kernel';
 import * as vscode from 'vscode';
 import {KernelspecMetadata, JupyterMessage} from './contracts';
-const jmp = require('jmp');
+import {JmpModuleLoadError} from '../common/errors';
 const uuid = require('uuid');
-const zmq = jmp.zmq;
 
 export class ZMQKernel extends Kernel {
     private executionCallbacks: Map<string, Function>;
@@ -49,7 +48,16 @@ export class ZMQKernel extends Kernel {
     private shellSocstdinSocketket: any;
     private stdinSocket: any;
     private ioSocket: any;
+    private jmp: any;
     public _connect() {
+        try {
+            this.jmp = require('jmp');
+        }
+        catch (ex) {
+            console.log(ex);
+            throw new JmpModuleLoadError();
+        }
+        const jmp = this.jmp;
         const scheme = this.connection.signature_scheme.slice('hmac-'.length);
         const key = this.connection.key;
         this.shellSocket = new jmp.Socket('dealer', scheme, key);
@@ -112,6 +120,9 @@ export class ZMQKernel extends Kernel {
     };
 
     public shutdown(restart?: boolean) {
+        if (!this.jmp) {
+            return;
+        }
         if (restart == null) {
             restart = false;
         }
@@ -120,7 +131,7 @@ export class ZMQKernel extends Kernel {
         message.content = {
             restart: restart
         };
-        return this.shellSocket.send(new jmp.Message(message));
+        return this.shellSocket.send(new this.jmp.Message(message));
     };
 
     public _execute(code: string, requestId: string, onResults: Function) {
@@ -133,7 +144,7 @@ export class ZMQKernel extends Kernel {
             allow_stdin: true
         };
         this.executionCallbacks.set(requestId, onResults);
-        return this.shellSocket.send(new jmp.Message(message));
+        return this.shellSocket.send(new this.jmp.Message(message));
     };
 
     public execute(code: string, onResults: Function) {
@@ -156,7 +167,7 @@ export class ZMQKernel extends Kernel {
             cursor_pos: code.length
         };
         this.executionCallbacks.set(requestId, onResults);
-        return this.shellSocket.send(new jmp.Message(message));
+        return this.shellSocket.send(new this.jmp.Message(message));
     };
 
     public inspect(code: string, cursor_pos, onResults: Function) {
@@ -168,7 +179,7 @@ export class ZMQKernel extends Kernel {
             detail_level: 0
         };
         this.executionCallbacks.set(requestId, onResults);
-        return this.shellSocket.send(new jmp.Message(message));
+        return this.shellSocket.send(new this.jmp.Message(message));
     };
 
     public inputReply(input: string) {
@@ -177,7 +188,7 @@ export class ZMQKernel extends Kernel {
         message.content = {
             value: input
         };
-        return this.stdinSocket.send(new jmp.Message(message));
+        return this.stdinSocket.send(new this.jmp.Message(message));
     };
 
     private onShellMessage(message: JupyterMessage) {

Original file line number	Diff line number	Diff line change
`@@ -78,5 +78,6 @@ export namespace Documentation {`
`78`	`78`	`export const GettingStarted = '/docs/jupyter_getting-started/';`
`79`	`79`	`export const Examples = '/docs/jupyter_examples/';`
`80`	`80`	`export const Setup = '/docs/jupyter_prerequisites/';`
	`81`	`+ export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies'`
`81`	`82`	`}`
`82`	`83`	`}`