feat(net): Add originalRequest to shaka.extern.Response (#7857)

Author: avelad

externs/shaka/net.js

@@ -130,7 +130,8 @@ shaka.extern.Request;
  *   status: (number|undefined),
  *   headers: !Object.<string, string>,
  *   timeMs: (number|undefined),
- *   fromCache: (boolean|undefined)
+ *   fromCache: (boolean|undefined),
+ *   originalRequest: shaka.extern.Request
  * }}
  *
  * @description
@@ -158,6 +159,8 @@ shaka.extern.Request;
  * @property {(boolean|undefined)} fromCache
  *   Optional. If true, this response was from a cache and should be ignored
  *   for bandwidth estimation.
+ * @property {shaka.extern.Request} originalRequest
+ *   The original request that gave rise to this response.
  *
  * @exportDoc
  */

lib/net/data_uri_plugin.js

@@ -41,6 +41,7 @@ shaka.net.DataUriPlugin = class {
         headers: {
           'content-type': parsed.contentType,
         },
+        originalRequest: request,
       };
 
       return shaka.util.AbortableOperation.completed(response);

lib/net/http_fetch_plugin.js

@@ -61,8 +61,8 @@ shaka.net.HttpFetchPlugin = class {
     const minBytes = config.minBytesForProgressEvents || 0;
 
     const pendingRequest = shaka.net.HttpFetchPlugin.request_(
-        uri, requestType, init, abortStatus, progressUpdated, headersReceived,
-        request.streamDataCallback, minBytes);
+        uri, request, requestType, init, abortStatus, progressUpdated,
+        headersReceived, request.streamDataCallback, minBytes);
 
     /** @type {!shaka.util.AbortableOperation} */
     const op = new shaka.util.AbortableOperation(pendingRequest, () => {
@@ -94,6 +94,7 @@ shaka.net.HttpFetchPlugin = class {
 
   /**
    * @param {string} uri
+   * @param {shaka.extern.Request} request
    * @param {shaka.net.NetworkingEngine.RequestType} requestType
    * @param {!RequestInit} init
    * @param {shaka.net.HttpFetchPlugin.AbortStatus} abortStatus
@@ -104,8 +105,8 @@ shaka.net.HttpFetchPlugin = class {
    * @return {!Promise<!shaka.extern.Response>}
    * @private
    */
-  static async request_(uri, requestType, init, abortStatus, progressUpdated,
-      headersReceived, streamDataCallback, minBytes) {
+  static async request_(uri, request, requestType, init, abortStatus,
+      progressUpdated, headersReceived, streamDataCallback, minBytes) {
     const fetch = shaka.net.HttpFetchPlugin.fetch_;
     const ReadableStream = shaka.net.HttpFetchPlugin.ReadableStream_;
     let response;
@@ -225,8 +226,8 @@ shaka.net.HttpFetchPlugin = class {
     const headers = shaka.net.HttpFetchPlugin.headersToGenericObject_(
         response.headers);
 
-    return shaka.net.HttpPluginUtils.makeResponse(
-        headers, arrayBuffer, response.status, uri, response.url, requestType);
+    return shaka.net.HttpPluginUtils.makeResponse(headers, arrayBuffer,
+        response.status, uri, response.url, request, requestType);
   }
 
   /**

lib/net/http_plugin_utils.js

@@ -24,10 +24,12 @@ shaka.net.HttpPluginUtils = class {
    * @param {number} status
    * @param {string} uri
    * @param {string} responseURL
+   * @param {shaka.extern.Request} request
    * @param {shaka.net.NetworkingEngine.RequestType} requestType
    * @return {!shaka.extern.Response}
    */
-  static makeResponse(headers, data, status, uri, responseURL, requestType) {
+  static makeResponse(headers, data, status, uri, responseURL, request,
+      requestType) {
     goog.asserts.assert(data, 'Data should be non-null!');
 
     if (status >= 200 && status <= 299 && status != 202) {
@@ -40,6 +42,7 @@ shaka.net.HttpPluginUtils = class {
         status: status,
         headers: headers,
         fromCache: !!headers['x-shaka-from-cache'],
+        originalRequest: request,
       };
       return response;
     } else {

lib/net/http_xhr_plugin.js

@@ -74,7 +74,8 @@ shaka.net.HttpXHRPlugin = class {
           progressUpdated(currentTime - lastTime, event.loaded - lastLoaded,
               /* numBytesRemaining= */ 0);
           const response = shaka.net.HttpPluginUtils.makeResponse(headers,
-              xhrResponse, xhr.status, uri, xhr.responseURL, requestType);
+              xhrResponse, xhr.status, uri, xhr.responseURL, request,
+              requestType);
           resolve(response);
         } catch (error) {
           goog.asserts.assert(error instanceof shaka.util.Error,

lib/offline/offline_scheme.js

@@ -32,12 +32,12 @@ shaka.offline.OfflineScheme = class {
     const offlineUri = shaka.offline.OfflineUri.parse(uri);
 
     if (offlineUri && offlineUri.isManifest()) {
-      return shaka.offline.OfflineScheme.getManifest_(uri);
+      return shaka.offline.OfflineScheme.getManifest_(uri, request);
     }
 
     if (offlineUri && offlineUri.isSegment()) {
       return shaka.offline.OfflineScheme.getSegment_(
-          offlineUri.key(), offlineUri);
+          offlineUri.key(), offlineUri, request);
     }
 
     return shaka.util.AbortableOperation.failed(
@@ -50,16 +50,18 @@ shaka.offline.OfflineScheme = class {
 
   /**
    * @param {string} uri
+   * @param {shaka.extern.Request} request
    * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
    * @private
    */
-  static getManifest_(uri) {
+  static getManifest_(uri, request) {
     /** @type {shaka.extern.Response} */
     const response = {
       uri: uri,
       originalUri: uri,
       data: new ArrayBuffer(0),
       headers: {'content-type': 'application/x-offline-manifest'},
+      originalRequest: request,
     };
 
     return shaka.util.AbortableOperation.completed(response);
@@ -68,10 +70,11 @@ shaka.offline.OfflineScheme = class {
   /**
    * @param {number} id
    * @param {!shaka.offline.OfflineUri} uri
+   * @param {shaka.extern.Request} request
    * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
    * @private
    */
-  static getSegment_(id, uri) {
+  static getSegment_(id, uri, request) {
     goog.asserts.assert(
         uri.isSegment(),
         'Only segment uri\'s should be given to getSegment');
@@ -90,6 +93,7 @@ shaka.offline.OfflineScheme = class {
             uri: uri,
             data: segment.data,
             headers: {},
+            originalRequest: request,
           };
         })
         .finally(() => muxer.destroy());

test/media/streaming_engine_unit.js

@@ -3461,6 +3461,7 @@ describe('StreamingEngine', () => {
           originalUri: request.uris[0],
           data: buffer,
           headers: {},
+          originalRequest: request,
         };
         return shaka.util.AbortableOperation.completed(response);
       });

test/net/networking_engine_unit.js

@@ -1275,6 +1275,7 @@ describe('NetworkingEngine', /** @suppress {accessControls} */ () => {
       originalUri: '',
       data: new ArrayBuffer(5),
       headers: {},
+      originalRequest: createRequest('fake'),
     };
   }
 });  // describe('NetworkingEngine')

test/test/util/fake_networking_engine.js

@@ -138,6 +138,7 @@ shaka.test.FakeNetworkingEngine = class {
         originalUri: requestedUri,
         data: result,
         headers: headers,
+        originalRequest: request,
       };
 
       // Modify the response using the response filter, this allows the app

test/test/util/test_scheme.js

@@ -83,6 +83,7 @@ shaka.test.TestScheme = class {
         originalUri: uri,
         data: new ArrayBuffer(0),
         headers: {'content-type': 'application/x-test-manifest'},
+        originalRequest: request,
       };
       return shaka.util.AbortableOperation.completed(response);
     }
@@ -127,7 +128,13 @@ shaka.test.TestScheme = class {
     }
 
     /** @type {shaka.extern.Response} */
-    const ret = {uri: uri, originalUri: uri, data: responseData, headers: {}};
+    const ret = {
+      uri: uri,
+      originalUri: uri,
+      data: responseData,
+      headers: {},
+      originalRequest: request,
+    };
     return shaka.util.AbortableOperation.completed(ret);
   }