Skip to content

isDom判断逻辑兼容iframe的node #639

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

apades
Copy link

@apades apades commented Apr 1, 2025

在用@rc-components/trigger时发现在documentPictureInPicture里的node有问题,改了这个就好了

Summary by CodeRabbit

  • 重构

    • 改进了页面元素识别机制,提升了在不同文档环境下的兼容性与准确性。
  • 测试

    • 新增了测试场景,确保在嵌入环境(如 iframe)中元素的正确识别和稳定性能。

Verified

This commit was signed with the committer’s verified signature.
Copy link

vercel bot commented Apr 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
util ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 1:04pm

Copy link

coderabbitai bot commented Apr 1, 2025

Walkthrough

这个 PR 修改了 isDOM 函数,通过引入新变量 win 从节点所属文档的 defaultView 获取上下文,进而使用该上下文中的 HTMLElementSVGElement 进行类型判断,以便在不同文档上下文中正确识别 DOM 节点。此外,还新增了一个测试用例,在 iframe 环境中对 SVG 元素进行测试,验证 isDOM 函数的行为。

Changes

文件 修改内容说明
src/Dom/findDOMNode.ts isDOM 函数中新增 win 变量,通过节点的 ownerDocument.defaultView 获取上下文中的元素构造函数,实现更准确的 DOM 类型判断。
tests/findDOMNode.test.tsx 新增了一个测试用例“isDOM type in iframe”,在 iframe 中创建 SVG 元素并验证 isDOM 函数对其的正确识别。

Sequence Diagram(s)

Loading
sequenceDiagram
    participant T as 测试用例 (iframe)
    participant I as iframe
    participant S as SVG 元素
    participant F as isDOM 函数

    T->>I: 创建并附加 iframe 到文档
    I->>I: 在 iframe 内创建 SVG 元素 (S)
    T->>F: 调用 isDOM(S)
    F->>S: 获取 S.ownerDocument.defaultView (win)
    F-->>T: 返回类型判断结果

Suggested reviewers

  • zombieJ

Poem

我是一只快乐的小兔子,
跳跃在代码的花园中找寻奇遇。
新加入的 win 如同魔法闪烁,
在 iframe 内测试展现独特魅力。
代码如诗,点缀着技术的梦! 🐰💻

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.

tests/findDOMNode.test.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

src/Dom/findDOMNode.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

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

Sorry, something went wrong.

Copy link

@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)
tests/findDOMNode.test.tsx (2)

88-88: 移除调试代码

请移除代码中的debugger;语句。这类调试语句不应保留在最终的代码中。

- // debugger;

80-95: 添加iframe清理代码

测试创建了iframe并添加到document.body中,但没有在测试结束后将其移除。应当在测试结束时清理这些DOM元素,以避免内存泄漏和对其他测试的影响。

  it('isDOM type in iframe', () => {
    const iframe = document.createElement('iframe');
    document.body.appendChild(iframe);
    const svg: any = iframe.contentWindow.document.createElementNS(
      'http://www.w3.org/2000/svg',
      'svg',
    );

    // This `getBoundingClientRect` is used for ts type check
    if (isDOM(svg) && svg.getBoundingClientRect()) {
      expect(true).toBeTruthy();
    } else {
      expect(true).toBeFalsy();
    }
+   // Clean up the iframe after test
+   document.body.removeChild(iframe);
  });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2880228 and b496704.

📒 Files selected for processing (2)
  • src/Dom/findDOMNode.ts (1 hunks)
  • tests/findDOMNode.test.tsx (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
tests/findDOMNode.test.tsx (1)
src/Dom/findDOMNode.ts (1)
  • isDOM (3-9)
🔇 Additional comments (3)
src/Dom/findDOMNode.ts (2)

4-5: 引入win变量增强了跨文档上下文的DOM节点识别能力

通过获取节点所属文档的defaultView,代码现在能够在不同的窗口上下文(如iframe中)正确识别DOM元素。这种方法比使用全局window更加健壮,可以解决在iframe环境中DOM元素无法被正确识别的问题。


8-8: 正确使用节点上下文的构造函数进行类型检查

修改后的代码使用win.HTMLElementwin.SVGElement进行类型检查,而不是直接使用全局窗口的构造函数。这解决了当节点来自不同窗口上下文(如iframe)时的类型识别问题。

tests/findDOMNode.test.tsx (1)

80-95: 有效验证了在iframe环境中的isDOM功能

这个测试用例很好地验证了修复的功能,确保isDOM函数能够正确识别来自iframe环境中的DOM元素。测试逻辑清晰,与现有的DOM测试保持一致的风格。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant