feat: Video editor supports transcripts [FC-0076] #36058

ChrisChV · 2024-12-25T21:16:28Z

Description

Add error handler on save video to avoid creating sjson
Support transcripts without edx_video_id in definition_to_xml
When copying a video from a library to a course: Create a new edx_video_id
Save transcripts as static assets in a video in a library when adding a new transcript.
Delete transcripts as static assets in a video in a library when deleting transcripts.
Support download transcript in a video in a library.
Support replace transcript in a video in a library.
Support updating transcripts in video in a library.
Refactor the code of downloading YouTube transcripts to enable this feature in libraries.
Support copy from a library to a course and a course to a library.
Which edX user roles will this change impact? "Course Author"

Supporting information

Github link: Video editor supports transcripts (minimal version) frontend-app-authoring#1352
Used in: feat: Enable transcripts for video library [FC-0076] frontend-app-authoring#1596
Internal ticket: FAL-3989

Testing instructions

Follow the testing instructions at: openedx/frontend-app-authoring#1596

Deadline

No rush

Other information

TODO: The transcripts are not copied when you add a library component in a course. This will be fixed in Copy static assets when using a library component in a course (via Problem Bank or Library Content) modular-learning#246

* Add error handler on save video to avoid create sjson * Support transcripts without edx_video_id in definition_to_xml

openedx-webhooks · 2024-12-25T21:16:33Z

Thanks for the pull request, @ChrisChV!

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.

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.

…ary components

…y videos

This is used to be retroactive in copy-paste videos from Library to Course and Course to Library

pomegranited

Hi @ChrisChV , this is working well for the most part, good job dealing with the old transcript code!

But I found a bug with the upstream/downstream syncing, and left a few nits/change requests too.

cms/djangoapps/contentstore/helpers.py

cms/djangoapps/contentstore/views/tests/test_transcripts.py

pomegranited · 2025-01-29T07:41:47Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

@@ -81,13 +84,17 @@ def link_video_to_component(video_component, user):
    edx_video_id = clean_video_id(video_component.edx_video_id)
    if not edx_video_id:
        edx_video_id = create_external_video(display_name='external video')
+
+        if isinstance(video_component.usage_key, UsageKeyV2):
+            return edx_video_id


I don't understand why we're returning early here.. Could you add a comment to clarify?

Updated e4f7c72

Makes sense. But I wonder, should we still be calling create_external_video and returning an edx_video_id at all, if it's not going to be saved into the video block? Doesn't that create some stranded video data in VAL?

cms/djangoapps/contentstore/views/transcripts_ajax.py

openedx/core/djangoapps/content_libraries/api.py

pomegranited · 2025-01-29T07:59:10Z

xmodule/video_block/transcripts_utils.py

+            except AttributeError:
+                pass


Why does this error need to be caught now? Seems a little dangerous.

Updated 5685f16

xmodule/video_block/video_handlers.py

pomegranited · 2025-01-29T09:36:04Z

cms/djangoapps/contentstore/helpers.py

@@ -10,6 +10,7 @@
 import re


I'm seeing a bug when I sync a LibraryBlock video with transcripts from an upstream video.

Steps to reproduce:

Create a library video with transcripts (here, I imported them from the example youtube video).

Publish the library video.

Copy it to the clipboard.

Paste into a course.
Note that the transcripts are displaying fine here.

