Skip to content

feat: Revert ability to create Legacy Libraries - #3077

Merged
bradenmacdonald merged 2 commits into
openedx:masterfrom
salman2013:salman/remove-legacy-library
Jun 18, 2026
Merged

feat: Revert ability to create Legacy Libraries#3077
bradenmacdonald merged 2 commits into
openedx:masterfrom
salman2013:salman/remove-legacy-library

Conversation

@salman2013

@salman2013 salman2013 commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Description

In this PR, we reverted the code that added the ability to create legacy libraries.
Ref: #2551

Ticket: openedx/openedx-platform#38056

Testing instructions

Getting there:

  • Open Studio, log in as staff / course creator
  • Go to the "Legacy Libraries" tab
  • Hit "+ New Library"
  • You should brought to the new CreateLegacyLibraries page.

Test v2 CreateLibrary unchanged:

  • In Studio, go to the "Libraries (Beta)" tab
  • Hit "+ New Library"
  • You should be brought to the regular v2 "Create Library" page.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

Settings

EDX_PLATFORM_REPOSITORY: https://github.com/openedx/openedx-platform.git
EDX_PLATFORM_VERSION: master

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 Jun 3, 2026
@openedx-webhooks

openedx-webhooks commented Jun 3, 2026

Copy link
Copy Markdown

Thanks for the pull request, @salman2013!

This repository is currently maintained by @bradenmacdonald.

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.

@codecov

codecov Bot commented Jun 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.64%. Comparing base (3f531d5) to head (07dc024).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3077      +/-   ##
==========================================
+ Coverage   95.61%   95.64%   +0.02%     
==========================================
  Files        1391     1403      +12     
  Lines       33075    33307     +232     
  Branches     7680     7812     +132     
==========================================
+ Hits        31626    31855     +229     
- Misses       1384     1389       +5     
+ Partials       65       63       -2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR removes the in-app “Create Legacy Library” flow and instead routes legacy-library creation users to the Studio “home_library” page via a direct URL.

Changes:

  • Update StudioHome “New library” behavior for legacy (v1) libraries to open ${STUDIO_BASE_URL}/home_library.
  • Update StudioHome tests to assert window.open is called instead of SPA navigation.
  • Remove legacy library creation UI/API/hooks/messages and the /libraries-v1/create route/export.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/studio-home/StudioHome.tsx Opens legacy library creation via window.open to home_library instead of client-side routing.
src/studio-home/StudioHome.test.tsx Updates expectation to window.open for legacy library creation.
src/library-authoring/index.tsx Removes export for legacy library creation component.
src/library-authoring/create-legacy-library/messages.ts Deletes legacy create-library i18n messages.
src/library-authoring/create-legacy-library/index.ts Deletes legacy create-library module export.
src/library-authoring/create-legacy-library/data/apiHooks.ts Deletes legacy create-library mutation hook.
src/library-authoring/create-legacy-library/data/api.ts Deletes legacy create-library API helper.
src/library-authoring/create-legacy-library/CreateLegacyLibrary.tsx Deletes legacy create-library page/component.
src/library-authoring/create-legacy-library/CreateLegacyLibrary.test.tsx Removes tests for deleted legacy create-library flow.
src/index.jsx Removes /libraries-v1/create route and CreateLegacyLibrary import usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/studio-home/StudioHome.tsx Outdated
Comment on lines +111 to +112
// Studio home library for legacy libraries
window.open(`${getConfig().STUDIO_BASE_URL}/home_library`);

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.

Actually we need to remove window.open completely - see comment below.

Comment thread src/studio-home/StudioHome.test.tsx Outdated
Comment thread src/studio-home/StudioHome.test.tsx Outdated
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 4, 2026
Comment thread src/index.jsx
@irfanuddinahmad

Copy link
Copy Markdown

Two non-code notes:

Testing instructions are stale — the "Getting there" section still says "You should be brought to the new CreateLegacyLibraries page", but that page no longer exists. The instructions should describe what actually happens now (e.g. a new browser tab opens to {STUDIO_BASE_URL}/home_library).

Commit typefeat: is semantically odd for a pure deletion of a deprecated feature. The referenced ticket (#2551) was the feat that added this; this PR is reverting it, so revert: (which is in the allowed type-enum) would be the most accurate type.

@salman2013

Copy link
Copy Markdown
Contributor Author

@irfanuddinahmad This PR is actually the revert of this #2551 I did not make any improvement or any other code addition.

{intl.formatMessage(messages.addNewLibraryBtnText)}
</Button>,
);
}

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.

This whole thing needs to be radically simplified:

  • We don't want to send users to ${getConfig().STUDIO_BASE_URL}/home_library - that's a legacy UI page for creating v1 libraries. Instead we want to remove all references to creating a v1 library.
  • Remove showNewLibraryButton, showV2LibraryURL, showV2LibraryURL, showNewLibraryV2Button - we don't need these flags anymore. We just need one, canCreateNewLibrary (does the user have permission to create v2 libraries?)
  • Do not use imperative navigate or window.open. Use <Button as="link" ...> instead, since this goes to a new URL.
Suggested change
if (canCreateNewLibrary) {
headerButtons.push(
<Button
as={Link}
to="/library/create"
variant="outline-primary"
iconBefore={AddIcon}
size="sm"
>
<FormattedMessage {...messages.addNewLibraryBtnText}/>
</Button>,
);
}

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.

@bradenmacdonald
As I understand it, the canCreateNewLibrary flag does not currently exist. The showNewLibraryV2Button field is provided by the backend and indicates whether the user has permission to create a new library.

I see two possibilities:

  1. Introduce a new flag in hooks.tsx, for example:

    const canCreateNewLibrary = librariesV2Enabled && showNewLibraryV2Button;
  2. Since we plan to remove showNewLibraryV2Button, are you suggesting introducing a new backend flag to represent this permission instead?

Could you clarify which approach you have in mind?

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 was thinking 1. A new variable that represents that libraries v2 are (A) enabled and (B) that the user has permission. But you can keep them split up as two separate variables, if you prefer.

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.

Thanks for those changes. This looks good now. Do you want me to review and merge?

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.

@bradenmacdonald Yes please review the changes and if they look fine to you, merge them. Thanks

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

Thanks! However a simple revert is not the right solution here, as the code we had before still includes some way to create a legacy library. So we need to update this to remove it completely.

Removes all legacy library creation UI, flags, and routing.
Replaces showNewLibraryButton/showNewLibraryV2Button with a single
canCreateNewLibrary flag computed in the hook, and uses declarative
Link navigation instead of imperative navigate/window.open.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013 salman2013 added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jun 18, 2026
@salman2013 salman2013 closed this Jun 18, 2026
@salman2013 salman2013 reopened this Jun 18, 2026
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Jun 18, 2026
@kdmccormick

kdmccormick commented Jun 18, 2026

Copy link
Copy Markdown
Member

Adding some more clarity:

There used to be a legacy frontend page to create Legacy Libraries. It was removed here: openedx/openedx-platform#37454

But, we weren't ready to remove Legacy Libraries yet at that point. So we had to add a temporary MFE frontend page to create Legacy Libraries: #2551 . Reverting that PR will remove the MFE frontend page, which is why I'd suggested it in the parent ticket.

However, as @bradenmacdonald pointed out, it seems like there also underlying Legacy Library creation logic which was shared by both the legacy frontend page and the MFE frontend page, and we will need to remove that too.

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

Thanks!

@bradenmacdonald
bradenmacdonald merged commit 3b6ae01 into openedx:master Jun 18, 2026
16 of 17 checks passed
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). create-sandbox open-craft-grove should create a sandbox environment from this PR 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