fix(tabs): Optimize multi terminal caching logic, add add add delete operations to trigger sub component destruction and reconstruction logic #3601
Conversation
WalkthroughThe changes introduce a caching mechanism for tab panels in a Vue component. The renderless state is extended to include a cache object and a computed list of tab names. The tab panel rendering logic is refactored to use this cache, removing reliance on Vue's KeepAlive and improving cache management for rendered tab panels. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant VueComponent
participant State (tabPanelCache)
participant TabPanel
User->>VueComponent: Selects a tab
VueComponent->>State (tabPanelCache): Check for cached tab panel by name
alt Not cached
VueComponent->>TabPanel: Create new TabPanel vnode
VueComponent->>State (tabPanelCache): Store vnode in cache
else Cached
VueComponent->>TabPanel: Toggle display style (show/hide)
end
VueComponent->>VueComponent: Render tab panels from cache
Estimated code review effort4 (approximately one day) 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/renderless/src/tabs-mf/vue.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/tabs/src/mobile-first.vueOops! 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 (
|
chenxi-20
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
packages/vue/src/tabs/src/mobile-first.vue (3)
43-45: Remove redundant cache initialization.The
tabPanelCacheis already initialized in the renderless state (packages/renderless/src/tabs-mf/vue.ts:49). This check is unnecessary.- if (!state.tabPanelCache) { - state.tabPanelCache = {} - } const panelCache = state.tabPanelCache
49-54: Consider implementing cache size limits.While the cleanup logic removes tabs not in current
includeNames, the cache could grow unbounded in applications that dynamically create many unique tab names over time.Consider implementing:
- Maximum cache size limit
- LRU (Least Recently Used) eviction strategy
- Time-based cache expiration
Example approach:
const MAX_CACHE_SIZE = 50 if (Object.keys(panelCache).length > MAX_CACHE_SIZE) { // Implement LRU eviction }
42-77: Add tests for the new caching mechanism.The PR checklist indicates that tests were not added. This caching logic introduces complexity that should be thoroughly tested, including:
- Cache initialization and cleanup
- Tab switching with cached panels
- Memory management
- Vue 2/3 compatibility
Would you like me to help generate unit tests for the caching mechanism or open an issue to track this task?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/renderless/src/tabs-mf/vue.ts(1 hunks)packages/vue/src/tabs/src/mobile-first.vue(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/vue/src/tabs/src/mobile-first.vue (2)
Learnt from: Davont
PR: opentiny/tiny-vue#2513
File: packages/vue/src/huicharts/huicharts-histogram/src/chart-histogram.vue:33-36
Timestamp: 2024-11-25T03:43:05.285Z
Learning: 在 Tiny Vue 代码库中，使用 `chart-core` 中的 `huiChartOption` 的组件，不应在其 `data` 中定义 `huiChartOption` 或 `option`，而是应该依赖 `chart-core` 提供的 `huiChartOption`。
Learnt from: Davont
PR: opentiny/tiny-vue#2513
File: packages/vue/src/huicharts/huicharts-sunburst/src/chart-sunburst.vue:30-32
Timestamp: 2024-11-25T03:24:05.740Z
Learning: 在位于`packages/vue/src/huicharts/huicharts-sunburst/src/chart-sunburst.vue`的组件中，当使用`chart-core`时，应删除错误的`option`定义，使用`chart-core`中的`huiChartOption`。
🔇 Additional comments (1)
packages/renderless/src/tabs-mf/vue.ts (1)
48-50: LGTM! State additions for caching mechanism.The new state properties are correctly implemented:
tabPanelCacheprovides storage for cached tab panelsincludeNamescomputed property efficiently tracks active tab names for cache cleanup- Trailing comma improves formatting consistency
| if (panelCache[cacheKey].elm) { | ||
| panelCache[cacheKey].elm.style.display = item.name === currentName ? 'block' : 'none' | ||
| } |
There was a problem hiding this comment.
Avoid direct DOM manipulation - use Vue's reactivity system.
Direct manipulation of elm.style.display bypasses Vue's virtual DOM and could lead to synchronization issues. Consider using a reactive approach instead.
Alternative approaches:
- Store visibility state in a reactive property
- Use v-show directive in the template
- Wrap cached vnodes with a visibility controller component
Example reactive approach:
- if (panelCache[cacheKey].elm) {
- panelCache[cacheKey].elm.style.display = item.name === currentName ? 'block' : 'none'
- }
+ // Store visibility state in cache
+ if (!panelCache[cacheKey].visible) {
+ panelCache[cacheKey].visible = reactive({ show: false })
+ }
+ panelCache[cacheKey].visible.show = item.name === currentNameCommittable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In packages/vue/src/tabs/src/mobile-first.vue around lines 71 to 73, avoid
directly manipulating the DOM element's style property to show or hide panels.
Instead, refactor the code to store the visibility state in a reactive property
and use Vue's v-show directive in the template to control panel visibility. This
ensures synchronization with Vue's virtual DOM and maintains reactivity.
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