Skip to content

Moving allow public read switch from admin console#2942

Merged
arbrandes merged 2 commits intoopenedx:masterfrom
WGU-Open-edX:public-read-switch
Mar 18, 2026
Merged

Moving allow public read switch from admin console#2942
arbrandes merged 2 commits intoopenedx:masterfrom
WGU-Open-edX:public-read-switch

Conversation

@jacobo-dominguez-wgu
Copy link
Copy Markdown
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Mar 13, 2026

Description

Adding the "Allow public read" switch into the sidebar on the library page.
This feature was moved from admin-console since we are also supporting courses there and it is not gonna be exclusive for libraries anymore.

Useful information to include:
Resolves #2925
PR removing feature on admin console: openedx/frontend-app-admin-console#99

image

Testing instructions

  • Go to studio http://studio.local.openedx.io:8001/
  • On the Libraries Tab select any of the libraries (be sure you have manage permissions over that library, if not the switch is going to be disabled)
  • When in the library page, click on the "Library Info" button to show the Info sidebar (It maybe visible by default).
  • The switch should appear under the "Settings" subtitle.
  • Click on the switch to toggle public read of the library.

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'

@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 Mar 13, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @jacobo-dominguez-wgu!

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
Copy link
Copy Markdown

codecov Bot commented Mar 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.51%. Comparing base (24e1c73) to head (d40370f).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2942   +/-   ##
=======================================
  Coverage   95.51%   95.51%           
=======================================
  Files        1329     1330    +1     
  Lines       30557    30582   +25     
  Branches     6925     6927    +2     
=======================================
+ Hits        29186    29211   +25     
  Misses       1303     1303           
  Partials       68       68           

☔ View full report in Codecov by Sentry.
📢 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.

Copy link
Copy Markdown
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

I tested this and it works as advertised, nice!

I have some concerns about the code, though, as seen below.

Comment thread src/library-authoring/library-info/LibraryInfo.test.tsx Outdated
Comment thread src/library-authoring/library-info/LibraryInfo.tsx Outdated
Comment thread src/library-authoring/components/PublicReadToggle.tsx
Comment thread src/library-authoring/components/PublicReadToggle.test.tsx Outdated
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Mar 17, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Mar 17, 2026
Copy link
Copy Markdown
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Thanks! A couple more observations inline below.

Comment thread src/library-authoring/components/PublicReadToggle.tsx Outdated
Comment thread src/library-authoring/components/PublicReadToggle.tsx Outdated
Comment thread src/library-authoring/components/PublicReadToggle.test.tsx Outdated
Comment thread src/library-authoring/components/PublicReadToggle.tsx Outdated
Comment on lines +24 to +26
onError: () => {
showToast(formatMessage(messages.publicReadToggleDefaultError));
},
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.

Do we still need the onError, or is the catch() below enough?

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.

Yes we need both, onError catches errors like 400 and 500 errors and catch() handles JS runtime errors, React Query errors or network errors with no http status.

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 did some research, and it doesn't look like we need it. getAuthenticatedHttpClient() rejects the promise for any non-2xx status by default, so 400s and 500s will also be caught by .catch().

(Another way to look at it: if we did need an onError, then the rest of this codebase that uses mutateAsync would be missing it.)

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.

Good to know, I have removed the onError, thanks!

Copy link
Copy Markdown
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Looks good!

@arbrandes arbrandes merged commit 4d5c583 into openedx:master Mar 18, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Mar 18, 2026
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). mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). 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.

Task - RBAC AuthZ - Add the Allow public read switch to the library page

5 participants