Merge pull request msgpack#24 from msgpack/workaround_for_ie_dataview

gfx · web-flow · commit 64741fd8c6f2 · 2019-05-12T23:05:25.000+09:00
workround IE11 issues
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,7 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 90%
+        threshold: 1%
+    patch: off
diff --git a/karma.conf.ts b/karma.conf.ts
@@ -6,6 +6,15 @@ export default function configure(config: any) {
   config.set({
     customLaunchers: {
       ...sauceLaunchers,
+
+      // To debug it wih IE11,
+      // Install `karma-virtualbox-ie11-launcher`,
+      // and configure custom launchers like this:
+      // IE11: {
+      //   base: "VirtualBoxIE11",
+      //   keepAlive: true,
+      //   vmName: "IE11 - Win10",
+      // },
     },
     sauceLabs,
     browsers: ["ChromeHeadless", "FirefoxHeadless"],
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,11 +46,11 @@
     "@types/node": "^11.13.10",
     "@typescript-eslint/eslint-plugin": "^1.8.0",
     "@typescript-eslint/parser": "^1.8.0",
-    "assert": "github:browserify/commonjs-assert#sync-with-node-master",
+    "assert": "^2.0.0",
     "core-js": "^3.0.1",
     "eslint": "^5.16.0",
     "eslint-config-prettier": "^4.2.0",
-    "eslint-plugin-prettier": "^3.0.1",
+    "eslint-plugin-prettier": "^3.1.0",
     "ieee754": "^1.1.13",
     "karma": "^4.1.0",
     "karma-chrome-launcher": "^2.2.0",
diff --git a/src/Decoder.ts b/src/Decoder.ts
@@ -29,7 +29,21 @@ type StackState = StackArrayState | StackMapState;
 const HEAD_BYTE_REQUIRED = -1;
 
 const EMPTY_VIEW = new DataView(new ArrayBuffer(0));
-const MORE_DATA = new RangeError("Insufficient data");
+
+// IE11: Hack to support IE11.
+// IE11: Drop this hack and just use RangeError when IE11 is obsolete.
+export const DataViewIndexOutOfBoundsError: typeof Error = (() => {
+  try {
+    // IE11: The spec says it should throw RangeError,
+    // IE11: but in IE11 it throws TypeError.
+    EMPTY_VIEW.getInt8(0);
+  } catch (e) {
+    return e.constructor;
+  }
+  throw new Error("never reached");
+})();
+
+const MORE_DATA = new DataViewIndexOutOfBoundsError("Insufficient data");
 
 export class Decoder {
   totalPos = 0;
@@ -92,7 +106,7 @@ export class Decoder {
         object = this.decodeSync();
         decoded = true;
       } catch (e) {
-        if (!(e instanceof RangeError)) {
+        if (!(e instanceof DataViewIndexOutOfBoundsError)) {
           throw e; // rethrow
         }
         // fallthrough
diff --git a/test/edge-cases.test.ts b/test/edge-cases.test.ts
@@ -1,5 +1,6 @@
 import assert from "assert";
 import { encode, decode, decodeAsync } from "../src";
+import { DataViewIndexOutOfBoundsError } from "../src/Decoder";
 
 describe("edge cases", () => {
   context("try to encode trycyclic refs", () => {
@@ -15,7 +16,7 @@ describe("edge cases", () => {
   context("try to encode non-encodable objects", () => {
     it("throws errors", () => {
       assert.throws(() => {
-        encode(Symbol("this is a symbol!"));
+        encode(() => {});
       }, /unrecognized object/i);
     });
   });
@@ -51,7 +52,8 @@ describe("edge cases", () => {
           0x92, // fixarray size=2
           0xc0, // nil
         ]);
-      }, RangeError);
+        // [IE11] A raw error thrown by DataView
+      }, DataViewIndexOutOfBoundsError);
     });
 
     it("throws errors (asynchronous)", async () => {
diff --git a/test/karma-run.ts b/test/karma-run.ts
@@ -1,3 +1,7 @@
+// import "util" first,
+// because core-js breaks the util polyfll (https://github.com/browserify/node-util) on IE11.
+import "util";
+
 import "core-js";
 
 const testsContext = (require as any).context(".", true, /\.test\.ts$/);
