fix(grid): fix tree table children edit revert error #3542
Conversation
WalkthroughThe updates introduce explicit destruction of sortable instances in the grid body, refactor the internal row revert logic to use a new origin row retrieval method, and add methods for managing original row backups. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GridComponent
participant SortableInstance
participant BackupMap
User->>GridComponent: Update tbody (with dropConfig)
GridComponent->>SortableInstance: Destroy existing rowSortable and columnSortable
GridComponent->>SortableInstance: Initialize new sortable instances
User->>GridComponent: Revert row data
GridComponent->>BackupMap: getOriginRow(row)
BackupMap-->>GridComponent: Return original row
GridComponent->>GridComponent: Restore row data from original
User->>GridComponent: Reload row (with/without record/field)
GridComponent->>BackupMap: getOriginRow(row)
GridComponent->>GridComponent: Clone/restore row data, handle tree children
GridComponent->>BackupMap: setOriginRow(row, record)
Poem
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
packages/vue/src/grid/src/edit/src/methods.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-vue". (The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. packages/vue/src/grid/src/body/src/body.tsxOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-vue". (The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. packages/vue/src/grid/src/table/src/methods.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-vue". (The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/vue/src/grid/src/body/src/body.tsx(2 hunks)packages/vue/src/grid/src/edit/src/methods.ts(2 hunks)packages/vue/src/grid/src/table/src/methods.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*`: 用于写产品需求和开发文档的文件，需求应尽量写得简单清晰易懂。 在需求设计阶段应遵从逐步迭代的原则，早期版本可以尽量简洁。
**/*: 用于写产品需求和开发文档的文件，需求应尽量写得简单清晰易懂。
在需求设计阶段应遵从逐步迭代的原则，早期版本可以尽量简洁。
📄 Source: CodeRabbit Inference Engine (.cursor/rules/product.mdc)
List of files the instruction was applied to:
packages/vue/src/grid/src/edit/src/methods.tspackages/vue/src/grid/src/body/src/body.tsxpackages/vue/src/grid/src/table/src/methods.ts
🧬 Code Graph Analysis (1)
packages/vue/src/grid/src/table/src/methods.ts (1)
packages/renderless/src/grid/utils/common.ts (1)
getRowkey(36-36)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (2)
packages/vue/src/grid/src/edit/src/methods.ts (1)
281-294: Good refactoring to use the centralized origin row retrievalThe changes properly integrate with the new backup map approach by using
getOriginRowinstead of manual searching. This improves consistency and maintainability.packages/vue/src/grid/src/body/src/body.tsx (1)
755-756: Excellent cleanup improvements for sortable instancesThe explicit destruction of sortable instances before creating new ones and the use of optional chaining in lifecycle hooks are good practices that prevent memory leaks and potential errors.
Also applies to: 792-793
| reloadRow(row, record, field) { | ||
| let { tableData, tableSourceData } = this | ||
| let rowIndex = this.getRowIndex(row) | ||
| let originRow = tableSourceData[rowIndex] | ||
| let hasSrc = originRow && row | ||
| let hasSrcNoField = hasSrc && !field | ||
| const { tableData, treeConfig, treeOrdered } = this | ||
| const { children: childrenKey, temporaryIndex = '_$index_' } = treeConfig || {} | ||
| const rowKey = getRowkey(this) | ||
| const originRow = this.getOriginRow(row) | ||
| const hasSrc = originRow && row | ||
| const hasSrcNoField = hasSrc && !field | ||
|
|
||
| if (hasSrc && field) { | ||
| set(originRow, field, get(record || row, field)) | ||
| } | ||
|
|
||
| if (hasSrcNoField && record) { | ||
| tableSourceData[rowIndex] = record | ||
| const backupRow = this.defineField({ ...record, [rowKey]: originRow[rowKey] }) | ||
| let rowChildren, clonedRow | ||
|
|
||
| if (treeConfig) { | ||
| backupRow[childrenKey] = undefined | ||
| rowChildren = row[childrenKey] | ||
|
|
||
| if (!treeOrdered) { | ||
| backupRow[temporaryIndex] = originRow[temporaryIndex] | ||
| } | ||
| } | ||
|
|
||
| clonedRow = clone(backupRow, true) | ||
|
|
||
| if (treeConfig) { | ||
| backupRow[childrenKey] = originRow[childrenKey] | ||
| } | ||
|
|
||
| this.setOriginRow(row, backupRow) | ||
| clear(row, undefined) | ||
| Object.assign(row, this.defineField({ ...record })) | ||
| Object.assign(row, clonedRow, treeConfig ? { [childrenKey]: rowChildren } : null) | ||
| this.updateCache() | ||
| } | ||
|
|
||
| if (hasSrcNoField && !record) { | ||
| destructuring(originRow, clone(row, true)) | ||
| let clonedRow | ||
|
|
||
| if (treeConfig) { | ||
| clonedRow = clone({ ...row, [childrenKey]: undefined }, true) | ||
| clonedRow[childrenKey] = originRow[childrenKey] | ||
| } else { | ||
| clonedRow = clone(row, true) | ||
| } | ||
|
|
||
| destructuring(originRow, clonedRow) | ||
| } | ||
|
|
||
| this.tableData = tableData.slice(0) | ||
|
|
||
| return this.$nextTick() | ||
| }, |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider refactoring reloadRow for better maintainability
The method has become complex with multiple conditional branches. Consider extracting the logic into smaller, focused methods for better readability and testability.
Consider breaking down the method into smaller functions:
reloadRow(row, record, field) {
const originRow = this.getOriginRow(row)
if (!originRow || !row) {
return this.$nextTick()
}
if (field) {
return this._reloadRowField(row, originRow, record, field)
}
if (record) {
return this._reloadRowWithRecord(row, originRow, record)
}
return this._reloadRowWithoutRecord(row, originRow)
}
_reloadRowField(row, originRow, record, field) {
set(originRow, field, get(record || row, field))
this.tableData = this.tableData.slice(0)
return this.$nextTick()
}
_reloadRowWithRecord(row, originRow, record) {
// Extract lines 352-375 here
}
_reloadRowWithoutRecord(row, originRow) {
// Extract lines 377-388 here
}🤖 Prompt for AI Agents
In packages/vue/src/grid/src/table/src/methods.ts from lines 340 to 393, the
reloadRow method is complex with multiple conditional branches. Refactor by
extracting the logic into smaller helper methods: create _reloadRowField to
handle the field update logic, _reloadRowWithRecord to handle the case when a
record is provided (lines 352-375), and _reloadRowWithoutRecord for when no
record is provided (lines 377-388). Modify reloadRow to call these helpers based
on conditions, improving readability and maintainability.
| setOriginRow(row, record) { | ||
| const { backupMap } = this | ||
|
|
||
| if (backupMap.has(row) && record) { | ||
| backupMap.set(row, record) | ||
| } | ||
| }, |
There was a problem hiding this comment.
Fix the logic in setOriginRow to handle new entries
The current implementation only updates existing entries in the backup map. It should also handle the case where the row doesn't exist in the backupMap yet.
Apply this diff to fix the logic:
setOriginRow(row, record) {
const { backupMap } = this
- if (backupMap.has(row) && record) {
+ if (record) {
backupMap.set(row, record)
}
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| setOriginRow(row, record) { | |
| const { backupMap } = this | |
| if (backupMap.has(row) && record) { | |
| backupMap.set(row, record) | |
| } | |
| }, | |
| setOriginRow(row, record) { | |
| const { backupMap } = this | |
| if (record) { | |
| backupMap.set(row, record) | |
| } | |
| }, |
🤖 Prompt for AI Agents
In packages/vue/src/grid/src/table/src/methods.ts around lines 333 to 339, the
setOriginRow method only updates the backupMap if the row already exists,
missing the case to add new entries. Modify the logic to set the record in
backupMap regardless of whether the row key exists, ensuring both new and
existing entries are handled correctly.
PR
修复树表子行编辑无法恢复问题
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Bug Fixes
Refactor