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: modified error message #9423

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

noufalrahim
Copy link
Contributor

@noufalrahim noufalrahim commented Dec 14, 2024

Proposed Changes

@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

Screenshot from 2024-12-14 21-10-55

Summary by CodeRabbit

  • New Features

    • Enhanced error handling in the request and data fetching processes by introducing an optional parameter for custom error objects.
    • Improved the DischargeModal component's error reporting for missing consultation data.
  • Bug Fixes

    • Adjusted error handling logic to provide more context in case of errors during data fetching.
  • Documentation

    • Updated method signatures to reflect the new optional parameters for better clarity on usage.

@noufalrahim noufalrahim requested a review from a team as a code owner December 14, 2024 15:44
Copy link
Contributor

coderabbitai bot commented Dec 14, 2024

Walkthrough

This pull request introduces an optional errorObj parameter to the request function in src/Utils/request/request.ts and the useTanStackQueryInstead function in src/Utils/request/useQuery.ts. The change enhances error handling by allowing custom error objects with code and detail properties to be passed during data fetching. In the DischargeModal component, this new error handling mechanism is utilized when fetching consultation data, providing more context for potential errors.

Changes

File Change Summary
src/Utils/request/request.ts Added optional errorObj parameter to request function with code and detail properties
src/Utils/request/useQuery.ts Updated useTanStackQueryInstead function to accept optional errorObj parameter
src/components/Facility/DischargeModal.tsx Added error object with empty code and translated warning detail to useTanStackQueryInstead hook

Assessment against linked issues

Objective Addressed Explanation
Improve error handling for shifting cards [#9061]
Prevent indefinite loading state during errors

Possibly related PRs

Suggested labels

needs review, tested

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

🐰 In the realm of code, where errors dance,
A new parameter leaps with a chance
To catch and tell tales of what went wrong
With code and detail, error's new song
Debugging magic, rabbit's delight! 🔍✨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


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 Dec 14, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit c55af60
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/675da7d259cee600083ff3d6
😎 Deploy Preview https://deploy-preview-9423--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
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

🧹 Outside diff range and nitpick comments (4)
src/Utils/request/request.ts (2)

21-24: Consider using a reusable type for errorObj.

The errorObj interface is duplicated across files. Consider extracting it to a shared types file for better maintainability.

+// In src/Utils/request/types.ts
+export interface ErrorObject {
+  code: string;
+  detail: string;
+}

-  errorObj?: {
-    code: string;
-    detail: string;
-  },
+  errorObj?: ErrorObject,

50-54: Simplify the error assignment logic.

The nested ternary operation can be simplified for better readability.

-      error: res.ok
-        ? undefined
-        : errorObj
-          ? errorObj
-          : (data as Record<string, unknown>),
+      error: res.ok ? undefined : (errorObj ?? data as Record<string, unknown>),
src/Utils/request/useQuery.ts (1)

20-23: Use consistent error object type.

Once the ErrorObject type is extracted, update this interface to use it as well.

-  errorObj?: {
-    code: string;
-    detail: string;
-  },
+  errorObj?: ErrorObject,
src/components/Facility/DischargeModal.tsx (1)

95-105: Consider handling loading and error states explicitly.

While the code provides an error message for missing consultations, it could benefit from more explicit error handling.

  const { data, error } = useTanStackQueryInstead(
    routes.getConsultation,
    {
      pathParams: { id: consultationData.id ?? "" },
      prefetch: !!consultationData.id,
    },
    {
      code: "",
      detail: t("consultation_missing_warning"),
    },
  );

+ if (error) {
+   return (
+     <div className="text-error-600">
+       {error.detail || t("general_error")}
+     </div>
+   );
+ }

- const initialDiagnoses = data?.diagnoses;
+ const initialDiagnoses = data?.diagnoses;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c8963ad and c55af60.

📒 Files selected for processing (3)
  • src/Utils/request/request.ts (2 hunks)
  • src/Utils/request/useQuery.ts (2 hunks)
  • src/components/Facility/DischargeModal.tsx (1 hunks)
🔇 Additional comments (1)
src/Utils/request/useQuery.ts (1)

42-42: LGTM: Proper error object propagation.

The errorObj is correctly passed to the request function.

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

Successfully merging this pull request may close these issues.

Improper Error Handling while moving the Shifting Cards
1 participant