Source: lib/polyfill/abort_controller.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.polyfill.AbortController');
  9. goog.require('shaka.polyfill');
  10. goog.require('shaka.util.FakeEvent');
  11. goog.require('shaka.util.FakeEventTarget');
  13. /**
  14.  * @summary A polyfill for systems that do not implement AbortController.
  15.  * This is used both with the fetch API for HTTP requests and inside the HLS
  16.  * parser.
  17.  * @export
  18.  * @extends AbortController
  19.  */
  20. shaka.polyfill.AbortController = class {
  21.   /**
  22.    * Install the polyfill if needed.
  23.    * @export
  24.    */
  25.   static install() {
  26.     if (window.AbortController) {
  27.       // Not needed.
  28.       return;
  29.     }
  31.     window.AbortController = shaka.polyfill.AbortController;
  32.     window.AbortSignal = shaka.polyfill.AbortController.AbortSignal;
  33.   }
  35.   /** */
  36.   constructor() {
  37.     /** @private {!shaka.polyfill.AbortController.AbortSignal} */
  38.     this.signal_ = new shaka.polyfill.AbortController.AbortSignal();
  39.   }
  41.   /**
  42.    * @override
  43.    * @suppress {const|duplicate} Since the original is defined as "const", we
  44.    *   need this suppression to override it.
  45.    */
  46.   get signal() {
  47.     return this.signal_;
  48.   }
  50.   /**
  51.    * @param {*=} reason
  52.    * @override
  53.    */
  54.   abort(reason) {
  55.     this.signal_.doAbort_(reason);
  56.   }
  57. };
  59. /**
  60.  * @summary A polyfill for AbortSignal, part of the AbortController API.
  61.  * @extends AbortSignal
  62.  */
  63. shaka.polyfill.AbortController.AbortSignal = class {
  64.   /** */
  65.   constructor() {
  66.     /** @private {boolean} */
  67.     this.aborted_ = false;
  69.     /** @private {*} */
  70.     this.reason_ = undefined;
  72.     /** @type {?function(!Event)} */
  73.     this.onabort = null;
  75.     /** @private {!shaka.util.FakeEventTarget} */
  76.     this.eventTarget_ = new shaka.util.FakeEventTarget();
  77.   }
  79.   /** @override */
  80.   addEventListener(type, listener, options) {
  81.     return this.eventTarget_.addEventListener(type, listener, options);
  82.   }
  84.   /** @override */
  85.   removeEventListener(type, listener, options) {
  86.     return this.eventTarget_.removeEventListener(type, listener, options);
  87.   }
  89.   /** @override */
  90.   dispatchEvent(event) {
  91.     return this.eventTarget_.dispatchEvent(event);
  92.   }
  94.   /** @override */
  95.   get aborted() {
  96.     return this.aborted_;
  97.   }
  99.   /** @override */
  100.   get reason() {
  101.     return this.reason_;
  102.   }
  104.   /** @override */
  105.   throwIfAborted() {
  106.     if (this.aborted_) {
  107.       throw this.reason_;
  108.     }
  109.   }
  111.   /**
  112.    * @param {*} reason
  113.    * @private
  114.    */
  115.   doAbort_(reason) {
  116.     if (this.aborted_) {
  117.       return;
  118.     }
  120.     this.aborted_ = true;
  121.     this.reason_ = reason;
  122.     if (this.reason_ === undefined) {
  123.       // This is equivalent to a native implementation.
  124.       this.reason_ = new DOMException(
  125.           'signal is aborted without reason', 'AbortError');
  126.     }
  128.     // According to MDN:
  129.     // "Event type - A generic Event with no added properties."
  130.     const event = new shaka.util.FakeEvent('abort');
  131.     if (this.onabort) {
  132.       this.onabort(event);
  133.     }
  134.     this.dispatchEvent(event);
  135.   }
  137.   /** @override */
  138.   static abort(reason) {
  139.     const signal = new shaka.polyfill.AbortController.AbortSignal();
  140.     signal.doAbort_(reason);
  141.     return signal;
  142.   }
  144.   /** @override */
  145.   static timeout(timeMs) {
  146.     const signal = new shaka.polyfill.AbortController.AbortSignal();
  148.     window.setTimeout(() => {
  149.       // This is equivalent to a native implementation.
  150.       signal.doAbort_(new DOMException('signal timed out', 'TimeoutError'));
  151.     }, timeMs);
  153.     return signal;
  154.   }
  155. };
  158. shaka.polyfill.register(shaka.polyfill.AbortController.install);