Skip to content

refactor(effectScope): scopes doubly-linked list #13535

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 4 commits into
base: main
Choose a base branch
from

Conversation

importwu
Copy link

@importwu importwu commented Jun 27, 2025

Summary by CodeRabbit

  • Refactor
    • Improved internal management of child scopes for better performance and maintainability. No changes to public APIs or user-facing behavior.

Copy link

coderabbitai bot commented Jun 27, 2025

Walkthrough

The internal implementation of the EffectScope class has been refactored to manage its child scopes using a custom doubly linked list instead of an array. Methods for pausing, resuming, and stopping scopes now traverse this linked list, and scope removal updates the list pointers accordingly. No public APIs were changed.

Changes

File(s) Change Summary
packages/reactivity/src/effectScope.ts Refactored EffectScope to use a doubly linked list for child scope management instead of an array.

Sequence Diagram(s)

sequenceDiagram
    participant ParentScope
    participant ChildScope
    note over ParentScope: On creation of ChildScope
    ParentScope->>ChildScope: Construct ChildScope
    ChildScope-->>ParentScope: Add to linked list (update head/tail and pointers)
    note over ParentScope,ChildScope: On stop()
    ParentScope->>ChildScope: Traverse via nextEffectScope
    ChildScope-->>ParentScope: Unlink self (update prev/next pointers, head/tail)
Loading

Poem

In the garden of scopes where effects like to play,
Arrays made way for links—doubly, they say!
Each scope now holds paws, both forward and back,
Hopping through changes, no child left off track.
With pointers aligned, our code’s neat and tight—
A warren of logic, now linked just right!
🐇✨


📜 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 1f63cf6 and 001a1e6.

📒 Files selected for processing (1)
  • packages/reactivity/src/effectScope.ts (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/reactivity/src/effectScope.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

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: 0

🧹 Nitpick comments (5)
packages/reactivity/src/effectScope.ts (5)

37-42: Improve documentation for the linked list properties.

The comment "sibling scope" is somewhat misleading. These properties implement a doubly linked list structure for child scope management.

Consider updating the documentation to be more descriptive:

   /**
-   *  sibling scope
+   * Pointer to the previous scope in the parent's linked list of child scopes
+   * @internal
    */
   prevEffectScope: EffectScope | undefined
+  /**
+   * Pointer to the next scope in the parent's linked list of child scopes  
+   * @internal
+   */
   nextEffectScope: EffectScope | undefined

47-53: Fix semicolon consistency.

There's inconsistent semicolon usage in the linked list insertion logic.

       if (activeEffectScope.scopesTail) {
-        this.prevEffectScope = activeEffectScope.scopesTail;
-        activeEffectScope.scopesTail.nextEffectScope = this;
-        activeEffectScope.scopesTail = this;
+        this.prevEffectScope = activeEffectScope.scopesTail
+        activeEffectScope.scopesTail.nextEffectScope = this
+        activeEffectScope.scopesTail = this
       } else {
-        activeEffectScope.scopes = activeEffectScope.scopesTail = this;
+        activeEffectScope.scopes = activeEffectScope.scopesTail = this
       }

64-66: Fix semicolon consistency in pause() method.

       for (let child = this.scopes; child != undefined; child = child.nextEffectScope) {
-        child.pause();
+        child.pause()
       }

80-82: Fix semicolon consistency in resume() method.

         for (let child = this.scopes; child != undefined; child = child.nextEffectScope) {
-          child.resume();
+          child.resume()
         }

141-144: Fix semicolon consistency in stop() method.

       for (let child = this.scopes; child != undefined; child = child.nextEffectScope) {
-        child.stop(true);
+        child.stop(true)
       }
-      this.scopes = this.scopesTail = undefined;
+      this.scopes = this.scopesTail = undefined
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ba391f5 and 1f63cf6.

📒 Files selected for processing (1)
  • packages/reactivity/src/effectScope.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
🔇 Additional comments (2)
packages/reactivity/src/effectScope.ts (2)

147-160: Well-implemented doubly linked list removal logic!

The removal logic correctly handles all edge cases:

  • Updates pointers of neighboring nodes
  • Properly updates parent's head pointer when removing the first node
  • Properly updates parent's tail pointer when removing the last node

This ensures the linked list remains consistent after removal.


35-160: Excellent refactoring to improve performance!

The refactoring from array-based child scope management to a doubly linked list is well-executed. This change provides O(1) insertion at the tail and O(1) removal operations, which should improve performance when dealing with many child scopes that are frequently created and destroyed.

The implementation correctly maintains all invariants of a doubly linked list and properly handles edge cases during removal.

@edison1105
Copy link
Member

edison1105 commented Jun 27, 2025

Thanks for the PR.
Could you please provide a benchmark for these changes?

NOTE:
This PR increases the bundle size

@edison1105 edison1105 added the need more info Further information is requested label Jun 27, 2025
Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+252 B) 38.3 kB (+26 B) 34.6 kB (+47 B)
vue.global.prod.js 159 kB (+252 B) 58.5 kB (+17 B) 52.1 kB (+46 B)

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.8 kB (+252 B) 18.2 kB (+35 B) 16.7 kB (+17 B)
createApp 54.7 kB (+252 B) 21.2 kB (+19 B) 19.4 kB (+25 B)
createSSRApp 58.9 kB (+254 B) 22.9 kB (+21 B) 20.9 kB (+34 B)
defineCustomElement 59.7 kB (+252 B) 22.8 kB (+22 B) 20.8 kB (+26 B)
overall 68.8 kB (+252 B) 26.4 kB (+33 B) 24 kB (-15 B)

Copy link

pkg-pr-new bot commented Jun 27, 2025

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13535

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13535

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13535

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13535

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13535

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13535

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13535

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13535

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13535

vue

npm i https://pkg.pr.new/vue@13535

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13535

commit: 001a1e6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need more info Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy