Source: lib/net/http_xhr_plugin.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.net.HttpXHRPlugin');
  9. goog.require('goog.asserts');
  10. goog.require('shaka.net.HttpPluginUtils');
  11. goog.require('shaka.net.NetworkingEngine');
  12. goog.require('shaka.util.AbortableOperation');
  13. goog.require('shaka.util.Error');
  16. /**
  17.  * @summary A networking plugin to handle http and https URIs via XHR.
  18.  * @export
  19.  */
  20. shaka.net.HttpXHRPlugin = class {
  21.   /**
  22.    * @param {string} uri
  23.    * @param {shaka.extern.Request} request
  24.    * @param {shaka.net.NetworkingEngine.RequestType} requestType
  25.    * @param {shaka.extern.ProgressUpdated} progressUpdated Called when a
  26.    *   progress event happened.
  27.    * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  28.    * @export
  29.    */
  30.   static parse(uri, request, requestType, progressUpdated) {
  31.     const xhr = new shaka.net.HttpXHRPlugin.Xhr_();
  33.     // Last time stamp when we got a progress event.
  34.     let lastTime = Date.now();
  35.     // Last number of bytes loaded, from progress event.
  36.     let lastLoaded = 0;
  38.     const promise = new Promise(((resolve, reject) => {
  39.       xhr.open(request.method, uri, true);
  40.       xhr.responseType = 'arraybuffer';
  41.       xhr.timeout = request.retryParameters.timeout;
  42.       xhr.withCredentials = request.allowCrossSiteCredentials;
  44.       xhr.onabort = () => {
  45.         reject(new shaka.util.Error(
  46.             shaka.util.Error.Severity.RECOVERABLE,
  47.             shaka.util.Error.Category.NETWORK,
  48.             shaka.util.Error.Code.OPERATION_ABORTED,
  49.             uri, requestType));
  50.       };
  51.       xhr.onload = (event) => {
  52.         const target = event.target;
  53.         goog.asserts.assert(target, 'XHR onload has no target!');
  54.         // Since IE and Edge incorrectly return the header with a leading new
  55.         // line character ('\n'), we trim the header here.
  56.         const headerLines = target.getAllResponseHeaders().trim().split('\r\n');
  57.         const headers = {};
  58.         for (const header of headerLines) {
  59.           /** @type {!Array.<string>} */
  60.           const parts = header.split(': ');
  61.           headers[parts[0].toLowerCase()] = parts.slice(1).join(': ');
  62.         }
  64.         try {
  65.           const response = shaka.net.HttpPluginUtils.makeResponse(headers,
  66.               target.response, target.status, uri, target.responseURL,
  67.               requestType);
  68.           resolve(response);
  69.         } catch (error) {
  70.           goog.asserts.assert(error instanceof shaka.util.Error,
  71.               'Wrong error type!');
  72.           reject(error);
  73.         }
  74.       };
  75.       xhr.onerror = (event) => {
  76.         reject(new shaka.util.Error(
  77.             shaka.util.Error.Severity.RECOVERABLE,
  78.             shaka.util.Error.Category.NETWORK,
  79.             shaka.util.Error.Code.HTTP_ERROR,
  80.             uri, event, requestType));
  81.       };
  82.       xhr.ontimeout = (event) => {
  83.         reject(new shaka.util.Error(
  84.             shaka.util.Error.Severity.RECOVERABLE,
  85.             shaka.util.Error.Category.NETWORK,
  86.             shaka.util.Error.Code.TIMEOUT,
  87.             uri, requestType));
  88.       };
  89.       xhr.onprogress = (event) => {
  90.         const currentTime = Date.now();
  91.         // If the time between last time and this time we got progress event
  92.         // is long enough, or if a whole segment is downloaded, call
  93.         // progressUpdated().
  94.         if (currentTime - lastTime > 100 ||
  95.             (event.lengthComputable && event.loaded == event.total)) {
  96.           progressUpdated(currentTime - lastTime, event.loaded - lastLoaded,
  97.               event.total - event.loaded);
  98.           lastLoaded = event.loaded;
  99.           lastTime = currentTime;
  100.         }
  101.       };
  103.       for (const key in request.headers) {
  104.         // The Fetch API automatically normalizes outgoing header keys to
  105.         // lowercase. For consistency's sake, do it here too.
  106.         const lowercasedKey = key.toLowerCase();
  107.         xhr.setRequestHeader(lowercasedKey, request.headers[key]);
  108.       }
  109.       xhr.send(request.body);
  110.     }));
  112.     return new shaka.util.AbortableOperation(
  113.         promise,
  114.         () => {
  115.           xhr.abort();
  116.           return Promise.resolve();
  117.         });
  118.   }
  119. };
  122. /**
  123.  * Overridden in unit tests, but compiled out in production.
  124.  *
  125.  * @const {function(new: XMLHttpRequest)}
  126.  * @private
  127.  */
  128. shaka.net.HttpXHRPlugin.Xhr_ = window.XMLHttpRequest;
  131. shaka.net.NetworkingEngine.registerScheme(
  132.     'http', shaka.net.HttpXHRPlugin.parse,
  133.     shaka.net.NetworkingEngine.PluginPriority.FALLBACK);
  134. shaka.net.NetworkingEngine.registerScheme(
  135.     'https', shaka.net.HttpXHRPlugin.parse,
  136.     shaka.net.NetworkingEngine.PluginPriority.FALLBACK);