Convert BuiltIn Video Block's html from mako template into django template #37509

salman2013 · 2025-10-20T17:16:57Z

Description

In this PR

I converted the builtin video block's html from mako template to django template
I just converted video.html template which is rendering in student_view, public_view and author_view.
Render django template in video_block.py with the class ResourceLoader from Xblock
I left studio_view as it is because there is already deprecation ticket to remove legacy video editor which is rendering in studio_view.

Alternate Approach/ considerations:

I also tried using Django’s built-in template loader (django.template.loaders) to render the template. It successfully found the HTML file under lms/templates when running in the LMS, but not in the CMS. The reason is that the CMS (settings) do not include a path to read files from the lms directory, and the file exists only within the LMS app.
In this approach if we update the video.html location from lms/templates to common/templates it render properly on both CMS and LMS

Reasons:

We are transitioning from Mako to Django templates.
Eventually we have to extract out the Video Block into xblocks-contrib repository

Ticket: openedx/public-engineering#427

Acceptance Criteria:

html template should be refactored to django template with minimal code changes
Video XBlock experience shouldn't be changed
All unit and karma test cases should be passed on the edx-platform

Testing results:

I tested this PR on sandbox with following video formats.

Youtube

Youtube with transcript

Mp4

HLS

webm

In-video quiz

Video Sharing

openedx-webhooks · 2025-10-20T17:17:02Z

Thanks for the pull request, @salman2013!

This repository is currently maintained by @openedx/wg-maintenance-edx-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

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

open-craft-grove · 2025-10-20T18:58:35Z