fix(net): Allow preventDefault() on retry event (#8058)

Fixes #8041
shaka-project · Feb 17, 2025 · a514199 · a514199
1 parent fc1b96a
commit a514199
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/lib/net/networking_engine.js b/lib/net/networking_engine.js
@@ -716,8 +716,16 @@ shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
         if (error.severity == shaka.util.Error.Severity.RECOVERABLE) {
           const data = (new Map()).set('error', error);
           const event = new shaka.util.FakeEvent('retry', data);
+          // A user can call preventDefault() on a cancelable event.
+          event.cancelable = true;
           this.dispatchEvent(event);
 
+          if (event.defaultPrevented) {
+            // If the caller uses preventDefault() on the 'retry' event, don't
+            // retry any more.
+            throw error;
+          }
+
           // Move to the next URI.
           index = (index + 1) % request.uris.length;
           return this.send_(

diff --git a/test/net/networking_engine_unit.js b/test/net/networking_engine_unit.js
@@ -63,6 +63,7 @@ describe('NetworkingEngine', /** @suppress {accessControls} */ () => {
   afterEach(() => {
     shaka.net.NetworkingEngine.unregisterScheme('resolve');
     shaka.net.NetworkingEngine.unregisterScheme('reject');
+    networkingEngine.destroy();
   });
 
   afterAll(() => {
@@ -142,6 +143,31 @@ describe('NetworkingEngine', /** @suppress {accessControls} */ () => {
       expect(rejectScheme).toHaveBeenCalledTimes(3);
     });
 
+    it('allow abort retry', async () => {
+      const request = createRequest('reject://foo', {
+        maxAttempts: 2,
+        baseDelay: 0,
+        backoffFactor: 0,
+        fuzzFactor: 0,
+        timeout: 0,
+        stallTimeout: 0,
+        connectionTimeout: 0,
+      });
+      rejectScheme.and.callFake(() => {
+        if (rejectScheme.calls.count() == 1) {
+          return shaka.util.AbortableOperation.failed(error);
+        } else {
+          return shaka.util.AbortableOperation.completed(createResponse());
+        }
+      });
+      networkingEngine.addEventListener('retry', (event) => {
+        event.preventDefault();
+      });
+      await expectAsync(networkingEngine.request(requestType, request).promise)
+          .toBeRejected();
+      expect(rejectScheme).toHaveBeenCalledTimes(1);
+    });
+
     describe('backoff', () => {
       const baseDelay = 200;
       const realRandom = Math.random;