Skip to content

Sgb/fix video test#38060

Draft
Gi-ron wants to merge 2 commits intoopenedx:masterfrom
eduNEXT:sgb/fix-video-test
Draft

Sgb/fix video test#38060
Gi-ron wants to merge 2 commits intoopenedx:masterfrom
eduNEXT:sgb/fix-video-test

Conversation

@Gi-ron
Copy link

@Gi-ron Gi-ron commented Feb 27, 2026

Problem

After upgrading to jQuery UI 1.14.2, many video tests started failing with:

TypeError: can't access property "player", this.videoPlayer is undefined
destroy@commons.js:71601

jQuery UI now extends cleanData to automatically trigger "remove" events:

// jQuery UI 1.14.2+
t.cleanData = function (e) {
    for (n = 0; null != (s = e[n]); n++) 
        (i = t._data(s, "events")) && i.remove && t(s).triggerHandler("remove");
    p(e);
}

Why tests failed

  1. VideoPlayer listens for "remove" events and calls destroy() (correct production behavior)
  2. During tests, when jasmine-jquery cleans fixtures or tests modify the DOM, jQuery UI triggers "remove" events
  3. This caused destroy() to be called automatically during test execution
  4. Then, the afterEach called destroy() again explicitly
  5. The second call failed because this.videoPlayer was already deleted

Solution

Make destroy() idempotent (safe for multiple calls) in tests:

// Applied after each videoPlayer initialization
var originalDestroy = state.videoPlayer.destroy;
state.videoPlayer.destroy = function() {
    if (!this || !this.videoPlayer) {
        return;  // Already destroyed, do nothing
    }
    return originalDestroy.apply(this, arguments);
};

Additional improvements

  • Made all afterEach blocks check if state exists before using it
  • Added try/catch for specific videoPlayer is undefined errors
  • Applied protection only where needed (video-related tests)

Files changed

  • xmodule/js/spec/video/events_spec.js
  • xmodule/js/spec/video/general_spec.js
  • xmodule/js/spec/video/video_caption_spec.js
  • xmodule/js/spec/video/video_player_spec.js
  • xmodule/js/spec/video/video_quality_control_spec.js
  • xmodule/js/spec/video/video_auto_advance_spec.js
  • xmodule/js/spec/video/video_events_plugin_spec.js
  • xmodule/js/spec/video/video_play_placeholder_spec.js
  • xmodule/js/spec/video/video_transcript_feedback_spec.js
  • xmodule/js/spec/video/video_context_menu_spec.js

Testing

  • Verified with Firefox 142.0.0
  • Verified with jQuery UI 1.14.2
  • All video tests pass locally
  • JUnit report: 619 tests, 0 errors, 0 failures

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 27, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @Gi-ron!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants