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: 拦截器类型 #5528

Closed
wants to merge 3 commits into from
Closed

Conversation

aojiaoxiaolinlin
Copy link

@aojiaoxiaolinlin aojiaoxiaolinlin commented Feb 13, 2025

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

  • Chores

    • Updated development configurations to optimize search exclusions and package management.
  • Refactor

    • Enhanced error handling and retry logic for network operations.
    • Improved internal type safety across API requests, authentication, and file uploads, ensuring a more robust and predictable experience.

Copy link

changeset-bot bot commented Feb 13, 2025

⚠️ No Changeset found

Latest commit: ded5b7b

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 Feb 13, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several type safety enhancements across multiple files. Changes include replacing instances of any with unknown, refining generic type parameters, and simplifying type declarations. In addition, VS Code settings are updated to exclude certain directories and files from searches. Updates to error handling in API requests and HTTP interceptors further improve clarity and robustness. New interfaces are added to better define response and package structures, while ESLint rules are adjusted to warn against explicit any usage.

Changes

File(s) Change Summary
.vscode/settings.json Updated search settings to exclude the .vscode folder and LICENSE files.
apps/backend-mock/utils/response.ts, apps/web-ele/src/store/auth.ts, docs/src/demos/vben-api-component/…/index.vue, docs/src/demos/vben-drawer/shared-data/drawer.vue, docs/src/demos/vben-vxe-table/mock-api.ts, packages/@core/base/shared/src/global-state.ts, playground/src/views/examples/form/basic.vue Replaced any with unknown in function signatures, generic defaults, and interface declarations to enforce stronger type safety and leverage type inference.
internal/lint-configs/eslint-config/src/configs/typescript.ts Changed ESLint rule for @typescript-eslint/no-explicit-any from "off" to "warn".
packages/@core/base/shared/src/utils/unique.ts, packages/@core/ui-kit/popup-ui/src/drawer/drawer-api.ts Refined generic constraints and type parameters for utility functions and API methods to ensure consistency.
packages/effects/request/src/request-client/modules/interceptor.ts, …/uploader.ts, …/preset-interceptors.ts, …/request-client.ts, …/types.ts Enhanced HTTP request/response processing with updated generics, improved error types, and revised interceptor signatures.
apps/web-antd/src/api/request.ts Modified error handling in interceptors to provide a structured fallback response object.
scripts/turbo-run/src/run.ts Added a new ScriptsPackageJson interface and updated package filtering logic for improved type enforcement.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant RequestClient
  participant Axios
  note over RequestClient: Updated error handling and type safety
  Client->>RequestClient: Send HTTP request
  RequestClient->>Axios: Forward request
  Axios-->>RequestClient: Return response or error
  alt Error Occurs
      RequestClient->>RequestClient: Cast error to AxiosError and process via interceptors
      RequestClient-->>Client: Return structured error response
  else Successful Response
      RequestClient-->>Client: Return response data
  end
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

I'm a bunny on the run,
Skipping through code, having fun.
With types refined from any to unknown,
Our code base has brightly shone.
Hopping ahead with every change, so won! 🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web-antd/src/api/request.ts

Oops! Something went wrong! :(

ESLint: 9.17.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

docs/src/demos/vben-vxe-table/mock-api.ts

Oops! Something went wrong! :(

ESLint: 9.17.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

apps/backend-mock/utils/response.ts

Oops! Something went wrong! :(

ESLint: 9.17.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

  • 14 others

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 182f1c9 and ded5b7b.

📒 Files selected for processing (18)
  • .vscode/settings.json (1 hunks)
  • apps/backend-mock/utils/response.ts (4 hunks)
  • apps/web-antd/src/api/request.ts (1 hunks)
  • apps/web-ele/src/store/auth.ts (1 hunks)
  • docs/src/demos/vben-api-component/cascader/index.vue (2 hunks)
  • docs/src/demos/vben-drawer/shared-data/drawer.vue (1 hunks)
  • docs/src/demos/vben-vxe-table/mock-api.ts (2 hunks)
  • internal/lint-configs/eslint-config/src/configs/typescript.ts (1 hunks)
  • packages/@core/base/shared/src/global-state.ts (1 hunks)
  • packages/@core/base/shared/src/utils/unique.ts (1 hunks)
  • packages/@core/ui-kit/popup-ui/src/drawer/drawer-api.ts (1 hunks)
  • packages/effects/request/src/request-client/modules/interceptor.ts (2 hunks)
  • packages/effects/request/src/request-client/modules/uploader.ts (1 hunks)
  • packages/effects/request/src/request-client/preset-interceptors.ts (4 hunks)
  • packages/effects/request/src/request-client/request-client.ts (4 hunks)
  • packages/effects/request/src/request-client/types.ts (3 hunks)
  • playground/src/views/examples/form/basic.vue (1 hunks)
  • scripts/turbo-run/src/run.ts (3 hunks)
✨ 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.

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.

1 participant