You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by se...@apache.org on 2018/02/09 15:12:34 UTC
aurora git commit: Update Javascript Thrift to 0.10
Repository: aurora
Updated Branches:
refs/heads/master 8cd04aa77 -> cb0faf831
Update Javascript Thrift to 0.10
We missed this change when bumping the Thrift version used by Python and
Java. https://reviews.apache.org/r/64290/
List of changes: https://github.com/apache/thrift/commits/master/lib/js/src/thrift.js
Reviewed at https://reviews.apache.org/r/65433/
Project: http://git-wip-us.apache.org/repos/asf/aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/cb0faf83
Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/cb0faf83
Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/cb0faf83
Branch: refs/heads/master
Commit: cb0faf831747baa93ba9cff2423862eccb9b99bb
Parents: 8cd04aa
Author: Stephan Erb <se...@apache.org>
Authored: Fri Feb 9 15:10:53 2018 +0000
Committer: Stephan Erb <se...@apache.org>
Committed: Fri Feb 9 15:10:53 2018 +0000
----------------------------------------------------------------------
.../javascript/scheduler/assets/js/thrift.js | 937 +++++++++++++++++--
1 file changed, 859 insertions(+), 78 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/aurora/blob/cb0faf83/3rdparty/javascript/scheduler/assets/js/thrift.js
----------------------------------------------------------------------
diff --git a/3rdparty/javascript/scheduler/assets/js/thrift.js b/3rdparty/javascript/scheduler/assets/js/thrift.js
index 1115187..41935c4 100644
--- a/3rdparty/javascript/scheduler/assets/js/thrift.js
+++ b/3rdparty/javascript/scheduler/assets/js/thrift.js
@@ -1,26 +1,74 @@
/*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
*/
-var Thrift = {
- Version: '0.9.1',
-/*
- Description: 'JavaScript bindings for the Apache Thrift RPC system',
- License: 'http://www.apache.org/licenses/LICENSE-2.0',
- Homepage: 'http://thrift.apache.org',
- BugReports: 'https://issues.apache.org/jira/browse/THRIFT',
- Maintainer: 'dev@thrift.apache.org',
-*/
+/*jshint evil:true*/
+
+/**
+ * The Thrift namespace houses the Apache Thrift JavaScript library
+ * elements providing JavaScript bindings for the Apache Thrift RPC
+ * system. End users will typically only directly make use of the
+ * Transport (TXHRTransport/TWebSocketTransport) and Protocol
+ * (TJSONPRotocol/TBinaryProtocol) constructors.
+ *
+ * Object methods beginning with a __ (e.g. __onOpen()) are internal
+ * and should not be called outside of the object's own methods.
+ *
+ * This library creates one global object: Thrift
+ * Code in this library must never create additional global identifiers,
+ * all features must be scoped within the Thrift namespace.
+ * @namespace
+ * @example
+ * var transport = new Thrift.Transport("http://localhost:8585");
+ * var protocol = new Thrift.Protocol(transport);
+ * var client = new MyThriftSvcClient(protocol);
+ * var result = client.MyMethod();
+ */
+var Thrift = {
+ /**
+ * Thrift JavaScript library version.
+ * @readonly
+ * @const {string} Version
+ * @memberof Thrift
+ */
+ Version: '0.10.0',
+
+ /**
+ * Thrift IDL type string to Id mapping.
+ * @readonly
+ * @property {number} STOP - End of a set of fields.
+ * @property {number} VOID - No value (only legal for return types).
+ * @property {number} BOOL - True/False integer.
+ * @property {number} BYTE - Signed 8 bit integer.
+ * @property {number} I08 - Signed 8 bit integer.
+ * @property {number} DOUBLE - 64 bit IEEE 854 floating point.
+ * @property {number} I16 - Signed 16 bit integer.
+ * @property {number} I32 - Signed 32 bit integer.
+ * @property {number} I64 - Signed 64 bit integer.
+ * @property {number} STRING - Array of bytes representing a string of characters.
+ * @property {number} UTF7 - Array of bytes representing a string of UTF7 encoded characters.
+ * @property {number} STRUCT - A multifield type.
+ * @property {number} MAP - A collection type (map/associative-array/dictionary).
+ * @property {number} SET - A collection type (unordered and without repeated values).
+ * @property {number} LIST - A collection type (unordered).
+ * @property {number} UTF8 - Array of bytes representing a string of UTF8 encoded characters.
+ * @property {number} UTF16 - Array of bytes representing a string of UTF16 encoded characters.
+ */
Type: {
'STOP' : 0,
'VOID' : 1,
@@ -41,12 +89,26 @@ var Thrift = {
'UTF16' : 17
},
+ /**
+ * Thrift RPC message type string to Id mapping.
+ * @readonly
+ * @property {number} CALL - RPC call sent from client to server.
+ * @property {number} REPLY - RPC call normal response from server to client.
+ * @property {number} EXCEPTION - RPC call exception response from server to client.
+ * @property {number} ONEWAY - Oneway RPC call from client to server with no response.
+ */
MessageType: {
'CALL' : 1,
'REPLY' : 2,
- 'EXCEPTION' : 3
+ 'EXCEPTION' : 3,
+ 'ONEWAY' : 4
},
+ /**
+ * Utility function returning the count of an object's own properties.
+ * @param {object} obj - Object to test.
+ * @returns {number} number of object's own properties
+ */
objectLength: function(obj) {
var length = 0;
for (var k in obj) {
@@ -54,26 +116,60 @@ var Thrift = {
length++;
}
}
-
return length;
},
- inherits: function(constructor, superConstructor) {
- //Prototypal Inheritance http://javascript.crockford.com/prototypal.html
+ /**
+ * Utility function to establish prototype inheritance.
+ * @see {@link http://javascript.crockford.com/prototypal.html|Prototypal Inheritance}
+ * @param {function} constructor - Contstructor function to set as derived.
+ * @param {function} superConstructor - Contstructor function to set as base.
+ * @param {string} [name] - Type name to set as name property in derived prototype.
+ */
+ inherits: function(constructor, superConstructor, name) {
function F() {}
F.prototype = superConstructor.prototype;
constructor.prototype = new F();
+ constructor.prototype.name = name || "";
}
};
-
-
+/**
+ * Initializes a Thrift TException instance.
+ * @constructor
+ * @augments Error
+ * @param {string} message - The TException message (distinct from the Error message).
+ * @classdesc TException is the base class for all Thrift exceptions types.
+ */
Thrift.TException = function(message) {
this.message = message;
};
-Thrift.inherits(Thrift.TException, Error);
-Thrift.TException.prototype.name = 'TException';
+Thrift.inherits(Thrift.TException, Error, 'TException');
+/**
+ * Returns the message set on the exception.
+ * @readonly
+ * @returns {string} exception message
+ */
+Thrift.TException.prototype.getMessage = function() {
+ return this.message;
+};
+
+/**
+ * Thrift Application Exception type string to Id mapping.
+ * @readonly
+ * @property {number} UNKNOWN - Unknown/undefined.
+ * @property {number} UNKNOWN_METHOD - Client attempted to call a method unknown to the server.
+ * @property {number} INVALID_MESSAGE_TYPE - Client passed an unknown/unsupported MessageType.
+ * @property {number} WRONG_METHOD_NAME - Unused.
+ * @property {number} BAD_SEQUENCE_ID - Unused in Thrift RPC, used to flag proprietary sequence number errors.
+ * @property {number} MISSING_RESULT - Raised by a server processor if a handler fails to supply the required return result.
+ * @property {number} INTERNAL_ERROR - Something bad happened.
+ * @property {number} PROTOCOL_ERROR - The protocol layer failed to serialize or deserialize data.
+ * @property {number} INVALID_TRANSFORM - Unused.
+ * @property {number} INVALID_PROTOCOL - The protocol (or version) is not supported.
+ * @property {number} UNSUPPORTED_CLIENT_TYPE - Unused.
+ */
Thrift.TApplicationExceptionType = {
'UNKNOWN' : 0,
'UNKNOWN_METHOD' : 1,
@@ -88,13 +184,24 @@ Thrift.TApplicationExceptionType = {
'UNSUPPORTED_CLIENT_TYPE' : 10
};
+/**
+ * Initializes a Thrift TApplicationException instance.
+ * @constructor
+ * @augments Thrift.TException
+ * @param {string} message - The TApplicationException message (distinct from the Error message).
+ * @param {Thrift.TApplicationExceptionType} [code] - The TApplicationExceptionType code.
+ * @classdesc TApplicationException is the exception class used to propagate exceptions from an RPC server back to a calling client.
+*/
Thrift.TApplicationException = function(message, code) {
this.message = message;
- this.code = (code === null) ? 0 : code;
+ this.code = typeof code === "number" ? code : 0;
};
-Thrift.inherits(Thrift.TApplicationException, Thrift.TException);
-Thrift.TApplicationException.prototype.name = 'TApplicationException';
+Thrift.inherits(Thrift.TApplicationException, Thrift.TException, 'TApplicationException');
+/**
+ * Read a TApplicationException from the supplied protocol.
+ * @param {object} input - The input protocol to read from.
+ */
Thrift.TApplicationException.prototype.read = function(input) {
while (1) {
var ret = input.readFieldBegin();
@@ -133,9 +240,11 @@ Thrift.TApplicationException.prototype.read = function(input) {
input.readStructEnd();
};
+/**
+ * Wite a TApplicationException to the supplied protocol.
+ * @param {object} output - The output protocol to write to.
+ */
Thrift.TApplicationException.prototype.write = function(output) {
- var xfer = 0;
-
output.writeStructBegin('TApplicationException');
if (this.message) {
@@ -154,52 +263,134 @@ Thrift.TApplicationException.prototype.write = function(output) {
output.writeStructEnd();
};
+/**
+ * Returns the application exception code set on the exception.
+ * @readonly
+ * @returns {Thrift.TApplicationExceptionType} exception code
+ */
Thrift.TApplicationException.prototype.getCode = function() {
return this.code;
};
-Thrift.TApplicationException.prototype.getMessage = function() {
- return this.message;
+Thrift.TProtocolExceptionType = {
+ UNKNOWN: 0,
+ INVALID_DATA: 1,
+ NEGATIVE_SIZE: 2,
+ SIZE_LIMIT: 3,
+ BAD_VERSION: 4,
+ NOT_IMPLEMENTED: 5,
+ DEPTH_LIMIT: 6
+};
+
+Thrift.TProtocolException = function TProtocolException(type, message) {
+ Error.call(this);
+ Error.captureStackTrace(this, this.constructor);
+ this.name = this.constructor.name;
+ this.type = type;
+ this.message = message;
};
+Thrift.inherits(Thrift.TProtocolException, Thrift.TException, 'TProtocolException');
/**
- *If you do not specify a url then you must handle ajax on your own.
- *This is how to use js bindings in a async fashion.
+ * Constructor Function for the XHR transport.
+ * If you do not specify a url then you must handle XHR operations on
+ * your own. This type can also be constructed using the Transport alias
+ * for backward compatibility.
+ * @constructor
+ * @param {string} [url] - The URL to connect to.
+ * @classdesc The Apache Thrift Transport layer performs byte level I/O
+ * between RPC clients and servers. The JavaScript TXHRTransport object
+ * uses Http[s]/XHR. Target servers must implement the http[s] transport
+ * (see: node.js example server_http.js).
+ * @example
+ * var transport = new Thrift.TXHRTransport("http://localhost:8585");
*/
-Thrift.Transport = function(url) {
+Thrift.Transport = Thrift.TXHRTransport = function(url, options) {
this.url = url;
this.wpos = 0;
this.rpos = 0;
-
+ this.useCORS = (options && options.useCORS);
+ this.customHeaders = options ? (options.customHeaders ? options.customHeaders : {}): {};
this.send_buf = '';
this.recv_buf = '';
};
-Thrift.Transport.prototype = {
-
- //Gets the browser specific XmlHttpRequest Object
+Thrift.TXHRTransport.prototype = {
+ /**
+ * Gets the browser specific XmlHttpRequest Object.
+ * @returns {object} the browser XHR interface object
+ */
getXmlHttpRequestObject: function() {
try { return new XMLHttpRequest(); } catch (e1) { }
try { return new ActiveXObject('Msxml2.XMLHTTP'); } catch (e2) { }
try { return new ActiveXObject('Microsoft.XMLHTTP'); } catch (e3) { }
- throw "Your browser doesn't support the XmlHttpRequest object.";
+ throw "Your browser doesn't support XHR.";
},
- flush: function(async) {
- //async mode
- if (async || this.url === undefined || this.url === '') {
+ /**
+ * Sends the current XRH request if the transport was created with a URL
+ * and the async parameter is false. If the transport was not created with
+ * a URL, or the async parameter is True and no callback is provided, or
+ * the URL is an empty string, the current send buffer is returned.
+ * @param {object} async - If true the current send buffer is returned.
+ * @param {object} callback - Optional async completion callback
+ * @returns {undefined|string} Nothing or the current send buffer.
+ * @throws {string} If XHR fails.
+ */
+ flush: function(async, callback) {
+ var self = this;
+ if ((async && !callback) || this.url === undefined || this.url === '') {
return this.send_buf;
}
var xreq = this.getXmlHttpRequestObject();
if (xreq.overrideMimeType) {
- xreq.overrideMimeType('application/json');
+ xreq.overrideMimeType('application/vnd.apache.thrift.json; charset=utf-8');
+ }
+
+ if (callback) {
+ //Ignore XHR callbacks until the data arrives, then call the
+ // client's callback
+ xreq.onreadystatechange =
+ (function() {
+ var clientCallback = callback;
+ return function() {
+ if (this.readyState == 4 && this.status == 200) {
+ self.setRecvBuffer(this.responseText);
+ clientCallback();
+ }
+ };
+ }());
+
+ // detect net::ERR_CONNECTION_REFUSED and call the callback.
+ xreq.onerror =
+ (function() {
+ var clientCallback = callback;
+ return function() {
+ clientCallback();
+ };
+ }());
+
+ }
+
+ xreq.open('POST', this.url, !!async);
+
+ // add custom headers
+ Object.keys(self.customHeaders).forEach(function(prop) {
+ xreq.setRequestHeader(prop, self.customHeaders[prop]);
+ });
+
+ if (xreq.setRequestHeader) {
+ xreq.setRequestHeader('Accept', 'application/vnd.apache.thrift.json; charset=utf-8');
+ xreq.setRequestHeader('Content-Type', 'application/vnd.apache.thrift.json; charset=utf-8');
}
- xreq.open('POST', this.url, false);
xreq.send(this.send_buf);
+ if (async && callback) {
+ return;
+ }
if (xreq.readyState != 4) {
throw 'encountered an unknown ajax ready state: ' + xreq.readyState;
@@ -215,6 +406,15 @@ Thrift.Transport.prototype = {
this.rpos = 0;
},
+ /**
+ * Creates a jQuery XHR object to be used for a Thrift server call.
+ * @param {object} client - The Thrift Service client object generated by the IDL compiler.
+ * @param {object} postData - The message to send to the server.
+ * @param {function} args - The original call arguments with the success call back at the end.
+ * @param {function} recv_method - The Thrift Service Client receive method for the call.
+ * @returns {object} A new jQuery XHR object.
+ * @throws {string} If the jQuery version is prior to 1.5 or if jQuery is not found.
+ */
jqRequest: function(client, postData, args, recv_method) {
if (typeof jQuery === 'undefined' ||
typeof jQuery.Deferred === 'undefined') {
@@ -228,7 +428,7 @@ Thrift.Transport.prototype = {
data: postData,
type: 'POST',
cache: false,
- contentType: 'application/json',
+ contentType: 'application/vnd.apache.thrift.json; charset=utf-8',
dataType: 'text thrift',
converters: {
'text thrift' : function(responseData) {
@@ -244,6 +444,10 @@ Thrift.Transport.prototype = {
return jqXHR;
},
+ /**
+ * Sets the buffer to provide the protocol when deserializing.
+ * @param {string} buf - The buffer to supply the protocol.
+ */
setRecvBuffer: function(buf) {
this.recv_buf = buf;
this.recv_buf_sz = this.recv_buf.length;
@@ -251,14 +455,31 @@ Thrift.Transport.prototype = {
this.rpos = 0;
},
+ /**
+ * Returns true if the transport is open, XHR always returns true.
+ * @readonly
+ * @returns {boolean} Always True.
+ */
isOpen: function() {
return true;
},
+ /**
+ * Opens the transport connection, with XHR this is a nop.
+ */
open: function() {},
+ /**
+ * Closes the transport connection, with XHR this is a nop.
+ */
close: function() {},
+ /**
+ * Returns the specified number of characters from the response
+ * buffer.
+ * @param {number} len - The number of characters to return.
+ * @returns {string} Characters sent by the server.
+ */
read: function(len) {
var avail = this.wpos - this.rpos;
@@ -279,14 +500,27 @@ Thrift.Transport.prototype = {
return ret;
},
+ /**
+ * Returns the entire response buffer.
+ * @returns {string} Characters sent by the server.
+ */
readAll: function() {
return this.recv_buf;
},
+ /**
+ * Sets the send buffer to buf.
+ * @param {string} buf - The buffer to send.
+ */
write: function(buf) {
this.send_buf = buf;
},
+ /**
+ * Returns the send buffer.
+ * @readonly
+ * @returns {string} The send buffer.
+ */
getSendBuffer: function() {
return this.send_buf;
}
@@ -294,11 +528,213 @@ Thrift.Transport.prototype = {
};
+/**
+ * Constructor Function for the WebSocket transport.
+ * @constructor
+ * @param {string} [url] - The URL to connect to.
+ * @classdesc The Apache Thrift Transport layer performs byte level I/O
+ * between RPC clients and servers. The JavaScript TWebSocketTransport object
+ * uses the WebSocket protocol. Target servers must implement WebSocket.
+ * (see: node.js example server_http.js).
+ * @example
+ * var transport = new Thrift.TWebSocketTransport("http://localhost:8585");
+ */
+Thrift.TWebSocketTransport = function(url) {
+ this.__reset(url);
+};
+
+Thrift.TWebSocketTransport.prototype = {
+ __reset: function(url) {
+ this.url = url; //Where to connect
+ this.socket = null; //The web socket
+ this.callbacks = []; //Pending callbacks
+ this.send_pending = []; //Buffers/Callback pairs waiting to be sent
+ this.send_buf = ''; //Outbound data, immutable until sent
+ this.recv_buf = ''; //Inbound data
+ this.rb_wpos = 0; //Network write position in receive buffer
+ this.rb_rpos = 0; //Client read position in receive buffer
+ },
+
+ /**
+ * Sends the current WS request and registers callback. The async
+ * parameter is ignored (WS flush is always async) and the callback
+ * function parameter is required.
+ * @param {object} async - Ignored.
+ * @param {object} callback - The client completion callback.
+ * @returns {undefined|string} Nothing (undefined)
+ */
+ flush: function(async, callback) {
+ var self = this;
+ if (this.isOpen()) {
+ //Send data and register a callback to invoke the client callback
+ this.socket.send(this.send_buf);
+ this.callbacks.push((function() {
+ var clientCallback = callback;
+ return function(msg) {
+ self.setRecvBuffer(msg);
+ clientCallback();
+ };
+ }()));
+ } else {
+ //Queue the send to go out __onOpen
+ this.send_pending.push({
+ buf: this.send_buf,
+ cb: callback
+ });
+ }
+ },
+
+ __onOpen: function() {
+ var self = this;
+ if (this.send_pending.length > 0) {
+ //If the user made calls before the connection was fully
+ //open, send them now
+ this.send_pending.forEach(function(elem) {
+ this.socket.send(elem.buf);
+ this.callbacks.push((function() {
+ var clientCallback = elem.cb;
+ return function(msg) {
+ self.setRecvBuffer(msg);
+ clientCallback();
+ };
+ }()));
+ });
+ this.send_pending = [];
+ }
+ },
+
+ __onClose: function(evt) {
+ this.__reset(this.url);
+ },
+
+ __onMessage: function(evt) {
+ if (this.callbacks.length) {
+ this.callbacks.shift()(evt.data);
+ }
+ },
+
+ __onError: function(evt) {
+ console.log("Thrift WebSocket Error: " + evt.toString());
+ this.socket.close();
+ },
+
+ /**
+ * Sets the buffer to use when receiving server responses.
+ * @param {string} buf - The buffer to receive server responses.
+ */
+ setRecvBuffer: function(buf) {
+ this.recv_buf = buf;
+ this.recv_buf_sz = this.recv_buf.length;
+ this.wpos = this.recv_buf.length;
+ this.rpos = 0;
+ },
+
+ /**
+ * Returns true if the transport is open
+ * @readonly
+ * @returns {boolean}
+ */
+ isOpen: function() {
+ return this.socket && this.socket.readyState == this.socket.OPEN;
+ },
+
+ /**
+ * Opens the transport connection
+ */
+ open: function() {
+ //If OPEN/CONNECTING/CLOSING ignore additional opens
+ if (this.socket && this.socket.readyState != this.socket.CLOSED) {
+ return;
+ }
+ //If there is no socket or the socket is closed:
+ this.socket = new WebSocket(this.url);
+ this.socket.onopen = this.__onOpen.bind(this);
+ this.socket.onmessage = this.__onMessage.bind(this);
+ this.socket.onerror = this.__onError.bind(this);
+ this.socket.onclose = this.__onClose.bind(this);
+ },
+
+ /**
+ * Closes the transport connection
+ */
+ close: function() {
+ this.socket.close();
+ },
+
+ /**
+ * Returns the specified number of characters from the response
+ * buffer.
+ * @param {number} len - The number of characters to return.
+ * @returns {string} Characters sent by the server.
+ */
+ read: function(len) {
+ var avail = this.wpos - this.rpos;
+
+ if (avail === 0) {
+ return '';
+ }
-Thrift.Protocol = function(transport) {
+ var give = len;
+
+ if (avail < len) {
+ give = avail;
+ }
+
+ var ret = this.read_buf.substr(this.rpos, give);
+ this.rpos += give;
+
+ //clear buf when complete?
+ return ret;
+ },
+
+ /**
+ * Returns the entire response buffer.
+ * @returns {string} Characters sent by the server.
+ */
+ readAll: function() {
+ return this.recv_buf;
+ },
+
+ /**
+ * Sets the send buffer to buf.
+ * @param {string} buf - The buffer to send.
+ */
+ write: function(buf) {
+ this.send_buf = buf;
+ },
+
+ /**
+ * Returns the send buffer.
+ * @readonly
+ * @returns {string} The send buffer.
+ */
+ getSendBuffer: function() {
+ return this.send_buf;
+ }
+
+};
+
+/**
+ * Initializes a Thrift JSON protocol instance.
+ * @constructor
+ * @param {Thrift.Transport} transport - The transport to serialize to/from.
+ * @classdesc Apache Thrift Protocols perform serialization which enables cross
+ * language RPC. The Protocol type is the JavaScript browser implementation
+ * of the Apache Thrift TJSONProtocol.
+ * @example
+ * var protocol = new Thrift.Protocol(transport);
+ */
+Thrift.TJSONProtocol = Thrift.Protocol = function(transport) {
+ this.tstack = [];
+ this.tpos = [];
this.transport = transport;
};
+/**
+ * Thrift IDL type Id to string mapping.
+ * @readonly
+ * @see {@link Thrift.Type}
+ */
Thrift.Protocol.Type = {};
Thrift.Protocol.Type[Thrift.Type.BOOL] = '"tf"';
Thrift.Protocol.Type[Thrift.Type.BYTE] = '"i8"';
@@ -312,7 +748,11 @@ Thrift.Protocol.Type[Thrift.Type.MAP] = '"map"';
Thrift.Protocol.Type[Thrift.Type.LIST] = '"lst"';
Thrift.Protocol.Type[Thrift.Type.SET] = '"set"';
-
+/**
+ * Thrift IDL type string to Id mapping.
+ * @readonly
+ * @see {@link Thrift.Type}
+ */
Thrift.Protocol.RType = {};
Thrift.Protocol.RType.tf = Thrift.Type.BOOL;
Thrift.Protocol.RType.i8 = Thrift.Type.BYTE;
@@ -326,15 +766,30 @@ Thrift.Protocol.RType.map = Thrift.Type.MAP;
Thrift.Protocol.RType.lst = Thrift.Type.LIST;
Thrift.Protocol.RType.set = Thrift.Type.SET;
-Thrift.Protocol.Version = 1;
+/**
+ * The TJSONProtocol version number.
+ * @readonly
+ * @const {number} Version
+ * @memberof Thrift.Protocol
+ */
+ Thrift.Protocol.Version = 1;
Thrift.Protocol.prototype = {
-
+ /**
+ * Returns the underlying transport.
+ * @readonly
+ * @returns {Thrift.Transport} The underlying transport.
+ */
getTransport: function() {
return this.transport;
},
- //Write functions
+ /**
+ * Serializes the beginning of a Thrift RPC message.
+ * @param {string} name - The service method to call.
+ * @param {Thrift.MessageType} messageType - The type of method call.
+ * @param {number} seqid - The sequence number of this call (always 0 in Apache Thrift).
+ */
writeMessageBegin: function(name, messageType, seqid) {
this.tstack = [];
this.tpos = [];
@@ -343,6 +798,9 @@ Thrift.Protocol.prototype = {
name + '"', messageType, seqid]);
},
+ /**
+ * Serializes the end of a Thrift RPC message.
+ */
writeMessageEnd: function() {
var obj = this.tstack.pop();
@@ -355,11 +813,18 @@ Thrift.Protocol.prototype = {
},
+ /**
+ * Serializes the beginning of a struct.
+ * @param {string} name - The name of the struct.
+ */
writeStructBegin: function(name) {
this.tpos.push(this.tstack.length);
this.tstack.push({});
},
+ /**
+ * Serializes the end of a struct.
+ */
writeStructEnd: function() {
var p = this.tpos.pop();
@@ -380,6 +845,12 @@ Thrift.Protocol.prototype = {
this.tstack[p] = str;
},
+ /**
+ * Serializes the beginning of a struct field.
+ * @param {string} name - The name of the field.
+ * @param {Thrift.Protocol.Type} fieldType - The data type of the field.
+ * @param {number} fieldId - The field's unique identifier.
+ */
writeFieldBegin: function(name, fieldType, fieldId) {
this.tpos.push(this.tstack.length);
this.tstack.push({ 'fieldId': '"' +
@@ -388,6 +859,9 @@ Thrift.Protocol.prototype = {
},
+ /**
+ * Serializes the end of a field.
+ */
writeFieldEnd: function() {
var value = this.tstack.pop();
var fieldInfo = this.tstack.pop();
@@ -397,17 +871,28 @@ Thrift.Protocol.prototype = {
this.tpos.pop();
},
+ /**
+ * Serializes the end of the set of fields for a struct.
+ */
writeFieldStop: function() {
//na
},
+ /**
+ * Serializes the beginning of a map collection.
+ * @param {Thrift.Type} keyType - The data type of the key.
+ * @param {Thrift.Type} valType - The data type of the value.
+ * @param {number} [size] - The number of elements in the map (ignored).
+ */
writeMapBegin: function(keyType, valType, size) {
- //size is invalid, we'll set it on end.
this.tpos.push(this.tstack.length);
this.tstack.push([Thrift.Protocol.Type[keyType],
Thrift.Protocol.Type[valType], 0]);
},
+ /**
+ * Serializes the end of a map.
+ */
writeMapEnd: function() {
var p = this.tpos.pop();
@@ -443,11 +928,19 @@ Thrift.Protocol.prototype = {
this.tstack[p] = '[' + this.tstack[p].join(',') + ']';
},
+ /**
+ * Serializes the beginning of a list collection.
+ * @param {Thrift.Type} elemType - The data type of the elements.
+ * @param {number} size - The number of elements in the list.
+ */
writeListBegin: function(elemType, size) {
this.tpos.push(this.tstack.length);
this.tstack.push([Thrift.Protocol.Type[elemType], size]);
},
+ /**
+ * Serializes the end of a list.
+ */
writeListEnd: function() {
var p = this.tpos.pop();
@@ -460,11 +953,19 @@ Thrift.Protocol.prototype = {
this.tstack[p] = '[' + this.tstack[p].join(',') + ']';
},
+ /**
+ * Serializes the beginning of a set collection.
+ * @param {Thrift.Type} elemType - The data type of the elements.
+ * @param {number} size - The number of elements in the list.
+ */
writeSetBegin: function(elemType, size) {
this.tpos.push(this.tstack.length);
this.tstack.push([Thrift.Protocol.Type[elemType], size]);
},
+ /**
+ * Serializes the end of a set.
+ */
writeSetEnd: function() {
var p = this.tpos.pop();
@@ -477,30 +978,37 @@ Thrift.Protocol.prototype = {
this.tstack[p] = '[' + this.tstack[p].join(',') + ']';
},
+ /** Serializes a boolean */
writeBool: function(value) {
this.tstack.push(value ? 1 : 0);
},
+ /** Serializes a number */
writeByte: function(i8) {
this.tstack.push(i8);
},
+ /** Serializes a number */
writeI16: function(i16) {
this.tstack.push(i16);
},
+ /** Serializes a number */
writeI32: function(i32) {
this.tstack.push(i32);
},
+ /** Serializes a number */
writeI64: function(i64) {
this.tstack.push(i64);
},
+ /** Serializes a number */
writeDouble: function(dbl) {
this.tstack.push(dbl);
},
+ /** Serializes a string */
writeString: function(str) {
// We do not encode uri components for wire transfer:
if (str === null) {
@@ -512,16 +1020,8 @@ Thrift.Protocol.prototype = {
var ch = str.charAt(i); // a single double quote: "
if (ch === '\"') {
escapedString += '\\\"'; // write out as: \"
- } else if (ch === '\\') { // a single backslash: \
- escapedString += '\\\\'; // write out as: \\
- /* Currently escaped forward slashes break TJSONProtocol.
- * As it stands, we can simply pass forward slashes into
- * our strings across the wire without being escaped.
- * I think this is the protocol's bug, not thrift.js
- * } else if(ch === '/') { // a single forward slash: /
- * escapedString += '\\/'; // write out as \/
- * }
- */
+ } else if (ch === '\\') { // a single backslash
+ escapedString += '\\\\'; // write out as double backslash
} else if (ch === '\b') { // a single backspace: invisible
escapedString += '\\b'; // write out as: \b"
} else if (ch === '\f') { // a single formfeed: invisible
@@ -540,18 +1040,40 @@ Thrift.Protocol.prototype = {
}
},
- writeBinary: function(str) {
- this.writeString(str);
+ /** Serializes a string */
+ writeBinary: function(binary) {
+ var str = '';
+ if (typeof binary == 'string') {
+ str = binary;
+ } else if (binary instanceof Uint8Array) {
+ var arr = binary;
+ for (var i = 0; i < arr.length; ++i) {
+ str += String.fromCharCode(arr[i]);
+ }
+ } else {
+ throw new TypeError('writeBinary only accepts String or Uint8Array.');
+ }
+ this.tstack.push('"' + btoa(str) + '"');
},
-
-
- // Reading functions
- readMessageBegin: function(name, messageType, seqid) {
+ /**
+ @class
+ @name AnonReadMessageBeginReturn
+ @property {string} fname - The name of the service method.
+ @property {Thrift.MessageType} mtype - The type of message call.
+ @property {number} rseqid - The sequence number of the message (0 in Thrift RPC).
+ */
+ /**
+ * Deserializes the beginning of a message.
+ * @returns {AnonReadMessageBeginReturn}
+ */
+ readMessageBegin: function() {
this.rstack = [];
this.rpos = [];
- if (typeof jQuery !== 'undefined') {
+ if (typeof JSON !== 'undefined' && typeof JSON.parse === 'function') {
+ this.robj = JSON.parse(this.transport.readAll());
+ } else if (typeof jQuery !== 'undefined') {
this.robj = jQuery.parseJSON(this.transport.readAll());
} else {
this.robj = eval(this.transport.readAll());
@@ -575,9 +1097,15 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Deserializes the end of a message. */
readMessageEnd: function() {
},
+ /**
+ * Deserializes the beginning of a struct.
+ * @param {string} [name] - The name of the struct (ignored)
+ * @returns {object} - An object with an empty string fname property
+ */
readStructBegin: function(name) {
var r = {};
r.fname = '';
@@ -590,12 +1118,24 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Deserializes the end of a struct. */
readStructEnd: function() {
if (this.rstack[this.rstack.length - 2] instanceof Array) {
this.rstack.pop();
}
},
+ /**
+ @class
+ @name AnonReadFieldBeginReturn
+ @property {string} fname - The name of the field (always '').
+ @property {Thrift.Type} ftype - The data type of the field.
+ @property {number} fid - The unique identifier of the field.
+ */
+ /**
+ * Deserializes the beginning of a field.
+ * @returns {AnonReadFieldBeginReturn}
+ */
readFieldBegin: function() {
var r = {};
@@ -643,6 +1183,7 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Deserializes the end of a field. */
readFieldEnd: function() {
var pos = this.rpos.pop();
@@ -653,11 +1194,28 @@ Thrift.Protocol.prototype = {
},
- readMapBegin: function(keyType, valType, size) {
+ /**
+ @class
+ @name AnonReadMapBeginReturn
+ @property {Thrift.Type} ktype - The data type of the key.
+ @property {Thrift.Type} vtype - The data type of the value.
+ @property {number} size - The number of elements in the map.
+ */
+ /**
+ * Deserializes the beginning of a map.
+ * @returns {AnonReadMapBeginReturn}
+ */
+ readMapBegin: function() {
var map = this.rstack.pop();
+ var first = map.shift();
+ if (first instanceof Array) {
+ this.rstack.push(map);
+ map = first;
+ first = map.shift();
+ }
var r = {};
- r.ktype = Thrift.Protocol.RType[map.shift()];
+ r.ktype = Thrift.Protocol.RType[first];
r.vtype = Thrift.Protocol.RType[map.shift()];
r.size = map.shift();
@@ -668,11 +1226,22 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Deserializes the end of a map. */
readMapEnd: function() {
this.readFieldEnd();
},
- readListBegin: function(elemType, size) {
+ /**
+ @class
+ @name AnonReadColBeginReturn
+ @property {Thrift.Type} etype - The data type of the element.
+ @property {number} size - The number of elements in the collection.
+ */
+ /**
+ * Deserializes the beginning of a list.
+ * @returns {AnonReadColBeginReturn}
+ */
+ readListBegin: function() {
var list = this.rstack[this.rstack.length - 1];
var r = {};
@@ -680,23 +1249,32 @@ Thrift.Protocol.prototype = {
r.size = list.shift();
this.rpos.push(this.rstack.length);
- this.rstack.push(list);
+ this.rstack.push(list.shift());
return r;
},
+ /** Deserializes the end of a list. */
readListEnd: function() {
this.readFieldEnd();
},
+ /**
+ * Deserializes the beginning of a set.
+ * @returns {AnonReadColBeginReturn}
+ */
readSetBegin: function(elemType, size) {
return this.readListBegin(elemType, size);
},
+ /** Deserializes the end of a set. */
readSetEnd: function() {
return this.readListEnd();
},
+ /** Returns an object with a value property set to
+ * False unless the next number in the protocol buffer
+ * is 1, in which case the value property is True */
readBool: function() {
var r = this.readI32();
@@ -709,14 +1287,20 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readByte: function() {
return this.readI32();
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readI16: function() {
return this.readI32();
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readI32: function(f) {
if (f === undefined) {
f = this.rstack[this.rstack.length - 1];
@@ -749,26 +1333,223 @@ Thrift.Protocol.prototype = {
return r;
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readI64: function() {
return this.readI32();
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readDouble: function() {
return this.readI32();
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readString: function() {
var r = this.readI32();
return r;
},
+ /** Returns the an object with a value property set to the
+ next value found in the protocol buffer */
readBinary: function() {
- return this.readString();
+ var r = this.readI32();
+ r.value = atob(r.value);
+ return r;
},
-
- //Method to arbitrarily skip over data.
+ /**
+ * Method to arbitrarily skip over data */
skip: function(type) {
- throw 'skip not supported yet';
+ var ret, i;
+ switch (type) {
+ case Thrift.Type.STOP:
+ return null;
+
+ case Thrift.Type.BOOL:
+ return this.readBool();
+
+ case Thrift.Type.BYTE:
+ return this.readByte();
+
+ case Thrift.Type.I16:
+ return this.readI16();
+
+ case Thrift.Type.I32:
+ return this.readI32();
+
+ case Thrift.Type.I64:
+ return this.readI64();
+
+ case Thrift.Type.DOUBLE:
+ return this.readDouble();
+
+ case Thrift.Type.STRING:
+ return this.readString();
+
+ case Thrift.Type.STRUCT:
+ this.readStructBegin();
+ while (true) {
+ ret = this.readFieldBegin();
+ if (ret.ftype == Thrift.Type.STOP) {
+ break;
+ }
+ this.skip(ret.ftype);
+ this.readFieldEnd();
+ }
+ this.readStructEnd();
+ return null;
+
+ case Thrift.Type.MAP:
+ ret = this.readMapBegin();
+ for (i = 0; i < ret.size; i++) {
+ if (i > 0) {
+ if (this.rstack.length > this.rpos[this.rpos.length - 1] + 1) {
+ this.rstack.pop();
+ }
+ }
+ this.skip(ret.ktype);
+ this.skip(ret.vtype);
+ }
+ this.readMapEnd();
+ return null;
+
+ case Thrift.Type.SET:
+ ret = this.readSetBegin();
+ for (i = 0; i < ret.size; i++) {
+ this.skip(ret.etype);
+ }
+ this.readSetEnd();
+ return null;
+
+ case Thrift.Type.LIST:
+ ret = this.readListBegin();
+ for (i = 0; i < ret.size; i++) {
+ this.skip(ret.etype);
+ }
+ this.readListEnd();
+ return null;
+ }
}
};
+
+
+/**
+ * Initializes a MutilplexProtocol Implementation as a Wrapper for Thrift.Protocol
+ * @constructor
+ */
+Thrift.MultiplexProtocol = function (srvName, trans, strictRead, strictWrite) {
+ Thrift.Protocol.call(this, trans, strictRead, strictWrite);
+ this.serviceName = srvName;
+};
+Thrift.inherits(Thrift.MultiplexProtocol, Thrift.Protocol, 'multiplexProtocol');
+
+/** Override writeMessageBegin method of prototype*/
+Thrift.MultiplexProtocol.prototype.writeMessageBegin = function (name, type, seqid) {
+
+ if (type === Thrift.MessageType.CALL || type === Thrift.MessageType.ONEWAY) {
+ Thrift.Protocol.prototype.writeMessageBegin.call(this, this.serviceName + ":" + name, type, seqid);
+ } else {
+ Thrift.Protocol.prototype.writeMessageBegin.call(this, name, type, seqid);
+ }
+};
+
+Thrift.Multiplexer = function () {
+ this.seqid = 0;
+};
+
+/** Instantiates a multiplexed client for a specific service
+ * @constructor
+ * @param {String} serviceName - The transport to serialize to/from.
+ * @param {Thrift.ServiceClient} SCl - The Service Client Class
+ * @param {Thrift.Transport} transport - Thrift.Transport instance which provides remote host:port
+ * @example
+ * var mp = new Thrift.Multiplexer();
+ * var transport = new Thrift.Transport("http://localhost:9090/foo.thrift");
+ * var protocol = new Thrift.Protocol(transport);
+ * var client = mp.createClient('AuthService', AuthServiceClient, transport);
+*/
+Thrift.Multiplexer.prototype.createClient = function (serviceName, SCl, transport) {
+ if (SCl.Client) {
+ SCl = SCl.Client;
+ }
+ var self = this;
+ SCl.prototype.new_seqid = function () {
+ self.seqid += 1;
+ return self.seqid;
+ };
+ var client = new SCl(new Thrift.MultiplexProtocol(serviceName, transport));
+
+ return client;
+};
+
+
+
+var copyList, copyMap;
+
+copyList = function(lst, types) {
+
+ if (!lst) {return lst; }
+
+ var type;
+
+ if (types.shift === undefined) {
+ type = types;
+ }
+ else {
+ type = types[0];
+ }
+ var Type = type;
+
+ var len = lst.length, result = [], i, val;
+ for (i = 0; i < len; i++) {
+ val = lst[i];
+ if (type === null) {
+ result.push(val);
+ }
+ else if (type === copyMap || type === copyList) {
+ result.push(type(val, types.slice(1)));
+ }
+ else {
+ result.push(new Type(val));
+ }
+ }
+ return result;
+};
+
+copyMap = function(obj, types){
+
+ if (!obj) {return obj; }
+
+ var type;
+
+ if (types.shift === undefined) {
+ type = types;
+ }
+ else {
+ type = types[0];
+ }
+ var Type = type;
+
+ var result = {}, val;
+ for(var prop in obj) {
+ if(obj.hasOwnProperty(prop)) {
+ val = obj[prop];
+ if (type === null) {
+ result[prop] = val;
+ }
+ else if (type === copyMap || type === copyList) {
+ result[prop] = type(val, types.slice(1));
+ }
+ else {
+ result[prop] = new Type(val);
+ }
+ }
+ }
+ return result;
+};
+
+Thrift.copyMap = copyMap;
+Thrift.copyList = copyList;