@depup/jsdom 28.1.0-depup.1

package/lib/jsdom/living/helpers/form-controls.js

@@ -0,0 +1,309 @@
+"use strict";
+
+const {
+  isValidFloatingPointNumber,
+  isValidSimpleColor,
+  parseFloatingPointNumber,
+  stripLeadingAndTrailingASCIIWhitespace,
+  stripNewlines,
+  splitOnCommas
+} = require("./strings");
+const {
+  isValidDateString,
+  isValidMonthString,
+  isValidTimeString,
+  isValidWeekString,
+  parseLocalDateAndTimeString,
+  serializeNormalizedDateAndTime
+} = require("./dates-and-times");
+const whatwgURL = require("whatwg-url");
+
+const NodeList = require("../../../generated/idl/NodeList");
+const { domSymbolTree } = require("./internal-constants");
+const { closest, firstChildWithLocalName } = require("./traversal");
+const NODE_TYPE = require("../node-type");
+const { HTML_NS } = require("./namespaces");
+
+// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#concept-fe-disabled
+exports.isDisabled = formControl => {
+  if (formControl.localName === "button" || formControl.localName === "input" || formControl.localName === "select" ||
+      formControl.localName === "textarea") {
+    if (formControl.hasAttributeNS(null, "disabled")) {
+      return true;
+    }
+  }
+
+  let e = formControl.parentNode;
+  while (e) {
+    if (e.localName === "fieldset" && e.hasAttributeNS(null, "disabled")) {
+      const firstLegendElementChild = firstChildWithLocalName(e, "legend");
+      if (!firstLegendElementChild || !firstLegendElementChild.contains(formControl)) {
+        return true;
+      }
+    }
+    e = e.parentNode;
+  }
+
+  return false;
+};
+
+// https://html.spec.whatwg.org/multipage/forms.html#category-listed
+const listedElements = new Set(["button", "fieldset", "input", "object", "output", "select", "textarea"]);
+exports.isListed = formControl => listedElements.has(formControl._localName) && formControl.namespaceURI === HTML_NS;
+
+// https://html.spec.whatwg.org/multipage/forms.html#category-submit
+const submittableElements = new Set(["button", "input", "object", "select", "textarea"]);
+exports.isSubmittable = formControl => {
+  return submittableElements.has(formControl._localName) && formControl.namespaceURI === HTML_NS;
+};
+
+// https://html.spec.whatwg.org/multipage/forms.html#concept-submit-button
+const submitButtonInputTypes = new Set(["submit", "image"]);
+exports.isSubmitButton = formControl => {
+  return ((formControl._localName === "input" && submitButtonInputTypes.has(formControl.type)) ||
+          (formControl._localName === "button" && formControl.type === "submit")) &&
+         formControl.namespaceURI === HTML_NS;
+};
+
+// https://html.spec.whatwg.org/multipage/forms.html#concept-button
+const buttonInputTypes = new Set([...submitButtonInputTypes, "reset", "button"]);
+exports.isButton = formControl => {
+  return ((formControl._localName === "input" && buttonInputTypes.has(formControl.type)) ||
+          formControl._localName === "button") &&
+         formControl.namespaceURI === HTML_NS;
+};
+
+// https://html.spec.whatwg.org/multipage/dom.html#interactive-content-2
+exports.isInteractiveContent = node => {
+  if (node.nodeType !== NODE_TYPE.ELEMENT_NODE) {
+    return false;
+  }
+  if (node.namespaceURI !== HTML_NS) {
+    return false;
+  }
+  if (node.hasAttributeNS(null, "tabindex")) {
+    return true;
+  }
+  switch (node.localName) {
+    case "a":
+      return node.hasAttributeNS(null, "href");
+
+    case "audio":
+    case "video":
+      return node.hasAttributeNS(null, "controls");
+
+    case "img":
+    case "object":
+      return node.hasAttributeNS(null, "usemap");
+
+    case "input":
+      return node.type !== "hidden";
+
+    case "button":
+    case "details":
+    case "embed":
+    case "iframe":
+    case "label":
+    case "select":
+    case "textarea":
+      return true;
+  }
+
+  return false;
+};
+
+// https://html.spec.whatwg.org/multipage/forms.html#category-label
+exports.isLabelable = node => {
+  if (node.nodeType !== NODE_TYPE.ELEMENT_NODE) {
+    return false;
+  }
+  if (node.namespaceURI !== HTML_NS) {
+    return false;
+  }
+  switch (node.localName) {
+    case "button":
+    case "meter":
+    case "output":
+    case "progress":
+    case "select":
+    case "textarea":
+      return true;
+
+    case "input":
+      return node.type !== "hidden";
+  }
+  if (node._ceDefinition?.formAssociated) {
+    return true;
+  }
+
+  return false;
+};
+
+exports.getLabelsForLabelable = labelable => {
+  if (!exports.isLabelable(labelable)) {
+    return null;
+  }
+  if (!labelable._labels) {
+    const root = labelable.getRootNode({});
+    labelable._labels = NodeList.createImpl(root._globalObject, [], {
+      element: root,
+      query: () => {
+        const nodes = [];
+        for (const descendant of domSymbolTree.treeIterator(root)) {
+          if (descendant.control === labelable) {
+            nodes.push(descendant);
+          }
+        }
+        return nodes;
+      }
+    });
+  }
+  return labelable._labels;
+};
+
+// https://html.spec.whatwg.org/multipage/forms.html#valid-e-mail-address
+exports.isValidEmailAddress = (emailAddress, multiple = false) => {
+  const emailAddressRegExp = new RegExp("^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9]" +
+    "(?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}" +
+    "[a-zA-Z0-9])?)*$");
+  // A valid e-mail address list is a set of comma-separated tokens, where each token is itself
+  // a valid e - mail address.To obtain the list of tokens from a valid e - mail address list,
+  // an implementation must split the string on commas.
+  if (multiple) {
+    return splitOnCommas(emailAddress).every(value => emailAddressRegExp.test(value));
+  }
+  return emailAddressRegExp.test(emailAddress);
+};
+
+exports.isValidAbsoluteURL = url => {
+  return whatwgURL.parseURL(url) !== null;
+};
+
+exports.sanitizeValueByType = (input, val) => {
+  switch (input.type.toLowerCase()) {
+    case "password":
+    case "search":
+    case "tel":
+    case "text":
+      val = stripNewlines(val);
+      break;
+
+    case "color":
+      // https://html.spec.whatwg.org/multipage/forms.html#color-state-(type=color):value-sanitization-algorithm
+      val = isValidSimpleColor(val) ? val.toLowerCase() : "#000000";
+      break;
+
+    case "date":
+      // https://html.spec.whatwg.org/multipage/input.html#date-state-(type=date):value-sanitization-algorithm
+      if (!isValidDateString(val)) {
+        val = "";
+      }
+      break;
+
+    case "datetime-local": {
+      // https://html.spec.whatwg.org/multipage/input.html#local-date-and-time-state-(type=datetime-local):value-sanitization-algorithm
+      const dateAndTime = parseLocalDateAndTimeString(val);
+      val = dateAndTime !== null ? serializeNormalizedDateAndTime(dateAndTime) : "";
+      break;
+    }
+
+    case "email":
+      // https://html.spec.whatwg.org/multipage/forms.html#e-mail-state-(type=email):value-sanitization-algorithm
+      // https://html.spec.whatwg.org/multipage/forms.html#e-mail-state-(type=email):value-sanitization-algorithm-2
+      if (input.hasAttributeNS(null, "multiple")) {
+        val = val.split(",").map(token => stripLeadingAndTrailingASCIIWhitespace(token)).join(",");
+      } else {
+        val = stripNewlines(val);
+        val = stripLeadingAndTrailingASCIIWhitespace(val);
+      }
+      break;
+
+    case "month":
+      // https://html.spec.whatwg.org/multipage/input.html#month-state-(type=month):value-sanitization-algorithm
+      if (!isValidMonthString(val)) {
+        val = "";
+      }
+      break;
+
+    case "number":
+      // https://html.spec.whatwg.org/multipage/input.html#number-state-(type=number):value-sanitization-algorithm
+      // TODO: using parseFloatingPointNumber in addition to isValidFloatingPointNumber to pass number.html WPT.
+      // Possible spec bug.
+      if (!isValidFloatingPointNumber(val) || parseFloatingPointNumber(val) === null) {
+        val = "";
+      }
+      break;
+
+    case "range":
+      // https://html.spec.whatwg.org/multipage/input.html#range-state-(type=range):value-sanitization-algorithm
+      // TODO: using parseFloatingPointNumber in addition to isValidFloatingPointNumber to pass number.html WPT.
+      // Possible spec bug.
+      if (!isValidFloatingPointNumber(val) || parseFloatingPointNumber(val) === null) {
+        const minimum = input._minimum;
+        const maximum = input._maximum;
+        const defaultValue = maximum < minimum ? minimum : (minimum + maximum) / 2;
+        val = `${defaultValue}`;
+      } else if (val < input._minimum) {
+        val = `${input._minimum}`;
+      } else if (val > input._maximum) {
+        val = `${input._maximum}`;
+      }
+      break;
+
+    case "time":
+      // https://html.spec.whatwg.org/multipage/input.html#time-state-(type=time):value-sanitization-algorithm
+      if (!isValidTimeString(val)) {
+        val = "";
+      }
+      break;
+
+    case "url":
+      // https://html.spec.whatwg.org/multipage/forms.html#url-state-(type=url):value-sanitization-algorithm
+      val = stripNewlines(val);
+      val = stripLeadingAndTrailingASCIIWhitespace(val);
+      break;
+
+    case "week":
+      // https://html.spec.whatwg.org/multipage/input.html#week-state-(type=week):value-sanitization-algorithm
+      if (!isValidWeekString(val)) {
+        val = "";
+      }
+  }
+
+  return val;
+};
+
+// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#form-owner
+// TODO: The spec describes an imperative process for assigning/resetting an element's form
+// owner based on activities involving form-associated elements. This simpler implementation
+// instead calculates the current form owner only when the property is accessed. This is not
+// sufficient to pass all the web platform tests, but is good enough for most purposes. We
+// should eventually update it to use the correct version, though. See
+// https://github.com/whatwg/html/issues/4050 for some discussion.
+
+exports.formOwner = formControl => {
+  const formAttr = formControl.getAttributeNS(null, "form");
+  if (formAttr === "") {
+    return null;
+  }
+  if (formAttr === null) {
+    return closest(formControl, "form");
+  }
+
+  const root = formControl.getRootNode({});
+  let firstElementWithId;
+  for (const descendant of domSymbolTree.treeIterator(root)) {
+    if (descendant.nodeType === NODE_TYPE.ELEMENT_NODE &&
+      descendant.getAttributeNS(null, "id") === formAttr) {
+      firstElementWithId = descendant;
+      break;
+    }
+  }
+
+  if (firstElementWithId &&
+    firstElementWithId.namespaceURI === HTML_NS &&
+    firstElementWithId.localName === "form") {
+    return firstElementWithId;
+  }
+  return null;
+};

