@jupyterlab/services
Version:
Client APIs for the Jupyter services REST APIs
263 lines • 10.7 kB
JavaScript
;
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.deserialize = exports.serialize = void 0;
const KernelMessage = __importStar(require("./messages"));
/**
* Serialize a kernel message for transport.
*/
function serialize(msg, protocol = '') {
switch (protocol) {
case KernelMessage.supportedKernelWebSocketProtocols
.v1KernelWebsocketJupyterOrg:
return Private.serializeV1KernelWebsocketJupyterOrg(msg);
default:
return Private.serializeDefault(msg);
}
}
exports.serialize = serialize;
/**
* Deserialize and return the unpacked message.
*/
function deserialize(data, protocol = '') {
switch (protocol) {
case KernelMessage.supportedKernelWebSocketProtocols
.v1KernelWebsocketJupyterOrg:
return Private.deserializeV1KernelWebsocketJupyterOrg(data);
default:
return Private.deserializeDefault(data);
}
}
exports.deserialize = deserialize;
var Private;
(function (Private) {
/**
* Deserialize and return the unpacked message.
* Protocol `v1.kernel.websocket.jupyter.org`
*/
function deserializeV1KernelWebsocketJupyterOrg(binMsg) {
let msg;
const data = new DataView(binMsg);
const offsetNumber = Number(data.getBigUint64(0, true /* littleEndian */));
let offsets = [];
for (let i = 0; i < offsetNumber; i++) {
// WARNING: we cast our 64-bit unsigned int to a number!
// so offsets cannot index up to 2**64 bytes
offsets.push(Number(data.getBigUint64(8 * (i + 1), true /* littleEndian */)));
}
const decoder = new TextDecoder('utf8');
const channel = decoder.decode(binMsg.slice(offsets[0], offsets[1]));
const header = JSON.parse(decoder.decode(binMsg.slice(offsets[1], offsets[2])));
const parent_header = JSON.parse(decoder.decode(binMsg.slice(offsets[2], offsets[3])));
const metadata = JSON.parse(decoder.decode(binMsg.slice(offsets[3], offsets[4])));
const content = JSON.parse(decoder.decode(binMsg.slice(offsets[4], offsets[5])));
let buffers = [];
for (let i = 5; i < offsets.length - 1; i++) {
buffers.push(new DataView(binMsg.slice(offsets[i], offsets[i + 1])));
}
msg = {
channel,
header,
parent_header,
metadata,
content,
buffers
};
return msg;
}
Private.deserializeV1KernelWebsocketJupyterOrg = deserializeV1KernelWebsocketJupyterOrg;
/**
* Serialize a kernel message for transport.
* Protocol `v1.kernel.websocket.jupyter.org`
*/
function serializeV1KernelWebsocketJupyterOrg(msg) {
const header = JSON.stringify(msg.header);
const parentHeader = msg.parent_header == null ? '{}' : JSON.stringify(msg.parent_header);
const metadata = JSON.stringify(msg.metadata);
const content = JSON.stringify(msg.content);
const buffers = msg.buffers !== undefined ? msg.buffers : [];
const offsetNumber = 1 + 4 + buffers.length + 1;
let offsets = [];
offsets.push(8 * (1 + offsetNumber));
offsets.push(msg.channel.length + offsets[offsets.length - 1]);
const encoder = new TextEncoder();
const channelEncoded = encoder.encode(msg.channel);
const headerEncoded = encoder.encode(header);
const parentHeaderEncoded = encoder.encode(parentHeader);
const metadataEncoded = encoder.encode(metadata);
const contentEncoded = encoder.encode(content);
const binMsgNoBuff = new Uint8Array(channelEncoded.length +
headerEncoded.length +
parentHeaderEncoded.length +
metadataEncoded.length +
contentEncoded.length);
binMsgNoBuff.set(channelEncoded);
binMsgNoBuff.set(headerEncoded, channelEncoded.length);
binMsgNoBuff.set(parentHeaderEncoded, channelEncoded.length + headerEncoded.length);
binMsgNoBuff.set(metadataEncoded, channelEncoded.length + headerEncoded.length + parentHeaderEncoded.length);
binMsgNoBuff.set(contentEncoded, channelEncoded.length +
headerEncoded.length +
parentHeaderEncoded.length +
metadataEncoded.length);
for (let length of [
headerEncoded.length,
parentHeaderEncoded.length,
metadataEncoded.length,
contentEncoded.length
]) {
offsets.push(length + offsets[offsets.length - 1]);
}
let buffersByteLength = 0;
for (let buffer of buffers) {
let length = buffer.byteLength;
offsets.push(length + offsets[offsets.length - 1]);
buffersByteLength += length;
}
const binMsg = new Uint8Array(8 * (1 + offsetNumber) + binMsgNoBuff.byteLength + buffersByteLength);
const word = new ArrayBuffer(8);
const data = new DataView(word);
data.setBigUint64(0, BigInt(offsetNumber), true /* littleEndian */);
binMsg.set(new Uint8Array(word), 0);
for (let i = 0; i < offsets.length; i++) {
data.setBigUint64(0, BigInt(offsets[i]), true /* littleEndian */);
binMsg.set(new Uint8Array(word), 8 * (i + 1));
}
binMsg.set(binMsgNoBuff, offsets[0]);
for (let i = 0; i < buffers.length; i++) {
const buffer = buffers[i];
binMsg.set(new Uint8Array(ArrayBuffer.isView(buffer) ? buffer.buffer : buffer), offsets[5 + i]);
}
return binMsg.buffer;
}
Private.serializeV1KernelWebsocketJupyterOrg = serializeV1KernelWebsocketJupyterOrg;
/**
* Deserialize and return the unpacked message.
* Default protocol
*
* #### Notes
* Handles JSON blob strings and binary messages.
*/
function deserializeDefault(data) {
let value;
if (typeof data === 'string') {
value = JSON.parse(data);
}
else {
value = deserializeBinary(data);
}
return value;
}
Private.deserializeDefault = deserializeDefault;
/**
* Serialize a kernel message for transport.
* Default protocol
*
* #### Notes
* If there is binary content, an `ArrayBuffer` is returned,
* otherwise the message is converted to a JSON string.
*/
function serializeDefault(msg) {
var _a;
let value;
if ((_a = msg.buffers) === null || _a === void 0 ? void 0 : _a.length) {
value = serializeBinary(msg);
}
else {
value = JSON.stringify(msg);
}
return value;
}
Private.serializeDefault = serializeDefault;
/**
* Deserialize a binary message to a Kernel Message.
*/
function deserializeBinary(buf) {
const data = new DataView(buf);
// read the header: 1 + nbufs 32b integers
const nbufs = data.getUint32(0);
const offsets = [];
if (nbufs < 2) {
throw new Error('Invalid incoming Kernel Message');
}
for (let i = 1; i <= nbufs; i++) {
offsets.push(data.getUint32(i * 4));
}
const jsonBytes = new Uint8Array(buf.slice(offsets[0], offsets[1]));
const msg = JSON.parse(new TextDecoder('utf8').decode(jsonBytes));
// the remaining chunks are stored as DataViews in msg.buffers
msg.buffers = [];
for (let i = 1; i < nbufs; i++) {
const start = offsets[i];
const stop = offsets[i + 1] || buf.byteLength;
msg.buffers.push(new DataView(buf.slice(start, stop)));
}
return msg;
}
/**
* Implement the binary serialization protocol.
*
* Serialize Kernel message to ArrayBuffer.
*/
function serializeBinary(msg) {
const offsets = [];
const buffers = [];
const encoder = new TextEncoder();
let origBuffers = [];
if (msg.buffers !== undefined) {
origBuffers = msg.buffers;
delete msg['buffers'];
}
const jsonUtf8 = encoder.encode(JSON.stringify(msg));
buffers.push(jsonUtf8.buffer);
for (let i = 0; i < origBuffers.length; i++) {
// msg.buffers elements could be either views or ArrayBuffers
// buffers elements are ArrayBuffers
const b = origBuffers[i];
buffers.push(ArrayBuffer.isView(b) ? b.buffer : b);
}
const nbufs = buffers.length;
offsets.push(4 * (nbufs + 1));
for (let i = 0; i + 1 < buffers.length; i++) {
offsets.push(offsets[offsets.length - 1] + buffers[i].byteLength);
}
const msgBuf = new Uint8Array(offsets[offsets.length - 1] + buffers[buffers.length - 1].byteLength);
// use DataView.setUint32 for network byte-order
const view = new DataView(msgBuf.buffer);
// write nbufs to first 4 bytes
view.setUint32(0, nbufs);
// write offsets to next 4 * nbufs bytes
for (let i = 0; i < offsets.length; i++) {
view.setUint32(4 * (i + 1), offsets[i]);
}
// write all the buffers at their respective offsets
for (let i = 0; i < buffers.length; i++) {
msgBuf.set(new Uint8Array(buffers[i]), offsets[i]);
}
return msgBuf.buffer;
}
})(Private || (Private = {}));
//# sourceMappingURL=serialize.js.map