Skip to content

fix: keep the edx_video_id for libraries#282

Open
marslanabdulrauf wants to merge 2 commits into
openedx:mainfrom
mitodl:marslan/12414-video-sources
Open

fix: keep the edx_video_id for libraries#282
marslanabdulrauf wants to merge 2 commits into
openedx:mainfrom
mitodl:marslan/12414-video-sources

Conversation

@marslanabdulrauf

Copy link
Copy Markdown
Contributor

Related Ticket

https://github.com/mitodl/hq/issues/12414 (MIT Internal)

Steps to reproduce the Issue:

  1. Get video id from course videos
  2. Create or go to any Library, add video component. Go to the video component, put the video id in and save (optionally publish)
  3. Click edit again and the "Video ID" is missing now.
  4. Strangely though you can see it in the "Advanced Details"
  5. And in the preview we get "No playable video source"

Possible root cause:

For new runtime edxval edx_video_id is being set to None which causes no sources to be loaded, which leads to this "No playable video sources found." error.

Description

This pull request updates the handling of the edx_video_id field in the parse_xml_new_runtime method to improve video compatibility in content libraries. Instead of setting edx_video_id to None, the code now retains its value, ensuring that videos already present in the Video Asset Library (VAL) continue to work as expected.

  • Video compatibility fix:
    • video.py: Updated parse_xml_new_runtime to retain the edx_video_id field, preventing issues where videos become unplayable or lose their ID in the editor after saving.
image

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 20, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @marslanabdulrauf!

This repository is currently maintained by @openedx/axim-engineering.

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
🔘 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.

Details
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.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jul 20, 2026
@farhan
farhan requested a review from Copilot July 21, 2026 14:40

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses a regression in the “new runtime” (content libraries v2) XML parsing for VideoBlock where edx_video_id was being cleared during parse_xml_new_runtime, causing library videos that already exist in VAL to lose their Video ID in the editor and become unplayable.

Changes:

  • Stop nulling video_block.edx_video_id in parse_xml_new_runtime so VAL-backed library videos keep resolving.
  • Add a regression test to ensure edx_video_id is preserved and that VAL-import is not attempted in the new runtime path.
  • Add clarifying inline comments documenting why edx_video_id is retained in the new runtime.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
xblocks_contrib/video/video.py Keeps edx_video_id intact in parse_xml_new_runtime to preserve VAL-backed playback for library videos.
xblocks_contrib/video/tests/test_video.py Adds a regression test verifying edx_video_id preservation and no VAL import call in the new runtime path.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@farhan

farhan commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Important

It's all Claude Code generated, @openedx/axim-aximprovements team will plan its review ahead

Code Review

The fix is correct, minimal, and well-targeted. Removing video_block.edx_video_id = None lets the ID parsed from OLX survive, so VAL resolves the video sources in the new (Content Libraries v2) runtime.

I traced the full path:

  • parse_video_xml reads edx_video_id into field_data; the old = None then wiped it.
  • get_html resolves sources from VAL by edx_video_id, and the lookup is wrapped in try/except, so videos absent from VAL degrade to html5_sources rather than crashing.
  • VAL Video records are global (not course-scoped), so resolving a library video against VAL is sound.

Nits (non-blocking):

  1. mock_import_into_val.assert_not_called() is a tautology. parse_xml_new_runtime never called import_video_info_into_val, before or after this PR, so the assertion passes regardless of the fix. The only assertion validating the fix is block.edx_video_id == edx_video_id. Consider dropping the mock or reframing it as an explicit intent guard.
  2. The <video_asset> payload in the test XML is inert. parse_video_xml never parses <video_asset>/<encoded_video>, so those encodings do nothing for the assertions. A one-line comment or trimming would avoid confusion.
  3. Scope is limited to videos already present in VAL on the instance. A library video whose encodings live only in the OLX <video_asset> still renders no sources. This matches the stated intent, but worth calling out that cross-instance portability is not addressed here.

Suggestion: add a negative-case test, an OLX <video> with no edx_video_id, to confirm it falls back to the field default without error.

Before merge: bump __version__ (currently 0.17.1) and add a CHANGELOG.rst entry. This repo tags releases from __version__, and every merge-checklist item is currently unticked.

Otherwise, approve. Nice catch on the root cause, and thanks for including a regression test.

@farhan farhan moved this to 🔖 Ready in Aximprovements Team Jul 21, 2026
@farhan
farhan requested a review from a team July 21, 2026 14:56
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: 🔖 Ready
Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

5 participants