Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Update error message while adding library team member [FC-0062] #1572

Merged

Conversation

ChrisChV
Copy link
Contributor

Update the error message while adding a library team member to show the error message generated by the server

Supporting information

Testing instructions

  • Select a library from the list of v2 Libraries, and open the Library Info sidebar. You need to use a user with Admin access.
  • Click on Manage Access, and add a user that doesn't exist.
  • Verify the new error message.
  • Add a user who already is a team member.
  • Verify the new error message.

Other information

N/A

@ChrisChV ChrisChV requested a review from a team as a code owner December 16, 2024 19:40
@openedx-webhooks
Copy link

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 16, 2024
@ChrisChV ChrisChV force-pushed the chris/update-error-msg-library-member branch from 33c0e96 to 3c42def Compare December 16, 2024 19:42
Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.96%. Comparing base (b110b6b) to head (7927ba3).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1572   +/-   ##
=======================================
  Coverage   92.96%   92.96%           
=======================================
  Files        1075     1075           
  Lines       21190    21194    +4     
  Branches     4554     4556    +2     
=======================================
+ Hits        19700    19704    +4     
+ Misses       1424     1418    -6     
- Partials       66       72    +6     

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

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 17, 2024
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

LGTM and works well. Thanks!

const url = getLibraryTeamApiUrl(libraryId);
const axiosMock = new MockAdapter(getAuthenticatedHttpClient());
axiosMock.onPost(url).reply(400, { email: 'Error' });
axiosMock.onPost(url).reply(400, { email: 'This is an specific error.' });
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
axiosMock.onPost(url).reply(400, { email: 'This is an specific error.' });
axiosMock.onPost(url).reply(400, { email: 'This is a specific error.' });

@@ -204,7 +204,7 @@ describe('<LibraryTeam />', () => {
});

expect(await screen.findByText(
'Error adding Team Member. Please verify that the email is correct and belongs to a registered user.',
'Error adding Team Member. This is an specific error.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'Error adding Team Member. This is an specific error.',
'Error adding Team Member. This is a specific error.',

addMemberSpecificError: {
id: 'course-authoring.library-authoring.library-team.add-member-specific-error',
defaultMessage: 'Error adding Team Member. {message}',
description: 'Message shown when an error occurs with an specific error while adding a Library Team member.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: 'Message shown when an error occurs with an specific error while adding a Library Team member.',
description: 'Message shown when an error occurs while adding a Library Team member, including a specific error message.',

@ChrisChV ChrisChV merged commit 64906a1 into openedx:master Dec 18, 2024
7 checks passed
@ChrisChV ChrisChV deleted the chris/update-error-msg-library-member branch December 18, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project 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.

4 participants