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: add delay for disposing inline edit adapter to prevent rejection #4400

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

erha19
Copy link
Member

@erha19 erha19 commented Feb 23, 2025

… issues

Types

  • 🐛 Bug Fixes

Background or solution

当前 freeInlineEdit 的执行时机比 reject 命令执行时机更快,导致命令 dispose 后异常

Changelog

add delay for disposing inline edit adapter to prevent rejection

Summary by CodeRabbit

  • Bug Fixes
    • 延迟内联编辑操作结束时资源释放,防止快速退出编辑时产生异常,提高内联编辑稳定性。

@erha19
Copy link
Member Author

erha19 commented Feb 23, 2025

/next

@opensumi opensumi bot added the 🐞 bug Something isn't working label Feb 23, 2025
Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

Walkthrough

ExtHostLanguages 类的 $freeInlineEdit 方法中,对内联编辑操作的清理逻辑进行了调整。原先直接调用 adapter.disposeEdit(pid) 的方式被替换成了通过 setTimeout 延时 100 毫秒后再进行调用,从而避免了在用户通过 ESC 键提前取消内联编辑时可能出现的异常。方法的签名保持不变,只是将资源释放的时机改为异步处理。

Changes

文件路径 修改说明
packages/extension/src/hosted/api/vscode/ext.host.language.ts 将直接调用 adapter.disposeEdit(pid) 修改为使用 setTimeout 延时100毫秒后调用,防止内联编辑被提前销毁导致异常

Sequence Diagram(s)

sequenceDiagram
    participant C as 调用者
    participant L as ExtHostLanguages
    participant A as Adapter
    C->>L: 调用 $freeInlineEdit(handle, pid)
    L->>L: 启动 setTimeout (100ms 延时)
    Note right of L: 延迟后进行资源释放
    L->>A: 调用 disposeEdit(pid)
Loading

Possibly related PRs

Suggested labels

🐞 bug

Suggested reviewers

  • bytemain
  • 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 [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:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

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

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

🧹 Nitpick comments (1)
packages/extension/src/hosted/api/vscode/ext.host.language.ts (1)

696-707: 延迟释放内联编辑适配器的修复看起来合理。

通过添加 100ms 的延迟来避免内联编辑适配器在 reject 命令完成之前被销毁的问题,这是一个简单有效的解决方案。注释也清晰地解释了这个修改的目的。

不过建议考虑以下几点改进:

  1. 可以将延迟时间提取为一个命名常量,使代码更易维护
  2. 考虑使用 disposableTimeout 而不是 setTimeout,以确保定时器在需要时能被正确清理
-        setTimeout(() => adapter.disposeEdit(pid), 100);
+        const INLINE_EDIT_DISPOSE_DELAY = 100;
+        disposableTimeout(() => adapter.disposeEdit(pid), INLINE_EDIT_DISPOSE_DELAY);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7094c8c and 9334214.

📒 Files selected for processing (1)
  • packages/extension/src/hosted/api/vscode/ext.host.language.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: 🚀🚀🚀 Next Version for pull request
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build-windows

@opensumi
Copy link
Contributor

opensumi bot commented Feb 23, 2025

🎉 PR Next publish successful!

3.7.2-next-1740323956.0

Copy link

codecov bot commented Feb 23, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 53.58%. Comparing base (7094c8c) to head (9334214).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...tension/src/hosted/api/vscode/ext.host.language.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4400      +/-   ##
==========================================
- Coverage   53.58%   53.58%   -0.01%     
==========================================
  Files        1651     1651              
  Lines      101806   101806              
  Branches    22027    22027              
==========================================
- Hits        54557    54552       -5     
- Misses      39304    39308       +4     
- Partials     7945     7946       +1     
Flag Coverage Δ
jsdom 49.08% <0.00%> (-0.01%) ⬇️
node 12.23% <0.00%> (ø)

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.

@Aaaaash Aaaaash merged commit c312476 into main Feb 24, 2025
14 checks passed
@Aaaaash Aaaaash deleted the fix/reject-inlineEdit-command branch February 24, 2025 01:32
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