Zwave JS display allowed range of config values #21892

bramkragten · 2024-09-05T12:03:41Z

Proposed change

For zwave-js/certification-backlog#38

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

New Features
- Enhanced configuration panel with localized helper text for numeric input fields.
- Improved validation for numeric inputs to ensure values fall within specified ranges, with user-friendly error messages.
Documentation
- Added new translation entries for improved user guidance on input constraints.

coderabbitai · 2024-09-05T12:03:51Z

Walkthrough

The changes enhance the ZWaveJSNodeConfig class by introducing helper text for numeric input fields and improving validation mechanisms. A new property for localized guidance based on input ranges is added, along with updated validation logic that generates error messages for out-of-range values. Additionally, new string entries are incorporated into the translation file to support user-facing messages related to these validations.

Changes

File	Change Summary
`src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-config.ts`	Added helper text and validation for numeric input fields, including error handling for out-of-range values.
`src/translations/en.json`	Introduced new strings for user messages regarding input validation: `"between_min_max"` and `"error_not_in_range"`.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d216991 and fcd05a0.

Files selected for processing (1)

src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-config.ts (2 hunks)

Additional comments not posted (2)

src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-config.ts (2)

278-282: Enhancement: Helper text for numeric input fields.

The addition of localized helper text to the <ha-textfield> component is a significant improvement. It provides users with clear guidance on the acceptable range of values, enhancing the user experience and preventing configuration errors.

364-376: Enhancement: Updated validation logic for numeric input fields.

The updated validation logic in the _numericInputChanged method enhances the robustness of the configuration process. It correctly checks for values strictly outside the allowed range and provides immediate feedback to the user, which is crucial for maintaining the integrity of node configurations.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 or @coderabbitai title 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: 1

coderabbitai · 2024-09-05T12:09:31Z

src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-config.ts

+    if (
+      (ev.target.min !== undefined && value <= ev.target.min) ||
+      (ev.target.max !== undefined && value >= ev.target.max)
+    ) {
+      this.setError(
+        ev.target.key,
+        this.hass.localize(
+          "ui.panel.config.zwave_js.node_config.error_not_in_range",
+          { min: ev.target.min, max: ev.target.max }
+        )
+      );
+      return;
+    }


Enhancement: Validation logic for numeric input fields.

The validation logic added to the _numericInputChanged method is well-implemented. It ensures that values entered are within the specified range and provides immediate feedback to the user if they are not. This proactive error handling is crucial for maintaining the integrity of node configurations.

However, there is a minor issue in the condition:

(ev.target.min !== undefined && value <= ev.target.min) || (ev.target.max !== undefined && value >= ev.target.max)

This condition should be corrected to:

(ev.target.min !== undefined && value < ev.target.min) || (ev.target.max !== undefined && value > ev.target.max)

to accurately reflect values that are strictly outside the allowed range.

Consider adjusting the condition to correctly handle the boundary values of the input range.

🤦🏻‍♂️

@bramkragten It seems like you might have already caught that! If there's anything else you'd like help with, feel free to let me know. 😊

bramkragten added 2 commits September 5, 2024 14:01

Zwave: Display allowed range of config values, catch wrong values

8759a4d

allow min and max

d216991

home-assistant bot added the cla-signed label Sep 5, 2024

coderabbitai bot reviewed Sep 5, 2024

View reviewed changes

Update zwave_js-node-config.ts

fcd05a0

silamon approved these changes Sep 6, 2024

View reviewed changes

silamon merged commit 8bc9927 into dev Sep 6, 2024
13 checks passed

silamon deleted the zwave-config-value-validation branch September 6, 2024 22:38

AlCalzone mentioned this pull request Sep 12, 2024

Show value range of config parameter in UI zwave-js/certification-backlog#38

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Zwave JS display allowed range of config values #21892

Zwave JS display allowed range of config values #21892

bramkragten commented Sep 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 5, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Sep 5, 2024 •

edited

Loading

bramkragten Sep 5, 2024

coderabbitai bot Sep 5, 2024

Zwave JS display allowed range of config values #21892

Zwave JS display allowed range of config values #21892

Conversation

bramkragten commented Sep 5, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

coderabbitai bot commented Sep 5, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

bramkragten Sep 5, 2024

Choose a reason for hiding this comment

coderabbitai bot Sep 5, 2024

Choose a reason for hiding this comment

bramkragten commented Sep 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

coderabbitai bot Sep 5, 2024 •

edited

Loading