Add AbortSignal's reason property

MattiasBuelens · web-flow · commit a3037212707d · 2021-11-12T17:45:05.000-05:00
Implements whatwg/dom#1027.
diff --git a/lib/jsdom/living/aborting/AbortController-impl.js b/lib/jsdom/living/aborting/AbortController-impl.js
@@ -7,8 +7,8 @@ class AbortControllerImpl {
     this.signal = AbortSignal.createImpl(globalObject, []);
   }
 
-  abort() {
-    this.signal._signalAbort();
+  abort(reason) {
+    this.signal._signalAbort(reason);
   }
 }
 
diff --git a/lib/jsdom/living/aborting/AbortController.webidl b/lib/jsdom/living/aborting/AbortController.webidl
@@ -5,5 +5,5 @@ interface AbortController {
 
   [SameObject] readonly attribute AbortSignal signal;
 
-  undefined abort();
+  undefined abort(optional any reason);
 };
diff --git a/lib/jsdom/living/aborting/AbortSignal-impl.js b/lib/jsdom/living/aborting/AbortSignal-impl.js
@@ -4,6 +4,7 @@ const { setupForSimpleEventAccessors } = require("../helpers/create-event-access
 const { fireAnEvent } = require("../helpers/events");
 const EventTargetImpl = require("../events/EventTarget-impl").implementation;
 const AbortSignal = require("../generated/AbortSignal");
+const DOMException = require("domexception/webidl2js-wrapper");
 
 class AbortSignalImpl extends EventTargetImpl {
   constructor(globalObject, args, privateData) {
@@ -12,21 +13,34 @@ class AbortSignalImpl extends EventTargetImpl {
     // make event firing possible
     this._ownerDocument = globalObject.document;
 
-    this.aborted = false;
+    this.reason = undefined;
     this.abortAlgorithms = new Set();
   }
 
-  static abort(globalObject) {
+  get aborted() {
+    return this.reason !== undefined;
+  }
+
+  static abort(globalObject, reason) {
     const abortSignal = AbortSignal.createImpl(globalObject, []);
-    abortSignal.aborted = true;
+    if (reason !== undefined) {
+      abortSignal.reason = reason;
+    } else {
+      abortSignal.reason = DOMException.create(globalObject, ["The operation was aborted.", "AbortError"]);
+    }
     return abortSignal;
   }
 
-  _signalAbort() {
+  _signalAbort(reason) {
     if (this.aborted) {
       return;
     }
-    this.aborted = true;
+
+    if (reason !== undefined) {
+      this.reason = reason;
+    } else {
+      this.reason = DOMException.create(this._globalObject, ["The operation was aborted.", "AbortError"]);
+    }
 
     for (const algorithm of this.abortAlgorithms) {
       algorithm();
diff --git a/lib/jsdom/living/aborting/AbortSignal.webidl b/lib/jsdom/living/aborting/AbortSignal.webidl
@@ -1,8 +1,9 @@
 [Exposed=(Window,Worker)]
 interface AbortSignal : EventTarget {
-  [WebIDL2JSCallWithGlobal, NewObject] static AbortSignal abort();
+  [WebIDL2JSCallWithGlobal, NewObject] static AbortSignal abort(optional any reason);
 
   readonly attribute boolean aborted;
+  readonly attribute any reason;
 
   attribute EventHandler onabort;
 };
diff --git a/test/web-platform-tests/to-run.yaml b/test/web-platform-tests/to-run.yaml
@@ -173,14 +173,6 @@ throw-on-dynamic-markup-insertion-counter-reactions.html: [timeout, document.ope
 
 DIR: dom/abort
 
-event.any.html:
-  "AbortController abort() should fire event synchronously": [fail, AbortSignal.reason is not implemented]
-  "AbortController abort(reason) should set signal.reason": [fail, AbortSignal.reason is not implemented]
-  "aborting AbortController without reason creates an \"AbortError\" DOMException": [fail, AbortSignal.reason is not implemented]
-  "AbortController abort(undefined) creates an \"AbortError\" DOMException": [fail, AbortSignal.reason is not implemented]
-  "static aborting signal should have right properties": [fail, AbortSignal.reason is not implemented]
-  "static aborting signal with reason should set signal.reason": [fail, AbortSignal.reason is not implemented]
-
 ---
 
 DIR: dom/collections

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@ class AbortControllerImpl {`
`7`	`7`	`this.signal = AbortSignal.createImpl(globalObject, []);`
`8`	`8`	`}`
`9`	`9`
`10`		`- abort() {`
`11`		`- this.signal._signalAbort();`
	`10`	`+ abort(reason) {`
	`11`	`+ this.signal._signalAbort(reason);`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`