Skip to content

fix: sumi extension restart logic#4498

Merged
erha19 merged 1 commit intomainfrom
fix/sumi-extension-restart
Mar 26, 2025
Merged

fix: sumi extension restart logic#4498
erha19 merged 1 commit intomainfrom
fix/sumi-extension-restart

Conversation

@erha19
Copy link
Copy Markdown
Member

@erha19 erha19 commented Mar 26, 2025

Types

  • 🐛 Bug Fixes

Background or solution

  1. 修复插件贡献点重复注册逻辑,解决菜单重复注册问题
image
  1. 优化 ExtensionHost Restart 时序,移除并发状态下的 cancel 逻辑(会导致 Extension 的 activate 方法重复调用多次问题)

Changelog

优化 Sumi Extension 重启流程

Summary by CodeRabbit

  • 重构

    • 优化了扩展实例清理流程,使操作逻辑更简洁高效,保障扩展正常关闭。
  • 修复

    • 改进了扩展重启时加载状态的管理,避免重复显示进度指示,提升了重启体验的流畅性。

@opensumi opensumi Bot added the 🐞 bug Something isn't working label Mar 26, 2025
@erha19
Copy link
Copy Markdown
Member Author

erha19 commented Mar 26, 2025

/next

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 26, 2025

Walkthrough

此次更新涉及两个模块的改进。第一个模块在扩展实例销毁方法中移除了条件判断,采用可选链直接调用 dispose 方法,从而简化了代码。第二个模块为 ExtensionServiceImpl 类新增了 isProgressShowing 属性,用于跟踪扩展重启的加载状态,并在重启流程中增加了相应的检查和状态更新,以防止重复显示加载进度。整体逻辑保持不变,仅优化了内部处理流程。

Changes

文件路径 变更摘要
packages/extension/src/browser/...extension-instance-management.ts 修改了 disposeExtensionInstancesByPath 方法,移除条件检查,使用可选链直接调用 dispose 方法。
packages/extension/src/browser/...extension.service.ts ExtensionServiceImpl 类中新增私有属性 isProgressShowing,并在扩展重启逻辑中加入状态检查及更新,防止重复显示加载状态。

Sequence Diagram(s)

sequenceDiagram
    participant 用户 as 用户
    participant ES as ExtensionServiceImpl
    participant PS as ProgressService
    用户->>ES: 触发扩展重启 (ERestartPolicy.Always)
    Note right of ES: 检查 isProgressShowing 标志
    alt isProgressShowing 为 true
        ES->>用户: 输出日志并跳过重启流程
    else isProgressShowing 为 false
        ES->>PS: 显示重启进度
        ES->>ES: 设置 isProgressShowing = true
        ES->>ES: 执行 doRestart() (具有副作用,不可取消)
        ES->>PS: 隐藏重启进度
        ES->>ES: 设置 isProgressShowing = false
        ES->>用户: 重启完成
    end
Loading

Suggested labels

🎨 feature

Suggested reviewers

  • hacke2

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.

yarn install v1.22.22
[1/4] Resolving packages...
warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: 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 > glob@7.2.3: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.


📜 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 5851e8d and 83a2f78.

📒 Files selected for processing (2)
  • packages/extension/src/browser/extension-instance-management.ts (1 hunks)
  • packages/extension/src/browser/extension.service.ts (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: 🚀🚀🚀 Next Version for pull request
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: build-windows
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
🔇 Additional comments (6)
packages/extension/src/browser/extension-instance-management.ts (1)

78-78: 代码改进:使用可选链简化逻辑

代码变更使用了可选链操作符 ?. 来简化扩展实例的销毁逻辑,消除了不必要的条件检查,使代码更加简洁和易读。这种写法在实例不存在时会优雅地不执行 dispose 方法。

packages/extension/src/browser/extension.service.ts (5)

179-180: 添加状态跟踪变量来优化重启逻辑

新增了 isProgressShowing 属性用于跟踪扩展重启过程中是否已经显示加载状态,这有助于防止在多个并发状态下重复显示加载进度。


389-389: 完善状态重置:取消重启时清除加载状态

在重启过程被取消时,确保重置 isProgressShowing 状态为 false,避免后续重启操作被错误地阻止。这是对新增状态管理的完整处理。


400-400: 完善状态重置:重启完成后清除加载状态

在重启流程完成时重置 isProgressShowing,确保下次重启能够正常显示加载进度。这是对新增状态管理的完整处理。


420-426: 优化重启流程:避免重复显示加载状态

在启动重启流程前先检查 isProgressShowing 状态,如果已经在显示加载状态则跳过,防止多次触发重启导致的 UI 问题。同时在显示进度前将状态设为 true,确保状态一致性。


443-443: 添加重要注释说明重启函数行为

添加了关键注释解释 doRestart 函数存在严重的副作用且不应被取消,这有助于开发者理解代码的设计意图和限制,提高代码维护性。

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

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@opensumi
Copy link
Copy Markdown
Contributor

opensumi Bot commented Mar 26, 2025

🎉 PR Next publish successful!

3.8.3-next-1742977855.0

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 26, 2025

Codecov Report

Attention: Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.

Project coverage is 53.12%. Comparing base (5851e8d) to head (83a2f78).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ackages/extension/src/browser/extension.service.ts 14.28% 5 Missing and 1 partial ⚠️
...nsion/src/browser/extension-instance-management.ts 0.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4498      +/-   ##
==========================================
- Coverage   53.13%   53.12%   -0.01%     
==========================================
  Files        1665     1665              
  Lines      102645   102648       +3     
  Branches    22216    22224       +8     
==========================================
- Hits        54541    54536       -5     
- Misses      40018    40025       +7     
- Partials     8086     8087       +1     
Flag Coverage Δ
jsdom 48.62% <12.50%> (-0.01%) ⬇️
node 12.12% <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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@erha19 erha19 merged commit 91eaefa into main Mar 26, 2025
14 checks passed
@erha19 erha19 deleted the fix/sumi-extension-restart branch March 26, 2025 09:29
@erha19 erha19 mentioned this pull request May 20, 2025
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