feat(authz): [FC-0099] create toggle to make a library plublic read #25

dcoa · 2025-10-27T02:46:59Z

Description

This PR creates a toggle component that updates the library metadata to allow public read. This to keep compatibility with the current functionality in Libraries Manage team modal.

Behavior

With manage team, The user can turn the toggle On/Off. When the save succeeds, a toast is displayed.
Without manage team and toggle Off, the user does not see the toggle.
Without manage team and toggle On, the user sees it but cannot change it.

Extra information

US: Allow reuse of library content by all Studio users openedx-authz#52

Evidence

Manage Team Permissions

Only View Permissions

Toggle On

Toggle off

Test Instructions

Have a instance with https://github.com/openedx/openedx-authz Django Plugin
Load the policies in the lms container with "./manage lms load_policies"
Create a library
Use http://local.openedx.io:8000/api-docs/#/ to grand roles.
Add 2 users to the library team one with library_admin role and the other one with library_user role
Test the admin can see and edit the toggle.
Test the user can see the toggle when is enable and not see the toggle when the feature is disabled.

openedx-webhooks · 2025-10-27T02:47:04Z

Thanks for the pull request, @dcoa!

This repository is currently maintained by @openedx/committers-frontend.

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 · 2025-10-27T02:49:34Z

Codecov Report

❌ Patch coverage is 96.07843% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.14%. Comparing base (8dc3139) to head (1ce31ac).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
.../libraries-manager/components/PublicReadToggle.tsx	88.88%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #25      +/-   ##
==========================================
+ Coverage   93.86%   94.14%   +0.27%     
==========================================
  Files          43       44       +1     
  Lines         799      837      +38     
  Branches      159      169      +10     
==========================================
+ Hits          750      788      +38     
- Misses         46       47       +1     
+ Partials        3        2       -1

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

brian-smith-tcril

Overall this looks great!

I left one comment with a change request that I consider blocking, but the rest of the comments don't need to be addressed for this to land.

Thank you so much for all the great work on this!

brian-smith-tcril · 2025-10-27T15:15:44Z

src/authz-module/libraries-manager/components/messages.ts

+  'libraries.authz.public.read.toggle.success': {
+    id: 'libraries.authz.public.read.toggle.success',
+    defaultMessage: 'The library setting has been updated successfully.',
+    description: 'Sucessfull message for allow public read',


Suggested change

description: 'Sucessfull message for allow public read',

description: 'Success message for allow public read',

brian-smith-tcril · 2025-10-27T15:22:55Z

src/authz-module/data/hooks.test.tsx

  });
 });
