forked from jupyterlab/jupyterlab
/
validate.ts
182 lines (168 loc) · 4.98 KB
/
validate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { Kernel } from './kernel';
import { KernelMessage } from './messages';
/**
* Required fields for `IKernelHeader`.
*/
const HEADER_FIELDS = ['username', 'version', 'session', 'msg_id', 'msg_type'];
/**
* Required fields and types for contents of various types of `kernel.IMessage`
* messages on the iopub channel.
*/
const IOPUB_CONTENT_FIELDS: { [key: string]: any } = {
stream: { name: 'string', text: 'string' },
display_data: { data: 'object', metadata: 'object' },
execute_input: { code: 'string', execution_count: 'number' },
execute_result: {
execution_count: 'number',
data: 'object',
metadata: 'object'
},
error: { ename: 'string', evalue: 'string', traceback: 'object' },
status: { execution_state: 'string' },
clear_output: { wait: 'boolean' },
comm_open: { comm_id: 'string', target_name: 'string', data: 'object' },
comm_msg: { comm_id: 'string', data: 'object' },
comm_close: { comm_id: 'string' },
shutdown_reply: { restart: 'boolean' } // Emitted by the IPython kernel.
};
/**
* Validate a property as being on an object, and optionally
* of a given type.
*/
function validateProperty(object: any, name: string, typeName?: string): void {
if (!object.hasOwnProperty(name)) {
throw Error(`Missing property '${name}'`);
}
if (typeName !== void 0) {
let valid = true;
let value = object[name];
switch (typeName) {
case 'array':
valid = Array.isArray(value);
break;
case 'object':
valid = typeof value !== 'undefined';
break;
default:
valid = typeof value === typeName;
}
if (!valid) {
throw new Error(`Property '${name}' is not of type '${typeName}`);
}
}
}
/**
* Validate the header of a kernel message.
*/
function validateHeader(header: KernelMessage.IHeader): void {
for (let i = 0; i < HEADER_FIELDS.length; i++) {
validateProperty(header, HEADER_FIELDS[i], 'string');
}
}
/**
* Validate a kernel message object.
*/
export function validateMessage(msg: KernelMessage.IMessage): void {
validateProperty(msg, 'metadata', 'object');
validateProperty(msg, 'content', 'object');
validateProperty(msg, 'channel', 'string');
validateHeader(msg.header);
if (msg.channel === 'iopub') {
validateIOPubContent(msg as KernelMessage.IIOPubMessage);
}
}
/**
* Validate content an kernel message on the iopub channel.
*/
function validateIOPubContent(msg: KernelMessage.IIOPubMessage): void {
if (msg.channel === 'iopub') {
let fields = IOPUB_CONTENT_FIELDS[msg.header.msg_type];
// Check for unknown message type.
if (fields === void 0) {
return;
}
let names = Object.keys(fields);
let content = msg.content;
for (let i = 0; i < names.length; i++) {
validateProperty(content, names[i], fields[names[i]]);
}
}
}
/**
* Validate a `Kernel.IModel` object.
*/
export function validateModel(model: Kernel.IModel): void {
validateProperty(model, 'name', 'string');
validateProperty(model, 'id', 'string');
}
/**
* Validate a server kernelspec model to a client side model.
*/
export function validateSpecModel(data: any): Kernel.ISpecModel {
let spec = data.spec;
if (!spec) {
throw new Error('Invalid kernel spec');
}
validateProperty(data, 'name', 'string');
validateProperty(data, 'resources', 'object');
validateProperty(spec, 'language', 'string');
validateProperty(spec, 'display_name', 'string');
validateProperty(spec, 'argv', 'array');
let metadata: any = null;
if (spec.hasOwnProperty('metadata')) {
validateProperty(spec, 'metadata', 'object');
metadata = spec.metadata;
}
let env: any = null;
if (spec.hasOwnProperty('env')) {
validateProperty(spec, 'env', 'object');
env = spec.env;
}
return {
name: data.name,
resources: data.resources,
language: spec.language,
display_name: spec.display_name,
argv: spec.argv,
metadata,
env
};
}
/**
* Validate a `Kernel.ISpecModels` object.
*/
export function validateSpecModels(data: any): Kernel.ISpecModels {
if (!data.hasOwnProperty('kernelspecs')) {
throw new Error('No kernelspecs found');
}
let keys = Object.keys(data.kernelspecs);
let kernelspecs: { [key: string]: Kernel.ISpecModel } = Object.create(null);
let defaultSpec = data.default;
for (let i = 0; i < keys.length; i++) {
let ks = data.kernelspecs[keys[i]];
try {
kernelspecs[keys[i]] = validateSpecModel(ks);
} catch (err) {
// Remove the errant kernel spec.
console.warn(`Removing errant kernel spec: ${keys[i]}`);
}
}
keys = Object.keys(kernelspecs);
if (!keys.length) {
throw new Error('No valid kernelspecs found');
}
if (
!defaultSpec ||
typeof defaultSpec !== 'string' ||
!(defaultSpec in kernelspecs)
) {
defaultSpec = keys[0];
console.warn(`Default kernel not found, using '${keys[0]}'`);
}
return {
default: defaultSpec,
kernelspecs
};
}