fix: use AbortController in backward compatible way for Node.js >=12.20.0 (#3141)

Author: char0n

config/jest/jest.unit.coverage.config.js

@@ -9,7 +9,7 @@ module.exports = {
       branches: 84,
       functions: 91,
       lines: 89,
-      statements: 89,
+      statements: 88,
     },
   },
 };

package-lock.json

@@ -8,7 +8,10 @@
     "./es/helpers/btoa.node.js": "./es/helpers/btoa.browser.js",
     "./src/helpers/fetch-polyfill.node.js": "./src/helpers/fetch-polyfill.browser.js",
     "./es/helpers/fetch-polyfill.node.js": "./es/helpers/fetch-polyfill.browser.js",
-    "./lib/helpers/fetch-polyfill.node.js": "./lib/helpers/fetch-polyfill.browser.js"
+    "./lib/helpers/fetch-polyfill.node.js": "./lib/helpers/fetch-polyfill.browser.js",
+    "./src/helpers/abortcontroller-polyfill.node.js": "./src/helpers/abortcontroller-polyfill.browser.js",
+    "./es/helpers/abortcontroller-polyfill.node.js": "./es/helpers/abortcontroller-polyfill.browser.js",
+    "./lib/helpers/abortcontroller-polyfill.node.js": "./lib/helpers/abortcontroller-polyfill.browser.js"
   },
   "main": "lib/commonjs.js",
   "module": "es/index.js",
@@ -110,13 +113,13 @@
     "@swagger-api/apidom-json-pointer": ">=0.76.2 <1.0.0",
     "@swagger-api/apidom-ns-openapi-3-1": ">=0.76.2 <1.0.0",
     "@swagger-api/apidom-reference": ">=0.76.2 <1.0.0",
-    "abort-controller": "^3.0.0",
     "cookie": "~0.5.0",
     "deepmerge": "~4.3.0",
     "fast-json-patch": "^3.0.0-1",
     "is-plain-object": "^5.0.0",
     "js-yaml": "^4.1.0",
     "node-fetch-commonjs": "^3.3.1",
+    "node-abort-controller": "^3.1.1",
     "qs": "^6.10.2",
     "traverse": "~0.6.6",
     "undici": "^5.24.0"

package.json

@@ -0,0 +1,8 @@
+import { AbortController, AbortSignal } from './abortcontroller-ponyfill.browser.js';
+
+if (typeof globalThis.AbortController === 'undefined') {
+  globalThis.AbortController = AbortController;
+}
+if (typeof globalThis.AbortSignal === 'undefined') {
+  globalThis.AbortSignal = AbortSignal;
+}

src/helpers/abortcontroller-polyfill.browser.js

@@ -0,0 +1,8 @@
+import { AbortController, AbortSignal } from './abortcontroller-ponyfill.node.js';
+
+if (typeof globalThis.AbortController === 'undefined') {
+  globalThis.AbortController = AbortController;
+}
+if (typeof globalThis.AbortSignal === 'undefined') {
+  globalThis.AbortSignal = AbortSignal;
+}

src/helpers/abortcontroller-polyfill.node.js

@@ -0,0 +1,4 @@
+// we're targeting browsers that already support fetch API
+const { AbortController, AbortSignal } = globalThis;
+
+export { AbortController, AbortSignal };

src/helpers/abortcontroller-ponyfill.browser.js

@@ -0,0 +1 @@
+export { AbortController, AbortSignal } from 'node-abort-controller';

src/helpers/abortcontroller-ponyfill.node.js

@@ -1,7 +1,7 @@
-import AbortController from 'abort-controller';
 import { ResolverError, HttpResolver } from '@swagger-api/apidom-reference/configuration/empty';
 
 import '../../../../../../helpers/fetch-polyfill.node.js';
+import '../../../../../../helpers/abortcontroller-polyfill.node.js';
 import Http from '../../../../../../http/index.js';
 
 const HttpResolverSwaggerClient = HttpResolver.compose({

src/resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js

@@ -1,5 +1,3 @@
-import AbortController from 'abort-controller';
-
 import { execute, buildRequest, self as stubs } from '../../src/execute/index.js';
 // eslint-disable-next-line camelcase
 import normalize from '../../src/resolver/strategies/generic/normalize.js';

test/execute/main.js

@@ -1,5 +1,3 @@
-import AbortController from 'abort-controller';
-
 import {
   mapTagOperations,
   makeApisTagOperationsOperationExecute,

test/interfaces.js

@@ -2,7 +2,6 @@ import process from 'node:process';
 import http from 'node:http';
 import path from 'node:path';
 import fs from 'node:fs';
-import AbortController from 'abort-controller';
 
 import {
   fetch,
@@ -23,9 +22,6 @@ globalThis.FormData = FormData;
 globalThis.File = File;
 globalThis.Blob = Blob;
 
-// provide AbortController for older Node.js versions
-globalThis.AbortController = AbortController;
-
 // helpers for reading local files
 globalThis.loadFile = (uri) => fs.readFileSync(uri).toString();
 globalThis.loadJsonFile = (uri) => JSON.parse(globalThis.loadFile(uri));