Server settings

packages/apputils/src/clientsession.ts

@@ -6,7 +6,7 @@ import {
 } from '@jupyterlab/coreutils';
 
 import {
-  Kernel, KernelMessage, Session, utils
+  Kernel, KernelMessage, ServerConnection, Session
 } from '@jupyterlab/services';
 
 import {
@@ -79,6 +79,7 @@ interface IClientSession extends IDisposable {
    * The current path associated with the client sesssion.
    */
   readonly path: string;
+
   /**
    * The current name associated with the client sesssion.
    */
@@ -627,7 +628,7 @@ class ClientSession implements IClientSession {
   /**
    * Handle an error in session startup.
    */
-  private _handleSessionError(err: utils.IAjaxError): Promise<void> {
+  private _handleSessionError(err: ServerConnection.IError): Promise<void> {
     let response = String(err.xhr.response);
     try {
       response = JSON.parse(err.xhr.response)['traceback'];

packages/filebrowser/src/listing.ts

@@ -396,9 +396,6 @@ class DirListing extends Widget {
       }
     }
     return Promise.all(promises).catch(error => {
-      if (error.throwError) {
-        error.message = error.throwError;
-      }
       utils.showErrorMessage('Duplicate file', error);
     });
   }

packages/filebrowser/src/utils.ts

@@ -33,7 +33,7 @@ function showErrorMessage(title: string, error: any): Promise<void> {
   console.error(error);
   let options = {
     title: title,
-    body: error.throwError || error.message || `File ${title}`,
+    body: error.message || `File ${title}`,
     buttons: [Dialog.okButton()],
     okText: 'DISMISS'
   };

packages/notebook-extension/src/index.ts

@@ -555,7 +555,7 @@ function addCommands(app: JupyterLab, services: IServiceManager, tracker: Notebo
 
       let notebookPath = URLExt.encodeParts(current.context.path);
       let url = URLExt.join(
-        services.baseUrl,
+        services.serverSettings.baseUrl,
         'nbconvert',
         (args['format']) as string,
         notebookPath
@@ -1074,7 +1074,7 @@ function createMenu(app: JupyterLab): Menu {
   EXPORT_TO_FORMATS.forEach(exportToFormat => {
     exportTo.addItem({ command: CommandIDs.exportToFormat, args: exportToFormat });
   });
-  
+
   menu.addItem({ command: CommandIDs.undo });
   menu.addItem({ command: CommandIDs.redo });
   menu.addItem({ type: 'separator' });

packages/services/README.md

@@ -120,14 +120,19 @@ Follow the package install instructions first.
 npm install --save xmlhttprequest ws
 ```
 
-Override the global `XMLHttpRequest` and `WebSocket` (in ES6 syntax):
+Use `XMLHttpRequest` and `WebSocket` in the server settings (in ES6 syntax):
 
 ```typescript
+import { Kernel, ServerConnection } from '@jupyterlab/services';
 import { XMLHttpRequest } from "xmlhttprequest";
 import { default as WebSocket } from 'ws';
 
-global.XMLHttpRequest = XMLHttpRequest;
-global.WebSocket = WebSocket;
+
+let serverSettings = ServerConnection.makeSettings({
+  xml: XMLHttpRequest,
+  webSocket: WebSocket
+});
+Kernel.startNew({ serverSettings }).then(...);
 ```
 
 See `examples/node` for an example of using an ES5 node script.
@@ -148,29 +153,21 @@ import {
   KernelMessage, Kernel
 } from '@jupyterlab/services';
 
-// The base url of the notebook server.
-const BASE_URL = 'http://localhost:8000';
 
-
-// Get a list of available kernels and connect to one.
-Kernel.listRunning({ baseUrl: BASE_URL }).then(kernelModels => {
-  let options: Kernel.IOptions = {
-    baseUrl: BASE_URL,
-    name: kernelModels[0].name
-  };
-  Kernel.connectTo(kernelModels[0].id, options).then((kernel) => {
+/ Get a list of available kernels and connect to one.
+Kernel.listRunning().then(kernelModels => {
+  Kernel.connectTo(kernelModels[0].id).then((kernel) => {
     console.log(kernel.name);
   });
 });
 
 
 // Get info about the available kernels and start a new one.
-Kernel.getSpecs({ baseUrl: BASE_URL }).then(kernelSpecs => {
+Kernel.getSpecs().then(kernelSpecs => {
   console.log('Default spec:', kernelSpecs.default);
   console.log('Available specs', Object.keys(kernelSpecs.kernelspecs));
   // use the default name
   let options: Kernel.IOptions = {
-    baseUrl: BASE_URL,
     name: kernelSpecs.default
   };
   Kernel.startNew(options).then(kernel => {
@@ -211,6 +208,7 @@ Kernel.getSpecs({ baseUrl: BASE_URL }).then(kernelSpecs => {
     });
   });
 });
+
 ```
 
 **Session**
@@ -221,25 +219,15 @@ import {
 } from '@jupyterlab/services';
 
 
-// The base url of the Jupyter server.
-const BASE_URL = 'http://localhost:8000';
-
-
 // Get a list of available sessions and connect to one.
-Session.listRunning({ baseUrl: BASE_URL }).then(sessionModels => {
-  let options = {
-    baseUrl: BASE_URL,
-    kernelName: sessionModels[0].kernel.name,
-    path: sessionModels[0].notebook.path
-  };
-  Session.connectTo(sessionModels[0].id, options).then((session) => {
+Session.listRunning().then(sessionModels => {
+  Session.connectTo(sessionModels[0].id).then((session) => {
     console.log(session.kernel.name);
   });
 });
 
 // Start a new session.
 let options = {
-  baseUrl: BASE_URL,
   kernelName: 'python',
   path: '/tmp/foo.ipynb'
 };
@@ -273,16 +261,12 @@ Session.startNew(options).then(session => {
 **Comm**
 
 ```typescript
-// The base url of the Jupyter server.
-const BASE_URL = 'http://localhost:8000';
-
 
 // Create a comm from the server side.
 //
 // Get info about the available kernels and connect to one.
-Kernel.getSpecs({ baseUrl: BASE_URL }).then(kernelSpecs => {
+Kernel.getSpecs().then(kernelSpecs => {
   return Kernel.startNew({
-    baseUrl: BASE_URL,
     name: kernelSpecs.default,
   });
 }).then(kernel => {
@@ -293,9 +277,8 @@ Kernel.getSpecs({ baseUrl: BASE_URL }).then(kernelSpecs => {
 });
 
 // Create a comm from the client side.
-Kernel.getSpecs({ baseUrl: BASE_URL }).then(kernelSpecs => {
+Kernel.getSpecs().then(kernelSpecs => {
   return Kernel.startNew({
-    baseUrl: BASE_URL,
     name: kernelSpecs.default,
   });
 }).then(kernel => {
@@ -328,11 +311,7 @@ import {
   ContentsManager
 } from '@jupyterlab/services';
 
-// The base url of the Jupyter server.
-let baseUrl = 'http://localhost:8000';
-
-
-let contents = new ContentsManager({ baseUrl });
+let contents = new ContentsManager();
 
 // Create a new python file.
 contents.newUntitled({ path: '/foo', type: 'file', ext: 'py' }).then(
@@ -387,9 +366,8 @@ import {
 } from '@jupyterlab/services';
 
 // The base url of the Jupyter server.
-let baseUrl = 'http://localhost:8000';
 
-ConfigSection.create({ name: 'notebook', baseUrl }).then(section => {
+ConfigSection.create({ name: 'notebook' }).then(section => {
   let config = new ConfigWithDefaults({
     section,
     defaults: { default_cell_type: 'code' },

packages/services/examples/node/index.js

@@ -10,15 +10,18 @@ var ws = require('ws');
 var xhr = require('xmlhttprequest');
 
 
-// Override the global request and socket functions.
-global.XMLHttpRequest = xhr.XMLHttpRequest;
-global.WebSocket = ws;
-
+// Set the request and socket functions.
+var serverSettings = services.ServerConnection.makeSettings({
+  xhrFactory: function () { return new xhr.XMLHttpRequest() },
+  wsFactory: function (url, protocol) { return new ws(url, protocol); }
+});
 
 // Start a new session.
+
 var options = {
   kernelName: 'python',
-  path: 'foo.ipynb'
+  path: 'foo.ipynb',
+  serverSettings: serverSettings
 }
 
 

packages/services/package.json

@@ -39,9 +39,9 @@
     "build": "npm run build:src",
     "test:coverage": "istanbul cover --dir test/coverage _mocha -- --retries 3 test/build/**/*.spec.js test/build/*.spec.js --jupyter-config-data=./test/config.json",
     "test:integration": "cd test && python integration_test.py",
-    "test:devtool": "devtool node_modules/.bin/_mocha -qc test/build/**/*.spec.js test/build*.spec.js --jupyter-config-data=./test/config.json",
-    "test:debug": "mocha test/build/**/*.spec.js test/build*.spec.js  --jupyter-config-data=./test/config.json --debug-brk",
-    "test": "mocha --retries 3 test/build/**/*.spec.js test/build*.spec.js --jupyter-config-data=./test/config.json"
+    "test:devtool": "devtool node_modules/.bin/_mocha -qc ttest/build/**/*.spec.js test/build/*.spec.js --jupyter-config-data=./test/config.json --timeout=50000",
+    "test:debug": "mocha test/build/**/*.spec.js test/build/*.spec.js  --jupyter-config-data=./test/config.json --debug-brk",
+    "test": "mocha --retries 3 test/build/**/*.spec.js test/build/*.spec.js --jupyter-config-data=./test/config.json"
   },
   "repository": {
     "type": "git",

packages/services/src/config/index.ts

@@ -2,19 +2,16 @@
 // Distributed under the terms of the Modified BSD License.
 
 import {
-  PageConfig, URLExt
+  URLExt
 } from '@jupyterlab/coreutils';
 
 import {
-  JSONObject, JSONValue, JSONExt
+  JSONObject, JSONValue
 } from '@phosphor/coreutils';
 
 import {
-  IAjaxSettings
-} from '../utils';
-
-import * as utils
- from '../utils';
+  ServerConnection
+} from '..';
 
 
 /**
@@ -44,9 +41,9 @@ interface IConfigSection {
   update(newdata: JSONObject): Promise<JSONObject>;
 
   /**
-   * Optional default settings for ajax requests, if applicable.
+   * The server settings for the section.
    */
-  ajaxSettings?: IAjaxSettings;
+  readonly serverSettings: ServerConnection.ISettings;
 }
 
 
@@ -79,19 +76,9 @@ namespace ConfigSection {
     name: string;
 
     /**
-     * The server base url.
-     */
-    baseUrl?: string;
-
-    /**
-     * The authentication token for the API.
-     */
-    token?: string;
-
-    /**
-     * The default ajax settings.
+     * The optional server settings.
      */
-    ajaxSettings?: IAjaxSettings;
+    serverSettings?: ServerConnection.ISettings;
   }
 }
 
@@ -104,24 +91,17 @@ class DefaultConfigSection implements IConfigSection {
    * Construct a new config section.
    */
   constructor(options: ConfigSection.IOptions) {
-    let baseUrl = options.baseUrl || PageConfig.getBaseUrl();
-    this.ajaxSettings = utils.ajaxSettingsWithToken(options.ajaxSettings, options.token);
-    this._url = URLExt.join(baseUrl, SERVICE_CONFIG_URL,
+    let settings = this.serverSettings = (
+      options.serverSettings || ServerConnection.makeSettings()
+    );
+    this._url = URLExt.join(settings.baseUrl, SERVICE_CONFIG_URL,
                             encodeURIComponent(options.name));
   }
 
   /**
-   * Get a copy of the default ajax settings for the section.
+   * The server settings for the section.
    */
-  get ajaxSettings(): IAjaxSettings {
-    return JSONExt.deepCopy(this._ajaxSettings);
-  }
-  /**
-   * Set the default ajax settings for the section.
-   */
-  set ajaxSettings(value: IAjaxSettings) {
-    this._ajaxSettings = JSONExt.deepCopy(value);
-  }
+  readonly serverSettings: ServerConnection.ISettings;
 
   /**
    * Get the data for this section.
@@ -139,15 +119,15 @@ class DefaultConfigSection implements IConfigSection {
    * The promise is fulfilled on a valid response and rejected otherwise.
    */
   load(): Promise<void> {
-    let ajaxSettings = this.ajaxSettings;
-    ajaxSettings.method = 'GET';
-    ajaxSettings.dataType = 'json';
-    ajaxSettings.cache = false;
-    return utils.ajaxRequest(this._url, ajaxSettings).then(success => {
-      if (success.xhr.status !== 200) {
-         throw utils.makeAjaxError(success);
+    let request = {
+      url: this._url,
+      method: 'GET'
+    };
+    return ServerConnection.makeRequest(request, this.serverSettings).then(response => {
+      if (response.xhr.status !== 200) {
+         throw ServerConnection.makeError(response);
       }
-      this._data = success.data;
+      this._data = response.data as JSONObject;
     });
   }
 
@@ -165,25 +145,22 @@ class DefaultConfigSection implements IConfigSection {
    */
   update(newdata: JSONObject): Promise<JSONObject> {
     this._data = {...this._data, ...newdata};
-    let ajaxSettings = this.ajaxSettings;
-    ajaxSettings.method = 'PATCH';
-    ajaxSettings.data = JSON.stringify(newdata);
-    ajaxSettings.dataType = 'json';
-    ajaxSettings.contentType = 'application/json';
-
-    return utils.ajaxRequest(this._url, ajaxSettings).then(success => {
-      if (success.xhr.status !== 200) {
-       throw utils.makeAjaxError(success);
+    let request = {
+      url: this._url,
+      method: 'PATCH',
+      data: JSON.stringify(newdata)
+    };
+    return ServerConnection.makeRequest(request, this.serverSettings).then(response => {
+      if (response.xhr.status !== 200) {
+       throw ServerConnection.makeError(response);
       }
-
-      this._data = success.data;
+      this._data = response.data as JSONObject;
       return this._data;
     });
   }
 
   private _url = 'unknown';
   private _data: JSONObject = null;
-  private _ajaxSettings: IAjaxSettings = null;
 }