Skip to content

fix: setFieldValue should reset validation #744

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 12, 2024
Merged

fix: setFieldValue should reset validation #744

merged 1 commit into from
Dec 12, 2024

Conversation

@zombieJ
Copy link
Member

@zombieJ zombieJ commented Dec 12, 2024 •
edited by coderabbitai bot
Loading

ref ant-design/ant-design#51990

Summary by CodeRabbit

  • 新功能

    • 在字段值更新时，增强了错误和警告处理能力。

  • 测试

    • 添加了新测试用例，以验证设置字段值时是否清除相关的验证错误。

@vercel
Copy link

vercel bot commented Dec 12, 2024

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

Name Status Preview Comments Updated (UTC)
field-form ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 3:18am

@coderabbitai
Copy link

coderabbitai bot commented Dec 12, 2024 •
edited
Loading

Walkthrough

此次更改主要集中在 src/useForm.ts 文件中的 FormStore 类，增加了 setFieldValue 方法的新属性 errors 和 warnings，使其能够在更新字段值时直接处理特定的错误和警告信息。方法签名已更新，以反映这些新参数的引入，同时调整了内部逻辑以确保在设置字段值时正确处理错误和警告。此外，在 tests/index.test.tsx 文件中新增了一个测试用例，以验证设置字段值时是否能清除相关的验证错误。

Changes

文件路径 更改摘要
src/useForm.ts setFieldValue 方法签名更新，新增 errors 和 warnings 参数，并调整内部逻辑以处理这些新属性。
tests/index.test.tsx 新增测试用例 setFieldValue should reset errors，验证设置字段值后是否能清除相关的验证错误。

Possibly related PRs

  • fix: change #731: 此PR修改了 Field 组件中的 getControlled 方法，可能影响 FormStore 类中 setFieldValue 方法的行为。
  • fix: change not trigger on Date #734: 此PR也改变了 Field 组件中的 getControlled 方法，调整了值比较逻辑，可能影响在 FormStore 中设置字段值时错误和警告的管理。
  • fix: List nest Field should correct removed #737: 此PR处理了 Field 组件中的嵌套字段，可能与 FormStore 中 setFieldValue 方法引入的错误和警告管理相互作用。

在田野间，兔子跳跃欢，
新增错误警告，真是妙趣横生。
字段值更新，清除烦恼，
测试用例助力，确保无误，
兔子欢呼，代码更美好！ 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3dae665 and f7975d6.

📒 Files selected for processing (2)
  • src/useForm.ts (1 hunks)
  • tests/index.test.tsx (1 hunks)
🔇 Additional comments (2)
src/useForm.ts (1)

790-791: 代码修改符合预期！

在设置字段值时清空错误和警告状态是一个很好的做法，这样可以确保用户修改值后获得新的验证反馈。

tests/index.test.tsx (1)

999-1025: 测试用例设计合理！

测试用例完整验证了 setFieldValue 重置验证错误的功能：

  1. 通过始终失败的验证器模拟错误状态
  2. 验证错误状态的存在
  3. 确认调用 setFieldValue 后错误被清除

测试覆盖了关键功能路径，逻辑严谨。

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. (Experiment)
  • @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.

@codecov
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.44%. Comparing base (3dae665) to head (f7975d6).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #744   +/-   ##
=======================================
  Coverage   99.44%   99.44%           
=======================================
  Files          18       18           
  Lines        1257     1257           
  Branches      315      296   -19     
=======================================
  Hits         1250     1250           
  Misses          7        7

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

@zombieJ zombieJ merged commit c4fe13c into master Dec 12, 2024
12 checks passed
crazyair
crazyair reviewed Dec 12, 2024
View reviewed changes
tests/index.test.tsx

// Mock error first
await act(async () => {
await formRef.current?.validateFields().catch(() => {});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.catch(() => {}) 这点不写也可以吧

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think he wrote this to prevent it console.error when run test

@zombieJ zombieJ deleted the fix-set-not-reset branch January 17, 2025 09:24
@coderabbitai coderabbitai bot mentioned this pull request Jul 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@crazyair crazyair crazyair left review comments

@nqhd3v nqhd3v nqhd3v left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@zombieJ @crazyair @nqhd3v