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

[WIP]fix: comments being collapsed when toggle editor #4408

Open
wants to merge 1 commit into
base: v3.8
Choose a base branch
from

Conversation

hacke2
Copy link
Member

@hacke2 hacke2 commented Feb 25, 2025

Types

  • 🐛 Bug Fixes

Background or solution

Changelog

fix: comments being collapsed when toggle editor

Summary by CodeRabbit

  • 新功能
    • 优化了评论展示逻辑,现在返回评论界面时,相关组件会始终正常显示,带来更流畅的用户体验。
    • 增强了兼容性:在旧环境中若缺少生成唯一标识的原生支持,系统将自动启用备用方案,确保功能稳定实现。

@opensumi opensumi bot added the 🐞 bug Something isn't working label Feb 25, 2025
@hacke2
Copy link
Member Author

hacke2 commented Feb 25, 2025

/next

Copy link
Contributor

coderabbitai bot commented Feb 25, 2025

Walkthrough

本次变更涉及两个部分:首先,修改了 CommentsThread 中显示评论小部件的逻辑,移除了对 widget.isShow 的检查,确保只要编辑器的 URI 与线程的 URI 匹配就调用 show 方法,同时更新了相关注释;其次,在 index.html 中添加了对 window.crypto.randomUUID 方法的存在性检查,并在其不存在时提供了一个符合 UUID 格式的 polyfill。

Changes

文件路径 更改摘要
packages/.../comments-thread.ts 移除对 widget.isShow 的检查,改为只要编辑器 URI 与线程 URI 匹配就调用 show() 方法,并更新了相关注释。
tools/.../index.html 添加对 window.crypto.randomUUID 方法的检查,如不存在则提供 polyfill,实现 UUID 生成逻辑。

Sequence Diagram(s)

sequenceDiagram
    participant Editor as 编辑器
    participant Thread as 评论线程
    participant Widget as 小部件
    Editor->>Thread: 激活或更新编辑器 URI
    Thread->>Thread: 检查编辑器 URI 是否与线程 URI 匹配
    Thread->>Widget: 调用 show() 方法显示小部件
Loading

Possibly related PRs

Suggested labels

🐞 bug

Suggested reviewers

  • erha19

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)
tools/dev-tool/src/index.html (1)

26-33: 建议使用更安全的 UUID 生成方法

当前的 polyfill 实现使用 Math.random() 生成 UUID,这种方法不是密码学安全的,可能会导致 UUID 冲突。

建议使用以下实现来提高安全性:

-      if (typeof window.crypto.randomUUID === 'undefined') {
-        window.crypto.randomUUID = () =>
-          'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
-            const r = (Math.random() * 16) | 0;
-            const v = c === 'x' ? r : (r & 0x3) | 0x8;
-            return v.toString(16);
-          });
-      }
+      if (typeof window.crypto.randomUUID === 'undefined') {
+        window.crypto.randomUUID = () => {
+          const getRandomValues = window.crypto.getRandomValues.bind(window.crypto);
+          const rnds = new Uint8Array(16);
+          getRandomValues(rnds);
+          rnds[6] = (rnds[6] & 0x0f) | 0x40; // Version 4
+          rnds[8] = (rnds[8] & 0x3f) | 0x80; // Variant
+          const hex = Array.from(rnds).map(b => b.toString(16).padStart(2, '0')).join('');
+          return `${hex.slice(0,8)}-${hex.slice(8,12)}-${hex.slice(12,16)}-${hex.slice(16,20)}-${hex.slice(20)}`;
+        };
+      }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c4a200 and 8a0d401.

📒 Files selected for processing (2)
  • packages/comments/src/browser/comments-thread.ts (1 hunks)
  • tools/dev-tool/src/index.html (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: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build-windows
🔇 Additional comments (1)
packages/comments/src/browser/comments-thread.ts (1)

253-254: 代码逻辑优化合理

移除了冗余的 widget.isShow 检查,使得切换回已存在的评论组件时的行为更加一致和可预测。注释也准确反映了新的行为。

@opensumi
Copy link
Contributor

opensumi bot commented Feb 25, 2025

🎉 PR Next publish successful!

3.8.1-next-1740452912.0

@hacke2 hacke2 changed the title fix: comments being collapsed when toggle editor [WIP]fix: comments being collapsed when toggle editor Feb 25, 2025
@hacke2 hacke2 changed the base branch from main to v3.8 February 26, 2025 08:39
Copy link

codecov bot commented Feb 26, 2025

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 53.39%. Comparing base (f7916df) to head (146fbbd).

Files with missing lines Patch % Lines
packages/comments/src/browser/comments-thread.ts 0.00% 1 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             v3.8    #4408      +/-   ##
==========================================
- Coverage   53.45%   53.39%   -0.06%     
==========================================
  Files        1657     1657              
  Lines      102103   102188      +85     
  Branches    22084    22114      +30     
==========================================
- Hits        54576    54561      -15     
- Misses      39546    39619      +73     
- Partials     7981     8008      +27     
Flag Coverage Δ
jsdom 48.90% <0.00%> (-0.07%) ⬇️
node 12.19% <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.

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.

1 participant