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

API Erorr Handler: early exit if error can be silenced #10409

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Feb 5, 2025

Proposed Changes

cc: @khavinshankar

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • Bug Fixes
    • Improved error notifications so that non-critical issues (such as canceled actions) no longer trigger alerts, resulting in a cleaner and less disruptive user experience.

@rithviknishad rithviknishad requested a review from a team as a code owner February 5, 2025 09:47
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

The handleHttpError function has been updated to enhance error handling. It now checks if an error has its silent property set to true or if its name is "AbortError", and returns early without further processing if either condition is met. The overall functionality of processing HTTP errors and displaying notifications remains unchanged.

Changes

File Change Summary
src/Utils/.../errorHandler.ts Updated handleHttpError: now returns early for errors with silent set to true or with name "AbortError", removing the old check for error.silent.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Request Creator
    participant EH as handleHttpError

    Caller->>EH: Call handleHttpError(error)
    alt error.silent is true<br>or error.name == "AbortError"
        EH-->>Caller: Return early (skip processing)
    else Error not skipped
        EH-->>Caller: Process error (handle & display notification)
    end
Loading

Possibly related PRs

Poem

I’m a rabbit, swift and keen,
Skipping errors in the code routine,
If "AbortError" hops my way,
I quietly skip it without delay,
Hopping through bugs with a joyful leap,
In a world where silent errors sleep!
🐰✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Feb 5, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 0b3a84d
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67a3339ecd7416000964695c
😎 Deploy Preview https://deploy-preview-10409--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

Deploying care-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0b3a84d
Status: ✅  Deploy successful!
Preview URL: https://92e8a016.care-fe.pages.dev
Branch Preview URL: https://rithviknishad-fix-api-error.care-fe.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Utils/request/errorHandler.ts (1)

9-12: LGTM! Consider adding a type definition for silent errors.

The implementation correctly handles both silent errors and AbortError. The use of "silent" in error is a type-safe way to check for the optional property.

Consider adding a type definition for errors with the silent property:

interface SilentableError extends Error {
  silent?: boolean;
}

Then update the function signature:

export function handleHttpError(error: Error | SilentableError)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d9273d and 0b3a84d.

📒 Files selected for processing (1)
  • src/Utils/request/errorHandler.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: cypress-run (1)
  • GitHub Check: Cloudflare Pages: care-fe
🔇 Additional comments (1)
src/Utils/request/errorHandler.ts (1)

10-10: Verify AbortError handling across the codebase.

Let's ensure that AbortError is consistently handled across the codebase and that we're not missing any cases where we should be handling cancelled requests.

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Search for AbortError handling patterns
echo "Searching for AbortError handling patterns..."
rg -A 3 "AbortError|aborted|cancelled|canceled" --type ts

# Search for fetch/axios request cancellation
echo "Searching for request cancellation patterns..."
rg -A 3 "AbortController|CancelToken|cancel\(" --type ts

Length of output: 11316


AbortError Handling Verified Across Codebase

  • The pattern for checking error.name === "AbortError" is consistently applied in both src/Utils/request/errorHandler.ts and src/Utils/request/request.ts.
  • The use of AbortController in various components confirms that request cancellations are properly set up.

Copy link

cypress bot commented Feb 5, 2025

CARE    Run #4616

Run Properties:  status check passed Passed #4616  •  git commit 0b3a84de4e: API Erorr Handler: early exit if error can be silenced
Project CARE
Branch Review rithviknishad/fix/api-error-handler-move-silent-check-to-top
Run status status check passed Passed #4616
Run duration 05m 59s
Commit git commit 0b3a84de4e: API Erorr Handler: early exit if error can be silenced
Committer Rithvik Nishad
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 10
View all changes introduced in this branch ↗︎

@rithviknishad rithviknishad merged commit 6bf2f61 into develop Feb 5, 2025
22 checks passed
@rithviknishad rithviknishad deleted the rithviknishad/fix/api-error-handler-move-silent-check-to-top branch February 5, 2025 14:14
Copy link

github-actions bot commented Feb 5, 2025

@rithviknishad Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants