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: display debug hover view with correct size config #4338

Merged
merged 4 commits into from
Feb 5, 2025

Conversation

erha19
Copy link
Member

@erha19 erha19 commented Feb 5, 2025

Types

  • 🐛 Bug Fixes

Background or solution

Before:
image
After:
image

Changelog

display debug hover view with correct size config

Summary by CodeRabbit

  • 新功能
    • 调试悬停视图现可根据当前屏幕空间和状态栏位置自动调整高度,确保布局更加灵活和响应迅速,从而提升用户体验。
  • 其他变更
    • 更新了E2E测试的GitHub Actions工作流,升级了actions/upload-artifact的版本,从v3更新至v4

@erha19 erha19 requested a review from Ricbet February 5, 2025 06:37
@opensumi opensumi bot added the 🐞 bug Something isn't working label Feb 5, 2025
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

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.

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:*"

Walkthrough

这次修改在 debug-hover.view.tsx 文件中引入了三个新常量,并调整了调试悬浮视图的布局逻辑。新增的常量用于动态计算最大高度,考虑了视口高度、状态栏高度和底部边距。在收到 TreeNodeEvent.DidChangeExpansionState 事件时,组件会检查包装元素的边界信息,依据其位置进行高度计算,否则回退到默认最大高度。同时,简化了 treeHeight 的计算逻辑,确保在 branchSize 未定义时使用默认值。

Changes

文件路径 更改摘要
packages/debug/src/browser/editor/debug-hover.view.tsx 新增常量 DEFAULT_MAX_HEIGHTDEFAULT_HOVER_WEIGET_MARGIN_BOTTOMlayoutViewSize(通过注入 LayoutViewSizeConfig);调整事件监听逻辑,根据视口、状态栏和边距动态计算 treeLayoutHeight;简化 treeHeight 计算逻辑。
.github/workflows/e2e.yml 更新 actions/upload-artifact 动作版本,从 v3 升级到 v4

Sequence Diagram(s)

sequenceDiagram
    participant EVT as TreeNodeEvent
    participant HoverView as DebugHoverView
    participant Layout as 布局管理器

    EVT->>HoverView: 触发 DidChangeExpansionState 事件
    alt 获取到 wrapper 边界信息
        HoverView->>HoverView: 计算最大高度 = 视口高度 - wrapper.top - 状态栏高度 - 默认底部边距
    else 无边界信息
        HoverView->>HoverView: 使用 DEFAULT_MAX_HEIGHT 作为最大高度
    end
    HoverView->>Layout: 更新 treeLayoutHeight,实现自适应布局
Loading

Suggested reviewers

  • hacke2
  • Ricbet
  • Aaaaash

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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/debug/src/browser/editor/debug-hover.view.tsx (1)

52-52: 建议将魔法数字提取为常量

在计算树高度时使用了魔法数字 22,建议将其提取为有意义的常量,以提高代码的可维护性。

+const TREE_NODE_HEIGHT = 22;
 const treeHeight = Math.max(
   DEFAULT_LAYOUT_HEIGHT,
-  (model.treeModel?.root.branchSize || 0) * 22
+  (model.treeModel?.root.branchSize || 0) * TREE_NODE_HEIGHT
 );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5472a76 and 96ca281.

📒 Files selected for processing (1)
  • packages/debug/src/browser/editor/debug-hover.view.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • 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: build-windows
🔇 Additional comments (2)
packages/debug/src/browser/editor/debug-hover.view.tsx (2)

6-6: 代码结构清晰,依赖注入使用恰当!

新增的常量定义和依赖注入的使用都很合理,有助于提高代码的可维护性和可配置性。

Also applies to: 23-23, 26-27


51-61: 布局逻辑优化合理,提升了用户体验!

新的高度计算逻辑考虑了视口高度、状态栏高度和底部边距,使调试悬浮窗的展示更加合理。同时也添加了合适的回退机制,代码健壮性很好。

Ricbet
Ricbet previously approved these changes Feb 5, 2025
Copy link

codecov bot commented Feb 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.23%. Comparing base (9d9400c) to head (5c10877).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4338      +/-   ##
==========================================
- Coverage   54.23%   54.23%   -0.01%     
==========================================
  Files        1638     1638              
  Lines      100153   100153              
  Branches    21746    21746              
==========================================
- Hits        54320    54313       -7     
- Misses      38086    38091       +5     
- Partials     7747     7749       +2     
Flag Coverage Δ
jsdom 49.70% <ø> (-0.01%) ⬇️
node 12.30% <ø> (+<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
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 (2)
packages/debug/src/browser/editor/debug-hover.view.tsx (2)

6-6: 修正常量命名中的拼写错误

常量 DEFAULT_HOVER_WEIGET_MARGIN_BOTTOM 中的 "WEIGET" 拼写错误,应该是 "WIDGET"。

建议修改为:

-const DEFAULT_HOVER_WEIGET_MARGIN_BOTTOM = 4;
+const DEFAULT_HOVER_WIDGET_MARGIN_BOTTOM = 4;

Also applies to: 23-23, 26-27


51-61: 建议提取高度计算逻辑以提高可读性

当前的高度计算逻辑包含了多个条件和计算步骤,建议将其提取为独立的函数以提高可读性和可维护性。

建议重构为:

+const calculateTreeHeight = (root: any) => {
+  return Math.max(DEFAULT_LAYOUT_HEIGHT, (root?.branchSize || 0) * 22);
+};
+
+const calculateMaxHeight = (rect: DOMRect, statusBarHeight: number) => {
+  return window.innerHeight - rect.top - statusBarHeight - DEFAULT_HOVER_WIDGET_MARGIN_BOTTOM;
+};
+
 disposable = model.treeModel.root.watcher.on(TreeNodeEvent.DidChangeExpansionState, () => {
-  const treeHeight = Math.max(DEFAULT_LAYOUT_HEIGHT, (model.treeModel?.root.branchSize || 0) * 22);
+  const treeHeight = calculateTreeHeight(model.treeModel?.root);
   const rect = wrapperRef.current?.getBoundingClientRect();
   if (rect) {
-    const top = rect.top;
-    const maxHeight =
-      window.innerHeight - top - layoutViewSize.statusBarHeight - DEFAULT_HOVER_WEIGET_MARGIN_BOTTOM;
+    const maxHeight = calculateMaxHeight(rect, layoutViewSize.statusBarHeight);
     setTreeLayoutHeight(Math.min(maxHeight, treeHeight, DEFAULT_MAX_HEIGHT));
   } else {
     setTreeLayoutHeight(Math.min(DEFAULT_MAX_HEIGHT, treeHeight));
   }
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fb1339e and ade6714.

📒 Files selected for processing (1)
  • packages/debug/src/browser/editor/debug-hover.view.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • 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: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: build-windows
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, node)
🔇 Additional comments (1)
packages/debug/src/browser/editor/debug-hover.view.tsx (1)

21-158: 整体实现符合最佳实践

组件实现遵循了 React 最佳实践:

  • 使用 hooks 管理状态和副作用
  • 正确处理组件清理
  • 良好的关注点分离

@erha19 erha19 merged commit 4ff2942 into main Feb 5, 2025
11 checks passed
@erha19 erha19 deleted the fix/debug-varibales-visble branch February 5, 2025 09:42
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