package/lib/jsdom/living/helpers/html-constructor.js

@@ -0,0 +1,78 @@
+"use strict";
+
+const { HTML_NS } = require("./namespaces");
+const { createElement, getValidTagNames } = require("./create-element");
+
+const { implForWrapper, wrapperForImpl } = require("../../../generated/idl/utils");
+
+// https://html.spec.whatwg.org/multipage/custom-elements.html#concept-already-constructed-marker
+const ALREADY_CONSTRUCTED_MARKER = Symbol("already-constructed-marker");
+
+// https://html.spec.whatwg.org/multipage/dom.html#htmlconstructor
+function HTMLConstructor(globalObject, constructorName, newTarget) {
+  const registry = implForWrapper(globalObject._customElementRegistry);
+  if (newTarget === HTMLConstructor) {
+    throw new TypeError("Invalid constructor");
+  }
+
+  const definition = registry._customElementDefinitions.find(entry => entry.objectReference === newTarget);
+  if (definition === undefined) {
+    throw new TypeError("Invalid constructor, the constructor is not part of the custom element registry");
+  }
+
+  let isValue = null;
+
+  if (definition.localName === definition.name) {
+    if (constructorName !== "HTMLElement") {
+      throw new TypeError("Invalid constructor, autonomous custom element should extend from HTMLElement");
+    }
+  } else {
+    const validLocalNames = getValidTagNames(HTML_NS, constructorName);
+    if (!validLocalNames.includes(definition.localName)) {
+      throw new TypeError(`${definition.localName} is not valid local name for ${constructorName}`);
+    }
+
+    isValue = definition.name;
+  }
+
+  let { prototype } = newTarget;
+
+  if (prototype === null || typeof prototype !== "object") {
+    // The following line deviates from the specification. The HTMLElement prototype should be retrieved from the realm
+    // associated with the "new.target". Because it is impossible to get such information in jsdom, we fallback to the
+    // HTMLElement prototype associated with the current object.
+    prototype = globalObject.HTMLElement.prototype;
+  }
+
+  if (definition.constructionStack.length === 0) {
+    const documentImpl = implForWrapper(globalObject.document);
+
+    const elementImpl = createElement(documentImpl, definition.localName, HTML_NS);
+
+    const element = wrapperForImpl(elementImpl);
+    Object.setPrototypeOf(element, prototype);
+
+    elementImpl._ceState = "custom";
+    elementImpl._ceDefinition = definition;
+    elementImpl._isValue = isValue;
+
+    return element;
+  }
+
+  const elementImpl = definition.constructionStack[definition.constructionStack.length - 1];
+  const element = wrapperForImpl(elementImpl);
+
+  if (elementImpl === ALREADY_CONSTRUCTED_MARKER) {
+    throw new TypeError("This instance is already constructed");
+  }
+
+  Object.setPrototypeOf(element, prototype);
+
+  definition.constructionStack[definition.constructionStack.length - 1] = ALREADY_CONSTRUCTED_MARKER;
+
+  return element;
+}
+
+module.exports = {
+  HTMLConstructor
+};

