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

feat: Adding human readable 403 error access restricted #1569

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

farhaanbukhsh
Copy link
Member

@farhaanbukhsh farhaanbukhsh commented Dec 12, 2024

Description

Updated to have human readable forbidden error (403), this change came into picture from the discussion
on issue 361

Useful information to include:

New Alert

image

Supporting information

Discussion on issue 361

Testing instructions

  1. Start tutor in the dev mode, tutor dev launch
  2. Make sure frontend-app-authoring is mounted by tutor mounts add < path to frontend-app-authoring>
  3. if you have mounted it for the first time you might have to rebuild the openedx-dev image by tutor images build openedx-dev
  4. We need to stop the containers and start them by tutor dev stop followed by tutor dev start -d
  5. We need to change branch from master to the branch of this PR.
  6. Create two users one with staff/superuser permission and the other with just learner permission.
  7. Login the platform with the user that has staff/superuser permission, select any course, under the instructor tab, go to Course Team Management. Under "Select a course team role" select "Limited Staff Role". Enter the username of the learner account and click on "Add Limited Staff".
  8. Login with the Learner account and go to studio, try accessing the course, the banner should be visible.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Private ref: BB-9399

@farhaanbukhsh farhaanbukhsh requested a review from a team as a code owner December 12, 2024 21:40
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 12, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 12, 2024

Thanks for the pull request, @farhaanbukhsh!

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.

@farhaanbukhsh farhaanbukhsh marked this pull request as draft December 12, 2024 21:40
@farhaanbukhsh farhaanbukhsh removed the request for review from a team December 12, 2024 21:41
@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/adding-403-error branch from 4343567 to 3c103c9 Compare December 15, 2024 14:06
Copy link

codecov bot commented Dec 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.99%. Comparing base (dc0ba6a) to head (4ccb21c).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1569      +/-   ##
==========================================
+ Coverage   92.97%   92.99%   +0.01%     
==========================================
  Files        1075     1078       +3     
  Lines       21205    21359     +154     
  Branches     4562     4616      +54     
==========================================
+ Hits        19715    19862     +147     
- Misses       1424     1425       +1     
- Partials       66       72       +6     

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

@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/adding-403-error branch 2 times, most recently from 0d905f9 to bac3bee Compare December 27, 2024 21:33
@farhaanbukhsh farhaanbukhsh marked this pull request as ready for review December 28, 2024 05:32
@farhaanbukhsh
Copy link
Member Author

@ChrisChV can you review this?

@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/adding-403-error branch from bac3bee to b403144 Compare December 28, 2024 15:37
@ChrisChV
Copy link
Contributor

ChrisChV commented Jan 8, 2025

Sure @farhaanbukhsh I will review it tomorrow

src/course-outline/page-alerts/PageAlerts.jsx Show resolved Hide resolved
src/course-outline/page-alerts/PageAlerts.test.jsx Outdated Show resolved Hide resolved
src/course-outline/page-alerts/PageAlerts.jsx Outdated Show resolved Hide resolved
@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/adding-403-error branch 2 times, most recently from ff9c70b to 1ba6bb4 Compare January 10, 2025 15:28
@farhaanbukhsh
Copy link
Member Author

@ChrisChV I have fixed the comments and in addition to that I have fixed a typo that I encountered.

Copy link
Contributor

@ChrisChV ChrisChV 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!

export const getErrorDetails = (error, dismissible = true) => {
const errorInfo = { dismissible };
if (error.response?.status === 403) {
// For 403 status the error should be dismissible
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
// For 403 status the error should be dismissible
// For 403 status the error should not be dismissible

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch :) fixed. Please merge it when the tests go green 😄

@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/adding-403-error branch from 1ba6bb4 to 4ccb21c Compare January 10, 2025 18:04
@ChrisChV ChrisChV merged commit e6bce56 into openedx:master Jan 10, 2025
7 checks passed
@ChrisChV ChrisChV deleted the farhaan/adding-403-error branch January 10, 2025 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants