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

fix: fix the issues with the request.js (#4667) #4669

Closed
wants to merge 1 commit into from

Conversation

swamp-y
Copy link

@swamp-y swamp-y commented Oct 17, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling for API responses, providing more detailed error information for better troubleshooting.
  • Chores

    • Refined the error reporting mechanism to enhance clarity and accessibility of error data in the application.

@swamp-y swamp-y requested review from anncwb, vince292007 and a team as code owners October 17, 2024 14:39
Copy link

changeset-bot bot commented Oct 17, 2024

⚠️ No Changeset found

Latest commit: 773e5f7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes in this pull request focus on modifying the error handling logic within the response interceptor of the RequestClient in two files: request.ts in both the apps/web-antd/src/api and playground/src/api directories. The update alters how errors are reported when responses fall outside the successful status code range (200-399), changing from throwing a message to throwing an object containing the entire response. The core functionality and structure of the request client remain unchanged.

Changes

File Path Change Summary
apps/web-antd/src/api/request.ts Modified error handling in the response interceptor to throw an object with the entire response.
playground/src/api/request.ts Modified error handling in the response interceptor to throw an object with the entire response.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

🐰 In the meadow, where bunnies play,
Errors once scary, now fade away.
With objects in hand, we hop with glee,
Handling mistakes, as smooth as can be!
A leap in logic, a joyful cheer,
For clearer errors, we hold so dear! 🌼


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 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
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c432e0a and 773e5f7.

📒 Files selected for processing (2)
  • apps/web-antd/src/api/request.ts (1 hunks)
  • playground/src/api/request.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
playground/src/api/request.ts (1)

82-82: ⚠️ Potential issue

Consider the implications of changing the error structure

The modification to throw the entire response object instead of a constructed error message offers more flexibility in error handling. However, this is a breaking change that requires careful consideration:

  1. This change will affect all downstream error handling code that expects the error to be a string.
  2. The new error structure provides more information but may lead to type errors if not properly handled.

To address these concerns:

  1. Document the new error structure in the codebase, explaining what information is available and how to access it.
  2. Update all error handling code throughout the application to accommodate the new error structure.
  3. Consider adding a type definition for the new error structure to ensure type safety:
type RequestError = {
  response: {
    data: any;
    status: number;
    statusText: string;
    headers: any;
    config: any;
  };
};
  1. Implement a migration strategy to gradually update error handling across the application, possibly by providing a compatibility layer during the transition.

To assess the impact of this change, run the following script to find potential affected areas:

This will help identify areas of the codebase that may need updating due to the new error structure.

apps/web-antd/src/api/request.ts Show resolved Hide resolved
Copy link
Author

@swamp-y swamp-y left a comment

Choose a reason for hiding this comment

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

采用 @anncwb 的建议,throw 对象以用于后面处理错误拿到的数据结构有效,401判断能命中

@anncwb
Copy link
Collaborator

anncwb commented Oct 18, 2024

pr没校验通过。这个分支改善了,https://github.com/vbenjs/vue-vben-admin/pull/4679。

@anncwb anncwb closed this Oct 18, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Nov 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants