Skip to content

fix: Transcripts in downstream creation [FC-0076] - #36509

Merged
ChrisChV merged 6 commits into
openedx:masterfrom
open-craft:chris/FAL-4137-fix-transcripts-downstream
Apr 16, 2025
Merged

fix: Transcripts in downstream creation [FC-0076]#36509
ChrisChV merged 6 commits into
openedx:masterfrom
open-craft:chris/FAL-4137-fix-transcripts-downstream

Conversation

@ChrisChV

@ChrisChV ChrisChV commented Apr 10, 2025

Copy link
Copy Markdown
Contributor

Description

Fix the issue described in openedx/frontend-app-authoring#1352 (comment)

Supporting information

Github issue: openedx/frontend-app-authoring#1352 (comment)

Testing instructions

  • Go to a unit in a course
  • Create a video, you can use this video URL. Add transcripts. You can use this files.
  • Copy the video and paste it in a library.
  • Verify that the video in the library has the transcripts.
  • Publish the video in the library
  • Go to the unit and add a Library Content. Search and add the video copied in the library.
  • Verify that the new video block (downstream) created in the course has the transcripts.

Deadline

ASAP

Other information

N/A

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 10, 2025
@openedx-webhooks

Copy link
Copy Markdown

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.

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.

@pomegranited pomegranited left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 @ChrisChV This is working as described and fixes the bug -- one nit to see if we can avoid saving downstream_xblock twice.

  • I tested this using the PR testing instructions. Also tested that syncing library updates to the course video block doesn't disrupt this added edx_video_id.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation -- code comment explaining why
  • User-facing strings are extracted for translation N/A

# If the `downstream_xblock` is a new created block, we need to create
# a new `edx_video_id` to import the transcripts.
downstream_xblock.edx_video_id = create_external_video(display_name='external video')
store.update_item(downstream_xblock, request.user.id)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: Do we need to save the downstream_xblock here? _insert_static_files_into_downstream_xblock also performs an update_item.

Suggested change
store.update_item(downstream_xblock, request.user.id)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

And is there any way to add a test for this case, so we don't accidentally break it in future?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

nit: Do we need to save the downstream_xblock here? _insert_static_files_into_downstream_xblock also performs an update_item.

@pomegranited I think it's necessary here, because the update_item in _insert_static_files_into_downstream_xblock is conditional on substitutions, and I'm not sure if those conditions will always apply. What do you think?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah sorry, I didn't read the full context of that call. This is fine as is!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

And is there any way to add a test for this case, so we don't accidentally break it in future?

Tests added: e05d8d4

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 10, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Apr 14, 2025
@pomegranited
pomegranited requested a review from rpenido April 15, 2025 05:19

@rpenido rpenido left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍
Thank you for your work, @ChrisChV!

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@bradenmacdonald bradenmacdonald left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should maybe add a FIXME: comment that the sync code shouldn't have any special cases for specific block types like video in the future. But video is so messy this is probably a reasonable option for now.

@ChrisChV
ChrisChV enabled auto-merge (squash) April 16, 2025 16:51
@ChrisChV
ChrisChV merged commit 581596b into openedx:master Apr 16, 2025
@ChrisChV
ChrisChV deleted the chris/FAL-4137-fix-transcripts-downstream branch April 16, 2025 17:11
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Apr 16, 2025
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants