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

perf: axios default error interceptor allows you to customize error handling #4283

Merged
merged 1 commit into from
Aug 30, 2024

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented Aug 30, 2024

fixed #4282

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

  • New Features

    • Increased the height of the tab bar for improved visibility and layout.
    • Enhanced the default tab bar height in the layout component for better spacing.
  • Style Enhancements

    • Updated active tab styles for clearer visual distinction.
    • Improved text visibility in the check updates component with new styling.
  • Bug Fixes

    • Enhanced error handling by providing more context in error messages.

Copy link

changeset-bot bot commented Aug 30, 2024

⚠️ No Changeset found

Latest commit: f2548d9

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 Aug 30, 2024

Walkthrough

The changes encompass modifications to several components and configurations within the codebase. Key alterations include adjustments to UI properties such as tab bar heights and CSS class updates for improved visual styling. Additionally, enhancements to error handling mechanisms are introduced by expanding function signatures to accommodate more detailed error information. Overall, these updates aim to refine the user interface and bolster error reporting capabilities.

Changes

Files Change Summary
packages/@core/preferences/src/config.ts Updated tabbar.height from 36 to 38 in defaultPreferences.
packages/@core/ui-kit/layout-ui/src/vben-layout.vue Increased tabbarHeight default value from 36 to 40.
packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue Modified CSS classes for active tab states, changing background and text color classes.
packages/effects/layouts/src/widgets/check-updates/check-updates.vue Added text-primary-foreground class to enhance styling in handleNotice function.
packages/effects/request/src/request-client/preset-interceptors.ts Updated makeErrorMessage function calls to include an additional error parameter.
packages/effects/request/src/request-client/types.ts Modified MakeErrorMessageFn type to accept an additional error parameter.

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as UI Component
    participant C as Error Handling
    A->>B: Trigger action
    B->>C: Call error handling
    C->>C: Process error
    C->>B: Return error message
    B->>A: Display message
Loading

🐰 In a world of tabs and heights so bright,
The changes hop in, a delightful sight!
With colors that dance and errors that sing,
Our UI now sparkles, oh what joy they bring!
So let’s celebrate with a happy cheer,
For every little change, 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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

sonarcloud bot commented Aug 30, 2024

@anncwb anncwb merged commit b3e3e05 into main Aug 30, 2024
15 checks passed
@anncwb anncwb deleted the bugfix/axios branch August 30, 2024 14:06
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cc678a2 and f2548d9.

Files selected for processing (6)
  • packages/@core/preferences/src/config.ts (1 hunks)
  • packages/@core/ui-kit/layout-ui/src/vben-layout.vue (1 hunks)
  • packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue (3 hunks)
  • packages/effects/layouts/src/widgets/check-updates/check-updates.vue (1 hunks)
  • packages/effects/request/src/request-client/preset-interceptors.ts (2 hunks)
  • packages/effects/request/src/request-client/types.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • packages/@core/preferences/src/config.ts
  • packages/effects/layouts/src/widgets/check-updates/check-updates.vue
Additional comments not posted (4)
packages/effects/request/src/request-client/types.ts (1)

31-31: Approved: Enhanced error handling capability.

The modification to MakeErrorMessageFn to include an error object as a parameter enhances error handling capabilities. Ensure that all usages of this function across the codebase are updated to match the new signature.

Run the following script to verify the function usage:

Verification successful

Verification Successful: Function Usage Updated

The makeErrorMessage function is correctly used with the new signature, including the error object as a parameter. The codebase reflects this update appropriately.

  • Location: packages/effects/request/src/request-client/preset-interceptors.ts
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `MakeErrorMessageFn` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type typescript -A 5 $'MakeErrorMessageFn'

Length of output: 81


Script:

#!/bin/bash
# Description: Verify all function calls to `MakeErrorMessageFn` match the new signature.

# Search for the function usage without specifying a file type.
rg -A 5 'MakeErrorMessageFn'

Length of output: 2105


Script:

#!/bin/bash
# Description: Search for function implementations or calls using `MakeErrorMessageFn`.

# Search for any function that implements or calls `MakeErrorMessageFn`.
rg 'makeErrorMessage' -A 5

Length of output: 1666

packages/effects/request/src/request-client/preset-interceptors.ts (1)

90-90: Approved: Enhanced error context in interceptor.

The addition of the error parameter to makeErrorMessage calls within errorMessageResponseInterceptor enhances the error context provided. Ensure that the makeErrorMessage function is properly implemented to handle this additional parameter effectively.

Also applies to: 122-122

packages/@core/ui-kit/tabs-ui/src/components/tabs-chrome/tabs.vue (1)

94-94: Approved: Visual enhancements to tabs.

The updates to the CSS classes for active tab states enhance the visual distinction and user experience. Verify that these changes are consistent with the overall design language of the application.

Also applies to: 131-131, 171-171

packages/@core/ui-kit/layout-ui/src/vben-layout.vue (1)

53-53: Approve the change to tabbarHeight.

The change from 36 to 40 in tabbarHeight is approved as it is a straightforward adjustment. However, ensure to verify the visual impact on the layout, especially how it integrates with other UI elements that depend on this property.

The code change is approved.

Run the following script to verify the visual impact:

kkfive pushed a commit to kkfive/vue-vben-admin that referenced this pull request Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug:接口请求错误提示词不正确,始终返回的是框架内置错误
1 participant