+
+describe('useUpdateLibrary', () => {


These tests appear to only be testing that the title can be updated properly. Not blocking, but it'd be nice to have tests verifying each part of LibraryMetadata that can be updated via this endpoint is updated properly.

src/authz-module/components/AuthZTitle.tsx

src/authz-module/index.scss

brian-smith-tcril

I noticed some strange behavior with the divider after pulling latest and testing locally

Starting large

Screencast.From.2025-10-28.13-40-22.mp4

Starting small

Screencast.From.2025-10-28.13-41-26.mp4

src/authz-module/components/AuthZTitle.tsx

brian-smith-tcril

LGTM!

brian-smith-tcril · 2025-10-29T04:18:35Z

src/authz-module/components/AuthZTitle.tsx

+  const { width = window.innerWidth } = useWindowSize();
+  const minWidth = breakpoints.large?.minWidth || 1200;
+  const isDesktop = width > minWidth;


I'm not a huge fan of needing to do this, but I'm OK with it as a workaround.

I tried digging into why useMediaQuery wasn't responding to resizes and it's very strange. In my testing it even seemed to work as expected sometimes but not all, so it really isn't making sense to me.

I know Paragon just passes through useMediaQuery from react-responsive, but I couldn't find any issues on that repo that seemed to match what we're seeing here.

I made a Paragon issue to track this openedx/paragon#3958

Seems like installing react-responsive directly works, but not sure why using the imported version for Paragon does not behaves correctly.

I'm happy to install the library for better workaround, if you agree.

It looks like Paragon's version of react-responsive was updated to v10 in openedx/paragon#3895, which released in Paragon 23.14.8.

This MFE is using 23.14.2

frontend-app-admin-console/package-lock.json

Lines 6973 to 6974 in 8dc3139

"node_modules/@openedx/paragon": {

"version": "23.14.2",

Does it work if you update the version of Paragon this MFE is using to ^23.14.8?

It does!! 🎉

brian-smith-tcril

Re-approving with the Paragon bump fixing useMediaQuery!

dcoa added 3 commits October 27, 2025 13:45

refactor: modify actions to add splitter

87dcf70

feat: add API function to update the library metadata

4ed28ad

feat: create a toggle component to make the library public read

0e5b53f

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 Oct 27, 2025

openedx-webhooks added this to Contributions Oct 27, 2025

github-project-automation bot moved this to Needs Triage in Contributions Oct 27, 2025

refactor: update behaviour depending on user permissions

757f76f

dcoa force-pushed the dcoa/toggle-plublic-read branch from 7fcea7f to 9d73b3d Compare October 27, 2025 05:45

feat: add success toast

b387aba

dcoa force-pushed the dcoa/toggle-plublic-read branch from 9d73b3d to b387aba Compare October 27, 2025 05:48

dcoa requested review from arbrandes, brian-smith-tcril and jacobo-dominguez-wgu October 27, 2025 05:58

dcoa added this to RBAC AuthZ Board Oct 27, 2025

dcoa moved this to Ready for review in RBAC AuthZ Board Oct 27, 2025

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 27, 2025

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Oct 27, 2025

brian-smith-tcril requested changes Oct 27, 2025

View reviewed changes

dcoa added 2 commits October 28, 2025 03:28

refactor: use stack to display the actions

968e317

style: fix typo

82b5f05

brian-smith-tcril reviewed Oct 27, 2025

View reviewed changes

src/authz-module/components/AuthZTitle.tsx Show resolved Hide resolved

src/authz-module/index.scss Outdated Show resolved Hide resolved

src/authz-module/index.scss Outdated Show resolved Hide resolved

style: add mx-5 to divider to avoid wide growth

8ee18c3

dcoa force-pushed the dcoa/toggle-plublic-read branch from 218b4a9 to 8ee18c3 Compare October 27, 2025 23:47

dcoa mentioned this pull request Oct 28, 2025

feat(authz): [FC-0099] Manage action feedback using the Toast component. #26

Merged

brian-smith-tcril reviewed Oct 28, 2025

View reviewed changes

dcoa commented Oct 29, 2025

View reviewed changes

src/authz-module/components/AuthZTitle.tsx Show resolved Hide resolved

brian-smith-tcril mentioned this pull request Oct 29, 2025

useMediaQuery not updating on resize? openedx/paragon#3958

Closed

brian-smith-tcril approved these changes Oct 29, 2025

View reviewed changes

chore: update paragon to work with useMediaQuery

1ce31ac

dcoa force-pushed the dcoa/toggle-plublic-read branch from 29289d8 to 1ce31ac Compare October 29, 2025 19:00

brian-smith-tcril approved these changes Oct 29, 2025

View reviewed changes

brian-smith-tcril merged commit 9fef270 into openedx:master Oct 29, 2025
6 checks passed

github-project-automation bot moved this from Ready for review to Done in RBAC AuthZ Board Oct 29, 2025

github-project-automation bot moved this from Ready for Review to Done in Contributions Oct 29, 2025

	description: 'Sucessfull message for allow public read',
	description: 'Success message for allow public read',

feat(authz): [FC-0099] create toggle to make a library plublic read #25

feat(authz): [FC-0099] create toggle to make a library plublic read #25

Uh oh!

Conversation

dcoa commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

openedx-webhooks commented Oct 27, 2025

Uh oh!

codecov bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Starting large

Starting small

Uh oh!

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

dcoa Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

dcoa Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dcoa commented Oct 27, 2025 •

edited

Loading

codecov bot commented Oct 27, 2025 •

edited

Loading