package/lib/jsdom/living/helpers/internal-constants.js

@@ -0,0 +1,12 @@
+"use strict";
+const SymbolTree = require("symbol-tree");
+
+exports.cloningSteps = Symbol("cloning steps");
+
+// TODO: the many underscore-prefixed hooks should move here
+// E.g. _attrModified (which maybe should be split into its per-spec variants)
+
+/**
+ * This SymbolTree is used to build the tree for all Node in a document
+ */
+exports.domSymbolTree = new SymbolTree("DOM SymbolTree");

package/lib/jsdom/living/helpers/is-window.js

@@ -0,0 +1,18 @@
+"use strict";
+const idlUtils = require("../../../generated/idl/utils");
+
+// Until webidl2js gains support for checking for Window, this would have to do.
+module.exports = val => {
+  if (typeof val !== "object") {
+    return false;
+  }
+  const wrapper = idlUtils.wrapperForImpl(val);
+  if (typeof wrapper === "object") {
+    return wrapper === wrapper._globalProxy;
+  }
+
+  // `val` may be either impl or wrapper currently, because webidl2js currently unwraps Window objects (and their global
+  // proxies) to their underlying EventTargetImpl during conversion, which is not what we want. But at the same time,
+  // some internal usage call this constructor with the actual global proxy.
+  return module.exports(idlUtils.implForWrapper(val));
+};

