jsdom/lib/jsdom/living/aborting/AbortSignal-impl.js

A JavaScript implementation of many web standards

"use strict";

const { setupForSimpleEventAccessors } = require("../helpers/create-event-accessor");
const { fireAnEvent } = require("../helpers/events");
const EventTargetImpl = require("../events/EventTarget-impl").implementation;
const AbortSignal = require("../generated/AbortSignal");
const DOMException = require("../generated/DOMException");

class AbortSignalImpl extends EventTargetImpl {
  constructor(globalObject, args, privateData) {
    super(globalObject, args, privateData);

    // make event firing possible
    this._ownerDocument = globalObject.document;

    this.reason = undefined;
    this.abortAlgorithms = new Set();
    this._dependent = false;
    this._sourceSignals = new Set();
    this._dependentSignals = new Set();
  }

  get aborted() {
    return this.reason !== undefined;
  }

  throwIfAborted() {
    if (this.aborted) {
      throw this.reason;
    }
  }

  static abort(globalObject, reason) {
    const abortSignal = AbortSignal.createImpl(globalObject, []);
    if (reason !== undefined) {
      abortSignal.reason = reason;
    } else {
      abortSignal.reason = DOMException.create(globalObject, ["The operation was aborted.", "AbortError"]);
    }
    return abortSignal;
  }

  // https://dom.spec.whatwg.org/#abortsignal-dependent
  static any(globalObject, signals) {
    const resultSignal = AbortSignal.createImpl(globalObject, []);
    for (const signal of signals) {
      if (signal.aborted) {
        resultSignal.reason = signal.reason;
        return resultSignal;
      }
    }

    resultSignal.dependent = true;
    for (const signal of signals) {
      if (!signal.dependent) {
        resultSignal._sourceSignals.add(signal);
        signal._dependentSignals.add(resultSignal);
      } else {
        for (const sourceSignal of signal._sourceSignals) {
          if (!sourceSignal.aborted && !sourceSignal.dependent) {
            resultSignal._sourceSignals.add(sourceSignal);
            sourceSignal._dependentSignals.add(resultSignal);
          }
        }
      }
    }
    return resultSignal;
  }

  static timeout(globalObject, milliseconds) {
    const signal = AbortSignal.createImpl(globalObject, []);
    globalObject.setTimeout(() => {
      signal._signalAbort(DOMException.create(globalObject, ["The operation timed out.", "TimeoutError"]));
    }, milliseconds);

    return signal;
  }

  // https://dom.spec.whatwg.org/#abortsignal-signal-abort
  _signalAbort(reason) {
    if (this.aborted) {
      return;
    }

    if (reason !== undefined) {
      this.reason = reason;
    } else {
      this.reason = DOMException.create(this._globalObject, ["The operation was aborted.", "AbortError"]);
    }

    const dependentSignalsToAbort = [];
    for (const dependentSignal of this._dependentSignals) {
      if (!dependentSignal.aborted) {
        dependentSignal.reason = this.reason;
        dependentSignalsToAbort.push(dependentSignal);
      }
    }

    this._runAbortStep();

    for (const dependentSignal of dependentSignalsToAbort) {
      dependentSignal._runAbortStep();
    }
  }

  _runAbortStep() {
    for (const algorithm of this.abortAlgorithms) {
      algorithm();
    }
    this.abortAlgorithms.clear();

    fireAnEvent("abort", this);
  }

  _addAlgorithm(algorithm) {
    if (this.aborted) {
      return;
    }
    this.abortAlgorithms.add(algorithm);
  }

  _removeAlgorithm(algorithm) {
    this.abortAlgorithms.delete(algorithm);
  }
}

setupForSimpleEventAccessors(AbortSignalImpl.prototype, ["abort"]);

module.exports = {
  implementation: AbortSignalImpl
};