lib: implement AbortSignal.abort()

jasnell · targos · commit 448a6a22cf5b · 2021-04-30T12:00:35.000+02:00
Refs: whatwg/dom#960 PR-URL: #37693 Backport-PR-URL: #38386 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -283,6 +283,7 @@ module.exports = {
   },
   globals: {
     AbortController: 'readable',
+    AbortSignal: 'readable',
     Atomics: 'readable',
     BigInt: 'readable',
     BigInt64Array: 'readable',
diff --git a/doc/api/globals.md b/doc/api/globals.md
@@ -65,6 +65,15 @@ added: REPLACEME
 The `AbortSignal` is used to notify observers when the
 `abortController.abort()` method is called.
 
+#### Static method: `AbortSignal.abort()`
+<!-- YAML
+added: REPLACEME
+-->
+
+* Returns: {AbortSignal}
+
+Returns a new already aborted `AbortSignal`.
+
 #### Event: `'abort'`
 <!-- YAML
 added: REPLACEME
diff --git a/lib/internal/abort_controller.js b/lib/internal/abort_controller.js
@@ -50,6 +50,10 @@ class AbortSignal extends EventTarget {
       aborted: this.aborted
     }, depth, options);
   }
+
+  static abort() {
+    return createAbortSignal(true);
+  }
 }
 
 Object.defineProperties(AbortSignal.prototype, {
@@ -65,10 +69,10 @@ ObjectDefineProperty(AbortSignal.prototype, SymbolToStringTag, {
 
 defineEventHandler(AbortSignal.prototype, 'abort');
 
-function createAbortSignal() {
+function createAbortSignal(aborted = false) {
   const signal = new EventTarget();
   ObjectSetPrototypeOf(signal, AbortSignal.prototype);
-  signal[kAborted] = false;
+  signal[kAborted] = aborted;
   return signal;
 }
 
diff --git a/test/parallel/test-abortcontroller.js b/test/parallel/test-abortcontroller.js
@@ -68,3 +68,8 @@ const { Event } = require('internal/event_target');
   strictEqual(toString(ac), '[object AbortController]');
   strictEqual(toString(ac.signal), '[object AbortSignal]');
 }
+
+{
+  const signal = AbortSignal.abort();
+  ok(signal.aborted);
+}

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ class AbortSignal extends EventTarget {`
`50`	`50`	`aborted: this.aborted`
`51`	`51`	`}, depth, options);`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+ static abort() {`
	`55`	`+ return createAbortSignal(true);`
	`56`	`+ }`
`53`	`57`	`}`
`54`	`58`
`55`	`59`	`Object.defineProperties(AbortSignal.prototype, {`
`@@ -65,10 +69,10 @@ ObjectDefineProperty(AbortSignal.prototype, SymbolToStringTag, {`
`65`	`69`
`66`	`70`	`defineEventHandler(AbortSignal.prototype, 'abort');`
`67`	`71`
`68`		`-function createAbortSignal() {`
	`72`	`+function createAbortSignal(aborted = false) {`
`69`	`73`	`const signal = new EventTarget();`
`70`	`74`	`ObjectSetPrototypeOf(signal, AbortSignal.prototype);`
`71`		`- signal[kAborted] = false;`
	`75`	`+ signal[kAborted] = aborted;`
`72`	`76`	`return signal;`
`73`	`77`	`}`
`74`	`78`
Original file line number	Diff line number	Diff line change
`@@ -68,3 +68,8 @@ const { Event } = require('internal/event_target');`
`68`	`68`	`strictEqual(toString(ac), '[object AbortController]');`
`69`	`69`	`strictEqual(toString(ac.signal), '[object AbortSignal]');`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+{`
	`73`	`+ const signal = AbortSignal.abort();`
	`74`	`+ ok(signal.aborted);`
	`75`	`+}`