abortcontroller-polyfill
Version:
Polyfill/ponyfill for the AbortController DOM API + optional patching of fetch (stub that calls catch, doesn't actually abort request).
455 lines (440 loc) • 15.5 kB
JavaScript
(function (factory) {
typeof define === 'function' && define.amd ? define(factory) :
factory();
})((function () { 'use strict';
function _arrayLikeToArray(r, a) {
(null == a || a > r.length) && (a = r.length);
for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e];
return n;
}
function _assertThisInitialized(e) {
if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
return e;
}
function _callSuper(t, o, e) {
return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e));
}
function _classCallCheck(a, n) {
if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function");
}
function _defineProperties(e, r) {
for (var t = 0; t < r.length; t++) {
var o = r[t];
o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o);
}
}
function _createClass(e, r, t) {
return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", {
writable: !1
}), e;
}
function _createForOfIteratorHelper(r, e) {
var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
if (!t) {
if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) {
t && (r = t);
var n = 0,
F = function () {};
return {
s: F,
n: function () {
return n >= r.length ? {
done: !0
} : {
done: !1,
value: r[n++]
};
},
e: function (r) {
throw r;
},
f: F
};
}
throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
}
var o,
a = !0,
u = !1;
return {
s: function () {
t = t.call(r);
},
n: function () {
var r = t.next();
return a = r.done, r;
},
e: function (r) {
u = !0, o = r;
},
f: function () {
try {
a || null == t.return || t.return();
} finally {
if (u) throw o;
}
}
};
}
function _get() {
return _get = "undefined" != typeof Reflect && Reflect.get ? Reflect.get.bind() : function (e, t, r) {
var p = _superPropBase(e, t);
if (p) {
var n = Object.getOwnPropertyDescriptor(p, t);
return n.get ? n.get.call(arguments.length < 3 ? e : r) : n.value;
}
}, _get.apply(null, arguments);
}
function _getPrototypeOf(t) {
return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) {
return t.__proto__ || Object.getPrototypeOf(t);
}, _getPrototypeOf(t);
}
function _inherits(t, e) {
if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function");
t.prototype = Object.create(e && e.prototype, {
constructor: {
value: t,
writable: !0,
configurable: !0
}
}), Object.defineProperty(t, "prototype", {
writable: !1
}), e && _setPrototypeOf(t, e);
}
function _isNativeReflectConstruct() {
try {
var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {}));
} catch (t) {}
return (_isNativeReflectConstruct = function () {
return !!t;
})();
}
function _possibleConstructorReturn(t, e) {
if (e && ("object" == typeof e || "function" == typeof e)) return e;
if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined");
return _assertThisInitialized(t);
}
function _setPrototypeOf(t, e) {
return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) {
return t.__proto__ = e, t;
}, _setPrototypeOf(t, e);
}
function _superPropBase(t, o) {
for (; !{}.hasOwnProperty.call(t, o) && null !== (t = _getPrototypeOf(t)););
return t;
}
function _superPropGet(t, o, e, r) {
var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e);
return 2 & r && "function" == typeof p ? function (t) {
return p.apply(e, t);
} : p;
}
function _toPrimitive(t, r) {
if ("object" != typeof t || !t) return t;
var e = t[Symbol.toPrimitive];
if (void 0 !== e) {
var i = e.call(t, r || "default");
if ("object" != typeof i) return i;
throw new TypeError("@@toPrimitive must return a primitive value.");
}
return ("string" === r ? String : Number)(t);
}
function _toPropertyKey(t) {
var i = _toPrimitive(t, "string");
return "symbol" == typeof i ? i : i + "";
}
function _unsupportedIterableToArray(r, a) {
if (r) {
if ("string" == typeof r) return _arrayLikeToArray(r, a);
var t = {}.toString.call(r).slice(8, -1);
return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0;
}
}
var _ref = function (self) {
return {
NativeAbortSignal: self.AbortSignal,
NativeAbortController: self.AbortController
};
}(typeof self !== 'undefined' ? self : global),
NativeAbortSignal = _ref.NativeAbortSignal,
NativeAbortController = _ref.NativeAbortController;
var AbortSignal = /*#__PURE__*/function (_NativeAbortSignal) {
function AbortSignal() {
_classCallCheck(this, AbortSignal);
return _callSuper(this, AbortSignal);
}
/**
* polyfill flag
*/
_inherits(AbortSignal, _NativeAbortSignal);
return _createClass(AbortSignal, null, [{
key: "__polyfill__",
get: function get() {
return true;
}
/**
* @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/AbortSignal/abort_static}
*
* @param {any} reason The reason why the operation was aborted, which can be any JavaScript value. If not specified, the reason is set to "AbortError" {@link DOMException}.
*
* @returns {AbortSignal} An {@link AbortSignal} instance with the {@link AbortSignal.aborted} property set to `true`, and {@link AbortSignal.reason} set to the specified or default reason value.
*/
}, {
key: "abort",
value: function abort(reason) {
var ac = new AbortController();
ac.abort(reason);
return ac.signal;
}
/**
* @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/AbortSignal/timeout_static}
* @param {number} time The "active" time in milliseconds before the returned {@link AbortSignal} will abort.
* The value must be within range of 0 and {@link Number.MAX_SAFE_INTEGER}.
* @returns {AbortSignal} The signal will abort with its {@link AbortSignal.reason} property set to a `TimeoutError` {@link DOMException} on timeout,
* or an `AbortError` {@link DOMException} if the operation was user-triggered.
*/
}, {
key: "timeout",
value: function timeout(time) {
var controller = new AbortController();
setTimeout(function () {
return controller.abort(new DOMException("This signal is timeout in ".concat(time, "ms"), 'TimeoutError'));
}, time);
return controller.signal;
}
/**
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any_static}
*
* @param {Iterable<AbortSignal>} iterable An {@link Iterable} (such as an {@link Array}) of abort signals.
*
* @returns {AbortSignal} - **Already aborted**, if any of the abort signals given is already aborted.
* The returned {@link AbortSignal}'s reason will be already set to the `reason` of the first abort signal that was already aborted.
* - **Asynchronously aborted**, when any abort signal in `iterable` aborts.
* The `reason` will be set to the reason of the first abort signal that is aborted.
*/
}, {
key: "any",
value: function any(iterable) {
var controller = new AbortController();
/**
* @this AbortSignal
*/
function abort() {
controller.abort(this.reason);
clean();
}
function clean() {
var _iterator = _createForOfIteratorHelper(iterable),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var signal = _step.value;
signal.removeEventListener('abort', abort);
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
}
var _iterator2 = _createForOfIteratorHelper(iterable),
_step2;
try {
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
var signal = _step2.value;
if (signal.aborted) {
controller.abort(signal.reason);
break;
} else signal.addEventListener('abort', abort);
}
} catch (err) {
_iterator2.e(err);
} finally {
_iterator2.f();
}
return controller.signal;
}
}]);
}(NativeAbortSignal);
var AbortController = /*#__PURE__*/function (_NativeAbortControlle) {
function AbortController() {
var _this;
_classCallCheck(this, AbortController);
_this = _callSuper(this, AbortController);
patchAbortSignal(_this.signal);
return _this;
}
/**
* polyfill flag
*/
_inherits(AbortController, _NativeAbortControlle);
return _createClass(AbortController, [{
key: "abort",
value: function abort(reason) {
if (!this.signal.aborted) {
_superPropGet(AbortController, "abort", this, 3)([reason]);
if (this.signal.__polyfill__) {
var signalReason = normalizeAbortReason(reason);
var event = createAbortEvent(signalReason);
this.signal._reason = signalReason;
this.signal.dispatchEvent(event);
}
}
}
}], [{
key: "__polyfill__",
get: function get() {
return true;
}
}]);
}(NativeAbortController);
/**
* Make the native {@link AbortSignal} instances support the reason property and the throwIfAborted method.
* @param {AbortSignal} signal native {@link AbortSignal} instance
* @returns {AbortSignal} {@link AbortSignal} instance
*/
function patchAbortSignal(signal) {
if (!('reason' in signal)) {
signal._reason = undefined;
signal._onabort = null;
Object.defineProperties(signal, {
__polyfill__: {
value: true
},
reason: {
get: function get() {
return this._reason;
}
},
onabort: {
get: function get() {
return this._onabort;
},
set: function set(callback) {
var existing = this._onabort;
if (existing) {
this.removeEventListener('abort', existing);
}
this._onabort = callback;
this.addEventListener('abort', callback);
}
}
});
var dispatchEvent = signal.dispatchEvent,
addEventListener = signal.addEventListener,
removeEventListener = signal.removeEventListener;
signal.addEventListener = function (type, callback, options) {
if (type === 'abort' && callback && this.__polyfill__) {
if (!callback.__polyfill__) {
var rawCallback = callback;
Object.defineProperty(callback, '__polyfill__', {
value: function value(e) {
if (e.__polyfill__) {
return rawCallback.call(this, e);
}
}
});
}
callback = callback.__polyfill__;
}
return addEventListener.call(this, type, callback, options);
};
signal.removeEventListener = function (type, callback, options) {
if (type === 'abort' && callback && this.__polyfill__ && callback.__polyfill__) {
callback = callback.__polyfill__;
}
return removeEventListener.call(this, type, callback, options);
};
signal.dispatchEvent = function (event) {
if (event.type === 'abort') {
Object.defineProperty(event, '__polyfill__', {
value: true
});
}
return dispatchEvent.call(this, event);
};
}
if (!('throwIfAborted' in signal)) {
signal.throwIfAborted = function throwIfAborted() {
if (this.aborted) {
throw this.reason;
}
};
}
return signal;
}
/**
* @param {any} reason abort reason
*/
function createAbortEvent(reason) {
var event;
try {
event = new Event('abort');
} catch (e) {
if (typeof document !== 'undefined') {
if (!document.createEvent) {
// For Internet Explorer 8:
event = document.createEventObject();
event.type = 'abort';
} else {
// For Internet Explorer 11:
event = document.createEvent('Event');
event.initEvent('abort', false, false);
}
} else {
// Fallback where document isn't available:
event = {
type: 'abort',
bubbles: false,
cancelable: false
};
}
}
event.reason = reason;
return event;
}
/**
* @param {any} reason abort reason
*/
function normalizeAbortReason(reason) {
if (reason === undefined) {
if (typeof document === 'undefined') {
reason = new Error('This operation was aborted');
reason.name = 'AbortError';
} else {
try {
reason = new DOMException('signal is aborted without reason');
// The DOMException does not support setting the name property directly.
Object.defineProperty(reason, 'name', {
value: 'AbortError'
});
} catch (err) {
// IE 11 does not support calling the DOMException constructor, use a
// regular error object on it instead.
reason = new Error('This operation was aborted');
reason.name = 'AbortError';
}
}
}
return reason;
}
function signalPolyfillNeeded(self) {
if (self.__FORCE_INSTALL_ABORTCONTROLLER_POLYFILL) {
console.log('__FORCE_INSTALL_ABORTCONTROLLER_POLYFILL=true is set, will force install polyfill');
return true;
}
return !!self.AbortController && typeof self.AbortSignal === 'function' && !self.AbortSignal.prototype.hasOwnProperty('reason');
}
(function (self) {
if (!signalPolyfillNeeded(self)) {
return;
}
if (!self.AbortSignal.__polyfill__) {
self.AbortSignal = AbortSignal;
}
if (!self.AbortController.__polyfill__) {
self.AbortController = AbortController;
}
})(typeof self !== 'undefined' ? self : global);
}));