@depup/jsdom 28.1.0-depup.1

package/lib/jsdom/living/window/History-impl.js

@@ -0,0 +1,148 @@
+"use strict";
+const DOMException = require("../../../generated/idl/DOMException");
+const { serializeURL } = require("whatwg-url");
+
+// https://html.spec.whatwg.org/#history-3
+exports.implementation = class HistoryImpl {
+  constructor(globalObject, args, privateData) {
+    this._window = privateData.window;
+    this._document = privateData.document;
+    this._actAsIfLocationReloadCalled = privateData.actAsIfLocationReloadCalled;
+    this._state = null;
+
+    this._globalObject = globalObject;
+  }
+
+  _guardAgainstInactiveDocuments() {
+    if (!this._window) {
+      throw DOMException.create(this._globalObject, [
+        "History object is associated with a document that is not fully active.",
+        "SecurityError"
+      ]);
+    }
+  }
+
+  get length() {
+    this._guardAgainstInactiveDocuments();
+
+    return this._window._sessionHistory.length;
+  }
+
+  get state() {
+    this._guardAgainstInactiveDocuments();
+
+    return this._state;
+  }
+
+  go(delta) {
+    this._guardAgainstInactiveDocuments();
+
+    if (delta === 0) {
+      // When the go(delta) method is invoked, if delta is zero, the user agent must act as
+      // if the location.reload() method was called instead.
+      this._actAsIfLocationReloadCalled();
+    } else {
+      // Otherwise, the user agent must traverse the history by a delta whose value is delta
+      this._window._sessionHistory.traverseByDelta(delta);
+    }
+  }
+
+  back() {
+    this.go(-1);
+  }
+
+  forward() {
+    this.go(+1);
+  }
+
+  pushState(data, unused, url) {
+    this._sharedPushAndReplaceState(data, url, "push");
+  }
+  replaceState(data, unused, url) {
+    this._sharedPushAndReplaceState(data, url, "replace");
+  }
+
+  // https://html.spec.whatwg.org/#shared-history-push/replace-state-steps
+  _sharedPushAndReplaceState(data, url, historyHandling) {
+    this._guardAgainstInactiveDocuments();
+
+    // TODO structured clone data
+
+    let newURL = this._document._URL;
+    if (url !== null && url.length > 0) {
+      newURL = this._document.encodingParseAURL(url);
+
+      if (newURL === null) {
+        throw DOMException.create(this._globalObject, [
+          `Could not parse url argument "${url}" to ${historyHandling}State() against base URL ` +
+          `"${this._document.baseURLSerialized()}".`,
+          "SecurityError"
+        ]);
+      }
+
+      if (!canHaveItsURLRewritten(this._document, newURL)) {
+        throw DOMException.create(this._globalObject, [
+          `${historyHandling}State() cannot update history to the URL ${serializeURL(newURL)}.`,
+          "SecurityError"
+        ]);
+      }
+    }
+
+    // What follows is very unlike the spec's URL and history update steps. Maybe if we implement real session
+    // history/navigation, we can fix that.
+
+    if (historyHandling === "push") {
+      this._window._sessionHistory.removeAllEntriesAfterCurrentEntry();
+
+      this._window._sessionHistory.clearHistoryTraversalTasks();
+
+      const newEntry = {
+        document: this._document,
+        stateObject: data,
+        url: newURL
+      };
+      this._window._sessionHistory.addEntryAfterCurrentEntry(newEntry);
+      this._window._sessionHistory.updateCurrentEntry(newEntry);
+    } else {
+      const { currentEntry } = this._window._sessionHistory;
+      currentEntry.stateObject = data;
+      currentEntry.url = newURL;
+    }
+
+    // TODO: If the current entry in the session history represents a non-GET request
+    // (e.g. it was the result of a POST submission) then update it to instead represent
+    // a GET request.
+
+    this._document._URL = newURL;
+    this._document._clearBaseURLCache();
+
+    // arguably it's a bit odd that the state and latestEntry do not belong to the SessionHistory
+    // but the spec gives them to "History" and "Document" respecively.
+    this._state = data; // TODO clone again!! O_o
+    this._document._latestEntry = this._window._sessionHistory.currentEntry;
+  }
+};
+
+function canHaveItsURLRewritten(document, targetURL) {
+  const documentURL = document._URL;
+
+  if (targetURL.scheme !== documentURL.scheme || targetURL.username !== documentURL.username ||
+      targetURL.password !== documentURL.password || targetURL.host !== documentURL.host ||
+      targetURL.port !== documentURL.port) {
+    return false;
+  }
+
+  if (targetURL.scheme === "https" || targetURL.scheme === "http") {
+    return true;
+  }
+
+  if (targetURL.scheme === "file" && targetURL.path !== documentURL.path) {
+    return false;
+  }
+
+  if (targetURL.path.join("/") !== documentURL.path.join("/") || targetURL.query !== documentURL.query) {
+    return false;
+  }
+
+  return true;
+}

