feat: Add 'downloadcompleted' event (#7609)

Closes #7608
shaka-project · Nov 18, 2024 · 13186bd · 13186bd
1 parent 0fc5316
commit 13186bd
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 6 deletions.
diff --git a/lib/net/networking_engine.js b/lib/net/networking_engine.js
@@ -53,6 +53,8 @@ shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
    *   of whether the switching is allowed.
    * @param {shaka.net.NetworkingEngine.OnHeadersReceived=} onHeadersReceived
    *   Called when the headers are received for a download.
+   * @param {shaka.net.NetworkingEngine.OnDownloadCompleted=}
+   *   onDownloadCompleted Called when a download completed successfully.
    * @param {shaka.net.NetworkingEngine.OnDownloadFailed=} onDownloadFailed
    *   Called when a download fails, for any reason.
    * @param {shaka.net.NetworkingEngine.OnRequest=} onRequest
@@ -62,8 +64,8 @@ shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
    * @param {shaka.net.NetworkingEngine.OnResponse=} onResponse
    *   Called when receive the response
    */
-  constructor(onProgressUpdated, onHeadersReceived, onDownloadFailed,
-      onRequest, onRetry, onResponse) {
+  constructor(onProgressUpdated, onHeadersReceived, onDownloadCompleted,
+      onDownloadFailed, onRequest, onRetry, onResponse) {
     super();
 
     /** @private {boolean} */
@@ -84,6 +86,9 @@ shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
     /** @private {?shaka.net.NetworkingEngine.OnHeadersReceived} */
     this.onHeadersReceived_ = onHeadersReceived || null;
 
+    /** @private {?shaka.net.NetworkingEngine.OnDownloadCompleted} */
+    this.onDownloadCompleted_ = onDownloadCompleted || null;
+
     /** @private {?shaka.net.NetworkingEngine.OnDownloadFailed} */
     this.onDownloadFailed_ = onDownloadFailed || null;
 
@@ -635,7 +640,9 @@ shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
           this.onHeadersReceived_(response.headers, request, type);
         }
       }
-
+      if (this.onDownloadCompleted_) {
+        this.onDownloadCompleted_(request, response);
+      }
       return responseAndGotProgress;
     }, (error) => {
       if (connectionTimer) {
@@ -979,6 +986,18 @@ shaka.net.NetworkingEngine.OnHeadersReceived;
  */
 shaka.net.NetworkingEngine.onProgressUpdated;
 
+/**
+ * @typedef {function(
+ *    !shaka.extern.Request,
+ *    !shaka.extern.Response)}
+ *
+ * @description
+ * A callback function that notifies the player when a download completed
+ * successfully.
+ * @export
+ */
+shaka.net.NetworkingEngine.OnDownloadCompleted;
+
 /**
  * @typedef {function(
  *    !shaka.extern.Request,

diff --git a/lib/player.js b/lib/player.js
@@ -3469,6 +3469,15 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
         }
       });
     };
+    /** @type {shaka.net.NetworkingEngine.OnDownloadCompleted} */
+    const onDownloadCompleted_ = (request, response) => {
+      // Release a 'downloadcompleted' event.
+      const name = shaka.util.FakeEvent.EventName.DownloadCompleted;
+      const data = new Map()
+          .set('request', request)
+          .set('response', response);
+      dispatchEvent(shaka.Player.makeEvent_(name, data));
+    };
     /** @type {shaka.net.NetworkingEngine.OnDownloadFailed} */
     const onDownloadFailed_ = (request, error, httpResponseCode, aborted) => {
       // Release a 'downloadfailed' event.
@@ -3510,8 +3519,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
     };
 
     return new shaka.net.NetworkingEngine(
-        onProgressUpdated_, onHeadersReceived_, onDownloadFailed_, onRequest_,
-        onRetry_, onResponse_);
+        onProgressUpdated_, onHeadersReceived_, onDownloadCompleted_,
+        onDownloadFailed_, onRequest_, onRetry_, onResponse_);
   }
 
   /**

diff --git a/lib/util/fake_event.js b/lib/util/fake_event.js
@@ -158,6 +158,7 @@ shaka.util.FakeEvent.EventName = {
   AudioTrackChanged: 'audiotrackchanged',
   Buffering: 'buffering',
   Complete: 'complete',
+  DownloadCompleted: 'downloadcompleted',
   DownloadFailed: 'downloadfailed',
   DownloadHeadersReceived: 'downloadheadersreceived',
   DrmSessionUpdate: 'drmsessionupdate',

diff --git a/test/util/cmcd_manager_unit.js b/test/util/cmcd_manager_unit.js
@@ -113,7 +113,7 @@ describe('CmcdManager', () => {
       cmcd.applyData(type, request, context);
     }
 
-    return new NetworkingEngine(undefined, undefined, undefined,
+    return new NetworkingEngine(undefined, undefined, undefined, undefined,
         onRequest);
   }