Skip to content

fix: fix the edge mis trigger #1092

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

Merged
merged 1 commit into from
Dec 5, 2024
Merged

fix: fix the edge mis trigger #1092

merged 1 commit into from
Dec 5, 2024

Conversation

zombieJ
Copy link
Member

@zombieJ zombieJ commented Dec 5, 2024

Edge 自动完成的时候会莫名其妙触发一个 keyDown 事件到不相关的 input 上。目前只看出来最小复原结构为:

<!-- 当存在 `value` 时,会被随机影响到 -->
<input value="xxxx" />

解法为对触发打开的判断加一个键位判断,为空的话就认为是无效键跳过开启。

fix ant-design/ant-design#51292

Summary by CodeRabbit

  • Bug Fixes

    • 修复了与 Edge 浏览器相关的键验证逻辑,确保只有有效的键码被评估。
  • Tests

    • Select 组件添加了新的测试用例,以验证无效和有效键的处理。
    • 在测试中引入了 act 函数,以确保状态更新正确处理。
  • Chores

    • 更新了测试工具中的 keyDown 函数,以增强事件对象的功能。

Copy link

vercel bot commented Dec 5, 2024

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

Name Status Preview Comments Updated (UTC)
select ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 8:04am

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Walkthrough

此次更改主要涉及三个文件的修改。src/utils/keyUtil.ts中的isValidateOpenKey函数逻辑进行了调整,新增了对currentKeyCode的真值检查,以解决Edge浏览器中的特定bug。tests/Accessibility.test.tsx中增加了对Select组件的新测试用例,确保在处理无效和有效按键时组件的行为正确。最后,tests/utils/common.ts中对keyDown函数进行了小幅修改,增加了which属性到事件对象。

Changes

文件路径 更改摘要
src/utils/keyUtil.ts 修改isValidateOpenKey函数逻辑,新增对currentKeyCode的真值检查。
tests/Accessibility.test.tsx Select组件添加新测试用例,使用act函数处理状态更新。
tests/utils/common.ts 修改keyDown函数,增加which属性到事件对象。

Assessment against linked issues

Objective Addressed Explanation
选中浏览器的历史记录,不自动展开下拉框 (#[51292])

Possibly related PRs

Poem

🐇 在键盘上跳跃,轻轻一按,
Edge的烦恼,已不再烦恼,
选择组件欢快,状态更新,
测试用例增添,确保无误,
兔子欢呼,代码更美妙! 🌟

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.

src/utils/keyUtil.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Cannot read config file: /.eslintrc.js
Error: Cannot find module '@umijs/fabric/dist/eslint'
Require stack:

  • /.eslintrc.js
  • /node_modules/.pnpm/@eslint+eslintrc@2.1.4/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/index.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/.eslintrc.js:1:14)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)

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

🧹 Outside diff range and nitpick comments (3)
src/utils/keyUtil.ts (1)

5-39: 代码逻辑正确,建议增加防御性检查

修复方案通过增加 currentKeyCode 的真值检查来解决 Edge 浏览器的自动完成触发问题,实现简单有效。建议考虑增加类型检查以提高代码的健壮性。

建议增加以下类型检查:

 export function isValidateOpenKey(currentKeyCode: number): boolean {
   return (
     // Undefined for Edge bug:
     // https://github.com/ant-design/ant-design/issues/51292
-    currentKeyCode &&
+    typeof currentKeyCode === 'number' && currentKeyCode > 0 &&
     // Other keys
     ![
tests/Accessibility.test.tsx (1)

71-104: 测试用例覆盖了基本场景,建议补充边界情况

当前测试用例验证了 undefined 和有效按键的情况,这很好。但建议增加更多边界测试场景以确保修复的完整性。

建议增加以下测试场景:

  1. 测试 keyCode 为 0 的情况
  2. 测试 keyCode 为负数的情况
  3. 测试 keyCode 为非数字类型的情况

示例代码:

it('edge bug - additional edge cases', () => {
  const { container } = render(
    <Select
      mode="combobox"
      options={[{ value: '123' }]}
      defaultValue="123"
    />
  );

  // Test keyCode = 0
  keyDown(container.querySelector('input')!, 0);
  act(() => {
    jest.runAllTimers();
  });
  expectOpen(container, false);

  // Test negative keyCode
  keyDown(container.querySelector('input')!, -1);
  act(() => {
    jest.runAllTimers();
  });
  expectOpen(container, false);
});
tests/utils/common.ts (1)

104-106: 事件模拟实现正确,建议添加注释说明

通过 Object.defineProperties 添加 which 属性的实现符合 DOM 事件规范,但建议添加注释说明这个属性的作用和必要性。

建议添加如下注释:

  const event = createEvent.keyDown(element, { keyCode });
+ // 添加 which 属性以完整模拟键盘事件
+ // 某些浏览器依赖 which 属性来确定按键值
  Object.defineProperties(event, {
    which: { get: () => keyCode },
  });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 35546c0 and 2f62abe.

📒 Files selected for processing (3)
  • src/utils/keyUtil.ts (1 hunks)
  • tests/Accessibility.test.tsx (2 hunks)
  • tests/utils/common.ts (1 hunks)

Copy link

codecov bot commented Dec 5, 2024

Codecov Report

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

Project coverage is 98.31%. Comparing base (35546c0) to head (2f62abe).

Files with missing lines Patch % Lines
tests/utils/common.ts 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1092      +/-   ##
==========================================
+ Coverage   98.24%   98.31%   +0.07%     
==========================================
  Files          39       39              
  Lines        1483     1487       +4     
  Branches      419      443      +24     
==========================================
+ Hits         1457     1462       +5     
+ Misses         26       25       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zombieJ zombieJ merged commit a040910 into master Dec 5, 2024
11 of 12 checks passed
@zombieJ zombieJ deleted the fix-edge branch December 5, 2024 08:07
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.

edge 浏览器输入框选中历史记录,会出发其他下拉框展开下拉
1 participant