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: 修复因扩展vxe-table的query函数导致的表单参数不能获取到最新值 #4824

Closed
wants to merge 4 commits into from

Conversation

ORACLE128G
Copy link
Contributor

@ORACLE128G ORACLE128G commented Nov 6, 2024

Description

表单参数未能正确更新相关的issue:#4785,#4752

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

  • Improvements
    • Streamlined form submission process for better efficiency.
    • Enhanced clarity in handling form values during submissions.
    • Updated comments for better understanding of the changes made.

Copy link

changeset-bot bot commented Nov 6, 2024

⚠️ No Changeset found

Latest commit: 23295f8

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 Nov 6, 2024

Walkthrough

The changes in the use-vxe-grid.vue file involve modifications to the initialization logic and form submission handling. The init function has been updated to remove the extendProxyOptions call, allowing form values to be directly passed to the props.api.reload method during submission. This streamlines the data handling process. Comments in the code have also been revised for clarity. The overall structure of the component remains unchanged, and no new features have been introduced.

Changes

File Path Change Summary
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue Modified initialization logic and form submission handling; removed extendProxyOptions call and updated comments for clarity.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

🐇 In the meadow, the changes bloom,
A simpler path, dispelling gloom.
With forms that flow, and logic clear,
The grid now dances, full of cheer!
Let's hop along, with joy we'll sing,
For every tweak, a brighter spring! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 488ccb5 and 23295f8.

📒 Files selected for processing (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (1 hunks)
🔇 Additional comments (1)
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (1)

230-233: LGTM! The fix correctly addresses the form parameter update issue.

The removal of extendProxyOptions is the right approach since form values are already being passed directly to props.api.reload in the handleSubmit function. This change eliminates the potential interference with form value updates while maintaining the intended functionality.

Let's verify that no other components rely on the removed extendProxyOptions functionality:

✅ Verification successful

Removal of extendProxyOptions is safe and correctly fixes the form value update issue

Based on the codebase analysis:

  • The extendProxyOptions function is only defined in extends.ts and used in use-vxe-grid.vue
  • No other components are importing or using this functionality
  • The direct usage of proxyConfig.ajax is minimal and doesn't conflict with this change
  • The form values are now correctly passed directly to props.api.reload in handleSubmit

The removal is safe as it:

  1. Eliminates redundant proxy extension that was causing form value update issues
  2. Doesn't impact any other components in the codebase
  3. Maintains the core functionality while fixing the bug
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other usages of extendProxyOptions in the codebase
rg "extendProxyOptions"

# Search for components that might be extending vxe-table's query function
rg -g '*.{vue,ts,js}' "vxe.*table.*query|vxe.*grid.*query"

Length of output: 309


Script:

#!/bin/bash
# Let's examine the extends.ts file to understand the extendProxyOptions implementation
cat packages/effects/plugins/src/vxe-table/extends.ts

# Also check for any imports of extends.ts
rg -l "extends.*vxe-table"

Length of output: 1576


Script:

#!/bin/bash
# Let's check for any imports of the extendProxyOptions function
rg -l "import.*\{.*extendProxyOptions.*\}.*from.*vxe-table"

# Also check for direct usage of proxyConfig to see if any other components implement similar functionality
rg "proxyConfig.*ajax"

# Check for any other files that might be using the grid API's setState method
rg "gridOptions.*proxyConfig"

Length of output: 326


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.

@ORACLE128G ORACLE128G changed the title 修复因扩展vxe-table的query函数导致的表单参数不能获取到最新值 fix: 修复因扩展vxe-table的query函数导致的表单参数不能获取到最新值 Nov 6, 2024
@vince292007
Copy link
Collaborator

看着会导致 #4607 回归

@ORACLE128G
Copy link
Contributor Author

看着会导致 #4607 回归

问题的根源在于packages/effects/plugins/src/vxe-table/extends.ts, line: 41:
设置了store缓存之后,内部方法的执行和vue computed是否类似(我没用过tanstack-store),不会再重复执行了,导致拿不到最新参数

api.setState({
    gridOptions: {
      proxyConfig: {
        ajax: {
          [key]: wrapperFn,
        },
      },
    },
  });

或者说另外一种方案,修改这个方法:

const wrapperFn = async (params: any, _formValues: any, ...args: any[]) => {
    const formValues = getFormValues();
    const data = await configFn(params, formValues, ...args);
    return data;
  };

改为以下这样,这种我没试过:

const wrapperFn = async (params: any, _formValues: any, ...args: any[]) => {
    // const formValues = getFormValues();
    const data = await configFn(params, _formValues, ...args);
    return data;
  };

@anncwb anncwb closed this in #4834 Nov 7, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 8, 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.

2 participants