Merge branch 'master' of github.com:msgpack/msgpack-javascript

Author: sergeyzenchenko

.travis.yml

@@ -1,21 +1,37 @@
 language: node_js
 node_js:
   - lts/*
+addons:
+  firefox: latest
 env:
   matrix:
+    - BROWSER=
+    - BROWSER=FirefoxHeadless
     - BROWSER=slChrome
     - BROWSER=slFirefox
     - BROWSER=slSafari
     - BROWSER=slIE
     - BROWSER=slEdge
     - BROWSER=slIos
     - BROWSER=slAndroid
-    - BROWSER=
   global:
     # SAUCE_USERNAME
     - secure: J+FOPE/vVK6yzVXHVE7xibFV/hV+Ehc78MBADLlE10YIY7Ag6JkVeomgqRFB9I8zFzj5DALkpzOLGx4iIrFs6iYiNnEcl39fkm8myHl8xIuW+KHt5QOsCtM5qmvfSEZhJV+La0lSzFicjY9VX90VLZvJOHIbiCvIFRoxnwYVw6o=
     # SAUCE_ACCESS_KEY
     - secure: ay3CSAjya+UQDi0RulLIl6q25oobwLsjLbdkeASgjBq0qN5dXgFgEpBjecBxFqPGrwzzCj9K9fR81NWV80EjLkGdcfN0oGx0wvsOo2C2ulWGHc1dRgKUnMKAA2TL3br14KMfmGn6fmr+fA7Vq+qWajQpExlG0Kuw68C9iNuKIQw=
+matrix:
+  fast_finish: true
+  allow_failures:
+    # Because Travis CI does not expose credentials to pull-request builds from forked repositories.
+    # https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions
+    - env: BROWSER=slChrome
+    - env: BROWSER=slFirefox
+    - env: BROWSER=slSafari
+    - env: BROWSER=slIE
+    - env: BROWSER=slEdge
+    - env: BROWSER=slIos
+    - env: BROWSER=slAndroid
+
 cache: npm
 install: |
   if [ "${BROWSER}" = "" ]

CHANGELOG.md

@@ -1,5 +1,18 @@
 This is the revision history of @msgpack/msgpack
 
+## v1.2.3 2019/05/29
+
+https://github.com/msgpack/msgpack-javascript/compare/v1.2.2...v1.2.3
+
+* More optimizations for string decoding performance
+
+## v1.2.2 2019/05/29
+
+https://github.com/msgpack/msgpack-javascript/compare/v1.2.1...v1.2.2
+
+* Improved array decoding performance ([#32](https://github.com/msgpack/msgpack-javascript/pull/32) by @sergeyzenchenko)
+* Improved string decoding performance with TextDecoder ([#34](https://github.com/msgpack/msgpack-javascript/pull/34) by @sergeyzenchenko)
+
 ## v1.2.1 2019/05/26
 
 https://github.com/msgpack/msgpack-javascript/compare/v1.2.0...v1.2.1

README.md

@@ -152,6 +152,50 @@ const encoded: = encode(value, { extensionCodec });
 deepStrictEqual(decode(encoded, { extensionCodec }), value);
 ```
 
+#### The temporal module as timestamp extensions
+
+This library maps `Date` to the MessagePack timestamp extension, but you re-map the [temporal module](https://github.com/tc39/proposal-temporal) to the timestamp ext like this:
+
+```typescript
+import { Instant } from "@std-proposal/temporal";
+import { deepStrictEqual } from "assert";
+import {
+  encode,
+  decode,
+  ExtensionCodec,
+  EXT_TIMESTAMP,
+  encodeTimeSpecToTimestamp,
+  decodeTimestampToTimeSpec,
+} from "@msgpack/msgpack";
+
+const extensionCodec = new ExtensionCodec();
+extensionCodec.register({
+  type: EXT_TIMESTAMP, // override the default behavior!
+  encode: (input: any) => {
+    if (input instanceof Instant) {
+      const sec = input.seconds;
+      const nsec = Number(input.nanoseconds - BigInt(sec) * BigInt(1e9));
+      return encodeTimeSpecToTimestamp({ sec, nsec });
+    } else {
+      return null;
+    }
+  },
+  decode: (data: Uint8Array) => {
+    const timeSpec = decodeTimestampToTimeSpec(data);
+    const sec = BigInt(timeSpec.sec);
+    const nsec = BigInt(timeSpec.nsec);
+    return Instant.fromEpochNanoseconds(sec * BigInt(1e9) + nsec);
+  },
+});
+
+const instant = Instant.fromEpochMilliseconds(Date.now());
+const encoded = encode(instant, { extensionCodec });
+const decoded = decode(encoded, { extensionCodec });
+deepStrictEqual(decoded, instant);
+```
+
+This will be default after the temporal module is implemented in major browsers, which is not a near-future, though.
+
 ## MessagePack Mapping Table
 
 The following table shows how JavaScript values are mapped to [MessagePack formats](https://github.com/msgpack/msgpack/blob/master/spec.md) and vice versa.
@@ -193,17 +237,17 @@ NodeJS v10 is required, but NodeJS v12 or later is recommended because it includ
 
 ## Benchmark
 
-Benchmark on NodeJS/v12.1.0
+Benchmark on NodeJS/v12.3.1
 
 operation                                                         |   op   |   ms  |  op/s
 ----------------------------------------------------------------- | ------: | ----: | ------:
-buf = Buffer.from(JSON.stringify(obj));                           |  493600 |  5000 |   98720
-buf = JSON.stringify(obj);                                        |  959600 |  5000 |  191920
-obj = JSON.parse(buf);                                            |  346100 |  5000 |   69220
-buf = require("msgpack-lite").encode(obj);                        |  358300 |  5000 |   71660
-obj = require("msgpack-lite").decode(buf);                        |  270400 |  5000 |   54080
-buf = require("@msgpack/msgpack").encode(obj);                    |  594300 |  5000 |  118860
-obj = require("@msgpack/msgpack").decode(buf);                    |  343100 |  5000 |   68620
+buf = Buffer.from(JSON.stringify(obj));                           |  497600 |  5000 |   99520
+buf = JSON.stringify(obj);                                        |  969500 |  5000 |  193900
+obj = JSON.parse(buf);                                            |  345300 |  5000 |   69060
+buf = require("msgpack-lite").encode(obj);                        |  369100 |  5000 |   73820
+obj = require("msgpack-lite").decode(buf);                        |  278900 |  5000 |   55780
+buf = require("@msgpack/msgpack").encode(obj);                    |  556900 |  5000 |  111380
+obj = require("@msgpack/msgpack").decode(buf);                    |  502200 |  5000 |  100440
 
 Note that `Buffer.from()` for `JSON.stringify()` is added to emulate I/O where a JavaScript string must be converted into a byte array encoded in UTF-8, whereas MessagePack's `encode()` returns a byte array.
 

benchmark/decode-string.ts

@@ -1,50 +1,45 @@
 /* eslint-disable no-console */
-import { utf8Encode, utf8Count, utf8Decode } from "../src/utils/utf8";
+import { utf8Encode, utf8Count, utf8DecodeJs, utf8DecodeTD } from "../src/utils/utf8";
 import { utf8DecodeWasm } from "../src/wasmFunctions";
 
 // @ts-ignore
 import Benchmark from "benchmark";
 
-const textDecoder = new TextDecoder();
-
-const dataSet = [10, 100, 200, 1_000, 10_000, 100_000].map((n) => {
-  return "a".repeat(n);
-});
-
-for (const str of dataSet) {
-  const byteLength = utf8Count(str);
-  const bytes = new Uint8Array(new ArrayBuffer(byteLength));
-  utf8Encode(str, bytes, 0);
-
-  console.log(`\n## string length=${str.length} byteLength=${byteLength}\n`);
-
-  const suite = new Benchmark.Suite();
-
-  const N = Math.round(100_0000 / str.length);
-
-  // use the result to avoid void-context optimizations
-  let count = 0;
-
-  suite.add("utf8Decode", () => {
-    if (utf8Decode(bytes, 0, byteLength) !== str) {
-      throw new Error("wrong result!");
-    }
-  });
-
-  suite.add("utf8DecodeWasm", () => {
-    if (utf8DecodeWasm(bytes, 0, byteLength) !== str) {
-      throw new Error("wrong result!");
-    }
-  });
-
-  suite.add("TextDecoder", () => {
-    if (textDecoder.decode(bytes.subarray(0, byteLength)) !== str) {
-      throw new Error("wrong result!");
-    }
-  });
-  suite.on("cycle", (event: any) => {
-    console.log(String(event.target));
+for (const baseStr of ["A", "あ", "🌏"]) {
+  const dataSet = [10, 100, 200, 1_000, 10_000, 100_000].map((n) => {
+    return baseStr.repeat(n);
   });
 
-  suite.run();
+  for (const str of dataSet) {
+    const byteLength = utf8Count(str);
+    const bytes = new Uint8Array(new ArrayBuffer(byteLength));
+    utf8Encode(str, bytes, 0);
+
+    console.log(`\n## string "${baseStr}" x ${str.length} (byteLength=${byteLength})\n`);
+
+    const suite = new Benchmark.Suite();
+
+    suite.add("utf8DecodeJs", () => {
+      if (utf8DecodeJs(bytes, 0, byteLength) !== str) {
+        throw new Error("wrong result!");
+      }
+    });
+
+    suite.add("utf8DecodeWasm", () => {
+      if (utf8DecodeWasm(bytes, 0, byteLength) !== str) {
+        throw new Error("wrong result!");
+      }
+    });
+
+    suite.add("TextDecoder", () => {
+      if (utf8DecodeTD(bytes, 0, byteLength) !== str) {
+        throw new Error("wrong result!");
+      }
+    });
+    suite.on("cycle", (event: any) => {
+      console.log(String(event.target));
+    });
+
+    suite.run();
+  }
 }