Re-edit the library video, and replace a transcript. (Here, I replaced the English one, I don't know if replacing others causes the same issue).

Return to the course LibraryBlock, and refresh to see the "updates available" button. Click it.
Note that the upstream video preview shows its transcripts fine, but the downstream (course) video preview doesn't show its transcripts anymore.

Accept changes.
Note that the course video no longer shows its transcripts, but if you edit it, you can see they're still there.

Syncing.upstream.video.breaks.transcripts.mp4

I think this is related to openedx/modular-learning#246

@ChrisChV That could very well be.. however I don't think it's resolved by @DanielVZ96 's #36173, but it's also possible that I didn't merge conflicts accurately. cf my merged branch.

@pomegranited To be safe, I will wait until #36173 is ready to fix this bug.

No worries @ChrisChV , thank you for keeping an eye on this issue.

Now that that other PR is merged, any update on this?

…void raise AttributeError

pomegranited

👍 Thank you for making those changes @ChrisChV ! Code looks and works great.

I tested this using the testing instructions from feat: Enable transcripts for video library [FC-0076] frontend-app-authoring#1596.
I also tested "duplicating" video blocks with transcripts in courses, and they worked too.
I read through the code
I checked for accessibility issues by using my keyboard to navigate
Includes documentation -- good code comments
~~User-facing strings are extracted for translation~~ N/A

pomegranited · 2025-01-30T05:03:41Z

cms/djangoapps/contentstore/helpers.py

@@ -10,6 +10,7 @@
 import re


@ChrisChV That could very well be.. however I don't think it's resolved by @DanielVZ96 's #36173, but it's also possible that I didn't merge conflicts accurately. cf my merged branch.

DanielVZ96

👍

I tested this
I read through the code
I checked for accessibility issues

DanielVZ96 · 2025-02-01T14:35:32Z

cms/djangoapps/contentstore/helpers.py

@@ -299,13 +302,21 @@ def import_staged_content_from_user_clipboard(parent_key: UsageKey, request) ->
            tags=user_clipboard.content.tags,
        )

+        usage_key = new_xblock.scope_ids.usage_id
+        if usage_key.block_type == 'video':


This overlaps a bit with the changes at #36173. Since there are some refactors to these functions here. I'll wait for the merge of this PR to update #36173 with your changes

Since that PR merged first, does this one need to be updated?

bradenmacdonald

This is a big PR so I haven't finished reviewing yet, but here a couple questions so far.

bradenmacdonald · 2025-02-11T18:54:50Z

cms/djangoapps/contentstore/helpers.py

@@ -299,13 +302,21 @@ def import_staged_content_from_user_clipboard(parent_key: UsageKey, request) ->
            tags=user_clipboard.content.tags,
        )

+        usage_key = new_xblock.scope_ids.usage_id


Suggested change

usage_key = new_xblock.scope_ids.usage_id

usage_key = new_xblock.usage_key

If you want, there is now a simpler way to get this :)

bradenmacdonald · 2025-02-11T19:02:59Z

cms/djangoapps/contentstore/helpers.py

+        if usage_key.block_type == 'video':
+            # Adding transcripts to VAL using the new edx_video_id
+            language_code = next((k for k, v in block.transcripts.items() if v == filename), None)
+            if language_code:
+                sjson_subs = Transcript.convert(
+                    content=data,
+                    input_format=Transcript.SRT,
+                    output_format=Transcript.SJSON
+                ).encode()
+                create_or_update_video_transcript(
+                    video_id=block.edx_video_id,
+                    language_code=language_code,
+                    metadata={
+                        'file_format': Transcript.SJSON,
+                        'language_code': language_code
+                    },
+                    file_data=ContentFile(sjson_subs),
+                )


This new code does not seem to match the docstring of the function: "Import a single staged static asset file into the course, unless it already exists." It also doesn't use staged_content_id nor file_data_obj.

I think the code is fine but it should be moved out of _import_file_into_course and into a new helper function like _import_transcripts

bradenmacdonald · 2025-02-11T19:05:24Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

@@ -81,13 +84,17 @@ def link_video_to_component(video_component, user):
    edx_video_id = clean_video_id(video_component.edx_video_id)
    if not edx_video_id:
        edx_video_id = create_external_video(display_name='external video')
+
+        if isinstance(video_component.usage_key, UsageKeyV2):
+            return edx_video_id


Makes sense. But I wonder, should we still be calling create_external_video and returning an edx_video_id at all, if it's not going to be saved into the video block? Doesn't that create some stranded video data in VAL?

bradenmacdonald

@ChrisChV Nice work on a very complex and ugly part of the code 👏🏻. I have a few small changes to request but I think this is just about good to go.

bradenmacdonald · 2025-02-11T22:46:56Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

