reader_test.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. /**
  31. * @fileoverview Test cases for jspb's binary protocol buffer reader.
  32. *
  33. * There are two particular magic numbers that need to be pointed out -
  34. * 2^64-1025 is the largest number representable as both a double and an
  35. * unsigned 64-bit integer, and 2^63-513 is the largest number representable as
  36. * both a double and a signed 64-bit integer.
  37. *
  38. * Test suite is written using Jasmine -- see http://jasmine.github.io/
  39. *
  40. * @author aappleby@google.com (Austin Appleby)
  41. */
  42. goog.require('goog.testing.asserts');
  43. goog.require('jspb.BinaryConstants');
  44. goog.require('jspb.BinaryDecoder');
  45. goog.require('jspb.BinaryReader');
  46. goog.require('jspb.BinaryWriter');
  47. describe('binaryReaderTest', function() {
  48. /**
  49. * Tests the reader instance cache.
  50. * @suppress {visibility}
  51. */
  52. it('testInstanceCaches', function() {
  53. var writer = new jspb.BinaryWriter();
  54. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  55. writer.writeMessage(1, dummyMessage, goog.nullFunction);
  56. writer.writeMessage(2, dummyMessage, goog.nullFunction);
  57. var buffer = writer.getResultBuffer();
  58. // Empty the instance caches.
  59. jspb.BinaryReader.instanceCache_ = [];
  60. // Allocating and then freeing three decoders should leave us with three in
  61. // the cache.
  62. var decoder1 = jspb.BinaryDecoder.alloc();
  63. var decoder2 = jspb.BinaryDecoder.alloc();
  64. var decoder3 = jspb.BinaryDecoder.alloc();
  65. decoder1.free();
  66. decoder2.free();
  67. decoder3.free();
  68. assertEquals(3, jspb.BinaryDecoder.instanceCache_.length);
  69. assertEquals(0, jspb.BinaryReader.instanceCache_.length);
  70. // Allocating and then freeing a reader should remove one decoder from its
  71. // cache, but it should stay stuck to the reader afterwards since we can't
  72. // have a reader without a decoder.
  73. jspb.BinaryReader.alloc().free();
  74. assertEquals(2, jspb.BinaryDecoder.instanceCache_.length);
  75. assertEquals(1, jspb.BinaryReader.instanceCache_.length);
  76. // Allocating a reader should remove a reader from the cache.
  77. var reader = jspb.BinaryReader.alloc(buffer);
  78. assertEquals(2, jspb.BinaryDecoder.instanceCache_.length);
  79. assertEquals(0, jspb.BinaryReader.instanceCache_.length);
  80. // Processing the message reuses the current reader.
  81. reader.nextField();
  82. assertEquals(1, reader.getFieldNumber());
  83. reader.readMessage(dummyMessage, function() {
  84. assertEquals(0, jspb.BinaryReader.instanceCache_.length);
  85. });
  86. reader.nextField();
  87. assertEquals(2, reader.getFieldNumber());
  88. reader.readMessage(dummyMessage, function() {
  89. assertEquals(0, jspb.BinaryReader.instanceCache_.length);
  90. });
  91. assertEquals(false, reader.nextField());
  92. assertEquals(2, jspb.BinaryDecoder.instanceCache_.length);
  93. assertEquals(0, jspb.BinaryReader.instanceCache_.length);
  94. // Freeing the reader should put it back into the cache.
  95. reader.free();
  96. assertEquals(2, jspb.BinaryDecoder.instanceCache_.length);
  97. assertEquals(1, jspb.BinaryReader.instanceCache_.length);
  98. });
  99. /**
  100. * @param {number} x
  101. * @return {number}
  102. */
  103. function truncate(x) {
  104. var temp = new Float32Array(1);
  105. temp[0] = x;
  106. return temp[0];
  107. }
  108. /**
  109. * Verifies that misuse of the reader class triggers assertions.
  110. * @suppress {checkTypes|visibility}
  111. */
  112. it('testReadErrors', function() {
  113. // Calling readMessage on a non-delimited field should trigger an
  114. // assertion.
  115. var reader = jspb.BinaryReader.alloc([8, 1]);
  116. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  117. reader.nextField();
  118. assertThrows(function() {
  119. reader.readMessage(dummyMessage, goog.nullFunction);
  120. });
  121. // Reading past the end of the stream should trigger an assertion.
  122. reader = jspb.BinaryReader.alloc([9, 1]);
  123. reader.nextField();
  124. assertThrows(function() {reader.readFixed64()});
  125. // Reading past the end of a submessage should trigger an assertion.
  126. reader = jspb.BinaryReader.alloc([10, 4, 13, 1, 1, 1]);
  127. reader.nextField();
  128. reader.readMessage(dummyMessage, function() {
  129. reader.nextField();
  130. assertThrows(function() {reader.readFixed32()});
  131. });
  132. // Skipping an invalid field should trigger an assertion.
  133. reader = jspb.BinaryReader.alloc([12, 1]);
  134. reader.nextWireType_ = 1000;
  135. assertThrows(function() {reader.skipField()});
  136. // Reading fields with the wrong wire type should assert.
  137. reader = jspb.BinaryReader.alloc([9, 0, 0, 0, 0, 0, 0, 0, 0]);
  138. reader.nextField();
  139. assertThrows(function() {reader.readInt32()});
  140. assertThrows(function() {reader.readInt32String()});
  141. assertThrows(function() {reader.readInt64()});
  142. assertThrows(function() {reader.readInt64String()});
  143. assertThrows(function() {reader.readUint32()});
  144. assertThrows(function() {reader.readUint32String()});
  145. assertThrows(function() {reader.readUint64()});
  146. assertThrows(function() {reader.readUint64String()});
  147. assertThrows(function() {reader.readSint32()});
  148. assertThrows(function() {reader.readBool()});
  149. assertThrows(function() {reader.readEnum()});
  150. reader = jspb.BinaryReader.alloc([8, 1]);
  151. reader.nextField();
  152. assertThrows(function() {reader.readFixed32()});
  153. assertThrows(function() {reader.readFixed64()});
  154. assertThrows(function() {reader.readSfixed32()});
  155. assertThrows(function() {reader.readSfixed64()});
  156. assertThrows(function() {reader.readFloat()});
  157. assertThrows(function() {reader.readDouble()});
  158. assertThrows(function() {reader.readString()});
  159. assertThrows(function() {reader.readBytes()});
  160. });
  161. /**
  162. * Tests encoding and decoding of unsigned field types.
  163. * @param {Function} readField
  164. * @param {Function} writeField
  165. * @param {number} epsilon
  166. * @param {number} upperLimit
  167. * @param {Function} filter
  168. * @private
  169. * @suppress {missingProperties}
  170. */
  171. function doTestUnsignedField_(readField,
  172. writeField, epsilon, upperLimit, filter) {
  173. assertNotNull(readField);
  174. assertNotNull(writeField);
  175. var writer = new jspb.BinaryWriter();
  176. // Encode zero and limits.
  177. writeField.call(writer, 1, filter(0));
  178. writeField.call(writer, 2, filter(epsilon));
  179. writeField.call(writer, 3, filter(upperLimit));
  180. // Encode positive values.
  181. for (var cursor = epsilon; cursor < upperLimit; cursor *= 1.1) {
  182. writeField.call(writer, 4, filter(cursor));
  183. }
  184. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  185. // Check zero and limits.
  186. reader.nextField();
  187. assertEquals(1, reader.getFieldNumber());
  188. assertEquals(filter(0), readField.call(reader));
  189. reader.nextField();
  190. assertEquals(2, reader.getFieldNumber());
  191. assertEquals(filter(epsilon), readField.call(reader));
  192. reader.nextField();
  193. assertEquals(3, reader.getFieldNumber());
  194. assertEquals(filter(upperLimit), readField.call(reader));
  195. // Check positive values.
  196. for (var cursor = epsilon; cursor < upperLimit; cursor *= 1.1) {
  197. reader.nextField();
  198. if (4 != reader.getFieldNumber()) throw 'fail!';
  199. if (filter(cursor) != readField.call(reader)) throw 'fail!';
  200. }
  201. };
  202. /**
  203. * Tests encoding and decoding of signed field types.
  204. * @param {Function} readField
  205. * @param {Function} writeField
  206. * @param {number} epsilon
  207. * @param {number} lowerLimit
  208. * @param {number} upperLimit
  209. * @param {Function} filter
  210. * @private
  211. * @suppress {missingProperties}
  212. */
  213. function doTestSignedField_(readField,
  214. writeField, epsilon, lowerLimit, upperLimit, filter) {
  215. var writer = new jspb.BinaryWriter();
  216. // Encode zero and limits.
  217. writeField.call(writer, 1, filter(lowerLimit));
  218. writeField.call(writer, 2, filter(-epsilon));
  219. writeField.call(writer, 3, filter(0));
  220. writeField.call(writer, 4, filter(epsilon));
  221. writeField.call(writer, 5, filter(upperLimit));
  222. var inputValues = [];
  223. // Encode negative values.
  224. for (var cursor = lowerLimit; cursor < -epsilon; cursor /= 1.1) {
  225. var val = filter(cursor);
  226. writeField.call(writer, 6, val);
  227. inputValues.push({
  228. fieldNumber: 6,
  229. value: val
  230. });
  231. }
  232. // Encode positive values.
  233. for (var cursor = epsilon; cursor < upperLimit; cursor *= 1.1) {
  234. var val = filter(cursor);
  235. writeField.call(writer, 7, val);
  236. inputValues.push({
  237. fieldNumber: 7,
  238. value: val
  239. });
  240. }
  241. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  242. // Check zero and limits.
  243. reader.nextField();
  244. assertEquals(1, reader.getFieldNumber());
  245. assertEquals(filter(lowerLimit), readField.call(reader));
  246. reader.nextField();
  247. assertEquals(2, reader.getFieldNumber());
  248. assertEquals(filter(-epsilon), readField.call(reader));
  249. reader.nextField();
  250. assertEquals(3, reader.getFieldNumber());
  251. assertEquals(filter(0), readField.call(reader));
  252. reader.nextField();
  253. assertEquals(4, reader.getFieldNumber());
  254. assertEquals(filter(epsilon), readField.call(reader));
  255. reader.nextField();
  256. assertEquals(5, reader.getFieldNumber());
  257. assertEquals(filter(upperLimit), readField.call(reader));
  258. for (var i = 0; i < inputValues.length; i++) {
  259. var expected = inputValues[i];
  260. reader.nextField();
  261. assertEquals(expected.fieldNumber, reader.getFieldNumber());
  262. assertEquals(expected.value, readField.call(reader));
  263. }
  264. };
  265. /**
  266. * Tests fields that use varint encoding.
  267. */
  268. it('testVarintFields', function() {
  269. assertNotNull(jspb.BinaryReader.prototype.readUint32);
  270. assertNotNull(jspb.BinaryReader.prototype.writeUint32);
  271. assertNotNull(jspb.BinaryReader.prototype.readUint64);
  272. assertNotNull(jspb.BinaryReader.prototype.writeUint64);
  273. assertNotNull(jspb.BinaryReader.prototype.readBool);
  274. assertNotNull(jspb.BinaryReader.prototype.writeBool);
  275. doTestUnsignedField_(
  276. jspb.BinaryReader.prototype.readUint32,
  277. jspb.BinaryWriter.prototype.writeUint32,
  278. 1, Math.pow(2, 32) - 1, Math.round);
  279. doTestUnsignedField_(
  280. jspb.BinaryReader.prototype.readUint64,
  281. jspb.BinaryWriter.prototype.writeUint64,
  282. 1, Math.pow(2, 64) - 1025, Math.round);
  283. doTestSignedField_(
  284. jspb.BinaryReader.prototype.readInt32,
  285. jspb.BinaryWriter.prototype.writeInt32,
  286. 1, -Math.pow(2, 31), Math.pow(2, 31) - 1, Math.round);
  287. doTestSignedField_(
  288. jspb.BinaryReader.prototype.readInt64,
  289. jspb.BinaryWriter.prototype.writeInt64,
  290. 1, -Math.pow(2, 63), Math.pow(2, 63) - 513, Math.round);
  291. doTestSignedField_(
  292. jspb.BinaryReader.prototype.readEnum,
  293. jspb.BinaryWriter.prototype.writeEnum,
  294. 1, -Math.pow(2, 31), Math.pow(2, 31) - 1, Math.round);
  295. doTestUnsignedField_(
  296. jspb.BinaryReader.prototype.readBool,
  297. jspb.BinaryWriter.prototype.writeBool,
  298. 1, 1, function(x) { return !!x; });
  299. });
  300. /**
  301. * Tests 64-bit fields that are handled as strings.
  302. */
  303. it('testStringInt64Fields', function() {
  304. var writer = new jspb.BinaryWriter();
  305. var testSignedData = [
  306. '2730538252207801776',
  307. '-2688470994844604560',
  308. '3398529779486536359',
  309. '3568577411627971000',
  310. '272477188847484900',
  311. '-6649058714086158188',
  312. '-7695254765712060806',
  313. '-4525541438037104029',
  314. '-4993706538836508568',
  315. '4990160321893729138'
  316. ];
  317. var testUnsignedData = [
  318. '7822732630241694882',
  319. '6753602971916687352',
  320. '2399935075244442116',
  321. '8724292567325338867',
  322. '16948784802625696584',
  323. '4136275908516066934',
  324. '3575388346793700364',
  325. '5167142028379259461',
  326. '1557573948689737699',
  327. '17100725280812548567'
  328. ];
  329. for (var i = 0; i < testSignedData.length; i++) {
  330. writer.writeInt64String(2 * i + 1, testSignedData[i]);
  331. writer.writeUint64String(2 * i + 2, testUnsignedData[i]);
  332. }
  333. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  334. for (var i = 0; i < testSignedData.length; i++) {
  335. reader.nextField();
  336. assertEquals(2 * i + 1, reader.getFieldNumber());
  337. assertEquals(testSignedData[i], reader.readInt64String());
  338. reader.nextField();
  339. assertEquals(2 * i + 2, reader.getFieldNumber());
  340. assertEquals(testUnsignedData[i], reader.readUint64String());
  341. }
  342. });
  343. /**
  344. * Tests fields that use zigzag encoding.
  345. */
  346. it('testZigzagFields', function() {
  347. doTestSignedField_(
  348. jspb.BinaryReader.prototype.readSint32,
  349. jspb.BinaryWriter.prototype.writeSint32,
  350. 1, -Math.pow(2, 31), Math.pow(2, 31) - 1, Math.round);
  351. doTestSignedField_(
  352. jspb.BinaryReader.prototype.readSint64,
  353. jspb.BinaryWriter.prototype.writeSint64,
  354. 1, -Math.pow(2, 63), Math.pow(2, 63) - 513, Math.round);
  355. });
  356. /**
  357. * Tests fields that use fixed-length encoding.
  358. */
  359. it('testFixedFields', function() {
  360. doTestUnsignedField_(
  361. jspb.BinaryReader.prototype.readFixed32,
  362. jspb.BinaryWriter.prototype.writeFixed32,
  363. 1, Math.pow(2, 32) - 1, Math.round);
  364. doTestUnsignedField_(
  365. jspb.BinaryReader.prototype.readFixed64,
  366. jspb.BinaryWriter.prototype.writeFixed64,
  367. 1, Math.pow(2, 64) - 1025, Math.round);
  368. doTestSignedField_(
  369. jspb.BinaryReader.prototype.readSfixed32,
  370. jspb.BinaryWriter.prototype.writeSfixed32,
  371. 1, -Math.pow(2, 31), Math.pow(2, 31) - 1, Math.round);
  372. doTestSignedField_(
  373. jspb.BinaryReader.prototype.readSfixed64,
  374. jspb.BinaryWriter.prototype.writeSfixed64,
  375. 1, -Math.pow(2, 63), Math.pow(2, 63) - 513, Math.round);
  376. });
  377. /**
  378. * Tests floating point fields.
  379. */
  380. it('testFloatFields', function() {
  381. doTestSignedField_(
  382. jspb.BinaryReader.prototype.readFloat,
  383. jspb.BinaryWriter.prototype.writeFloat,
  384. jspb.BinaryConstants.FLOAT32_MIN,
  385. -jspb.BinaryConstants.FLOAT32_MAX,
  386. jspb.BinaryConstants.FLOAT32_MAX,
  387. truncate);
  388. doTestSignedField_(
  389. jspb.BinaryReader.prototype.readDouble,
  390. jspb.BinaryWriter.prototype.writeDouble,
  391. jspb.BinaryConstants.FLOAT64_EPS * 10,
  392. -jspb.BinaryConstants.FLOAT64_MIN,
  393. jspb.BinaryConstants.FLOAT64_MIN,
  394. function(x) { return x; });
  395. });
  396. /**
  397. * Tests length-delimited string fields.
  398. */
  399. it('testStringFields', function() {
  400. var s1 = 'The quick brown fox jumps over the lazy dog.';
  401. var s2 = '人人生而自由,在尊嚴和權利上一律平等。';
  402. var writer = new jspb.BinaryWriter();
  403. writer.writeString(1, s1);
  404. writer.writeString(2, s2);
  405. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  406. reader.nextField();
  407. assertEquals(1, reader.getFieldNumber());
  408. assertEquals(s1, reader.readString());
  409. reader.nextField();
  410. assertEquals(2, reader.getFieldNumber());
  411. assertEquals(s2, reader.readString());
  412. });
  413. /**
  414. * Tests length-delimited byte fields.
  415. */
  416. it('testByteFields', function() {
  417. var message = [];
  418. var lowerLimit = 1;
  419. var upperLimit = 256;
  420. var scale = 1.1;
  421. var writer = new jspb.BinaryWriter();
  422. for (var cursor = lowerLimit; cursor < upperLimit; cursor *= 1.1) {
  423. var len = Math.round(cursor);
  424. var bytes = [];
  425. for (var i = 0; i < len; i++) bytes.push(i % 256);
  426. writer.writeBytes(len, bytes);
  427. }
  428. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  429. for (var cursor = lowerLimit; reader.nextField(); cursor *= 1.1) {
  430. var len = Math.round(cursor);
  431. if (len != reader.getFieldNumber()) throw 'fail!';
  432. var bytes = reader.readBytes();
  433. if (len != bytes.length) throw 'fail!';
  434. for (var i = 0; i < bytes.length; i++) {
  435. if (i % 256 != bytes[i]) throw 'fail!';
  436. }
  437. }
  438. });
  439. /**
  440. * Tests nested messages.
  441. */
  442. it('testNesting', function() {
  443. var writer = new jspb.BinaryWriter();
  444. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  445. writer.writeInt32(1, 100);
  446. // Add one message with 3 int fields.
  447. writer.writeMessage(2, dummyMessage, function() {
  448. writer.writeInt32(3, 300);
  449. writer.writeInt32(4, 400);
  450. writer.writeInt32(5, 500);
  451. });
  452. // Add one empty message.
  453. writer.writeMessage(6, dummyMessage, goog.nullFunction);
  454. writer.writeInt32(7, 700);
  455. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  456. // Validate outermost message.
  457. reader.nextField();
  458. assertEquals(1, reader.getFieldNumber());
  459. assertEquals(100, reader.readInt32());
  460. reader.nextField();
  461. assertEquals(2, reader.getFieldNumber());
  462. reader.readMessage(dummyMessage, function() {
  463. // Validate embedded message 1.
  464. reader.nextField();
  465. assertEquals(3, reader.getFieldNumber());
  466. assertEquals(300, reader.readInt32());
  467. reader.nextField();
  468. assertEquals(4, reader.getFieldNumber());
  469. assertEquals(400, reader.readInt32());
  470. reader.nextField();
  471. assertEquals(5, reader.getFieldNumber());
  472. assertEquals(500, reader.readInt32());
  473. assertEquals(false, reader.nextField());
  474. });
  475. reader.nextField();
  476. assertEquals(6, reader.getFieldNumber());
  477. reader.readMessage(dummyMessage, function() {
  478. // Validate embedded message 2.
  479. assertEquals(false, reader.nextField());
  480. });
  481. reader.nextField();
  482. assertEquals(7, reader.getFieldNumber());
  483. assertEquals(700, reader.readInt32());
  484. assertEquals(false, reader.nextField());
  485. });
  486. /**
  487. * Tests skipping fields of each type by interleaving them with sentinel
  488. * values and skipping everything that's not a sentinel.
  489. */
  490. it('testSkipField', function() {
  491. var writer = new jspb.BinaryWriter();
  492. var sentinel = 123456789;
  493. // Write varint fields of different sizes.
  494. writer.writeInt32(1, sentinel);
  495. writer.writeInt32(1, 1);
  496. writer.writeInt32(1, 1000);
  497. writer.writeInt32(1, 1000000);
  498. writer.writeInt32(1, 1000000000);
  499. // Write fixed 64-bit encoded fields.
  500. writer.writeInt32(2, sentinel);
  501. writer.writeDouble(2, 1);
  502. writer.writeFixed64(2, 1);
  503. writer.writeSfixed64(2, 1);
  504. // Write fixed 32-bit encoded fields.
  505. writer.writeInt32(3, sentinel);
  506. writer.writeFloat(3, 1);
  507. writer.writeFixed32(3, 1);
  508. writer.writeSfixed32(3, 1);
  509. // Write delimited fields.
  510. writer.writeInt32(4, sentinel);
  511. writer.writeBytes(4, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
  512. writer.writeString(4, 'The quick brown fox jumps over the lazy dog');
  513. // Write a group with a nested group inside.
  514. writer.writeInt32(5, sentinel);
  515. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  516. writer.writeGroup(5, dummyMessage, function() {
  517. writer.writeInt64(42, 42);
  518. writer.writeGroup(6, dummyMessage, function() {
  519. writer.writeInt64(84, 42);
  520. });
  521. });
  522. // Write final sentinel.
  523. writer.writeInt32(6, sentinel);
  524. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  525. function skip(field, count) {
  526. for (var i = 0; i < count; i++) {
  527. reader.nextField();
  528. if (field != reader.getFieldNumber()) throw 'fail!';
  529. reader.skipField();
  530. }
  531. }
  532. reader.nextField();
  533. assertEquals(1, reader.getFieldNumber());
  534. assertEquals(sentinel, reader.readInt32());
  535. skip(1, 4);
  536. reader.nextField();
  537. assertEquals(2, reader.getFieldNumber());
  538. assertEquals(sentinel, reader.readInt32());
  539. skip(2, 3);
  540. reader.nextField();
  541. assertEquals(3, reader.getFieldNumber());
  542. assertEquals(sentinel, reader.readInt32());
  543. skip(3, 3);
  544. reader.nextField();
  545. assertEquals(4, reader.getFieldNumber());
  546. assertEquals(sentinel, reader.readInt32());
  547. skip(4, 2);
  548. reader.nextField();
  549. assertEquals(5, reader.getFieldNumber());
  550. assertEquals(sentinel, reader.readInt32());
  551. skip(5, 1);
  552. reader.nextField();
  553. assertEquals(6, reader.getFieldNumber());
  554. assertEquals(sentinel, reader.readInt32());
  555. });
  556. /**
  557. * Tests packed fields.
  558. */
  559. it('testPackedFields', function() {
  560. var writer = new jspb.BinaryWriter();
  561. var sentinel = 123456789;
  562. var unsignedData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
  563. var signedData = [-1, 2, -3, 4, -5, 6, -7, 8, -9, 10];
  564. var floatData = [1.1, 2.2, 3.3, 4.4, 5.5, 6.6, 7.7, 8.8, 9.9, 10.10];
  565. var doubleData = [1.1, 2.2, 3.3, 4.4, 5.5, 6.6, 7.7, 8.8, 9.9, 10.10];
  566. var boolData = [true, false, true, true, false, false, true, false];
  567. for (var i = 0; i < floatData.length; i++) {
  568. floatData[i] = truncate(floatData[i]);
  569. }
  570. writer.writeInt32(1, sentinel);
  571. writer.writePackedInt32(2, signedData);
  572. writer.writePackedInt64(2, signedData);
  573. writer.writePackedUint32(2, unsignedData);
  574. writer.writePackedUint64(2, unsignedData);
  575. writer.writePackedSint32(2, signedData);
  576. writer.writePackedSint64(2, signedData);
  577. writer.writePackedFixed32(2, unsignedData);
  578. writer.writePackedFixed64(2, unsignedData);
  579. writer.writePackedSfixed32(2, signedData);
  580. writer.writePackedSfixed64(2, signedData);
  581. writer.writePackedFloat(2, floatData);
  582. writer.writePackedDouble(2, doubleData);
  583. writer.writePackedBool(2, boolData);
  584. writer.writePackedEnum(2, unsignedData);
  585. writer.writeInt32(3, sentinel);
  586. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  587. reader.nextField();
  588. assertEquals(sentinel, reader.readInt32());
  589. reader.nextField();
  590. assertElementsEquals(reader.readPackedInt32(), signedData);
  591. reader.nextField();
  592. assertElementsEquals(reader.readPackedInt64(), signedData);
  593. reader.nextField();
  594. assertElementsEquals(reader.readPackedUint32(), unsignedData);
  595. reader.nextField();
  596. assertElementsEquals(reader.readPackedUint64(), unsignedData);
  597. reader.nextField();
  598. assertElementsEquals(reader.readPackedSint32(), signedData);
  599. reader.nextField();
  600. assertElementsEquals(reader.readPackedSint64(), signedData);
  601. reader.nextField();
  602. assertElementsEquals(reader.readPackedFixed32(), unsignedData);
  603. reader.nextField();
  604. assertElementsEquals(reader.readPackedFixed64(), unsignedData);
  605. reader.nextField();
  606. assertElementsEquals(reader.readPackedSfixed32(), signedData);
  607. reader.nextField();
  608. assertElementsEquals(reader.readPackedSfixed64(), signedData);
  609. reader.nextField();
  610. assertElementsEquals(reader.readPackedFloat(), floatData);
  611. reader.nextField();
  612. assertElementsEquals(reader.readPackedDouble(), doubleData);
  613. reader.nextField();
  614. assertElementsEquals(reader.readPackedBool(), boolData);
  615. reader.nextField();
  616. assertElementsEquals(reader.readPackedEnum(), unsignedData);
  617. reader.nextField();
  618. assertEquals(sentinel, reader.readInt32());
  619. });
  620. /**
  621. * Byte blobs inside nested messages should always have their byte offset set
  622. * relative to the start of the outermost blob, not the start of their parent
  623. * blob.
  624. */
  625. it('testNestedBlobs', function() {
  626. // Create a proto consisting of two nested messages, with the inner one
  627. // containing a blob of bytes.
  628. var fieldTag = (1 << 3) | jspb.BinaryConstants.WireType.DELIMITED;
  629. var blob = [1, 2, 3, 4, 5];
  630. var writer = new jspb.BinaryWriter();
  631. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  632. writer.writeMessage(1, dummyMessage, function() {
  633. writer.writeMessage(1, dummyMessage, function() {
  634. writer.writeBytes(1, blob);
  635. });
  636. });
  637. // Peel off the outer two message layers. Each layer should have two bytes
  638. // of overhead, one for the field tag and one for the length of the inner
  639. // blob.
  640. var decoder1 = new jspb.BinaryDecoder(writer.getResultBuffer());
  641. assertEquals(fieldTag, decoder1.readUnsignedVarint32());
  642. assertEquals(blob.length + 4, decoder1.readUnsignedVarint32());
  643. var decoder2 = new jspb.BinaryDecoder(decoder1.readBytes(blob.length + 4));
  644. assertEquals(fieldTag, decoder2.readUnsignedVarint32());
  645. assertEquals(blob.length + 2, decoder2.readUnsignedVarint32());
  646. assertEquals(fieldTag, decoder2.readUnsignedVarint32());
  647. assertEquals(blob.length, decoder2.readUnsignedVarint32());
  648. var bytes = decoder2.readBytes(blob.length);
  649. assertElementsEquals(bytes, blob);
  650. });
  651. /**
  652. * Tests read callbacks.
  653. */
  654. it('testReadCallbacks', function() {
  655. var writer = new jspb.BinaryWriter();
  656. var dummyMessage = /** @type {!jspb.BinaryMessage} */({});
  657. // Add an int, a submessage, and another int.
  658. writer.writeInt32(1, 100);
  659. writer.writeMessage(2, dummyMessage, function() {
  660. writer.writeInt32(3, 300);
  661. writer.writeInt32(4, 400);
  662. writer.writeInt32(5, 500);
  663. });
  664. writer.writeInt32(7, 700);
  665. // Create the reader and register a custom read callback.
  666. var reader = jspb.BinaryReader.alloc(writer.getResultBuffer());
  667. /**
  668. * @param {!jspb.BinaryReader} reader
  669. * @return {*}
  670. */
  671. function readCallback(reader) {
  672. reader.nextField();
  673. assertEquals(3, reader.getFieldNumber());
  674. assertEquals(300, reader.readInt32());
  675. reader.nextField();
  676. assertEquals(4, reader.getFieldNumber());
  677. assertEquals(400, reader.readInt32());
  678. reader.nextField();
  679. assertEquals(5, reader.getFieldNumber());
  680. assertEquals(500, reader.readInt32());
  681. assertEquals(false, reader.nextField());
  682. };
  683. reader.registerReadCallback('readCallback', readCallback);
  684. // Read the container message.
  685. reader.nextField();
  686. assertEquals(1, reader.getFieldNumber());
  687. assertEquals(100, reader.readInt32());
  688. reader.nextField();
  689. assertEquals(2, reader.getFieldNumber());
  690. reader.readMessage(dummyMessage, function() {
  691. // Decode the embedded message using the registered callback.
  692. reader.runReadCallback('readCallback');
  693. });
  694. reader.nextField();
  695. assertEquals(7, reader.getFieldNumber());
  696. assertEquals(700, reader.readInt32());
  697. assertEquals(false, reader.nextField());
  698. });
  699. });