Use Symbol.toStringTag to make Object.prototype.toString work

Closes #1809; closes #1136. Most of the changes are due to jsdom/webidl2js@0590e5a, but the non-webidl2js classes needed to be updated manually.
jsdom · Apr 29, 2017 · 9d0c03e · 9d0c03e
1 parent 4591c3c
commit 9d0c03e
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 15 deletions.
diff --git a/lib/jsdom/browser/Window.js b/lib/jsdom/browser/Window.js
@@ -503,6 +503,7 @@ function Window(options) {
 
 Object.setPrototypeOf(Window, EventTarget.interface);
 Object.setPrototypeOf(Window.prototype, EventTarget.interface.prototype);
+Window.prototype[Symbol.toStringTag] = "Window";
 
 function matchesDontThrow(el, selector) {
   try {

diff --git a/lib/jsdom/living/dom-token-list.js b/lib/jsdom/living/dom-token-list.js
@@ -111,6 +111,8 @@ class DOMTokenList {
   }
 }
 
+DOMTokenList.prototype[Symbol.toStringTag] = "DOMTokenList";
+
 function serialize(list) {
   const value = list[INTERNAL].element.getAttribute(list[INTERNAL].attribute);
   return value === null ? "" : value;

diff --git a/lib/jsdom/living/html-collection.js b/lib/jsdom/living/html-collection.js
@@ -42,6 +42,7 @@ class HTMLCollection {
 }
 
 HTMLCollection.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
+HTMLCollection.prototype[Symbol.toStringTag] = "HTMLCollection";
 
 function updateHTMLCollection(collection) {
   if (collection[privates].version < collection[privates].element._version) {

diff --git a/lib/jsdom/living/node-iterator.js b/lib/jsdom/living/node-iterator.js
@@ -226,7 +226,5 @@ module.exports = function (core) {
     // noop
   };
 
-  core.NodeIterator.prototype.toString = function () {
-    return "[object NodeIterator]";
-  };
+  core.NodeIterator.prototype[Symbol.toStringTag] = "NodeIterator";
 };
diff --git a/lib/jsdom/living/node-list.js b/lib/jsdom/living/node-list.js
@@ -71,6 +71,7 @@ class NodeList {
 }
 
 NodeList.prototype[Symbol.iterator] = NodeList.prototype.values = Array.prototype[Symbol.iterator];
+NodeList.prototype[Symbol.toStringTag] = "NodeList";
 
 function updateNodeList(nodeList) {
   if (nodeList[privates].isLive) {

diff --git a/lib/jsdom/living/xmlhttprequest-event-target.js b/lib/jsdom/living/xmlhttprequest-event-target.js
@@ -3,7 +3,7 @@
 const EventTarget = require("./generated/EventTarget");
 
 function XMLHttpRequestEventTarget() {
-  if (!(this instanceof XMLHttpRequestEventTarget)) {
+  if (!new.target) {
     throw new TypeError("DOM object constructor cannot be called as a function.");
   }
   EventTarget.setup(this);
@@ -17,6 +17,7 @@ function XMLHttpRequestEventTarget() {
 }
 
 XMLHttpRequestEventTarget.prototype = Object.create(EventTarget.interface.prototype);
+XMLHttpRequestEventTarget.prototype[Symbol.toStringTag] = "XMLHttpRequestEventTarget";
 
 module.exports = function (core) {
   core.XMLHttpRequestEventTarget = XMLHttpRequestEventTarget;

diff --git a/lib/jsdom/living/xmlhttprequest-upload.js b/lib/jsdom/living/xmlhttprequest-upload.js
@@ -6,11 +6,12 @@ module.exports = function (core) {
   class XMLHttpRequestUpload extends XMLHttpRequestEventTarget {
     constructor() {
       super();
-      if (!(this instanceof XMLHttpRequestUpload)) {
+      if (!new.target) {
         throw new TypeError("DOM object constructor cannot be called as a function.");
       }
     }
   }
+  XMLHttpRequestUpload.prototype[Symbol.toStringTag] = "XMLHttpRequestUpload";
 
   core.XMLHttpRequestUpload = XMLHttpRequestUpload;
 };

diff --git a/lib/jsdom/living/xmlhttprequest.js b/lib/jsdom/living/xmlhttprequest.js
@@ -801,15 +801,13 @@ module.exports = function createXMLHttpRequest(window) {
       flag.requestHeaders[lcHeader] = value;
     }
 
-    toString() {
-      return "[object XMLHttpRequest]";
-    }
-
     get _ownerDocument() {
       return idlUtils.implForWrapper(window.document);
     }
   }
 
+  XMLHttpRequest.prototype[Symbol.toStringTag] = "XMLHttpRequest";
+
   addConstants(XMLHttpRequest, {
     UNSENT: 0,
     OPENED: 1,

diff --git a/package.json b/package.json
@@ -65,7 +65,7 @@
     "st": "^1.2.0",
     "watchify": "^3.9.0",
     "wd": "^1.1.3",
-    "webidl2js": "^5.1.1"
+    "webidl2js": "^6.0.3"
   },
   "browser": {
     "canvas": false,

diff --git a/test/to-port-to-wpts/misc2.js b/test/to-port-to-wpts/misc2.js
@@ -812,11 +812,6 @@ describe("jsdom/miscellaneous", () => {
     assert.ok(iframeDocument.body);
   });
 
-  specify("issue_935_document_tostring_returns_null", () => {
-    const document = jsdom.jsdom();
-    assert.equal(document.toString(), "[object HTMLDocument]");
-  });
-
   specify("addmetatohead", () => {
     const window = jsdom.jsdom().defaultView;
     const meta = window.document.createElement("meta");