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: when context key cause different menu bars change at same time. only one menu bar refreshed #4182

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

xkaede
Copy link
Contributor

@xkaede xkaede commented Nov 25, 2024

Types

  • 🐛 Bug Fixes

Background or solution

复现步骤:
1、定义一个context key.设置两个不同的menubar下的menu item的when为该context key。
2、更改该context key的值。
现象:只有一个menubar被刷新。
期待结果:两个menubar应该都被刷新。

Changelog

Summary by CodeRabbit

  • 新功能
    • 改进了菜单更新处理,支持批量处理多个菜单变更,提高了菜单结构的刷新效率。

@opensumi opensumi bot added the 🐞 bug Something isn't working label Nov 25, 2024
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

本次变更对 packages/core-browser/src/menu/next/menubar-service.ts 文件中的 MenubarServiceImpl 类进行了修改。新增了一个名为 menuIdsSet<string>,用于跟踪已更改的菜单 ID。同时,更新了 onMenuChange 的事件监听器,以在去抖动时间内累积更改的菜单 ID,并随后针对每个唯一的菜单 ID 调用 _rebuildSingleRootMenus 方法。这一改动提高了菜单更新的处理效率,使多个菜单更改能够被集体处理。

Changes

文件路径 变更摘要
packages/core-browser/src/menu/next/menubar-service.ts 添加 menuIds 集合以跟踪更改的菜单 ID;更新 onMenuChange 事件监听器以处理菜单更新。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MenubarServiceImpl
    participant Menu

    User->>MenubarServiceImpl: 触发菜单更改
    MenubarServiceImpl->>MenubarServiceImpl: 更新 menuIds
    MenubarServiceImpl->>MenubarServiceImpl: 去抖动处理
    MenubarServiceImpl->>Menu: 调用 _rebuildSingleRootMenus
    Menu-->>MenubarServiceImpl: 返回更新后的菜单结构
Loading

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 (1.23.1)

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.

warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > [email protected]: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"


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 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
Contributor

@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

🧹 Outside diff range and nitpick comments (1)
packages/core-browser/src/menu/next/menubar-service.ts (1)

65-78: 事件处理逻辑改进得当,建议添加错误处理

实现方案很好地解决了多个菜单栏同步刷新的问题:

  • 使用 debounce 合理地控制了更新频率
  • 通过 Set 收集变更的菜单 ID
  • 批量处理所有累积的变更

建议添加 try-catch 来增强代码的健壮性:

      )(() => {
        const changedMenuIds = [...menuIds.values()];
        menuIds.clear();
+       try {
          changedMenuIds.forEach((menuId) => {
            this._rebuildSingleRootMenus(menuId);
          });
+       } catch (error) {
+         console.error('处理菜单更新时发生错误:', error);
+         this._onDidMenuBarChange.fire();  // 发生错误时触发完整刷新
+       }
      }, this),
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5ddaa0b and b874285.

📒 Files selected for processing (1)
  • packages/core-browser/src/menu/next/menubar-service.ts (1 hunks)
🔇 Additional comments (1)
packages/core-browser/src/menu/next/menubar-service.ts (1)

62-62: 使用 Set 来跟踪菜单 ID 是个不错的选择!

使用 Set 数据结构可以有效地确保菜单 ID 的唯一性,这是一个很好的实现方式。

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

Attention: Patch coverage is 11.11111% with 8 lines in your changes missing coverage. Please review.

Project coverage is 54.06%. Comparing base (5ddaa0b) to head (b874285).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
...ages/core-browser/src/menu/next/menubar-service.ts 11.11% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4182      +/-   ##
==========================================
- Coverage   54.06%   54.06%   -0.01%     
==========================================
  Files        1612     1612              
  Lines       97917    97925       +8     
  Branches    20051    20043       -8     
==========================================
  Hits        52941    52941              
- Misses      37365    37373       +8     
  Partials     7611     7611              
Flag Coverage Δ
jsdom 49.63% <11.11%> (-0.01%) ⬇️
node 15.56% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@hacke2 hacke2 left a comment

Choose a reason for hiding this comment

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

LGTM

@hacke2 hacke2 merged commit 5809d45 into opensumi:main Nov 26, 2024
13 checks passed
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.

2 participants