Skip to content

Conversation

@jacobo-dominguez-wgu
Copy link
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Nov 20, 2025

Description

This PR is intended to improve the feedback process and have a better feedback system for user's input in the add team member modal.
Closes #14.

What it changes:

  • Improved Toast Feedback System
    Before: Single generic toast message for all scenarios
    After: Separate toast messages for each status type:
    ✅ Successfully added users
    ❌ User already has the assigned role
    ❌ User not found
    ❌ Generic errors
    This provides clearer, more actionable feedback to users.

  • Enhanced Message Clarity
    Added user identification: Toast messages now include the specific userId that triggered each status
    Example: The user already has the role ([email protected])
    Benefit: Users can easily identify which specific user caused each message when multiple toasts are displayed

  • Visual Error Indicators
    Extended red text functionality: Previously only "user not found" errors showed red text in the input textarea
    Now applies to all error types: Any user causing an error will appear in red in the textarea
    Improved UX: Users can quickly identify problematic entries and fix them

  • Better Error Handling Flow
    Modal behavior: The "Add Team Member" modal no longer auto-closes when errors occur
    Why: Allows users to immediately correct typos or invalid entries without reopening the modal
    Result: Smoother error recovery workflow

  • Dynamic Toast Duration
    Adaptive timing: Toast display duration now scales with the number of messages
    Formula: 5 seconds × number of toast messages displayed
    Rationale: Gives users adequate time to read multiple concurrent messages (up to 4 different toast types)

Demo video

Grabacion.de.pantalla.2025-11-20.a.la.s.4.08.25.p.m.mov

How to test it

We can test all the error cases described here, but also the next case scenarios covers most of the error and success cases:

Test scenario 1 (success)

Add a role to an existing user which role is not already set.
Expected: It should show the success toast message for 5 seconds and the modal automatically closes.

Test scenario 2 (already set error)

Add a role to an existing user which role is already set.
Expected: It should show the already set toast message for 5 seconds and the modal does not close.

Test scenario 3 (two usernames, one successful and one error)

Type the username of an existing user and one nonexisting and asign a role not already set.
Expected: It should show the success toast message and the non existing user message for 10 seconds. The modal does not closes and the username of the nonexisting and input text area should be in error state.

Test scenario 4 (three usernames, one successful and two errors)

Type the username of an existing user, one nonexisting user and one existing user with a role asigned (user3), asign the role of the user 3.
Expected: It should show the success toast message, the non existing user message and the already set role error message for 15 seconds. The modal does not closes and the usernames of the nonexisting user and the already set user should be in error state.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 20, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 20, 2025

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

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

codecov bot commented Nov 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.05%. Comparing base (1903428) to head (591d4cb).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #42      +/-   ##
==========================================
+ Coverage   94.46%   95.05%   +0.58%     
==========================================
  Files          45       45              
  Lines         904      930      +26     
  Branches      177      178       +1     
==========================================
+ Hits          854      884      +30     
+ Misses         48       44       -4     
  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.

@jacobo-dominguez-wgu
Copy link
Contributor Author

Backport PR: #44

@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from Waiting on Author to Ready for Review in Contributions Nov 24, 2025
@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from In Progress to Ready for review in RBAC AuthZ Board Nov 24, 2025
@diana-villalvazo-wgu diana-villalvazo-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Nov 25, 2025
@MaferMazu MaferMazu self-requested a review November 27, 2025 00:58
Copy link
Contributor

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

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

Thanks for these improvements @jacobo-dominguez-wgu.

I just have a comment:
Regarding the USER_ALREADY_HAS_ROLE, although the user is not added to the team, the user's experience is that they achieve the goal (the users are in the group). So I think we should consider the case of already having a role as a success, like an informative success.
That implies we shouldn't keep those user/email in red, and if I only have users with the role, we should close the modal. (this is related to the first case in this comment #14 (comment))

What do you think, @jacobo-dominguez-wgu?

The rest looks good to me. I tested, and it works as expected! ✨

@jacobo-dominguez-wgu
Copy link
Contributor Author

Thanks for these improvements @jacobo-dominguez-wgu.

I just have a comment: Regarding the USER_ALREADY_HAS_ROLE, although the user is not added to the team, the user's experience is that they achieve the goal (the users are in the group). So I think we should consider the case of already having a role as a success, like an informative success. That implies we shouldn't keep those user/email in red, and if I only have users with the role, we should close the modal. (this is related to the first case in this comment #14 (comment))

What do you think, @jacobo-dominguez-wgu?

The rest looks good to me. I tested, and it works as expected! ✨

Hi @MaferMazu I have updated the code to consider the USER_ALREADY_HAS_ROLE cases as a successful message.
This includes, the userIds will not appear in read and will be removed from the textarea (in cases where there are other userIds with errors) and will automatically closes the modal (in cases where there are other no errors), always displaying a toast indicating the already existing role. Can you take a second look to review it?

Copy link
Contributor

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the comments @jacobo-dominguez-wgu!

The changes worked as expected! ✨

Minor comment (no blocker):
We should use a similar format for the message when users already have roles, and when the operation is successful (the count and the plural), because the current 'already have role' message is unclear when we have more than one user. (Unclear message: The user already has the role (freshuser, library_user_test).)

@MaferMazu
Copy link
Contributor

@arbrandes @dcoa @brian-smith-tcril, could you help with a review? I would like a more experienced look at frontend matters.

@mphilbrick211 mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Dec 3, 2025
Copy link

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

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

Tested and working as expected, code looks good. Thanks!

Copy link
Contributor

@dcoa dcoa left a comment

Choose a reason for hiding this comment

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

I haven't tested in my local but the code seems good to me, thank you!!

@openedx-webhooks openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Dec 15, 2025
@MaferMazu
Copy link
Contributor

@arbrandes @brian-smith-tcril, could you help us with a review/merge powers with this PR?

@dcoa dcoa changed the title changing how the feedback message is displayed for adding team members fix: changing how the feedback message is displayed for adding team members Dec 28, 2025
@dcoa dcoa merged commit c700ce5 into openedx:master Dec 28, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Dec 28, 2025
@github-project-automation github-project-automation bot moved this from Ready for review to Done in RBAC AuthZ Board Dec 28, 2025
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

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

Better manage in the feedback for user input in add team member modal

6 participants