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.

pomegranited · 2025-01-29T07:37:13Z

cms/djangoapps/contentstore/helpers.py

@@ -616,6 +630,24 @@ def _import_file_into_course(
        if thumbnail_content is not None:
            content.thumbnail_location = thumbnail_location
        contentstore().save(content)
+        if usage_key.block_type == 'video':
+            # Adding transcripts to VAL using the nex edx_video_id


nit: typo

Suggested change

# Adding transcripts to VAL using the nex edx_video_id

# Adding transcripts to VAL using the new edx_video_id

pomegranited · 2025-01-29T07:39:52Z

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

+        response = self.replace_transcript(self.library_block.usage_key, self.youtube_id)
+
+        # Verify the response
+        self.assert_response(response, expected_status_code=200, expected_message='Success')


Could you also test that the transcript is replaced as expected?

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?

pomegranited · 2025-01-29T07:44:57Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

+        except NotFoundError:
+            log.debug("Can't find transcripts in storage for youtube id: %s", youtube_id)
+
+    #check youtube local and server transcripts for equality


nit: pylint should have caught this?

Suggested change

#check youtube local and server transcripts for equality

# check youtube local and server transcripts for equality

pomegranited · 2025-01-29T07:49:14Z

cms/djangoapps/contentstore/views/transcripts_ajax.py

+            edx_video_id,
+            input_format,
+            transcript_content,
+            language_code='en',


I know you're dealing with the old transcripts code here, which is really convoluted.. but why is the language code hard-coded here (and below on save_video_transcript)? A comment would help :)

pomegranited · 2025-01-29T07:57:25Z

openedx/core/djangoapps/content_libraries/api.py

@@ -1952,3 +1952,6 @@ def import_blocks_create_task(library_key, course_key, use_course_key_as_block_i
    log.info(f"Import block task created: import_task={import_task} "
             f"celery_task={result.id}")
    return import_task
+
+# To enable use content library permissions as public API


nit: grammar

Suggested change

# To enable use content library permissions as public API

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

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.

pomegranited · 2025-01-29T08:05:06Z

xmodule/video_block/video_handlers.py

@@ -497,6 +498,7 @@ def studio_transcript(self, request, dispatch):
        """
        _ = self.runtime.service(self, "i18n").ugettext

+        # pylint: disable=too-many-nested-blocks


nit: pylint is not wrong :/

Could this massive method be refactored into _studio_transcript_upload, _studio_transcript_delete, and _studio_transcript_get ? Unless that means we have to add more tests..

pomegranited · 2025-01-29T08:11:02Z

xmodule/video_block/video_handlers.py

+                    transcript_file_path = f"static/{self.transcripts.pop(language, None)}"
+                    lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, transcript_file_path)


If transcript_file_path == "static/None", I think delete_library_block_static_asset_file raises a validation error. By contrast, the remove_subs_from_store method just passes if the transcript file isn't found.

So maybe we should check for that here (at the risk of enraging pylint further..):

Suggested change

transcript_file_path = f"static/{self.transcripts.pop(language, None)}"

lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, transcript_file_path)

transcript_path = self.transcripts.pop(language, None)

if transcript_path:

lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, f"static/{transcript_path}")

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

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

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

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

pomegranited left a comment

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

pomegranited Jan 29, 2025

	# Adding transcripts to VAL using the nex edx_video_id
	# Adding transcripts to VAL using the new edx_video_id

	#check youtube local and server transcripts for equality
	# check youtube local and server transcripts for equality

	# To enable use content library permissions as public API
	# Allow content library permissions to be used in the public API

		transcript_file_path = f"static/{self.transcripts.pop(language, None)}"
		lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, transcript_file_path)

-                    transcript_file_path = f"static/{self.transcripts.pop(language, None)}"
-                    lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, transcript_file_path)
+                    transcript_path = self.transcripts.pop(language, None)
+                    if transcript_path:
+                        lib_api.delete_library_block_static_asset_file(self.scope_ids.usage_id, f"static/{transcript_path}")

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

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

Where can I find more information?

When can I expect my changes to be merged?

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

ChrisChV commented Dec 25, 2024 •

edited

Loading

openedx-webhooks commented Dec 25, 2024 •

edited

Loading