package/lib/jsdom/living/window/Location-impl.js

@@ -0,0 +1,227 @@
+"use strict";
+const whatwgURL = require("whatwg-url");
+const DOMException = require("../../../generated/idl/DOMException");
+const { navigate } = require("./navigation");
+
+// Not implemented: use of entry settings object's API base URL in href setter, assign, and replace. Instead we just
+// use the document base URL. The difference matters in the case of cross-frame calls.
+
+exports.implementation = class LocationImpl {
+  constructor(globalObject, args, privateData) {
+    this._relevantDocument = privateData.relevantDocument;
+    this.url = null;
+
+    this._globalObject = globalObject;
+  }
+
+  get _url() {
+    return this._relevantDocument._URL;
+  }
+
+  _locationObjectSetterNavigate(url) {
+    // Not implemented: extra steps here to determine replacement flag.
+
+    return this._locationObjectNavigate(url);
+  }
+
+  _locationObjectNavigate(url, { replacement = false } = {}) {
+    // Not implemented: the setup for calling navigate, which doesn't apply to our stub navigate anyway.
+
+    navigate(this._relevantDocument._defaultView, url, { replacement, exceptionsEnabled: true });
+  }
+
+  toString() {
+    return this.href;
+  }
+
+  get href() {
+    return whatwgURL.serializeURL(this._url);
+  }
+  set href(v) {
+    const newURL = whatwgURL.parseURL(v, { baseURL: this._relevantDocument.baseURL() });
+    if (newURL === null) {
+      throw new TypeError(`Could not parse "${v}" as a URL`);
+    }
+
+    this._locationObjectSetterNavigate(newURL);
+  }
+
+  get origin() {
+    return whatwgURL.serializeURLOrigin(this._url);
+  }
+
+  get protocol() {
+    return this._url.scheme + ":";
+  }
+  set protocol(v) {
+    const copyURL = { ...this._url };
+
+    const possibleFailure = whatwgURL.basicURLParse(v + ":", { url: copyURL, stateOverride: "scheme start" });
+    if (possibleFailure === null) {
+      throw new TypeError(`Could not parse the URL after setting the procol to "${v}"`);
+    }
+
+    if (copyURL.scheme !== "http" && copyURL.scheme !== "https") {
+      return;
+    }
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get host() {
+    const url = this._url;
+
+    if (url.host === null) {
+      return "";
+    }
+    if (url.port === null) {
+      return whatwgURL.serializeHost(url.host);
+    }
+
+    return whatwgURL.serializeHost(url.host) + ":" + whatwgURL.serializeInteger(url.port);
+  }
+  set host(v) {
+    const copyURL = { ...this._url };
+
+    if (whatwgURL.hasAnOpaquePath(copyURL)) {
+      return;
+    }
+
+    whatwgURL.basicURLParse(v, { url: copyURL, stateOverride: "host" });
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get hostname() {
+    if (this._url.host === null) {
+      return "";
+    }
+
+    return whatwgURL.serializeHost(this._url.host);
+  }
+  set hostname(v) {
+    const copyURL = { ...this._url };
+
+    if (whatwgURL.hasAnOpaquePath(copyURL)) {
+      return;
+    }
+
+    whatwgURL.basicURLParse(v, { url: copyURL, stateOverride: "hostname" });
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get port() {
+    if (this._url.port === null) {
+      return "";
+    }
+
+    return whatwgURL.serializeInteger(this._url.port);
+  }
+  set port(v) {
+    const copyURL = { ...this._url };
+
+    if (whatwgURL.cannotHaveAUsernamePasswordPort(copyURL)) {
+      return;
+    }
+
+    whatwgURL.basicURLParse(v, { url: copyURL, stateOverride: "port" });
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get pathname() {
+    return whatwgURL.serializePath(this._url);
+  }
+  set pathname(v) {
+    const copyURL = { ...this._url };
+
+    if (whatwgURL.hasAnOpaquePath(copyURL)) {
+      return;
+    }
+
+    copyURL.path = [];
+    whatwgURL.basicURLParse(v, { url: copyURL, stateOverride: "path start" });
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get search() {
+    if (this._url.query === null || this._url.query === "") {
+      return "";
+    }
+
+    return "?" + this._url.query;
+  }
+  set search(v) {
+    const copyURL = { ...this._url };
+
+    if (v === "") {
+      copyURL.query = null;
+    } else {
+      const input = v[0] === "?" ? v.substring(1) : v;
+      copyURL.query = "";
+      whatwgURL.basicURLParse(input, {
+        url: copyURL,
+        stateOverride: "query",
+        encodingOverride: this._relevantDocument.charset
+      });
+    }
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  get hash() {
+    if (this._url.fragment === null || this._url.fragment === "") {
+      return "";
+    }
+
+    return "#" + this._url.fragment;
+  }
+  set hash(v) {
+    const copyURL = { ...this._url };
+
+    const input = v[0] === "#" ? v.substring(1) : v;
+    copyURL.fragment = "";
+    whatwgURL.basicURLParse(input, { url: copyURL, stateOverride: "fragment" });
+
+    if (copyURL.fragment === this._url.fragment) {
+      return;
+    }
+
+    this._locationObjectSetterNavigate(copyURL);
+  }
+
+  assign(url) {
+    // Should be entry settings object; oh well
+    const parsedURL = this._relevantDocument.encodingParseAURL(url);
+
+    if (parsedURL === null) {
+      throw DOMException.create(this._globalObject, [
+        `Could not resolve the given string "${url}" relative to the base URL "${this._relevantDocument.URL}"`,
+        "SyntaxError"
+      ]);
+    }
+
+    this._locationObjectNavigate(parsedURL);
+  }
+
+  replace(url) {
+    // Should be entry settings object; oh well
+    const parsedURL = this._relevantDocument.encodingParseAURL(url);
+
+    if (parsedURL === null) {
+      throw DOMException.create(this._globalObject, [
+        `Could not resolve the given string "${url}" relative to the base URL "${this._relevantDocument.URL}"`,
+        "SyntaxError"
+      ]);
+    }
+
+    this._locationObjectNavigate(parsedURL, { replacement: true });
+  }
+
+  reload() {
+    const flags = { replace: true, reloadTriggered: true, exceptionsEnabled: true };
+    navigate(this._relevantDocument._defaultView, this._url, flags);
+  }
+};

package/lib/jsdom/living/window/Screen-impl.js

@@ -0,0 +1,13 @@
+"use strict";
+
+// https://drafts.csswg.org/cssom-view-1/#the-screen-interface
+class ScreenImpl {}
+
+ScreenImpl.prototype.availWidth = 0;
+ScreenImpl.prototype.availHeight = 0;
+ScreenImpl.prototype.width = 0;
+ScreenImpl.prototype.height = 0;
+ScreenImpl.prototype.colorDepth = 24;
+ScreenImpl.prototype.pixelDepth = 24;
+
+exports.implementation = ScreenImpl;

package/lib/jsdom/living/window/SessionHistory.js

@@ -0,0 +1,163 @@
+"use strict";
+const whatwgURL = require("whatwg-url");
+const HashChangeEvent = require("../../../generated/idl/HashChangeEvent.js");
+const PopStateEvent = require("../../../generated/idl/PopStateEvent.js");
+const notImplemented = require("../../browser/not-implemented.js");
+const idlUtils = require("../../../generated/idl/utils.js");
+const { fireAnEvent } = require("../helpers/events");
+
+// https://html.spec.whatwg.org/#session-history
+class SessionHistory {
+  constructor(initialEntry, window) {
+    this._window = window;
+    this._windowImpl = idlUtils.implForWrapper(window);
+    this._historyTraversalQueue = new Set();
+    this._entries = [initialEntry];
+    this._currentIndex = 0;
+  }
+
+  _queueHistoryTraversalTask(fn) {
+    const timeoutId = this._window.setTimeout(() => {
+      this._historyTraversalQueue.delete(timeoutId);
+      fn();
+    }, 0);
+
+    this._historyTraversalQueue.add(timeoutId);
+  }
+
+  clearHistoryTraversalTasks() {
+    for (const timeoutId of this._historyTraversalQueue) {
+      this._window.clearTimeout(timeoutId);
+    }
+    this._historyTraversalQueue.clear();
+  }
+
+  get length() {
+    return this._entries.length;
+  }
+
+  get currentEntry() {
+    return this._entries[this._currentIndex];
+  }
+
+  // https://html.spec.whatwg.org/#dom-history-pushstate
+  removeAllEntriesAfterCurrentEntry() {
+    this._entries.splice(this._currentIndex + 1, Infinity);
+  }
+
+  // https://html.spec.whatwg.org/#traverse-the-history-by-a-delta
+  traverseByDelta(delta) {
+    this._queueHistoryTraversalTask(() => {
+      const newIndex = this._currentIndex + delta;
+      if (newIndex < 0 || newIndex >= this.length) {
+        return;
+      }
+
+      const specifiedEntry = this._entries[newIndex];
+
+      // Not implemented: unload a document guard
+
+      // Not clear that this should be queued. html/browsers/history/the-history-interface/004.html can be fixed
+      // by removing the queue, but doing so breaks some tests in history.js that also pass in browsers.
+      this._queueHistoryTraversalTask(() => {
+        // If there is an ongoing attempt to navigate specified browsing context that has not yet matured,
+        // then cancel that attempt to navigate the browsing context.
+
+        // Doing this seems to break tests involving navigating via push/pop state and via fragments. I think this
+        // is because these navigations should already count as having "matured" because the document is not changing.
+
+        // this.clearHistoryTraversalTasks();
+
+        if (specifiedEntry.document !== this.currentEntry.document) {
+          // TODO: unload the active document with the recycle parameter set to false
+          notImplemented(this._window, "traversing history to another Document");
+        }
+        this.traverseHistory(specifiedEntry);
+      });
+    });
+  }
+
+  // https://html.spec.whatwg.org/#traverse-the-history
+  traverseHistory(specifiedEntry, flags = {}) {
+    if (!specifiedEntry.document) {
+      // If entry no longer holds a Document object, then navigate the browsing context to entry's URL
+      // to perform an entry update of entry, and abort these steps
+      notImplemented(this._window, "traversing the history to an entry that no longer holds a Document");
+    }
+    // Not spec compliant, just minimal. Lots of missing steps.
+
+    const nonBlockingEvents = Boolean(flags.nonBlockingEvents);
+
+    const document = idlUtils.implForWrapper(this._window._document);
+
+    const { currentEntry } = this;
+
+    // If the current entry's title was not set by the pushState() or replaceState() methods, then set its title
+    // to the value returned by the document.title IDL attribute.
+    if (currentEntry.title === undefined) {
+      currentEntry.title = document.title;
+    }
+
+
+    if (specifiedEntry.document !== currentEntry.document) {
+      // If entry has a different Document object than the current entry, then...
+      notImplemented(this._window, "traversing the history to an entry with a different Document");
+    }
+
+    document._URL = specifiedEntry.url;
+
+    const hashChanged =
+      specifiedEntry.url.fragment !== currentEntry.url.fragment && specifiedEntry.document === currentEntry.document;
+    let oldURL, newURL;
+    if (hashChanged) {
+      oldURL = currentEntry.url;
+      newURL = specifiedEntry.url;
+    }
+
+    if (flags.replacement) {
+      // If the traversal was initiated with replacement enabled, remove the entry immediately before the
+      // specified entry in the session history.
+      this._entries.splice(this._entries.indexOf(specifiedEntry) - 1, 1);
+    }
+
+    this.updateCurrentEntry(specifiedEntry);
+
+    const state = specifiedEntry.stateObject; // TODO structured clone
+
+    // arguably it's a bit odd that the state and latestEntry do not belong to the SessionHistory
+    // but the spec gives them to "History" and "Document" respecively.
+    document._history._state = state;
+    const stateChanged = specifiedEntry.document._latestEntry !== specifiedEntry;
+    specifiedEntry.document._latestEntry = specifiedEntry;
+
+    const fireEvents = () => this._fireEvents(stateChanged, hashChanged, state, oldURL, newURL);
+
+    if (nonBlockingEvents) {
+      this._window.setTimeout(fireEvents, 0);
+    } else {
+      fireEvents();
+    }
+  }
+
+  _fireEvents(stateChanged, hashChanged, state, oldURL, newURL) {
+    if (stateChanged) {
+      fireAnEvent("popstate", this._windowImpl, PopStateEvent, { state });
+    }
+
+    if (hashChanged) {
+      fireAnEvent("hashchange", this._windowImpl, HashChangeEvent, {
+        oldURL: whatwgURL.serializeURL(oldURL),
+        newURL: whatwgURL.serializeURL(newURL)
+      });
+    }
+  }
+
+  addEntryAfterCurrentEntry(entry) {
+    this._entries.splice(this._currentIndex + 1, 0, entry);
+  }
+
+  updateCurrentEntry(entry) {
+    this._currentIndex = this._entries.indexOf(entry);
+  }
+}
+module.exports = SessionHistory;

package/lib/jsdom/living/window/navigation.js

@@ -0,0 +1,87 @@
+"use strict";
+const whatwgURL = require("whatwg-url");
+const { notImplemented } = require("../../browser/not-implemented.js");
+const reportException = require("../helpers/runtime-script-errors.js");
+const { utf8Decode } = require("../helpers/encoding.js");
+const idlUtils = require("../../../generated/idl/utils.js");
+
+// https://html.spec.whatwg.org/#evaluate-a-javascript:-url, kind of
+exports.evaluateJavaScriptURL = (window, urlRecord) => {
+  const urlString = whatwgURL.serializeURL(urlRecord);
+  const encodedScriptSource = urlString.substring("javascript:".length);
+  const scriptSource = utf8Decode(whatwgURL.percentDecodeString(encodedScriptSource));
+  if (window._runScripts === "dangerously") {
+    try {
+      return window.eval(scriptSource);
+    } catch (e) {
+      reportException(window, e, urlString);
+    }
+  }
+  return undefined;
+};
+
+// https://html.spec.whatwg.org/#navigating-across-documents
+exports.navigate = (window, newURL, flags) => {
+  // This is NOT a spec-compliant implementation of navigation in any way. It implements a few selective steps that
+  // are nice for jsdom users, regarding hash changes and JavaScript URLs. Full navigation support is being worked on
+  // and will likely require some additional hooks to be implemented.
+  if (!window._document) {
+    return;
+  }
+
+  const document = idlUtils.implForWrapper(window._document);
+  const currentURL = document._URL;
+
+  if (!flags.reloadTriggered && urlEquals(currentURL, newURL, { excludeFragments: true })) {
+    if (newURL.fragment !== currentURL.fragment) {
+      navigateToFragment(window, newURL, flags);
+    }
+    return;
+  }
+
+  // NOT IMPLEMENTED: Prompt to unload the active document of browsingContext.
+
+  // NOT IMPLEMENTED: form submission algorithm
+  // const navigationType = 'other';
+
+  // NOT IMPLEMENTED: if resource is a response...
+  if (newURL.scheme === "javascript") {
+    setTimeout(() => {
+      const result = exports.evaluateJavaScriptURL(window, newURL);
+      if (typeof result === "string") {
+        notImplemented(window, "string results from 'javascript:' URLs");
+      }
+    }, 0);
+    return;
+  }
+  navigateFetch(window);
+};
+
+// https://html.spec.whatwg.org/#scroll-to-fragid
+function navigateToFragment(window, newURL, flags) {
+  const document = idlUtils.implForWrapper(window._document);
+
+  window._sessionHistory.clearHistoryTraversalTasks();
+
+  if (!flags.replacement) {
+    // handling replacement=true here deviates from spec, but matches real browser behaviour
+    // see https://github.com/whatwg/html/issues/2796 for spec bug
+    window._sessionHistory.removeAllEntriesAfterCurrentEntry();
+  }
+  const newEntry = { document, url: newURL };
+  window._sessionHistory.addEntryAfterCurrentEntry(newEntry);
+  window._sessionHistory.traverseHistory(newEntry, { nonBlockingEvents: true, replacement: flags.replacement });
+}
+
+// https://html.spec.whatwg.org/#process-a-navigate-fetch
+function navigateFetch(window) {
+  // TODO:
+  notImplemented(window, "navigation to another Document");
+}
+
+// https://url.spec.whatwg.org/#concept-url-equals
+function urlEquals(a, b, flags) {
+  const serializedA = whatwgURL.serializeURL(a, flags.excludeFragments);
+  const serializedB = whatwgURL.serializeURL(b, flags.excludeFragments);
+  return serializedA === serializedB;
+}