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

dcoa · 2025-10-27T16:39:24Z

Toast Notification for Feedback

Surface errors via toasts while keeping the modal open. This ensures they can retry or correct input without losing context, improving usability and reducing frustration.

Note

This PR needs to be rebased after #25 is merged.
I'm working in the coverage but decided to open because is a quite large and complex PR.

Changes:

Add team member (single or multiple entries).
Add role (single entry).
On save failure: show toast in page context, keep modal open.
Disable primary action while request is in flight to prevent duplicate calls.
On success: close modal, refresh view, show success toast.

Error Handling:

Transient errors (Retryable): 500, 502, 5XX generic, 503, timeout, generic server failure
- Toast shows Retry, modal remains open
- Retry disables while request is in flight, sends a single retry request
- Validation errors (Non-retryable): user not found, mixed multiple entries
- Toast summarizes counts (e.g., 2 added, 1 not found)
- Modal remains open, failed entries retained for correction

Evidence

Screencast.from.2025-10-29.00-05-31.webm

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.
Test the toast are visible after actions trigger.

openedx-webhooks · 2025-10-27T16:39:29Z

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-28T01:57:56Z

Codecov Report

❌ Patch coverage is 94.81481% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.32%. Comparing base (9fef270) to head (ea8ea6b).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
.../AddNewTeamMemberModal/AddNewTeamMemberTrigger.tsx	94.11%	3 Missing ⚠️
.../libraries-manager/components/PublicReadToggle.tsx	80.00%	2 Missing ⚠️
...z-module/libraries-manager/ToastManagerContext.tsx	97.14%	1 Missing ⚠️
...e/libraries-manager/components/TeamTable/index.tsx	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #26      +/-   ##
==========================================
+ Coverage   94.14%   94.32%   +0.17%     
==========================================
  Files          44       44              
  Lines         837      881      +44     
  Branches      169      177       +8     
==========================================
+ Hits          788      831      +43     
- Misses         47       48       +1     
  Partials        2        2

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

arbrandes · 2025-10-28T16:24:27Z

Reviewing.

arbrandes

I tested it and it works, good work!

However, I'm going to wait to do a proper code review once #25 merges and this is rebased on it, since many of the commits here are shared with it.

arbrandes · 2025-10-28T19:53:04Z

src/authz-module/components/AuthZTitle.tsx

+                <Fragment key={`authz-header-action-${key}`}>
+                  {content}
+                  {(index === actions.length - 1) ? null
+                    : (<hr className="border-right mx-5" style={{ height: '30px' }} />)}


This hard-coded height is going to be addressed by #25, right?

Yes, it has been addressed there

brian-smith-tcril · 2025-10-29T20:32:09Z

@dcoa I merged #25 so this should be ready for a rebase!

Exposes a showToast for managing action errors and the showErrorToast for managing general server errors

…oast action

arbrandes

Thanks for the rebase! As before, this is working well. I did have a change request, though. See comment below.

arbrandes · 2025-10-30T13:00:41Z

...z-module/libraries-manager/components/AddNewTeamMemberModal/AddNewTeamMemberTrigger.test.tsx


-    // Loading indicator should be visible in the modal
-    expect(screen.getByTestId('loading-indicator')).toBeInTheDocument();
+    const userInput = screen.getByTestId('users-input');


Can we please avoid getByTestId, findByTestId, and the like, if possible? This applies here and elsewhere in this PR. Let me know if it's not possible, in any given instance, as I'd be curious to understand why. Thanks!

arbrandes

Given that 1) this PR actually works well, 2) the change request does not affect a user facing feature, 3) @dcoa is on the other side of the world, and 4) the Ulmo cut is in one hour, I'm electing to merge this under the assumption that a follow-up PR be issued to fix the getByTestIds.

👍🏼

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

dcoa force-pushed the dcoa/error-toast branch from 56b4d17 to 2008811 Compare October 27, 2025 16:46

dcoa changed the title ~~feat(authz): Manage action feedback through Toast component~~ feat(authz): [FC-0099] Manage action feedback using the Toast component. Oct 28, 2025

dcoa force-pushed the dcoa/error-toast branch from 2008811 to f4ef82a Compare October 28, 2025 01:55

dcoa force-pushed the dcoa/error-toast branch 3 times, most recently from 8ce7d07 to 8a110d6 Compare October 28, 2025 12:13

dcoa marked this pull request as ready for review October 28, 2025 13:09

dcoa requested review from arbrandes, brian-smith-tcril and jacobo-dominguez-wgu October 28, 2025 13:10

dcoa force-pushed the dcoa/error-toast branch from 7cc00a4 to d70f842 Compare October 28, 2025 13:24

arbrandes reviewed Oct 28, 2025

View reviewed changes

dcoa added 5 commits October 30, 2025 08:00

refactor: Modify ToastManager for general feedback

fe4760c

Exposes a showToast for managing action errors and the showErrorToast for managing general server errors

refactor: manage retry in fail server error

9923ea8

refactor: add isBlocking to modals to avoid closing it when trigger t…

ad375ce

…oast action

feat: manage error during the role asignation

5b6f043

test: add testing related to toast notifications

ea8ea6b

dcoa force-pushed the dcoa/error-toast branch from 371585a to ea8ea6b Compare October 29, 2025 21:03

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

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Oct 29, 2025

arbrandes requested changes Oct 30, 2025

View reviewed changes

arbrandes approved these changes Oct 30, 2025

View reviewed changes

arbrandes merged commit a9f8680 into openedx:master Oct 30, 2025
6 checks passed

github-project-automation bot moved this from In Eng Review to Done in Contributions Oct 30, 2025

arbrandes mentioned this pull request Oct 30, 2025

Avoid using getByTestId #28

Closed

brian-smith-tcril linked an issue Nov 3, 2025 that may be closed by this pull request

Add feedback when trying to add a role a user already has #21

Closed

jacobo-dominguez-wgu mentioned this pull request Nov 3, 2025

Replacing the usage of getByTestId and data-testid #30

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Uh oh!

dcoa commented Oct 27, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Oct 27, 2025 •

edited

Loading

Uh oh!

codecov bot commented Oct 28, 2025 •

edited

Loading

Uh oh!

arbrandes commented Oct 28, 2025

Uh oh!

arbrandes left a comment

Uh oh!

arbrandes Oct 28, 2025

Uh oh!

dcoa Oct 28, 2025

Uh oh!

brian-smith-tcril commented Oct 29, 2025

Uh oh!

arbrandes left a comment

Uh oh!

arbrandes Oct 30, 2025

Uh oh!

arbrandes left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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

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

Uh oh!

Conversation

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

Uh oh!

Toast Notification for Feedback

Changes:

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

arbrandes commented Oct 28, 2025

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

arbrandes Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

dcoa Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

brian-smith-tcril commented Oct 29, 2025

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

arbrandes Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dcoa commented Oct 27, 2025 •

edited

Loading

openedx-webhooks commented Oct 27, 2025 •

edited

Loading

codecov bot commented Oct 28, 2025 •

edited

Loading