Skip to content

feat: remove legacy library content block from component templates - #38930

Merged
kdmccormick merged 3 commits into
masterfrom
salman/remove-legacy-library-support
Aug 10, 2026
Merged

feat: remove legacy library content block from component templates#38930
kdmccormick merged 3 commits into
masterfrom
salman/remove-legacy-library-support

Conversation

@salman2013

@salman2013 salman2013 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes the library template from the Studio add-component strip, preventing creation of new LegacyLibraryContentBlock instances via the UI
  • Removes 'library' from COMPONENT_TYPES, its display name entry, the library block types loop, the component_not_supported_by_library list, and the libraries_v1_enabled() filter in _filter_disabled_blocks

Existing library_content blocks are fully unaffected:

  • Randomized settings editor continues to work
  • "View all" still navigates to the MFE-based children view
  • Migration to v2 libraries still works

Companion frontend PR: openedx/frontend-app-authoring#3180

Ticket: #38058

Test plan

  • Verify the "Legacy Library Content" button no longer appears in the add-component strip on a course unit
  • Verify existing library_content blocks still render correctly
  • Verify the randomized settings editor still works on existing legacy library content blocks
  • Verify "View all" still navigates to the MFE-based children view
  • Verify migration of legacy library content blocks to v2 still works

Testing Results

Screenshot 2026-07-28 at 10 56 39 PM

Removes the 'library' template from the Studio add-component strip so that
new LegacyLibraryContentBlock instances can no longer be created via the UI.

- Removes 'library' from COMPONENT_TYPES
- Removes 'library' display name entry from component_display_names
- Removes the library block types loop (category == 'library')
- Removes 'library' from component_not_supported_by_library
- Removes the libraries_v1_enabled() filter from _filter_disabled_blocks

Existing library_content blocks continue to work normally, including the
randomized settings editor, "View all" container navigation, and migration
to v2 libraries. Only creation of new blocks via the add-component UI is
prevented.

Refs: #38058

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jul 28, 2026
@openedx-webhooks

openedx-webhooks commented Jul 28, 2026

Copy link
Copy Markdown

Thanks for the pull request, @salman2013!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kdmccormick

kdmccormick commented Jul 28, 2026

Copy link
Copy Markdown
Member

The approach looks good! Can you also confirm that the legacy library block doesn't show up under "Advanced" ?

Please have someone else from Aximprovements review as well @salman2013 and then I'll approve and merge.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jul 28, 2026
The assertion that a 'library' component template exists is no longer
valid after removing 'library' from COMPONENT_TYPES.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013

Copy link
Copy Markdown
Contributor Author

The advanced component is not showing the legacy library component.
Screenshot 2026-08-05 at 12 53 22 PM

@farhan farhan 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.

I have tested the PR manually, PR looks good to me.

I got confused while ready docs from https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/use_randomized_content_blocks.html#add-a-randomized-content-block-to-your-course

Select Advanced, and then select Randomized Content Block. The randomized content block is added to your unit.

This line needs to be updated, make sure we have followup story to update the docs

@kdmccormick

Copy link
Copy Markdown
Member

good call out @farhan . we have a story here: openedx/docs.openedx.org#1396 . I added the docs you found to it.

@kdmccormick
kdmccormick merged commit d29e27c into master Aug 10, 2026
46 checks passed
@kdmccormick
kdmccormick deleted the salman/remove-legacy-library-support branch August 10, 2026 13:44
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Aug 10, 2026
@kdmccormick

Copy link
Copy Markdown
Member

Thanks @salman2013 !

I added an exclamation point to the commit type (feat!:) and added a BREAKING CHANGE note to the commit: d29e27c. Please make sure to do that going forward as it will help our release notes auto-generate with the right breaking change notices.

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

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants