Skip to content

fix: Memory leak caused by zombie event listeners in useTouchMove.ts #836

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

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

Conversation

mix0000
Copy link

@mix0000 mix0000 commented May 7, 2025

The code was smelly and it causes a memory leak, even if component is unmounted it will keep the whole context inside Detached Event Listener

image

Summary by CodeRabbit

  • 优化
    • 改进了触摸和滚轮事件的监听与清理机制,提升了性能和稳定性。用户体验保持一致,无需额外操作。

 - Use AbortController for all listeners to better readability and scalability
Copy link

vercel bot commented May 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tabs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 10:54am

Copy link

coderabbitai bot commented May 7, 2025

Walkthrough

本次更改将 useTouchMove 钩子中的事件监听器管理方式由手动移除改为使用 AbortController。事件监听器在添加时传入 signal,清理时通过调用 abort() 自动移除所有相关监听器。其他逻辑保持不变,导出接口未更改。

Changes

文件/路径 变更摘要
src/hooks/useTouchMove.ts 使用 AbortController 管理事件监听器的添加与清理,替代手动移除。

Poem

兔子挥动小爪爪,
事件监听不再愁。
AbortController 来帮忙,
一键清理,轻松溜。
代码整洁又高效,
跳跃前行不用停留!
🐇✨

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/hooks/useTouchMove.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" 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:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected]_jest@29.7.0_@types[email protected][email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 778663d and fb5472b.

📒 Files selected for processing (1)
  • src/hooks/useTouchMove.ts (2 hunks)
🔇 Additional comments (3)
src/hooks/useTouchMove.ts (3)

113-114: 使用 AbortController 是一个很好的改进

通过添加 AbortController,你为事件监听器提供了一个集中式的管理机制,这是处理事件监听器的现代化方法。


128-144: 正确使用 signal 参数注册事件监听器

在所有事件监听器上添加 signal: abortController.signal 参数是很好的做法,这确保了组件卸载时所有监听器都会被自动清理,从而防止内存泄漏。各个事件监听器的 passive 参数设置也保持了适当的值。

这种方法比手动移除每个监听器更加健壮,不易出错。


147-147: 使用 abort() 进行清理是一个简洁的解决方案

使用 abortController.abort() 替代手动移除每个事件监听器的方式更加简洁高效。这种方法确保了所有关联的事件监听器都会被正确清除,完全解决了 PR 中提到的"僵尸"事件监听器导致的内存泄漏问题。

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ 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.

Support

Need 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)

  • @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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant