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: vxeTable destruction/reconstruction remains at the first value #4805

Closed
wants to merge 2 commits into from

Conversation

imdap
Copy link
Contributor

@imdap imdap commented Nov 4, 2024

Description

解决VxeTable在modal/drawer中使用(或使用v-if切换)一直拿到的是第一次的表单

resolve: #4804 有详细复现步骤及分析
#4752
#4785

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
    • Enhanced handling of the grid API for improved flexibility and responsiveness within the component.
  • Bug Fixes
    • Ensured the extendedApi variable accurately reflects the latest instance of the API, enhancing stability.
  • Refactor
    • Updated variable declaration for better mutability and context usage within the component.

Copy link

changeset-bot bot commented Nov 4, 2024

⚠️ No Changeset found

Latest commit: 362005b

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 4, 2024

Walkthrough

The changes in this pull request modify the useVbenVxeGrid function within the use-vxe-grid.ts file. The extendedApi variable is now mutable, allowing it to be reassigned after the creation of the VxeGridApi instance. This adjustment ensures that extendedApi reflects the latest instance when defined within the component's context. Additionally, the useStore method is now defined in this context, while the onBeforeUnmount lifecycle hook remains unchanged, maintaining the cleanup process.

Changes

File Path Change Summary
packages/effects/plugins/src/vxe-table/use-vxe-grid.ts Changed extendedApi from a constant to a mutable variable and reassigned it within the component context. useStore method defined within the component.

Assessment against linked issues

Objective Addressed Explanation
Resolve the issue of useVbenVxeGrid retaining previous form data after destruction/recreation (#4804)

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

🐇 In the meadow where the grids do play,
A rabbit hops, bringing changes today.
With extendedApi now set to renew,
The forms will refresh, just like the dew.
So let’s celebrate this code so bright,
Hopping along, everything feels right! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9bc560d and 362005b.

📒 Files selected for processing (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.ts

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

Reviewing files that changed from the base of the PR and between 35eef33 and 9bc560d.

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

17-21: LGTM! This change properly fixes the state retention issue.

Creating a new api instance and defining useStore within the component scope ensures that:

  1. Each grid instance has its own isolated state
  2. Previous values aren't retained when the component is destroyed and reconstructed
  3. The store is properly bound to the correct api instance

This effectively resolves the issue described in #4804 where the grid was retaining initial values after destruction/reconstruction.


23-25: Verify cleanup implementation.

Let's ensure the cleanup is properly implemented to prevent memory leaks.

✅ Verification successful

Let me analyze the cleanup implementation further by checking the StateHandler class since it's involved in the cleanup process.


Cleanup implementation is properly handled

The cleanup implementation in unmount() is sufficient as it:

  • Resets the mounted state via isMounted = false
  • Properly cleans up the state handler which includes clearing any pending promises and their callbacks
  • No event listeners or subscriptions are created that would need cleanup
  • The Store updates are handled through the component lifecycle
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify VxeGridApi cleanup implementation
# Expected: Find unmount method implementation and any cleanup logic

# Search for VxeGridApi class implementation
echo "Searching for VxeGridApi class implementation..."
ast-grep --pattern 'class VxeGridApi {
  $$$
  unmount() {
    $$$
  }
  $$$
}'

# Search for additional cleanup related code
echo "Searching for additional cleanup patterns..."
rg -l "(?i)(cleanup|dispose|destroy|unmount)" --type ts

Length of output: 7810


Script:

#!/bin/bash
# Search for StateHandler class implementation to understand reset() method
ast-grep --pattern 'class StateHandler {
  $$$
  reset() {
    $$$
  }
  $$$
}'

# Check if there are any event listeners or subscriptions that need cleanup
rg "addEventListener|on\(" packages/effects/plugins/src/vxe-table/

Length of output: 4455

packages/effects/plugins/src/vxe-table/use-vxe-grid.ts Outdated Show resolved Hide resolved
@imdap imdap closed this Nov 4, 2024
@imdap imdap reopened this Nov 4, 2024
@imdap imdap changed the title fix: VxeTable destruction/reconstruction remains at the first value fix: vxeTable destruction/reconstruction remains at the first value Nov 4, 2024
@RanMaoting
Copy link

这个方案好像有问题,在某些情况下拿不到组件的实例对象
image
image
这样子拿到的对象是空的,没办法调用grid的方法

@imdap imdap closed this Nov 4, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 5, 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.

Bug: useVbenVxeGrid在销毁/重建后表单依旧为上次数据
2 participants