addSourceElement should return boolean too, update tests

videojs · Oct 8, 2024 · b81d154 · b81d154
1 parent 633aed8
commit b81d154
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 11 deletions.
diff --git a/src/js/player.js b/src/js/player.js
@@ -3718,11 +3718,16 @@ class Player extends Component {
    *
    * @param {string} [mimeType]
    *        The MIME type of the video source. Optional but recommended.
+   *
+   * @return {boolean}
+   *         Returns true if the source element was successfully added, false otherwise.
    */
   addSourceElement(srcUrl, mimeType) {
-    if (this.tech_) {
-      this.tech_.addSourceElement(srcUrl, mimeType);
+    if (!this.tech_) {
+      return false;
     }
+
+    return this.tech_.addSourceElement(srcUrl, mimeType);
   }
 
   /**
@@ -3735,9 +3740,11 @@ class Player extends Component {
    *         Returns true if the source element was successfully removed, false otherwise.
    */
   removeSourceElement(srcUrl) {
-    if (this.tech_) {
-      return this.tech_.removeSourceElement(srcUrl);
+    if (!this.tech_) {
+      return false;
     }
+
+    return this.tech_.removeSourceElement(srcUrl);
   }
 
   /**

diff --git a/src/js/tech/html5.js b/src/js/tech/html5.js
@@ -791,11 +791,14 @@ class Html5 extends Tech {
    *
    * @param {string} [mimeType]
    *        The MIME type of the video source. Optional but recommended.
+   *
+   * @return {boolean}
+   *         Returns true if the source element was successfully added, false otherwise.
    */
   addSourceElement(srcUrl, mimeType) {
     if (!srcUrl) {
       log.error('Invalid source URL.');
-      return;
+      return false;
     }
 
     const sourceAttributes = { src: srcUrl };
@@ -807,6 +810,8 @@ class Html5 extends Tech {
     const sourceElement = Dom.createEl('source', {}, sourceAttributes);
 
     this.el_.appendChild(sourceElement);
+
+    return true;
   }
 
   /**

diff --git a/test/unit/player.test.js b/test/unit/player.test.js
@@ -3626,6 +3626,19 @@ QUnit.test('addSourceElement calls tech method with correct args', function(asse
   player.dispose();
 });
 
+QUnit.test('addSourceElement returns false if no tech', function(assert) {
+  const player = TestHelpers.makePlayer();
+  const srcUrl = 'http://example.com/video.mp4';
+  const mimeType = 'video/mp4';
+
+  player.tech_ = undefined;
+
+  const added = player.addSourceElement(srcUrl, mimeType);
+
+  assert.notOk(added, 'Returned false');
+  player.dispose();
+});
+
 QUnit.test('removeSourceElement calls tech method with correct args', function(assert) {
   const player = TestHelpers.makePlayer();
   const removeSourceElementSpy = sinon.spy(player.tech_, 'removeSourceElement');
@@ -3639,3 +3652,16 @@ QUnit.test('removeSourceElement calls tech method with correct args', function(a
   removeSourceElementSpy.restore();
   player.dispose();
 });
+
+QUnit.test('removeSourceElement returns false if no tech', function(assert) {
+  const player = TestHelpers.makePlayer();
+  const srcUrl = 'http://example.com/video.mp4';
+  const mimeType = 'video/mp4';
+
+  player.tech_ = undefined;
+
+  const removed = player.removeSourceElement(srcUrl, mimeType);
+
+  assert.notOk(removed, 'Returned false');
+  player.dispose();
+});
diff --git a/test/unit/tech/html5.test.js b/test/unit/tech/html5.test.js
@@ -914,10 +914,10 @@ QUnit.test('addSourceElement adds a valid source element with srcUrl and mimeTyp
   const srcUrl = 'http://example.com/video.mp4';
   const mimeType = 'video/mp4';
 
-  tech.addSourceElement(srcUrl, mimeType);
-
+  const added = tech.addSourceElement(srcUrl, mimeType);
   const sourceElement = videoEl.querySelector('source');
 
+  assert.ok(added, 'Returned true');
   assert.ok(sourceElement, 'A source element was added');
   assert.equal(sourceElement.src, srcUrl, 'Source element has correct src');
   assert.equal(sourceElement.type, mimeType, 'Source element has correct type');
@@ -930,10 +930,10 @@ QUnit.test('addSourceElement adds a valid source element without a mimeType', fu
 
   const srcUrl = 'http://example.com/video2.mp4';
 
-  tech.addSourceElement(srcUrl);
-
+  const added = tech.addSourceElement(srcUrl);
   const sourceElement = videoEl.querySelector('source');
 
+  assert.ok(added, 'Returned true');
   assert.ok(sourceElement, 'A source element was added even without a type');
   assert.equal(sourceElement.src, srcUrl, 'Source element has correct src');
   assert.notOk(sourceElement.type, 'Source element does not have a type attribute');
@@ -944,10 +944,10 @@ QUnit.test('addSourceElement does not add a source element for invalid source UR
 
   tech.el_ = videoEl;
 
-  tech.addSourceElement('');
-
+  const added = tech.addSourceElement('');
   const sourceElement = videoEl.querySelector('source');
 
+  assert.notOk(added, 'Returned false');
   assert.notOk(sourceElement, 'No source element was added for missing src');
 });