+                output_format=Transcript.SRT
+            ).encode()
+
+            filename = f"static/{edx_video_id}-{language_code}.srt"


Do we need to put the edx_video_id in the filename? Because transcript-{language_code}.srt would be a much nicer name.

bradenmacdonald · 2025-02-11T22:52:22Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

+            lib_api.require_permission_for_library_key(
+                context_key,
+                request.user,
+                lib_api.lib_permissions.CAN_EDIT_THIS_CONTENT_LIBRARY
+            )
+            return xblock_api.load_block(usage_key, request.user)


There is already a public API for this:

Suggested change

lib_api.require_permission_for_library_key(

context_key,

request.user,

lib_api.lib_permissions.CAN_EDIT_THIS_CONTENT_LIBRARY

)

return xblock_api.load_block(usage_key, request.user)

return xblock_api.load_block(usage_key, request.user, check_permission=CheckPerm.CAN_EDIT)

bradenmacdonald · 2025-02-11T22:53:36Z

openedx/core/djangoapps/content_libraries/api.py

+
+# Allow content library permissions to be used in the public API
+lib_permissions = permissions


See comment above - we shouldn't expose the permissions as part of the API because they're considered internal to the content libraries feature. But you can use the xblock_api.load_block(..., check_permission=...) API to require permissions when you load the block.

bradenmacdonald · 2025-02-11T22:55:29Z

xmodule/tests/test_video.py

@@ -741,6 +741,48 @@ def test_export_to_xml(self, mock_val_api):
            course_id=self.block.scope_ids.usage_id.context_key,
        )

+    def test_export_to_xml_without_video_id(self):
+        """
+        Test that we write the correct XML without video_id on export.


It's a bit unclear from this wording - is this testing "that we write the correct XML for a block that doesn't have a video_id" or is this testing that "the correct XML should not include video_id when exported" ?

bradenmacdonald · 2025-02-11T22:56:43Z

xmodule/video_block/video_handlers.py

-                    delete_video_transcript(video_id=edx_video_id, language_code=language)
+    def _studio_transcript_upload(self, request):
+        """
+        Upload transcript. Usedn in "POST" method in `studio_transcript`


Suggested change

Upload transcript. Usedn in "POST" method in `studio_transcript`

Upload transcript. Used in "POST" method in `studio_transcript`

bradenmacdonald · 2025-02-11T22:56:59Z

xmodule/video_block/video_handlers.py

-                    remove_subs_from_store(self.transcripts.pop(language, None), self, language)
+    def _studio_transcript_delete(self, request):
+        """
+        Delete transcript. Usedn in "DELETE" method in `studio_transcript`


Suggested change

Delete transcript. Usedn in "DELETE" method in `studio_transcript`

Delete transcript. Used in "DELETE" method in `studio_transcript`

bradenmacdonald · 2025-02-11T22:57:15Z

xmodule/video_block/video_handlers.py


+    def _studio_transcript_get(self, request):
+        """
+        Get transcript. Usedn in "GET" method in `studio_transcript`


Suggested change

Get transcript. Usedn in "GET" method in `studio_transcript`

Get transcript. Used in "GET" method in `studio_transcript`

feat: Updates to support save video with transcript in library home

9cdf45f

* Add error handler on save video to avoid create sjson * Support transcripts without edx_video_id in definition_to_xml

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 25, 2024

ChrisChV marked this pull request as draft December 25, 2024 21:16

ChrisChV changed the title ~~feat: Video editor supports transcripts~~ feat: Video editor supports transcripts [FC-0076] Dec 25, 2024

style: Fix lint

3885dd1

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 27, 2024

ChrisChV added 15 commits January 15, 2025 14:50

feat: Updated code to get english transcript from filename

a723e96

style: Fix lint

1c2a575

feat: Upload transcript file as static asset in Learning Core in libr…

74f027f

…ary components

style: Fix lint

2adacee

feat: Updates to support download transcripts from youtube in vlibrar…

0393829

…y videos

style: Fix lint

e27221e

