You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by ns...@apache.org on 2015/11/15 06:02:31 UTC
[4/5] thrift git commit: THRIFT-3200 JS and nodejs do not encode JSON
protocol binary fields as base64 Client: Javascript Patch: Nobuaki Sukegawa
THRIFT-3200 JS and nodejs do not encode JSON protocol binary fields as base64
Client: Javascript
Patch: Nobuaki Sukegawa
This closes #698
Project: http://git-wip-us.apache.org/repos/asf/thrift/repo
Commit: http://git-wip-us.apache.org/repos/asf/thrift/commit/6defea5f
Tree: http://git-wip-us.apache.org/repos/asf/thrift/tree/6defea5f
Diff: http://git-wip-us.apache.org/repos/asf/thrift/diff/6defea5f
Branch: refs/heads/master
Commit: 6defea5f7b22ed539ad136ddd3ca09fc8352fffd
Parents: bc7e480
Author: Nobuaki Sukegawa <ns...@apache.org>
Authored: Sat Nov 14 17:36:29 2015 +0900
Committer: Nobuaki Sukegawa <ns...@apache.org>
Committed: Sun Nov 15 14:00:18 2015 +0900
----------------------------------------------------------------------
lib/js/Gruntfile.js | 6 +-
lib/js/src/thrift.js | 19 +-
lib/js/test/phantom-client.js | 382 +++++++++++++++++++++++++++++++++++++
lib/js/test/test.js | 20 +-
test/tests.json | 19 ++
5 files changed, 439 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/thrift/blob/6defea5f/lib/js/Gruntfile.js
----------------------------------------------------------------------
diff --git a/lib/js/Gruntfile.js b/lib/js/Gruntfile.js
index 32c8834..ae3783b 100644
--- a/lib/js/Gruntfile.js
+++ b/lib/js/Gruntfile.js
@@ -41,7 +41,7 @@ module.exports = function(grunt) {
command: 'mkdir test/build; mkdir test/build/js; cp src/thrift.js test/build/js/thrift.js'
},
InstallThriftNodeJSDep: {
- command: 'cd ../nodejs; npm install'
+ command: 'cd ../..; npm install'
},
ThriftGen: {
command: 'thrift -gen js -gen js:node -o test ../../test/ThriftTest.thrift'
@@ -61,7 +61,7 @@ module.exports = function(grunt) {
},
nodeSpawnOptions: {
cwd: "test",
- env: {NODE_PATH: "../../nodejs/lib:../../nodejs/node_modules"}
+ env: {NODE_PATH: "../../nodejs/lib:../../../node_modules"}
}
},
cmd: "node",
@@ -74,7 +74,7 @@ module.exports = function(grunt) {
},
nodeSpawnOptions: {
cwd: "test",
- env: {NODE_PATH: "../../nodejs/lib:../../nodejs/node_modules"}
+ env: {NODE_PATH: "../../nodejs/lib:../../../node_modules"}
}
},
cmd: "node",
http://git-wip-us.apache.org/repos/asf/thrift/blob/6defea5f/lib/js/src/thrift.js
----------------------------------------------------------------------
diff --git a/lib/js/src/thrift.js b/lib/js/src/thrift.js
index 9bd1198..664171e 100644
--- a/lib/js/src/thrift.js
+++ b/lib/js/src/thrift.js
@@ -1006,8 +1006,19 @@ Thrift.Protocol.prototype = {
},
/** Serializes a string */
- writeBinary: function(str) {
- this.writeString(str);
+ 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) + '"');
},
/**
@@ -1309,7 +1320,9 @@ Thrift.Protocol.prototype = {
/** 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;
},
/**
http://git-wip-us.apache.org/repos/asf/thrift/blob/6defea5f/lib/js/test/phantom-client.js
----------------------------------------------------------------------
diff --git a/lib/js/test/phantom-client.js b/lib/js/test/phantom-client.js
new file mode 100644
index 0000000..f75b256
--- /dev/null
+++ b/lib/js/test/phantom-client.js
@@ -0,0 +1,382 @@
+/*
+ * 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
+ *
+ * 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.
+ */
+ /* jshint -W100 */
+
+(function() {
+ 'use strict';
+
+ // Rudimentary test helper functions
+ // TODO: Return error code based on kind of errors rather than throw
+ var ok = function(t, msg) {
+ if (!t) {
+ console.log('*** FAILED ***');
+ throw new Error(msg);
+ }
+ };
+ var equal = function(a, b) {
+ if (a !== b) {
+ console.log('*** FAILED ***');
+ throw new Error();
+ }
+ };
+ var test = function(name, f) {
+ console.log('TEST : ' + name);
+ f();
+ console.log('OK\n');
+ };
+
+ var parseArgs = function(args) {
+ var skips = [
+ '--transport=http',
+ '--protocol=json',
+ ];
+ var opts = {
+ port: '9090',
+ // protocol: 'json',
+ };
+ var keys = {};
+ for (var key in opts) {
+ keys['--' + key + '='] = key;
+ }
+ for (var i in args) {
+ var arg = args[i];
+ if (skips.indexOf(arg) != -1) {
+ continue;
+ }
+ var hit = false;
+ for (var k in keys) {
+ if (arg.slice(0, k.length) === k) {
+ opts[keys[k]] = arg.slice(k.length);
+ hit = true;
+ break;
+ }
+ }
+ if (!hit) {
+ throw new Error('Unknown argument: ' + arg);
+ }
+ }
+ opts.port = parseInt(opts.port, 10);
+ if (!opts.port || opts.port < 1 || opts.port > 65535) {
+ throw new Error('Invalid port number');
+ }
+ return opts;
+ };
+
+ var execute = function() {
+ console.log('### Apache Thrift Javascript standalone test client');
+ console.log('------------------------------------------------------------');
+
+ phantom.page.injectJs('src/thrift.js');
+ phantom.page.injectJs('test/gen-js/ThriftTest_types.js');
+ phantom.page.injectJs('test/gen-js/ThriftTest.js');
+
+ var system = require('system');
+ var opts = parseArgs(system.args.slice(1));
+ var port = opts.port;
+ var transport = new Thrift.Transport('http://localhost:' + port + '/service');
+ var protocol = new Thrift.Protocol(transport);
+ var client = new ThriftTest.ThriftTestClient(protocol);
+
+
+ // TODO: Remove duplicate code with test.js.
+ // all Languages in UTF-8
+ var stringTest = "Afrikaans, Alemannisch, Aragonés, العربية, مصرى, Asturianu, Aymar aru, Azərbaycan, Башҡорт, Boarisch, Žemaitėška, Беларуская, Беларуская (тарашкевіца), Български, Bamanankan, বাংলা, Brezhoneg, Bosanski, Català, Mìng-dĕ̤ng-ngṳ̄, Нохчийн, Cebuano, ᏣᎳᎩ, Česky, Словѣ́ньскъ / ⰔⰎⰑⰂⰡⰐⰠⰔⰍⰟ, Чӑвашла, Cymraeg, Dansk, Zazaki, ދިވެހިބަސް, Ελληνικά, Emiliàn e rumagnòl, English, Esperanto, Español, Eesti, Euskara, فارسی, Suomi, Võro, Føroyskt, Français, Arpetan, Furlan, Frysk, Gaeilge, 贛語, Gàidhlig, Galego, Avañe'ẽ, ગુજરાતી, Gaelg, עברית, हिन्दी, Fiji Hindi, Hrvatski, Kreyòl ayisyen, Magyar, Հայերեն, Interlingua, Bahasa Indonesia, Ilokano, Ido, Íslenska, Italiano, 日本語, Lojban, Basa Jawa, ქართული, Kongo, Kalaallisut, ಕನ್ನಡ, 한국어, Къа
рачай-Малкъар, Ripoarisch, Kurdî, Коми, Kernewek, Кыргызча, Latina, Ladino, Lëtzebuergesch, Limburgs, Lingála, ລາວ, Lietuvių, Latviešu, Basa Banyumasan, Malagasy, Македонски, മലയാളം, मराठी, Bahasa Melayu, مازِرونی, Nnapulitano, Nedersaksisch, नेपाल भाषा, Nederlands, Norsk (nynorsk), Norsk (bokmål), Nouormand, Diné bizaad, Occitan, Иронау, Papiamentu, Deitsch, Norfuk / Pitkern, Polski, پنجابی, پښتو, Português, Runa Simi, Rumantsch, Romani, Română, Русский, Саха тыла, Sardu, Sicilianu, Scots, Sámegiella, Simple English, Slovenčina, Slovenščina, Српски / Srpski, Seeltersk, Svenska, Kiswahili, தமிழ், తెలుగు, Тоҷикӣ, ไทย, Türkmençe, Tagalog, Türkçe, Татарча/Tatarça, Українська, اردو, Tiếng Việt, Volapük, Walon, Winaray, 吴语, isiXhosa, ייִדיש, Yorùbá, Zeêuws, 中�
�, Bân-lâm-gú, 粵語";
+
+ function checkRecursively(map1, map2) {
+ if (typeof map1 !== 'function' && typeof map2 !== 'function') {
+ if (!map1 || typeof map1 !== 'object') {
+ equal(map1, map2);
+ } else {
+ for (var key in map1) {
+ checkRecursively(map1[key], map2[key]);
+ }
+ }
+ }
+ }
+
+ test("Void", function() {
+ equal(client.testVoid(), undefined);
+ });
+ test("Binary (String)", function() {
+ var binary = '';
+ for (var v = 255; v >= 0; --v) {
+ binary += String.fromCharCode(v);
+ }
+ equal(client.testBinary(binary), binary);
+ });
+ test("Binary (Uint8Array)", function() {
+ var binary = '';
+ for (var v = 255; v >= 0; --v) {
+ binary += String.fromCharCode(v);
+ }
+ var arr = new Uint8Array(binary.length);
+ for (var i = 0; i < binary.length; ++i) {
+ arr[i] = binary[i].charCodeAt();
+ }
+ equal(client.testBinary(arr), binary);
+ });
+ test("String", function() {
+ equal(client.testString(''), '');
+ equal(client.testString(stringTest), stringTest);
+
+ var specialCharacters = 'quote: \" backslash:' +
+ ' forwardslash-escaped: \/ ' +
+ ' backspace: \b formfeed: \f newline: \n return: \r tab: ' +
+ ' now-all-of-them-together: "\\\/\b\n\r\t' +
+ ' now-a-bunch-of-junk: !@#$%&()(&%$#{}{}<><><';
+ equal(client.testString(specialCharacters),specialCharacters);
+ });
+ test("Double", function() {
+ equal(client.testDouble(0), 0);
+ equal(client.testDouble(-1), -1);
+ equal(client.testDouble(3.14), 3.14);
+ equal(client.testDouble(Math.pow(2,60)), Math.pow(2,60));
+ });
+ test("Bool", function() {
+ equal(client.testBool(true), true);
+ equal(client.testBool(false), false);
+ });
+ test("I8", function() {
+ equal(client.testByte(0), 0);
+ equal(client.testByte(0x01), 0x01);
+ });
+ test("I32", function() {
+ equal(client.testI32(0), 0);
+ equal(client.testI32(Math.pow(2,30)), Math.pow(2,30));
+ equal(client.testI32(-Math.pow(2,30)), -Math.pow(2,30));
+ });
+ test("I64", function() {
+ equal(client.testI64(0), 0);
+ //This is usually 2^60 but JS cannot represent anything over 2^52 accurately
+ equal(client.testI64(Math.pow(2,52)), Math.pow(2,52));
+ equal(client.testI64(-Math.pow(2,52)), -Math.pow(2,52));
+ });
+
+ test("Struct", function() {
+ var structTestInput = new ThriftTest.Xtruct();
+ structTestInput.string_thing = 'worked';
+ structTestInput.byte_thing = 0x01;
+ structTestInput.i32_thing = Math.pow(2,30);
+ //This is usually 2^60 but JS cannot represent anything over 2^52 accurately
+ structTestInput.i64_thing = Math.pow(2,52);
+
+ var structTestOutput = client.testStruct(structTestInput);
+
+ equal(structTestOutput.string_thing, structTestInput.string_thing);
+ equal(structTestOutput.byte_thing, structTestInput.byte_thing);
+ equal(structTestOutput.i32_thing, structTestInput.i32_thing);
+ equal(structTestOutput.i64_thing, structTestInput.i64_thing);
+
+ equal(JSON.stringify(structTestOutput), JSON.stringify(structTestInput));
+ });
+
+ test("Nest", function() {
+ var xtrTestInput = new ThriftTest.Xtruct();
+ xtrTestInput.string_thing = 'worked';
+ xtrTestInput.byte_thing = 0x01;
+ xtrTestInput.i32_thing = Math.pow(2,30);
+ //This is usually 2^60 but JS cannot represent anything over 2^52 accurately
+ xtrTestInput.i64_thing = Math.pow(2,52);
+
+ var nestTestInput = new ThriftTest.Xtruct2();
+ nestTestInput.byte_thing = 0x02;
+ nestTestInput.struct_thing = xtrTestInput;
+ nestTestInput.i32_thing = Math.pow(2,15);
+
+ var nestTestOutput = client.testNest(nestTestInput);
+
+ equal(nestTestOutput.byte_thing, nestTestInput.byte_thing);
+ equal(nestTestOutput.struct_thing.string_thing, nestTestInput.struct_thing.string_thing);
+ equal(nestTestOutput.struct_thing.byte_thing, nestTestInput.struct_thing.byte_thing);
+ equal(nestTestOutput.struct_thing.i32_thing, nestTestInput.struct_thing.i32_thing);
+ equal(nestTestOutput.struct_thing.i64_thing, nestTestInput.struct_thing.i64_thing);
+ equal(nestTestOutput.i32_thing, nestTestInput.i32_thing);
+
+ equal(JSON.stringify(nestTestOutput), JSON.stringify(nestTestInput));
+ });
+
+ test("Map", function() {
+ var mapTestInput = {7:77, 8:88, 9:99};
+
+ var mapTestOutput = client.testMap(mapTestInput);
+
+ for (var key in mapTestOutput) {
+ equal(mapTestOutput[key], mapTestInput[key]);
+ }
+ });
+
+ test("StringMap", function() {
+ var mapTestInput = {
+ "a":"123", "a b":"with spaces ", "same":"same", "0":"numeric key",
+ "longValue":stringTest, stringTest:"long key"
+ };
+
+ var mapTestOutput = client.testStringMap(mapTestInput);
+
+ for (var key in mapTestOutput) {
+ equal(mapTestOutput[key], mapTestInput[key]);
+ }
+ });
+
+ test("Set", function() {
+ var setTestInput = [1,2,3];
+ ok(client.testSet(setTestInput), setTestInput);
+ });
+
+ test("List", function() {
+ var listTestInput = [1,2,3];
+ ok(client.testList(listTestInput), listTestInput);
+ });
+
+ test("Enum", function() {
+ equal(client.testEnum(ThriftTest.Numberz.ONE), ThriftTest.Numberz.ONE);
+ });
+
+ test("TypeDef", function() {
+ equal(client.testTypedef(69), 69);
+ });
+
+ test("Skip", function() {
+ var structTestInput = new ThriftTest.Xtruct();
+ var modifiedClient = new ThriftTest.ThriftTestClient(protocol);
+
+ modifiedClient.recv_testStruct = function() {
+ var input = modifiedClient.input;
+ var xtruct3 = new ThriftTest.Xtruct3();
+
+ input.readMessageBegin();
+ input.readStructBegin();
+
+ // read Xtruct data with Xtruct3
+ input.readFieldBegin();
+ xtruct3.read(input);
+ input.readFieldEnd();
+ // read Thrift.Type.STOP message
+ input.readFieldBegin();
+ input.readFieldEnd();
+
+ input.readStructEnd();
+ input.readMessageEnd();
+
+ return xtruct3;
+ };
+
+ structTestInput.string_thing = 'worked';
+ structTestInput.byte_thing = 0x01;
+ structTestInput.i32_thing = Math.pow(2,30);
+ structTestInput.i64_thing = Math.pow(2,52);
+
+ var structTestOutput = modifiedClient.testStruct(structTestInput);
+
+ equal(structTestOutput instanceof ThriftTest.Xtruct3, true);
+ equal(structTestOutput.string_thing, structTestInput.string_thing);
+ equal(structTestOutput.changed, null);
+ equal(structTestOutput.i32_thing, structTestInput.i32_thing);
+ equal(structTestOutput.i64_thing, structTestInput.i64_thing);
+ });
+
+ test("MapMap", function() {
+ var mapMapTestExpectedResult = {
+ "4":{"1":1,"2":2,"3":3,"4":4},
+ "-4":{"-4":-4, "-3":-3, "-2":-2, "-1":-1}
+ };
+
+ var mapMapTestOutput = client.testMapMap(1);
+
+
+ for (var key in mapMapTestOutput) {
+ for (var key2 in mapMapTestOutput[key]) {
+ equal(mapMapTestOutput[key][key2], mapMapTestExpectedResult[key][key2]);
+ }
+ }
+
+ checkRecursively(mapMapTestOutput, mapMapTestExpectedResult);
+ });
+
+ test("Xception", function() {
+ try {
+ client.testException("Xception");
+ ok(false);
+ } catch (e) {
+ equal(e.errorCode, 1001);
+ equal(e.message, "Xception");
+ }
+ });
+
+ test("no Exception", function() {
+ try {
+ client.testException("no Exception");
+ } catch (e) {
+ ok(false);
+ }
+ });
+
+ test("TException", function() {
+ try {
+ client.testException("TException");
+ ok(false);
+ } catch(e) {
+ ok(ok);
+ }
+ });
+
+ var crazy = {
+ "userMap":{ "5":5, "8":8 },
+ "xtructs":[{
+ "string_thing":"Goodbye4",
+ "byte_thing":4,
+ "i32_thing":4,
+ "i64_thing":4
+ },
+ {
+ "string_thing":"Hello2",
+ "byte_thing":2,
+ "i32_thing":2,
+ "i64_thing":2
+ }]
+ };
+ test("Insanity", function() {
+ var insanity = {
+ "1":{
+ "2":crazy,
+ "3":crazy
+ },
+ "2":{ "6":{ "userMap":null, "xtructs":null } }
+ };
+ var res = client.testInsanity(new ThriftTest.Insanity(crazy));
+ ok(res, JSON.stringify(res));
+ ok(insanity, JSON.stringify(insanity));
+
+ checkRecursively(res, insanity);
+ });
+
+ console.log('------------------------------------------------------------');
+ console.log('### All tests succeeded.');
+ return 0;
+ };
+
+ try {
+ var ret = execute();
+ phantom.exit(ret);
+ } catch (err) {
+ // Catch all and exit to avoid hang.
+ console.error(err);
+ phantom.exit(1);
+ }
+})();
http://git-wip-us.apache.org/repos/asf/thrift/blob/6defea5f/lib/js/test/test.js
----------------------------------------------------------------------
diff --git a/lib/js/test/test.js b/lib/js/test/test.js
index 0c7d2cb..2d8ec9b 100755
--- a/lib/js/test/test.js
+++ b/lib/js/test/test.js
@@ -58,7 +58,7 @@ if (typeof QUnit.log == 'function') {
if (!details.result) {
console.log('======== FAIL ========');
console.log('TestName: ' + details.name);
- details.message && console.log(details.message);
+ if (details.message) console.log(details.message);
console.log('Expected: ' + details.expected);
console.log('Actual : ' + details.actual);
console.log('======================');
@@ -86,6 +86,24 @@ module("Base Types");
test("Void", function() {
equal(client.testVoid(), undefined);
});
+ test("Binary (String)", function() {
+ var binary = '';
+ for (var v = 255; v >= 0; --v) {
+ binary += String.fromCharCode(v);
+ }
+ equal(client.testBinary(binary), binary);
+ });
+ test("Binary (Uint8Array)", function() {
+ var binary = '';
+ for (var v = 255; v >= 0; --v) {
+ binary += String.fromCharCode(v);
+ }
+ var arr = new Uint8Array(binary.length);
+ for (var i = 0; i < binary.length; ++i) {
+ arr[i] = binary[i].charCodeAt();
+ }
+ equal(client.testBinary(arr), binary);
+ });
test("String", function() {
equal(client.testString(''), '');
equal(client.testString(stringTest), stringTest);
http://git-wip-us.apache.org/repos/asf/thrift/blob/6defea5f/test/tests.json
----------------------------------------------------------------------
diff --git a/test/tests.json b/test/tests.json
index afc7531..2c1aa70 100644
--- a/test/tests.json
+++ b/test/tests.json
@@ -466,5 +466,24 @@
]
},
"workdir": "erl"
+ },
+ {
+ "name": "js",
+ "transports": [
+ "http"
+ ],
+ "sockets": [
+ "ip"
+ ],
+ "protocols": [
+ "json"
+ ],
+ "client": {
+ "command": [
+ "phantomjs",
+ "test/phantom-client.js"
+ ]
+ },
+ "workdir": "../lib/js"
}
]