Skip to content

Ability to delete video resources #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ibrahimjaved12
Copy link
Contributor

What are the relevant tickets?

Closes https://github.com/mitodl/hq/issues/2991

Description (What does it do?)

Adds the ability to delete all kinds of video resources according to the plan specified in: https://github.com/mitodl/hq/issues/2991#issuecomment-2651158964

Screenshots (if appropriate):

  • Desktop screenshots
  • Mobile width screenshots

How can this be tested?

Additional Context

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @ibrahimjaved12, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request implements the functionality to delete video resources. It modifies both the frontend and backend to control the display of the delete option and determine deletability based on resource type. The changes ensure that only video resources can be deleted, as specified in the linked issue.

Highlights

  • Feature: Delete Video Resources: This PR introduces the ability to delete video resources within the application, addressing issue #2991.
  • Frontend Changes: The RepeatableContentListing component is updated to conditionally display the 'Delete' option based on the is_deletable_by_resourcetype property of the content item.
  • Backend Changes: The WebsiteContentSerializer is modified to include a new field, is_deletable_by_resourcetype, which determines if a video resource can be deleted based on its resourcetype metadata.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds the ability to delete video resources by introducing the is_deletable_by_resourcetype flag in the WebsiteContent serializer, which is used to conditionally render the 'Delete' option on the frontend.

if obj.type != CONTENT_TYPE_RESOURCE:
return True
# for resources only, check metadata.resourcetype === "Video"
return (obj.metadata or {}).get("resourcetype") == "Video"

Choose a reason for hiding this comment

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

medium

Consider using the RESOURCE_TYPE_VIDEO constant from websites.constants for maintainability.

Suggested change
return (obj.metadata or {}).get("resourcetype") == "Video"
return (obj.metadata or {}).get("resourcetype") == RESOURCE_TYPE_VIDEO

@pdpinch
Copy link
Member

pdpinch commented Jun 24, 2025

Thanks for picking this up again @ibrahimjaved12. The OCW team was just asking me about it.

Since the there's a lot of discussion on the issue about the scope of this, can you please explain in detail what this PR does? If it's multiple steps, you might consider breaking it into several PRs.

@ibrahimjaved12
Copy link
Contributor Author

ibrahimjaved12 commented Jun 25, 2025

Since the there's a lot of discussion on the issue about the scope of this, can you please explain in detail what this PR does? If it's multiple steps, you might consider breaking it into several PRs.

@pdpinch
We have a) Legacy videos b) Gdrive Videos c) pre-existing YT videos. This PR will allow thorough deletion of each of these video kinds with their respective associations (e.g., caption/transcript files, gdrive files, s3 files, thumbnails (if any), and their corresponding objects from the database).

We already have the generic delete env var configuration:
OCW_STUDIO_DELETABLE_CONTENT_TYPES=external-resource,instructor,page,course-collection,
we will add resource here but that means it would enable delete for all kinds of resources (images, videos, pdfs, captions, etc). What I have done so far is limit the resource-deletion to video resources only.
So this allows video's WebsiteContent objects to be deleted, but that's only a very small part of the overall plan.

But more importantly, I just found out that when we embed videos or images, they do not appear as referenced. This is important because when we allow video deletion, we will also need to show the error in the Dialog like we do for other content types that it cannot be deleted because it's currently being referenced. This can be considered a separate task, @umar8hassan said he will work on this. @umar8hassan Could you please create the ticket for it as well?

Here is the detailed deletion-only plan from the ticket:

Unified Deletion Flow:

  1. Start with the WebsiteContent resource for the video. Using its UUID, check if there's a DriveFile object for the resource.
  2. If a DriveFile exists (It's Gdrive-based video):
    • Call delete_drive_file(), which currently calls:
        - drive_file.resource.delete()(deletes WebsiteContent object)
        - drive_file.video.delete() (deletes the Video object; this triggers the pre_delete signal that currently removes transcripts. We'll update it to call a standalone cleanup function for both transcripts and captions instead)
      • drive_file.delete() (deletes the DriveFile object)
    • However, before calling drive_file.delete(), invoke the Google Drive API (using get_drive_service()) to delete the file from GDrive.
    • Finally, call drive_file.delete() to remove the DriveFile object.
      • This triggers the pre_delete signal for the DriveFile object, which calls delete_s3_objects() and removes the file from the S3 bucket (AWS_STORAGE_BUCKET_NAME).
  3. If no DriveFile object exists (Legacy or pure YouTube resource):
    • Check if archive_url exists in the WebsiteContent metadata.
      • If archive_url exists: (Legacy video)
        • Delete the WebsiteContent object
        • Remove the associated video file from S3 (using S3 deletion function, e.g. delete_s3_objects())
        • Call the cleanup function to remove associated transcript and caption files.
      • If archive_url does not exist (pure Youtube resource):
        • Delete the WebsiteContent object and associated transcript/caption files via the cleanup function.

Other stuff:

  1. Making sure embedded videos/images show as referenced
  2. Update .env.example and maybe README for the recent changes we have done. This is only partly related to this PR, but we should do it. I brought this up here because when we added the delete functionality for other content types, we didn't update the example env (and README?). Also, Carey was reviewing a PR related to delete functionality Dialog, and he had trouble because .env.example is outdated and there is no documentation on it on the recent changes, like posthog feature flags, heroku config vars for deletion, etc.

Only these two should be worked on separate PRs/on parallel.

@ibrahimjaved12 ibrahimjaved12 force-pushed the ibrahim/2991-delete-video-resources branch from 57897f7 to 064f654 Compare June 26, 2025 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants