Skip to content

fix: default value for nested fields - #5763

Merged
mynetfan merged 1 commit into
vbenjs:mainfrom
mynetfan:fix/form-nested-fields
Mar 21, 2025
Merged

mynetfan merged 1 commit into
vbenjs:mainfrom
mynetfan:fix/form-nested-fields

Conversation

@mynetfan

@mynetfan mynetfan commented Mar 21, 2025 •

Copy link
Copy Markdown
Collaborator

Description

修复表单使用“x.x.x”作为字段名时,默认值无效的问题。

fix: #5762

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 initialization with improved handling of nested data, providing more robust merging of default values.
  • Chores

    • Updated project dependencies and type definitions to support advanced utility functions for data handling.

@changeset-bot

changeset-bot Bot commented Mar 21, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6ed04dd

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

@coderabbitai

coderabbitai Bot commented Mar 21, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request introduces the addition of the lodash.set library along with its type definitions to the shared package, reflected in both the package and workspace configuration files. It adds an export for the set function in the utilities module and updates the form context’s generateInitialValues function to use set for nested default value assignments and merges via mergeWithArrayOverride.

Changes

File(s) Change Summary
packages/@core/base/shared/package.json, pnpm-workspace.yaml Added lodash.set in dependencies and @types/lodash.set in devDependencies/catalog for type definitions.
packages/@core/base/shared/src/utils/index.ts Added a new export statement to expose the default export of the set function from lodash.set.
packages/@core/ui-kit/form-ui/src/use-form-context.ts Modified generateInitialValues to use the set function for assigning default values and introduced mergeWithArrayOverride for merging initial values with schema defaults.

Sequence Diagram(s)

sequenceDiagram
    participant F as Form
    participant G as generateInitialValues
    participant S as set (lodash)
    participant M as mergeWithArrayOverride
    F->>G: Request default values
    G->>S: Set nested default value for each field
    G->>S: Loop through schema defaults using set
    G->>M: Merge initialValues with schema defaults
    M-->>G: Return merged values
    G-->>F: Deliver the final initial values
Loading

Assessment against linked issues

Objective Addressed Explanation
Default value assignment for nested fields (e.g., 'meta.keepAlive') (#5762) ✅

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

I'm a hopping rabbit in the code night,
Skipping through changes with delight,
With lodash.set my path is set,
Nested defaults no longer fret,
Celebrating new code under the moonlight 🌙🐇!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39888ce and 6ed04dd.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • packages/@core/base/shared/package.json (2 hunks)
  • packages/@core/base/shared/src/utils/index.ts (1 hunks)
  • packages/@core/ui-kit/form-ui/src/use-form-context.ts (2 hunks)
  • pnpm-workspace.yaml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (8)
packages/@core/base/shared/src/utils/index.ts (1)

20-20: Excellent addition of lodash.set to support nested object paths

This addition enables setting values in deeply nested objects using dot notation (e.g., "a.b.c"), which is essential for working with nested form fields.

packages/@core/base/shared/package.json (2)

91-91: Properly added lodash.set dependency

The addition of the lodash.set dependency is necessary for the functionality to work. Good job using the "catalog:" reference to maintain consistency with other dependencies.


100-100: Correctly added TypeScript type definitions

Adding @types/lodash.set ensures proper TypeScript support for the new dependency. This maintains type safety throughout the project.

pnpm-workspace.yaml (2)

48-48: Appropriate TypeScript type definition version

The added TypeScript definition with version ^4.3.2 corresponds correctly with the lodash.set implementation.


120-120: Consistent lodash.set dependency version

The lodash.set dependency with version ^4.3.2 aligns with the TypeScript definition and is pinned appropriately.

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

10-10: Updated imports to include needed utilities

Good job importing both set and mergeWithArrayOverride from the shared utilities. This ensures that the form context has the necessary tools to handle nested fields.


53-53: Fixed default value assignment for nested fields

This is the core fix for the issue. By replacing direct assignment with set(initialValues, item.fieldName, item.defaultValue), the code now correctly handles nested field paths like "x.x.x" when setting default values.


61-65: Enhanced schema initial values handling

This change properly handles nested paths in schema initial values:

  1. Creates a dedicated object for zodDefaults
  2. Uses set to properly handle any nested paths in schema defaults
  3. Uses mergeWithArrayOverride for proper merging of arrays and objects

This is crucial for correctly handling both top-level and nested default values from Zod schemas.

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

@mynetfan
mynetfan merged commit 03ceb2a into vbenjs:main Mar 21, 2025
@mynetfan
mynetfan deleted the fix/form-nested-fields branch March 21, 2025 08:06
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: fieldName: 'meta.keepAlive' 表单字段默认值不起作用

1 participant