package/lib/jsdom/living/helpers/iterable-weak-set.js

@@ -0,0 +1,48 @@
+"use strict";
+
+// An iterable WeakSet implementation inspired by the iterable WeakMap example code in the WeakRefs specification:
+// https://github.com/tc39/proposal-weakrefs#iterable-weakmaps
+module.exports = class IterableWeakSet {
+  constructor() {
+    this._refSet = new Set();
+    this._refMap = new WeakMap();
+    this._finalizationRegistry = new FinalizationRegistry(({ ref, set }) => set.delete(ref));
+  }
+
+  add(value) {
+    if (!this._refMap.has(value)) {
+      const ref = new WeakRef(value);
+      this._refMap.set(value, ref);
+      this._refSet.add(ref);
+      this._finalizationRegistry.register(value, { ref, set: this._refSet }, ref);
+    }
+
+    return this;
+  }
+
+  delete(value) {
+    const ref = this._refMap.get(value);
+    if (!ref) {
+      return false;
+    }
+
+    this._refMap.delete(value);
+    this._refSet.delete(ref);
+    this._finalizationRegistry.unregister(ref);
+    return true;
+  }
+
+  has(value) {
+    return this._refMap.has(value);
+  }
+
+  * [Symbol.iterator]() {
+    for (const ref of this._refSet) {
+      const value = ref.deref();
+      if (value === undefined) {
+        continue;
+      }
+      yield value;
+    }
+  }
+};

