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 service advanced options UI #21925

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Sep 8, 2024

Proposed change

Fix #21629. hasSelector needs to also look into the subsections to find which sub-fields also have selectors.

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

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:

Summary by CodeRabbit

  • New Features
    • Enhanced the hasSelector property to detect selectors within nested fields, improving the accuracy of field representation.
  • Bug Fixes
    • Improved logic for identifying selectors, ensuring more comprehensive detection across different field structures.

Copy link
Contributor

coderabbitai bot commented Sep 8, 2024

Walkthrough

Walkthrough

The changes involve a modification to the HaServiceControl class, specifically in the logic for determining the hasSelector property. The new implementation enhances the detection of selectors by checking not only the top-level fields but also nested fields within the fields array. This results in a more comprehensive assessment of which fields contain selectors, thereby altering the control flow related to the hasSelector data.

Changes

File Change Summary
src/components/ha-service-control.ts Modified the logic for the hasSelector property to include checks for nested fields containing selectors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HaServiceControl
    participant Field

    User->>HaServiceControl: Request fields
    HaServiceControl->>Field: Check top-level fields for selector
    alt Has selector
        Field-->>HaServiceControl: Return selector found
    else No selector
        Field-->>HaServiceControl: Return no selector
    end
    HaServiceControl->>Field: Check nested fields for selector
    alt Has nested selector
        Field-->>HaServiceControl: Return nested selector found
    else No nested selector
        Field-->>HaServiceControl: Return no nested selector
    end
    HaServiceControl-->>User: Return hasSelector data
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7f6325f and 4c3eaca.

Files selected for processing (1)
  • src/components/ha-service-control.ts (1 hunks)

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.


const hasSelector: string[] = [];
fields.forEach((field) => {
if ((field as any).fields) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could not get the typing figured out here so had to avoid it. It seems like we're doing some type hacking in the header to try to make this work, but I think what we probably need is an update to home-assistant-js-websocket to properly type fields with subfields?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

Comment on lines +244 to +256
const hasSelector: string[] = [];
fields.forEach((field) => {
if ((field as any).fields) {
Object.entries((field as any).fields).forEach(([key, subField]) => {
if ((subField as any).selector) {
hasSelector.push(key);
}
});
} else if (field.selector) {
hasSelector.push(field.key);
}
});

Copy link
Contributor

Choose a reason for hiding this comment

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

Refactor the hasSelector computation for clarity and efficiency.

The new implementation of hasSelector now checks for nested fields, which is a significant improvement in functionality. However, the current implementation can be optimized for clarity and efficiency. Consider using a recursive function to handle nested fields, which would make the code cleaner and potentially more efficient by avoiding repeated type checks and conversions.

Here's a suggested refactor:

- const hasSelector: string[] = [];
- fields.forEach((field) => {
-   if ((field as any).fields) {
-     Object.entries((field as any).fields).forEach(([key, subField]) => {
-       if ((subField as any).selector) {
-         hasSelector.push(key);
-       }
-     });
-   } else if (field.selector) {
-     hasSelector.push(field.key);
-   }
- });
+ const hasSelector = fields.reduce((acc, field) => {
+   if (field.fields) {
+     acc.push(...Object.keys(field.fields).filter(key => field.fields[key].selector));
+   } else if (field.selector) {
+     acc.push(field.key);
+   }
+   return acc;
+ }, []);

This refactor uses reduce to accumulate keys, simplifying the logic and potentially improving performance by minimizing the scope of checks and transformations.

Committable suggestion was skipped due to low confidence.

@bramkragten bramkragten merged commit c7cfbb5 into home-assistant:dev Sep 9, 2024
15 checks passed
@labanex
Copy link

labanex commented Sep 9, 2024

Thank you for merging my post with this one. This lets me know that awareness is brought to this. Not a big issue, just annoying. Thank you again.

@karwosts karwosts deleted the fix-service-adv-options branch September 9, 2024 16:05
@labanex
Copy link

labanex commented Oct 2, 2024

This is working now with 2024.10 update. Thank you so much. You guys/gals/them are amazing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants