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: the value was not cleared correctly when cleaning the range picker #4904

Closed
wants to merge 1 commit into from

Conversation

imdap
Copy link
Contributor

@imdap imdap commented Nov 15, 2024

Description

fix: #4892

点击清理按钮后 提交时值没有被正确清理

image

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 handling of time fields in the form, ensuring stale data is removed when conditions are met.
  • Bug Fixes

    • Improved logic to prevent empty time fields from persisting alongside populated start and end time keys.
  • Documentation

    • Updated comments to clarify the purpose of the new logic in the component.

Copy link

changeset-bot bot commented Nov 15, 2024

⚠️ No Changeset found

Latest commit: 46a4622

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 Nov 15, 2024

Walkthrough

The changes in this pull request focus on the form-actions.vue component, specifically enhancing the handleRangeTimeValue function to improve the handling of time fields. A new conditional check is added to clear start and end time fields from the values object if they are empty while the corresponding keys are populated. Code comments have been updated for clarity, but the overall structure and public interface of the component remain unchanged.

Changes

File Change Summary
packages/@core/ui-kit/form-ui/src/components/form-actions.vue Enhanced handleRangeTimeValue to clear empty time fields; updated comments for clarity.

Assessment against linked issues

Objective Addressed Explanation
Clear stale time fields after clearing input (related to #4892)

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

In the meadow, time does flow,
With fields to clear, we make it so.
A rabbit hops, with joy and cheer,
For every change that brings us near.
Let's tidy up, and make it bright,
Our forms now shine, a pure delight! 🐇✨

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/components/form-actions.vue

Oops! Something went wrong! :(

ESLint: 9.14.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: 1

🧹 Outside diff range and nitpick comments (1)
packages/@core/ui-kit/form-ui/src/components/form-actions.vue (1)

98-102: Consider adding debug logging for easier troubleshooting.

Since this handles a specific edge case in form field clearing, it would be helpful to add debug logging to make troubleshooting easier in production environments.

 if (!values[field] && values[startTimeKey] && values[endTimeKey]) {
+  console.debug(
+    `Clearing mapped time fields: ${startTimeKey}, ${endTimeKey} for empty field: ${field}`
+  );
   delete values[startTimeKey];
   delete values[endTimeKey];
   return;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b87d41b and 46a4622.

📒 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)

94-102: LGTM! Well-implemented fix for the range picker clearing issue.

The added logic correctly handles the case where the range picker is cleared but mapped time fields still persist. This directly addresses the reported bug in issue #4892 where mapped time fields weren't being properly cleared upon form resubmission.

The implementation is robust because it:

  1. Properly detects when the range picker has been cleared
  2. Correctly removes the mapped start/end time values
  3. Maintains existing behavior for all other cases

* 时间字段为空 但是映射的start/end不为空 说明已经清理了组件的时间(组件右边的x)
* 需要删除对应的start/end字段 否则会被保留
*/
if (!values[field] && values[startTimeKey] && values[endTimeKey]) {
Copy link
Contributor

Choose a reason for hiding this comment

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

你这样改会有别的bug,这样在选了开始时间和结束时间之后,不改变值连续点击提交,会把原先选择的值删掉。
如下图:
image

@DesignHhuang
Copy link
Contributor

可以试一下 #4906 的方式,我试了下好像可以

@imdap
Copy link
Contributor Author

imdap commented Nov 15, 2024

可以试一下 #4906 的方式,我试了下好像可以

可以 忽略了undefined的情况导致有问题 我的关了

@imdap imdap closed this Nov 15, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2024
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: Form使用fieldMappingTime映射, 清除后再次提交映射字段仍存在
2 participants