test: Add test for download youtube transcripts in library content

05067f6

style: Fix lint

2f53a75

feat: Support copy transcripts from a library

5c6819a

refactor: Allow use edx_video_id (edxval) in new runtime

95b51e8

This is used to be retroactive in copy-paste videos from Library to Course and Course to Library

refactor: Adds new edx_video_id when copy to course

c42e223

refactor: Remove unnevessary code

4bf3af3

feat: Support delete transcripts in library

1de1d4e

style: Fix lint

a59898d

Merge branch 'master' into chris/FAL-3989-video-transcripts

9173ed8

ChrisChV marked this pull request as ready for review January 29, 2025 01:37

ChrisChV mentioned this pull request Jan 29, 2025

feat: Enable transcripts for video library [FC-0076] openedx/frontend-app-authoring#1596

Open

2 tasks

pomegranited requested changes Jan 29, 2025

View reviewed changes

ChrisChV added 5 commits January 29, 2025 19:30

style: Nits on the code

590a5cd

refactor: Update replace_transcript to verify transcript

0e54450

refactor: Verify LibraryLocatorV2 in manage_video_subtitles_save to a…

5685f16

…void raise AttributeError

style: Add comment in transcripts_ajax.py

e4f7c72

refactor: _get_item to avoid return isLibraryContent

b478ac5

ChrisChV added 2 commits January 29, 2025 21:24

refactor: studio_transcript to separate methods in separated functions

173a0af

refactor: Update code in video_handlers to avoid "static/None"

4532a2a

ChrisChV mentioned this pull request Jan 30, 2025

Copy static assets when using a library component in a course (via Problem Bank or Library Content) openedx/modular-learning#246

Closed

pomegranited approved these changes Jan 30, 2025

View reviewed changes

style: Fix nit

bb10d18

DanielVZ96 approved these changes Feb 1, 2025

View reviewed changes

bradenmacdonald reviewed Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Video editor supports transcripts [FC-0076] #36058

feat: Video editor supports transcripts [FC-0076] #36058

ChrisChV commented Dec 25, 2024 •

edited

Loading

openedx-webhooks commented Dec 25, 2024 •

edited

Loading

pomegranited left a comment

pomegranited Jan 29, 2025

ChrisChV Jan 30, 2025

bradenmacdonald Feb 11, 2025

pomegranited Jan 29, 2025

ChrisChV Jan 30, 2025

pomegranited Jan 29, 2025

ChrisChV Jan 30, 2025

pomegranited Jan 30, 2025

ChrisChV Jan 30, 2025

pomegranited Jan 31, 2025

bradenmacdonald Feb 11, 2025

pomegranited left a comment

pomegranited Jan 30, 2025

DanielVZ96 left a comment

DanielVZ96 Feb 1, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald left a comment

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald left a comment

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

bradenmacdonald Feb 11, 2025

	usage_key = new_xblock.scope_ids.usage_id
	usage_key = new_xblock.usage_key


		# Allow content library permissions to be used in the public API
		lib_permissions = permissions

	Upload transcript. Usedn in "POST" method in `studio_transcript`
	Upload transcript. Used in "POST" method in `studio_transcript`

	Delete transcript. Usedn in "DELETE" method in `studio_transcript`
	Delete transcript. Used in "DELETE" method in `studio_transcript`

	Get transcript. Usedn in "GET" method in `studio_transcript`
	Get transcript. Used in "GET" method in `studio_transcript`

feat: Video editor supports transcripts [FC-0076] #36058

Are you sure you want to change the base?

feat: Video editor supports transcripts [FC-0076] #36058

Conversation

ChrisChV commented Dec 25, 2024 • edited Loading

Description

Supporting information

Testing instructions

Deadline

Other information

openedx-webhooks commented Dec 25, 2024 • edited Loading

pomegranited left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pomegranited left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielVZ96 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradenmacdonald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradenmacdonald left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChrisChV commented Dec 25, 2024 •

edited

Loading

openedx-webhooks commented Dec 25, 2024 •

edited

Loading