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(select): [select] fix component error caused by vue2 deep cleanup memory leak #2843

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Jan 23, 2025

PR

修复因为vue2深度清理内存泄漏导致的组件报错问题

Vue2.mixin({
destroyed(){
delete xxx
}
})

在深度清理时会删除vue实例的_watcher,导致computed建立的_watcher为undefined的报错

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Refactor
    • Simplified the handling of currentValue property
    • Streamlined value assignment logic for option components

Copy link

coderabbitai bot commented Jan 23, 2025

Walkthrough

The pull request modifies the currentValue property handling in the Vue option component. The changes simplify the state management by replacing a computed property with a direct assignment approach. The currentValue is now set directly using props.value || props.label || '', removing the previous dynamic computation method and streamlining the value assignment logic in both the initialization and watch functions.

Changes

File Change Summary
packages/renderless/src/option/vue.ts Simplified currentValue property handling by replacing computed property with direct value assignment

Possibly related PRs

Suggested labels

bug

Poem

🐰 A rabbit's ode to code so neat,
Where currentValue finds its beat
No more computed, just plain and true
A simpler path, a clearer view
Hop along, code refactored bright! 🌟

✨ 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.

@github-actions github-actions bot added the bug Something isn't working label Jan 23, 2025
Copy link

Walkthrough

This pull request addresses a component error in the select component caused by a memory leak in Vue 2's deep cleanup process. The changes focus on modifying how currentValue is computed and updated to prevent the error.

Changes

File Summary
packages/renderless/src/option/vue.ts Modified the computation and assignment of currentValue to avoid using computed for its definition, and updated its value directly in the watcher function.

@@ -36,7 +36,7 @@ const initState = ({ reactive, computed, props, api, markRaw, select, parent })
disabled: computed(() => props.disabled || state.groupDisabled),
isObject: computed(() => Object.prototype.toString.call(props.value).toLowerCase() === '[object object]'),
currentLabel: computed(() => props.label || (state.isObject ? '' : props.value)),
currentValue: computed(() => props.value || props.label || ''),
currentValue: props.value || props.label || '',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from computed to a direct assignment for currentValue may lead to unexpected behavior if currentValue is expected to reactively update based on dependencies. Ensure that this change does not break reactive updates elsewhere in the component.

Copy link

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

@zzcr zzcr changed the title fix(select): fix component error caused by vue2 deep cleanup memory leak fix(select): [select] fix component error caused by vue2 deep cleanup memory leak Jan 23, 2025
Copy link

@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

🧹 Nitpick comments (1)
packages/renderless/src/option/vue.ts (1)

Line range hint 93-103: Consider extracting the object comparison logic.

The complex object comparison logic for valueKey could be extracted into a separate function for better maintainability and reusability.

+const isValueKeyEqual = (newVal, oldVal, valueKey) => {
+  return valueKey &&
+    typeof newVal === 'object' &&
+    typeof oldVal === 'object' &&
+    newVal[valueKey] === oldVal[valueKey]
+}

 watch(
   () => props.value,
   (value, oldVal) => {
     const { remote, valueKey } = select
     state.currentValue = value || props.label || ''
     if (!props.created && !remote) {
-      if (
-        valueKey &&
-        typeof value === 'object' &&
-        typeof oldVal === 'object' &&
-        value[valueKey] === oldVal[valueKey]
-      ) {
+      if (isValueKeyEqual(value, oldVal, valueKey)) {
         return
       }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05b7e6e and 9c40761.

📒 Files selected for processing (1)
  • packages/renderless/src/option/vue.ts (2 hunks)
🔇 Additional comments (2)
packages/renderless/src/option/vue.ts (2)

Line range hint 127-143: LGTM: Proper cleanup implementation.

The cleanup implementation in onBeforeUnmount is thorough and properly handles:

  • Removal from cached options
  • Event listener cleanup
  • Select state updates

39-39: Verify all update scenarios with the simplified currentValue implementation.

The change from a computed property to direct assignment helps reduce memory leaks by eliminating unnecessary watchers. However, we should verify that all update scenarios are properly handled, especially edge cases.

Let's verify the component's behavior in different scenarios:

✅ Verification successful

The currentValue implementation correctly handles all update scenarios

The simplified implementation with direct assignment and watch handler properly manages all value updates while reducing unnecessary watchers. The change is safe and aligned with the memory leak fix objective.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for all usages of currentValue to ensure we haven't missed any update scenarios
rg "currentValue" --type ts

# Look for potential test files that verify the component's behavior
fd -e spec.ts -e test.ts "option" 

Length of output: 24701

@@ -90,7 +90,7 @@ const initWatch = ({ watch, props, state, select, constants }) => {
() => props.value,
(value, oldVal) => {
const { remote, valueKey } = select

state.currentValue = value || props.label || ''
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Handle edge case where value is 0.

The fallback chain value || props.label || '' will treat 0 as falsy and fall back to props.label. This might not be the desired behavior if 0 is a valid value.

Consider this alternative implementation:

-      state.currentValue = value || props.label || ''
+      state.currentValue = value != null ? value : props.label || ''
📝 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.

Suggested change
state.currentValue = value || props.label || ''
state.currentValue = value != null ? value : props.label || ''

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant