Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Clean up utils and use external url functions #202

Merged
merged 10 commits into from
Jul 26, 2016
Merged

Clean up utils and use external url functions #202

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a10281d
Clean up utils and use external url join function
blink1073 Jul 23, 2016
372a68e
Switch out dependency
blink1073 Jul 24, 2016
38bd515
Use the url resolve function for the final url
blink1073 Jul 25, 2016
3274f70
Update docs
blink1073 Jul 25, 2016
ab0bad6
Update docs and use urljoin to normalize before splitting
blink1073 Jul 25, 2016
4dc6af8
Fix url in _createSocket
blink1073 Jul 25, 2016
71d0879
Separate urlResolve into a separate function
blink1073 Jul 25, 2016
bb95baf
Update docs and posix-path typing
blink1073 Jul 25, 2016
eaff233
Add more explicit json objects
blink1073 Jul 25, 2016
c2b7340
Add missing url dependency
blink1073 Jul 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"path-posix": "^1.0.0",
"phosphor-disposable": "^1.0.5",
"phosphor-signaling": "^1.2.0",
"requirejs": "^2.2.0"
"requirejs": "^2.2.0",
"url": "^0.11.0"
Copy link
Member

@jasongrout jasongrout Jul 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I noticed that both url and the path module we are using are missing upstream bugfixes from npm (cf. defunctzombie/node-url#24). They may be better than if we tried to write something from scratch, though, so +1 to not immediately trying to write our own.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually not using url, it should have been url-join, since url didn't offer anything over posix-path. Agreed that we don't want to have our own path implementation.

},
"devDependencies": {
"expect.js": "^0.3.1",
Expand Down
6 changes: 5 additions & 1 deletion src/contents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import {
import * as posix
from 'path-posix';

import {
JSONObject
} from './json';

import * as utils
from './utils';

Expand Down Expand Up @@ -352,7 +356,7 @@ class ContentsManager implements IContents.IManager {
if (options.type === 'notebook') {
delete options['format'];
}
let params = utils.copy(options);
let params: any = utils.copy(options as JSONObject);
params.content = options.content ? '1' : '0';
url += utils.jsonToQueryString(params);
}
Expand Down
2 changes: 1 addition & 1 deletion src/ikernel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ namespace IKernel {
* The options object used to initialize a kernel.
*/
export
interface IOptions {
interface IOptions extends JSONObject {
/**
* The kernel type (e.g. python3).
*/
Expand Down
2 changes: 1 addition & 1 deletion src/isession.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ namespace ISession {
* The session initialization options.
*/
export
interface IOptions {
interface IOptions extends JSONObject {
/**
* The path (not including name) to the session.
*/
Expand Down
20 changes: 10 additions & 10 deletions src/kernel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,10 @@ function findKernelById(id: string, options?: IKernel.IOptions): Promise<IKernel
* Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/kernelspecs).
*/
export
function getKernelSpecs(options?: IKernel.IOptions): Promise<IKernel.ISpecModels> {
options = options || {};
function getKernelSpecs(options: IKernel.IOptions = {}): Promise<IKernel.ISpecModels> {
let baseUrl = options.baseUrl || utils.getBaseUrl();
let url = utils.urlPathJoin(baseUrl, KERNELSPEC_SERVICE_URL);
let ajaxSettings = utils.copy(options.ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(options.ajaxSettings || {});
ajaxSettings.method = 'GET';
ajaxSettings.dataType = 'json';

Expand Down Expand Up @@ -281,11 +280,10 @@ function getKernelSpecs(options?: IKernel.IOptions): Promise<IKernel.ISpecModels
* The promise is fulfilled on a valid response and rejected otherwise.
*/
export
function listRunningKernels(options?: IKernel.IOptions): Promise<IKernel.IModel[]> {
options = options || {};
function listRunningKernels(options: IKernel.IOptions = {}): Promise<IKernel.IModel[]> {
let baseUrl = options.baseUrl || utils.getBaseUrl();
let url = utils.urlPathJoin(baseUrl, KERNEL_SERVICE_URL);
let ajaxSettings = utils.copy(options.ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(options.ajaxSettings || {});
ajaxSettings.method = 'GET';
ajaxSettings.dataType = 'json';
ajaxSettings.cache = false;
Expand Down Expand Up @@ -322,7 +320,7 @@ function startNewKernel(options?: IKernel.IOptions): Promise<IKernel> {
options = options || {};
let baseUrl = options.baseUrl || utils.getBaseUrl();
let url = utils.urlPathJoin(baseUrl, KERNEL_SERVICE_URL);
let ajaxSettings = utils.copy(options.ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(options.ajaxSettings || {});
ajaxSettings.method = 'POST';
ajaxSettings.data = JSON.stringify({ name: options.name });
ajaxSettings.dataType = 'json';
Expand Down Expand Up @@ -543,7 +541,7 @@ class Kernel implements IKernel {
* Clone the current kernel with a new clientId.
*/
clone(): IKernel {
let options = {
let options: IKernel.IOptions = {
baseUrl: this._baseUrl,
wsUrl: this._wsUrl,
name: this._name,
Expand Down Expand Up @@ -799,7 +797,7 @@ class Kernel implements IKernel {
username: this._username,
session: this._clientId
};
let defaults = {
let defaults: JSONObject = {
silent : false,
store_history : true,
user_expressions : {},
Expand Down Expand Up @@ -962,7 +960,9 @@ class Kernel implements IKernel {
return Promise.resolve(this._spec);
}
let name = this.name;
let options = { baseUrl: this._baseUrl, ajaxSettings: this._ajaxSettings };
let options: IKernel.IOptions = {
baseUrl: this._baseUrl, ajaxSettings: this.ajaxSettings
};
return getKernelSpecs(options).then(ids => {
let id = ids.kernelspecs[name];
if (!id) {
Expand Down
12 changes: 10 additions & 2 deletions src/manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ import {
ISession
} from './isession';

import {
JSONObject
} from './json';

import {
KernelManager, getKernelSpecs
} from './kernel';
Expand Down Expand Up @@ -131,7 +135,11 @@ function createServiceManager(options: IServiceManager.IOptions = {}): Promise<I
if (options.kernelspecs) {
return Promise.resolve(new ServiceManager(options));
}
return getKernelSpecs(options.baseUrl).then(specs => {
let kernelOptions: IKernel.IOptions = {
baseUrl: options.baseUrl,
ajaxSettings: options.ajaxSettings
};
return getKernelSpecs(kernelOptions).then(specs => {
options.kernelspecs = specs;
return new ServiceManager(options);
});
Expand All @@ -147,7 +155,7 @@ class ServiceManager implements IServiceManager {
* Construct a new services provider.
*/
constructor(options: IServiceManager.IOptions) {
let subOptions = {
let subOptions: JSONObject = {
baseUrl: options.baseUrl,
ajaxSettings: options.ajaxSettings
};
Expand Down
6 changes: 3 additions & 3 deletions src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ function listRunningSessions(options?: ISession.IOptions): Promise<ISession.IMod
options = options || {};
let baseUrl = options.baseUrl || utils.getBaseUrl();
let url = utils.urlPathJoin(baseUrl, SESSION_SERVICE_URL);
let ajaxSettings = utils.copy(options.ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(options.ajaxSettings || {});
ajaxSettings.method = 'GET';
ajaxSettings.dataType = 'json';
ajaxSettings.cache = false;
Expand Down Expand Up @@ -770,7 +770,7 @@ namespace Private {
kernel: { name: options.kernelName, id: options.kernelId },
notebook: { path: options.path }
};
let ajaxSettings = utils.copy(options.ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(options.ajaxSettings || {});
ajaxSettings.method = 'POST';
ajaxSettings.dataType = 'json';
ajaxSettings.data = JSON.stringify(model);
Expand All @@ -792,7 +792,7 @@ namespace Private {
*/
export
function createKernel(model: ISession.IModel, options: ISession.IOptions): Promise<IKernel> {
let kernelOptions = {
let kernelOptions: IKernel.IOptions = {
name: model.kernel.name,
baseUrl: options.baseUrl || utils.getBaseUrl(),
wsUrl: options.wsUrl,
Expand Down
16 changes: 10 additions & 6 deletions src/terminals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import {
JSONPrimitive, JSONObject, deepEqual
} from './json';

import {
IAjaxSettings
} from './utils';

import * as utils
from './utils';

Expand Down Expand Up @@ -70,7 +74,7 @@ namespace ITerminalSession {
* The options for intializing a terminal session object.
*/
export
interface IOptions {
interface IOptions extends JSONObject {
/**
* The name of the terminal.
*/
Expand Down Expand Up @@ -188,7 +192,7 @@ class TerminalManager implements ITerminalSession.IManager {
constructor(options: TerminalManager.IOptions = {}) {
this._baseUrl = options.baseUrl || utils.getBaseUrl();
this._wsUrl = options.wsUrl || utils.getWsUrl(this._baseUrl);
this._ajaxSettings = utils.copy(options.ajaxSettings) || {};
this._ajaxSettings = utils.copy(options.ajaxSettings || {});
}

/**
Expand Down Expand Up @@ -237,7 +241,7 @@ class TerminalManager implements ITerminalSession.IManager {
*/
shutdown(name: string): Promise<void> {
let url = utils.urlPathJoin(this._baseUrl, TERMINAL_SERVICE_URL, name);
let ajaxSettings = utils.copy(this._ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(this._ajaxSettings || {});
ajaxSettings.method = 'DELETE';

return utils.ajaxRequest(url, ajaxSettings).then(success => {
Expand All @@ -252,7 +256,7 @@ class TerminalManager implements ITerminalSession.IManager {
*/
listRunning(): Promise<ITerminalSession.IModel[]> {
let url = utils.urlPathJoin(this._baseUrl, TERMINAL_SERVICE_URL);
let ajaxSettings = utils.copy(this._ajaxSettings) || {};
let ajaxSettings: IAjaxSettings = utils.copy(this._ajaxSettings || {});
ajaxSettings.method = 'GET';
ajaxSettings.dataType = 'json';

Expand Down Expand Up @@ -392,7 +396,7 @@ class TerminalSession implements ITerminalSession {
*/
shutdown(): Promise<void> {
let url = utils.urlPathJoin(this._baseUrl, TERMINAL_SERVICE_URL, this._name);
let ajaxSettings = utils.copy(this._ajaxSettings);
let ajaxSettings: IAjaxSettings = utils.copy(this._ajaxSettings);
ajaxSettings.method = 'DELETE';

return utils.ajaxRequest(url, ajaxSettings).then(success => {
Expand Down Expand Up @@ -421,7 +425,7 @@ class TerminalSession implements ITerminalSession {
*/
private _getName(): Promise<string> {
let url = utils.urlPathJoin(this._baseUrl, TERMINAL_SERVICE_URL);
let ajaxSettings = utils.copy(this._ajaxSettings);
let ajaxSettings: IAjaxSettings = utils.copy(this._ajaxSettings);
ajaxSettings.method = 'POST';
ajaxSettings.dataType = 'json';

Expand Down
1 change: 1 addition & 0 deletions src/typings.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
/// <reference path="../typings/requirejs/r.d.ts"/>
/// <reference path="../typings/path-posix/path-posix.d.ts"/>
/// <reference path="../typings/text-encoding/text-encoding.d.ts"/>
/// <reference path="../typings/url-join/url-join.d.ts"/>
Loading