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

默认值只设置了default Value,没有设置zod的默认值 #4996

Closed
wants to merge 5 commits into from

Conversation

leizhiyou
Copy link
Contributor

@leizhiyou leizhiyou commented Dec 2, 2024

Description

修复之前设置嵌套对象的默认值只设置了default Value,覆盖了zod设置的默认值

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

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 validation by utilizing field rules for schema construction instead of default values.
  • Bug Fixes

    • Improved handling of non-string rules in form initialization, leading to more accurate validation.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request involve an update to the generateInitialValues function within the useFormInitial function of the use-form-context.ts file. The modification changes the source of the value assigned in the zodObject from item.defaultValue to item.rules when the item has defined rules that are not strings. This adjustment alters the schema construction for validation without affecting the overall structure or logic of the function.

Changes

File Path Change Summary
packages/@core/ui-kit/form-ui/src/use-form-context.ts Updated generateInitialValues to use item.rules instead of item.defaultValue for schema construction.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

In the garden where forms take flight,
Rules now guide with clearer light.
Default values take a bow,
For item rules are here, and how!
With every field, a story grows,
Validation blooms, as logic flows. 🐇✨

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.

packages/@core/ui-kit/form-ui/src/use-form-context.ts

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


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 (1)
packages/@core/ui-kit/form-ui/src/use-form-context.ts (1)

Line range hint 42-49: Consider adding type validation for Zod rules.

While the !isString(item.rules) check prevents string-based validation rules from being added to the Zod schema, it might be beneficial to add explicit type validation to ensure item.rules is a valid Zod schema type.

Consider adding a type guard:

      } else if (item.rules && !isString(item.rules)) {
+       // Ensure item.rules is a valid Zod schema
+       if ('_def' in item.rules) {
          set(zodObject, item.fieldName, item.rules);
+       }
      }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 014e6d3 and 473aba2.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/form-ui/src/use-form-context.ts (1 hunks)
🔇 Additional comments (2)
packages/@core/ui-kit/form-ui/src/use-form-context.ts (2)

46-46: LGTM! The fix correctly uses Zod rules for schema defaults.

The change properly addresses the issue by using item.rules instead of item.defaultValue when constructing the Zod schema object, ensuring that Zod's default values are correctly applied.

Let's verify the usage of Zod rules in the codebase:

✅ Verification successful

The fix correctly handles Zod schema defaults

Based on the code analysis:

  • The FormShape interface in types.ts shows that rules is correctly typed as ZodTypeAny
  • The generateInitialValues function properly merges both explicit defaults and Zod schema defaults using getDefaultsForSchema
  • The test suite confirms the form initialization behavior
  • The change to use item.rules instead of item.defaultValue for Zod schema construction is correct as it ensures Zod's built-in default values are properly applied
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent usage of Zod rules in form schemas
# Expected: Find form schema definitions to verify the fix's impact

# Search for form schema definitions using Zod rules
ast-grep --pattern 'schema: [
  {
    $$$
    rules: $$$
    $$$
  }
]'

# Search for potential Zod default value usage
rg -A 3 'default\(' --type ts

Length of output: 105


Script:

#!/bin/bash
# Let's try a different approach to find Zod schema and rules usage

# Search for Zod schema definitions and rules
rg -l "z\." --type ts

# Find files containing form schema definitions
rg -l "schema.*\[" --type ts

# Look for specific usage of the form context
rg -l "useFormContext" --type ts

# Check the implementation details of the form context
fd "use-form-context.ts" --type f --exec cat {}

Length of output: 2062


Script:

#!/bin/bash
# Let's examine the form schema structure and test cases

# Check the form schema type definition
cat packages/@core/ui-kit/form-ui/src/types.ts

# Look at test cases to understand usage patterns
cat packages/@core/ui-kit/form-ui/__tests__/form-api.test.ts

# Check the form API implementation
cat packages/@core/ui-kit/form-ui/src/form-api.ts

Length of output: 21589


Line range hint 51-51: Verify schema initialization with mixed default sources.

The merging of initialValues and schemaInitialValues looks correct, but it's worth verifying that the precedence order (initialValues being overridden by schemaInitialValues) is the intended behavior.

Let's check for any existing tests or documentation about this behavior:

✅ Verification successful

Schema initial values correctly override explicit default values

Based on the implementation in use-form-context.ts, the precedence order is intentional and correct:

  1. First, initialValues are populated from explicit defaultValue properties in the schema items
  2. Then, schemaInitialValues from Zod schema defaults are spread over the initial values
  3. This order ensures that Zod schema defaults take precedence, which is the expected behavior as schema validation rules should be the source of truth

The implementation follows a clear pattern where schema-derived values take precedence over explicitly set defaults, which is a common practice in form validation libraries to ensure consistency with the schema definition.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Look for tests or documentation about form default value precedence
# Expected: Find test cases or documentation explaining the intended behavior

# Search for related test files
fd -e test.ts -e spec.ts form

# Search for documentation about default values
rg -i "default.*value.*precedence" --type md

Length of output: 135


Script:

#!/bin/bash
# Let's examine the test file content and search for related tests
cat packages/@core/ui-kit/form-ui/__tests__/form-api.test.ts

# Also search for any usage patterns of initialValues and schemaInitialValues
rg -A 5 "initialValues.*schemaInitialValues|schemaInitialValues.*initialValues"

# Look for schema-related tests or implementations
ast-grep --pattern 'describe($_, () => {
  $$$
  test($_, () => {
    $$$
    initialValues
    $$$
  })
  $$$
})'

Length of output: 5766


Script:

#!/bin/bash
# Let's look for the implementation and any related tests specifically about initialValues
rg -A 10 "const getInitialValues" packages/@core/ui-kit/form-ui/src/use-form-context.ts

# Search for any schema-related tests that might involve initial values
rg -A 10 "initialValues.*=|schemaInitialValues.*=" packages/@core/ui-kit/form-ui/src/

# Look for any documentation comments about initial values
ast-grep --pattern '
/**
 * $$$
 * initialValues
 * $$$
 */'

Length of output: 2841

@mynetfan
Copy link
Collaborator

mynetfan commented Dec 6, 2024

该PR所依赖的commit已经被撤回,请重新提交。

@mynetfan mynetfan closed this Dec 6, 2024
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.

2 participants