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: repair the unexpected form default value #5567

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

littlesparklet
Copy link

@littlesparklet littlesparklet commented Feb 20, 2025

Description

当表单项校验规则为number\intersection等时,会出现不符合预期的默认值,如issue #5451 所述。
本提交增加了getCustomDefaultValue方法,以处理此类情况。

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Enhanced form initialization with dynamic default value resolution, enabling more robust handling of complex validation schemas for improved user experience.

Copy link

changeset-bot bot commented Feb 20, 2025

⚠️ No Changeset found

Latest commit: e222e65

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

The pull request updates the form context functionality by enhancing schema validation and initialization. The changes expand imported Zod types, modify the logic in the generateInitialValues function to check for custom default values, and introduce a new recursive function getCustomDefaultValue for extracting defaults. These modifications enable handling of more complex and nested validation schemas.

Changes

File Summary
packages/@core/ui-kit/form-ui/src/use-form-context.ts - Expanded import statements to include additional Zod types (ZodIntersection, ZodNumber, ZodObject, and ZodString).
- Updated generateInitialValues to check for custom default values using the new getCustomDefaultValue function.
- Added getCustomDefaultValue for recursive default extraction for various Zod types.

Sequence Diagram(s)

sequenceDiagram
    participant GF as generateInitialValues
    participant CD as getCustomDefaultValue
    participant ZF as Zod Validation Schema

    GF->>ZF: Parse form rules for each field
    GF->>CD: Check if custom default exists for rule
    CD-->>GF: Return custom default (if exists)
    GF->>ZF: Merge or apply default value based on type
Loading

Possibly related PRs

Suggested labels

feature

Suggested reviewers

  • mynetfan
  • anncwb
  • vince292007

Poem

I'm a rabbit with coding delight,
Nibbling on changes day and night.
Defaults and schemas now cleverly align,
In our form context, everything's just fine.
Hopping through the code with a joyful twitch—
A magical merge, oh what a switch!
🐇✨ Enjoy the hop of every new glitch!

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

@littlesparklet littlesparklet changed the title Form default value fix: repair the unexpected form default value.(issue #5451) Feb 20, 2025
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: 1

🧹 Nitpick comments (1)
packages/@core/ui-kit/form-ui/src/use-form-context.ts (1)

68-99: Handle potential type mismatch and other Zod types
The recursive default extraction is effective for ZodString, ZodNumber, ZodObject, and ZodIntersection. However, returning null for ZodNumber might cause type issues if the form logic expects a numeric value. Also consider how you'd like to handle boolean or array types (e.g., ZodBoolean, ZodArray) to avoid unexpected runtime errors:

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ccd99eb and e222e65.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/form-ui/src/use-form-context.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (1)
packages/@core/ui-kit/form-ui/src/use-form-context.ts (1)

13-13: Imports for advanced schema usage
Nice addition of ZodIntersection, ZodNumber, ZodObject, and ZodString from zod. These imports enable more flexible validation and facilitate the new custom default extraction logic.

Comment on lines +52 to +60
// 检查规则是否适合提取默认值
const customDefaultValue = getCustomDefaultValue(item.rules);
if (customDefaultValue === undefined) {
// 否则将规则添加到 zodObject
zodObject[item.fieldName] = item.rules;
} else {
// 如果有自定义默认值,直接使用
initialValues[item.fieldName] = customDefaultValue;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Retain validation rules to avoid skipping schema checks
Currently, adding the rule to zodObject only happens if no custom default is found. Fields with custom defaults never make it into zodObject, potentially skipping validation. If you want to both apply the custom default and preserve validation, consider merging the rule into the shape regardless:

- if (customDefaultValue === undefined) {
-   zodObject[item.fieldName] = item.rules;
- } else {
-   initialValues[item.fieldName] = customDefaultValue;
- }
+ zodObject[item.fieldName] = item.rules;
+ if (customDefaultValue !== undefined) {
+   initialValues[item.fieldName] = customDefaultValue;
+ }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// 检查规则是否适合提取默认值
const customDefaultValue = getCustomDefaultValue(item.rules);
if (customDefaultValue === undefined) {
// 否则将规则添加到 zodObject
zodObject[item.fieldName] = item.rules;
} else {
// 如果有自定义默认值,直接使用
initialValues[item.fieldName] = customDefaultValue;
}
// 检查规则是否适合提取默认值
const customDefaultValue = getCustomDefaultValue(item.rules);
zodObject[item.fieldName] = item.rules;
if (customDefaultValue !== undefined) {
initialValues[item.fieldName] = customDefaultValue;
}

@littlesparklet littlesparklet changed the title fix: repair the unexpected form default value.(issue #5451) fix: repair the unexpected form default value Feb 20, 2025
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.

1 participant