Skip to content

refactor: add typed getHttpErrorStatus helper and PlatformError type#171

Open
dcoa wants to merge 3 commits into
openedx:masterfrom
eduNEXT:dcoa/error-typing
Open

refactor: add typed getHttpErrorStatus helper and PlatformError type#171
dcoa wants to merge 3 commits into
openedx:masterfrom
eduNEXT:dcoa/error-typing

Conversation

@dcoa

@dcoa dcoa commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Consolidates the scattered request error's HTTP status into one typed helper, removing the as any / @ts-ignore / lie-to-the-compiler patterns that were duplicated across the module.

What and why

  • getHttpErrorStatus(error: unknown): number | undefined, which safely reads the status the auth client attaches to thrown errors.
  • PlatformError interface that return the AxiosError shape.

Small clean ups

  • ToastManagerContext clears pending toast-removal timers on unmount and wraps showToast/discardToast in useCallback (fixes a setState-after-unmount risk and a stale-closure in the context value).
  • audit-user typed the previously-implicit-any runRevokeRole param ({ data: RevokeUserRolesRequest }).
  • Remove 403 error in Save button Wizard validation, now that the permissions validation supports scope-less request and the scope list is limited to user management list.

AI use acknowledgement

Supported by Claude Code

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 25, 2026
@openedx-webhooks

openedx-webhooks commented Jun 25, 2026

Copy link
Copy Markdown

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.

@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 Jun 25, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 25, 2026
@dcoa
dcoa force-pushed the dcoa/error-typing branch from 467fb9d to 543fef9 Compare June 25, 2026 07:45
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 91.30435% with 2 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (master@e03ec4b). Learn more about missing BASE report.

Files with missing lines Patch % Lines
...rc/components/ToastManager/ToastManagerContext.tsx 86.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##             master     #171   +/-   ##
=========================================
  Coverage          ?   97.55%           
=========================================
  Files             ?       68           
  Lines             ?     1677           
  Branches          ?      404           
=========================================
  Hits              ?     1636           
  Misses            ?       41           
  Partials          ?        0           

☔ View full report in Codecov by Harness.
📢 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.

@dcoa
dcoa marked this pull request as ready for review June 25, 2026 07:52
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 25, 2026
@dcoa
dcoa force-pushed the dcoa/error-typing branch from 543fef9 to 96e1a06 Compare July 23, 2026 00:58

@bra-i-am bra-i-am left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

}, 5000);
};
}, DEFAULT_TOAST_DELAY);
removalTimers.current.push(timer);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: I see that the timers are being pushed to the ref at every discardToast, but they are never deleted

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I added a change for this, could you validate, please?

@dcoa
dcoa force-pushed the dcoa/error-typing branch from 34683af to c67213c Compare July 24, 2026 11:01
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). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants