Skip to content

feat: 支持useVbenForm的dependencies.triggerFields为嵌套字段 #6296

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

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

Conversation

wyc001122
Copy link
Contributor

@wyc001122 wyc001122 commented May 28, 2025

Description

close #6273

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 support for form dependencies by allowing access to nested form field values, enabling more flexible and dynamic form behavior.

Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

The change updates the dependencies logic in the form rendering utility to support accessing nested field values in triggerFieldValues. If a dependency field name contains a dot, the code now uses a utility to retrieve nested values, enabling dependency tracking for nested fields as well as top-level fields.

Changes

File(s) Change Summary
packages/@core/ui-kit/form-ui/src/form-render/dependencies.ts Modified logic in useDependencies to support nested field access in triggerFieldValues using getNestedValue.

Sequence Diagram(s)

sequenceDiagram
    participant FormComponent
    participant useDependencies
    participant getNestedValue

    FormComponent->>useDependencies: Provide form values and dependencies
    useDependencies->>useDependencies: Iterate over triggerFields
    alt Field is nested (contains '.')
        useDependencies->>getNestedValue: Retrieve nested value
        getNestedValue-->>useDependencies: Return nested field value
    else Field is top-level
        useDependencies->>useDependencies: Access value directly
    end
    useDependencies-->>FormComponent: Return computed triggerFieldValues
Loading

Assessment against linked issues

Objective Addressed Explanation
Support dependencies triggerFields for nested fields (#6273)

Possibly related issues

Suggested reviewers

  • anncwb
  • mynetfan
  • jinmao88

Poem

In fields both flat and nested deep,
A rabbit hops, no secrets to keep.
Now forms react to every change,
Even when paths are long and strange.
With dotty trails and values true,
The forms are smarter—thanks to you!
🐇✨

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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

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

40-45: Good implementation with minor edge case consideration.

The nested field access implementation is well-structured and maintains backward compatibility. The Chinese comment clearly explains the new functionality.

However, consider adding error handling for edge cases:

  return triggerFields.map((dep) => {
+   // Validate dependency field name
+   if (typeof dep !== 'string' || dep.length === 0) {
+     console.warn(`Invalid dependency field name: ${dep}`);
+     return undefined;
+   }
    // 支持嵌套字段访问,如 'config.name'
    if (dep.includes('.')) {
-     return getNestedValue(values.value, dep);
+     try {
+       return getNestedValue(values.value, dep);
+     } catch (error) {
+       console.warn(`Failed to access nested field '${dep}':`, error);
+       return undefined;
+     }
    }
    return values.value[dep];
  });

This adds resilience against invalid field names and provides helpful debugging information without breaking the form functionality.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f31360b and 132deb0.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/form-ui/src/form-render/dependencies.ts (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/@core/ui-kit/form-ui/src/form-render/dependencies.ts (1)
packages/@core/base/shared/src/utils/util.ts (1)
  • getNestedValue (27-44)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (1)
packages/@core/ui-kit/form-ui/src/form-render/dependencies.ts (1)

9-9: LGTM! Import statement correctly updated.

The addition of getNestedValue to the imports is necessary for the new nested field functionality.

Copy link

changeset-bot bot commented May 28, 2025

⚠️ No Changeset found

Latest commit: d52bd8d

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

@jinmao88
Copy link
Collaborator

jinmao88 commented Jun 2, 2025

根据AI提示 有可以优化的地方

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.

Bug: Vben Form的 dependencies 的 triggerFields 嵌套字段不生效
2 participants