fix: handleValuesChange brings processed values

[mynetfan]

form的handleValuesChange回调函数的参数将传递已转换后的表单值

Summary by CodeRabbit

• Bug Fixes

  • Improved form value change detection to ensure the latest form values are used when handling updates.
  • Fixed form reset action to correctly retrieve and process current form values.

• Documentation

  • Clarified details about the changed fields parameter in form value change callbacks, specifying its behavior with schema definitions and field mappings.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 45bed8f

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]

Walkthrough

The change updates the watcher on form.values within the vben-use-form.vue component to use an asynchronous callback. Instead of passing the new value directly to the handleValuesChange callback, it now asynchronously fetches the latest form values using the form API, performs a deep clone, and passes this result along with the changed fields. The logic for detecting which fields changed and caching values remains the same, and there are no modifications to exported or public entity declarations. Additionally, the documentation for handleValuesChange was clarified to specify that the fieldsChanged parameter only includes field names defined in the schema and excludes mapped field names. A fix was also made in form-actions.vue to await the asynchronous retrieval of form values before calling toRaw() in the reset handler.

Changes

File(s)	Change Summary
packages/@core/ui-kit/form-ui/src/vben-use-form.vue	Modified the watcher on form.values to use an async callback that fetches current form values from the API and passes them to handleValuesChange instead of the watcher’s newVal.
docs/src/components/common-ui/vben-form.md	Updated documentation for handleValuesChange callback to clarify that fieldsChanged only includes schema-defined field names and excludes mapped field names.
packages/@core/ui-kit/form-ui/src/components/form-actions.vue	Fixed handleReset function to await the promise returned by formApi?.getValues() before calling toRaw(), ensuring raw form values are processed correctly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FormComponent
    participant FormAPI

    User->>FormComponent: Change form value
    FormComponent->>FormComponent: Watcher detects change
    FormComponent->>FormAPI: getValues()
    FormAPI-->>FormComponent: Current form values
    FormComponent->>FormComponent: Deep clone values, detect changed fields
    FormComponent->>FormComponent: handleValuesChange(clonedValues, changedFields)

Loading

Possibly related PRs

• feat: pass fieldsChanged into the handleValuesChange callback #5968: Enhanced the form watcher to pass fieldsChanged into handleValuesChange, which is further built upon in this PR by fetching the latest form values asynchronously.

Suggested reviewers

• anncwb
• jinmao88

Poem

A watcher once watched with a synchronous eye,
But now it awaits as the values pass by.
With API fetches, the freshest it brings,
To handle each change and the fields that it pings.
In forms we now trust, with updates anew—
Hopping ahead, as all rabbits do! 🐇

---

📜 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 45bed8f and 8d10dd5.

📒 Files selected for processing (1)

• packages/@core/ui-kit/form-ui/src/components/form-actions.vue (1 hunks)

🔇 Additional comments (1)

packages/@core/ui-kit/form-ui/src/components/form-actions.vue (1)

65-65: Great fix for handling asynchronous form values correctly.

The addition of await ensures that toRaw() is called on the actual form values rather than on a Promise object. This makes the handleReset function consistent with the handleSubmit function (line 56) which was already correctly awaiting the values. This fix prevents potential bugs that could occur when the code expects values to be the actual form data rather than a Promise.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/@core/ui-kit/form-ui/src/vben-use-form.vue (1)

94-97: Improvement: Now passing processed form values.

This change addresses the core issue by ensuring that handleValuesChange receives the latest processed form values from the form API rather than the raw values from the watcher. This is an improvement as it ensures any transformations or validations applied by the form API are included in the values passed to the callback.

However, consider adding error handling for the API call.

-            forward.value.handleValuesChange(
-              cloneDeep(await forward.value.formApi.getValues()),
-              changedFields,
-            );
+            try {
+              const values = await forward.value.formApi.getValues();
+              forward.value.handleValuesChange(
+                cloneDeep(values),
+                changedFields,
+              );
+            } catch (error) {
+              console.error('Failed to get form values:', error);
+            }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0936861 and da65ddc.

📒 Files selected for processing (1)

• packages/@core/ui-kit/form-ui/src/vben-use-form.vue (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: post-update (windows-latest)

🔇 Additional comments (1)

packages/@core/ui-kit/form-ui/src/vben-use-form.vue (1)

75-75: Function changed to async to support API call.

The watcher callback is now marked as async to enable awaiting the form API call later in the code.