package/lib/jsdom/living/helpers/json.js

@@ -0,0 +1,7 @@
+"use strict";
+const { utf8Decode } = require("./encoding");
+
+// https://infra.spec.whatwg.org/#parse-json-bytes-to-a-javascript-value
+exports.parseJSONFromBytes = bytes => {
+  return JSON.parse(utf8Decode(bytes));
+};

package/lib/jsdom/living/helpers/mutation-observers.js

@@ -0,0 +1,198 @@
+"use strict";
+
+const { domSymbolTree } = require("./internal-constants");
+const reportException = require("./runtime-script-errors");
+
+const Event = require("../../../generated/idl/Event");
+const idlUtils = require("../../../generated/idl/utils");
+const MutationRecord = require("../../../generated/idl/MutationRecord");
+
+const MUTATION_TYPE = {
+  ATTRIBUTES: "attributes",
+  CHARACTER_DATA: "characterData",
+  CHILD_LIST: "childList"
+};
+
+// Note:
+// Since jsdom doesn't currently implement the concept of "unit of related similar-origin browsing contexts"
+// (https://html.spec.whatwg.org/multipage/browsers.html#unit-of-related-similar-origin-browsing-contexts)
+// we will approximate that the following properties are global for now.
+
+// https://dom.spec.whatwg.org/#mutation-observer-compound-microtask-queued-flag
+let mutationObserverMicrotaskQueueFlag = false;
+
+// Non-spec compliant: List of all the mutation observers with mutation records enqueued. It's a replacement for
+// mutation observer list (https://dom.spec.whatwg.org/#mutation-observer-list) but without leaking since it's empty
+// before notifying the mutation observers.
+const activeMutationObservers = new Set();
+
+// https://dom.spec.whatwg.org/#signal-slot-list
+const signalSlotList = [];
+
+// https://dom.spec.whatwg.org/#queue-a-mutation-record
+function queueMutationRecord(
+  type,
+  target,
+  name,
+  namespace,
+  oldValue,
+  addedNodes,
+  removedNodes,
+  previousSibling,
+  nextSibling
+) {
+  const interestedObservers = new Map();
+
+  const nodes = domSymbolTree.ancestorsToArray(target);
+
+  for (const node of nodes) {
+    for (const registered of node._registeredObserverList) {
+      const { options, observer: mo } = registered;
+
+      if (
+        !(node !== target && options.subtree === false) &&
+        !(type === MUTATION_TYPE.ATTRIBUTES && options.attributes !== true) &&
+        !(type === MUTATION_TYPE.ATTRIBUTES && options.attributeFilter &&
+          !options.attributeFilter.some(value => value === name || value === namespace)) &&
+        !(type === MUTATION_TYPE.CHARACTER_DATA && options.characterData !== true) &&
+        !(type === MUTATION_TYPE.CHILD_LIST && options.childList === false)
+      ) {
+        if (!interestedObservers.has(mo)) {
+          interestedObservers.set(mo, null);
+        }
+
+        if (
+          (type === MUTATION_TYPE.ATTRIBUTES && options.attributeOldValue === true) ||
+          (type === MUTATION_TYPE.CHARACTER_DATA && options.characterDataOldValue === true)
+        ) {
+          interestedObservers.set(mo, oldValue);
+        }
+      }
+    }
+  }
+
+  for (const [observer, mappedOldValue] of interestedObservers.entries()) {
+    const record = MutationRecord.createImpl(target._globalObject, [], {
+      type,
+      target,
+      attributeName: name,
+      attributeNamespace: namespace,
+      oldValue: mappedOldValue,
+      addedNodes,
+      removedNodes,
+      previousSibling,
+      nextSibling
+    });
+
+    observer._recordQueue.push(record);
+    activeMutationObservers.add(observer);
+  }
+
+  queueMutationObserverMicrotask();
+}
+
+// https://dom.spec.whatwg.org/#queue-a-tree-mutation-record
+function queueTreeMutationRecord(target, addedNodes, removedNodes, previousSibling, nextSibling) {
+  queueMutationRecord(
+    MUTATION_TYPE.CHILD_LIST,
+    target,
+    null,
+    null,
+    null,
+    addedNodes,
+    removedNodes,
+    previousSibling,
+    nextSibling
+  );
+}
+
+// https://dom.spec.whatwg.org/#queue-an-attribute-mutation-record
+function queueAttributeMutationRecord(target, name, namespace, oldValue) {
+  queueMutationRecord(
+    MUTATION_TYPE.ATTRIBUTES,
+    target,
+    name,
+    namespace,
+    oldValue,
+    [],
+    [],
+    null,
+    null
+  );
+}
+
+// https://dom.spec.whatwg.org/#queue-a-mutation-observer-compound-microtask
+function queueMutationObserverMicrotask() {
+  if (mutationObserverMicrotaskQueueFlag) {
+    return;
+  }
+
+  mutationObserverMicrotaskQueueFlag = true;
+
+  Promise.resolve().then(() => {
+    notifyMutationObservers();
+  });
+}
+
+// https://dom.spec.whatwg.org/#notify-mutation-observers
+function notifyMutationObservers() {
+  mutationObserverMicrotaskQueueFlag = false;
+
+  const notifyList = [...activeMutationObservers].sort((a, b) => a._id - b._id);
+  activeMutationObservers.clear();
+
+  const signalList = [...signalSlotList];
+  signalSlotList.splice(0, signalSlotList.length);
+
+  for (const mo of notifyList) {
+    const records = [...mo._recordQueue];
+    mo._recordQueue = [];
+
+    for (const node of mo._nodeList) {
+      node._registeredObserverList = node._registeredObserverList.filter(registeredObserver => {
+        return registeredObserver.source !== mo;
+      });
+    }
+
+    if (records.length > 0) {
+      try {
+        const moWrapper = idlUtils.wrapperForImpl(mo);
+        mo._callback.call(
+          moWrapper,
+          records.map(idlUtils.wrapperForImpl),
+          moWrapper
+        );
+      } catch (e) {
+        const { target } = records[0];
+        const window = target._ownerDocument._defaultView;
+
+        reportException(window, e);
+      }
+    }
+  }
+
+  for (const slot of signalList) {
+    const slotChangeEvent = Event.createImpl(
+      slot._globalObject,
+      [
+        "slotchange",
+        { bubbles: true }
+      ],
+      { isTrusted: true }
+    );
+
+    slot._dispatch(slotChangeEvent);
+  }
+}
+
+module.exports = {
+  MUTATION_TYPE,
+
+  queueMutationRecord,
+  queueTreeMutationRecord,
+  queueAttributeMutationRecord,
+
+  queueMutationObserverMicrotask,
+
+  signalSlotList
+};

package/lib/jsdom/living/helpers/namespaces.js

@@ -0,0 +1,16 @@
+"use strict";
+// Do not require generated files from here, as this file is shared with the Web IDL converter.
+
+// https://infra.spec.whatwg.org/#namespaces
+
+exports.HTML_NS = "http://www.w3.org/1999/xhtml";
+
+exports.MATHML_NS = "http://www.w3.org/1998/Math/MathML";
+
+exports.SVG_NS = "http://www.w3.org/2000/svg";
+
+exports.XLINK_NS = "http://www.w3.org/1999/xlink";
+
+exports.XML_NS = "http://www.w3.org/XML/1998/namespace";
+
+exports.XMLNS_NS = "http://www.w3.org/2000/xmlns/";