Add describeCondition and entity_ids as additional information to automation step details #21965

boern99 · 2024-09-12T17:32:54Z

Breaking change

Proposed change

Adds some extra information to Automation Traces, such as describeCondition and entity_id
see #20660

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 trace path details display with improved context on conditions and entities.
- Conditional rendering of alias and formatted display of entity_id for better clarity.
Bug Fixes
- Improved navigation through nested properties for accurate detail retrieval.

…omation step details

coderabbitai · 2024-09-12T17:33:02Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in the HaTracePathDetails component enhance the display of trace path details by introducing a new import, describeCondition, which provides descriptive information about conditions. The logic for extracting details from the selected configuration has been expanded to navigate nested properties, allowing for the retrieval of alias, entity_id, and other relevant details. The rendering logic has been updated to conditionally display these details, improving the clarity of the trace path information presented to users.

Changes

File	Change Summary
src/components/trace/ha-trace-path-details.ts	Introduced `describeCondition` import; expanded logic for extracting details from `this.selected.config`; updated rendering logic to display `alias` and condition descriptions based on the current path.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HaTracePathDetails
    participant Config

    User->>HaTracePathDetails: Request trace path details
    HaTracePathDetails->>Config: Retrieve selected configuration
    Config-->>HaTracePathDetails: Return details (alias, entity_id, conditions)
    HaTracePathDetails->>User: Display trace path details (alias, descriptions)

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.

jeeftor · 2024-10-02T15:27:24Z

Please merge this if it does what I think it might do!

MindFreeze

A screenshot of before & after is not required but would be very appreciated and it speeds up the review.

MindFreeze · 2024-11-06T13:38:54Z

src/components/trace/ha-trace-path-details.ts

+        if (currentDetail[nestPath[i]] !== undefined) {
+          if (typeof currentDetail[nestPath[i]] !== "string") {
+            currentDetail = currentDetail[nestPath[i]];
+          }
+        }


Suggested change

if (currentDetail[nestPath[i]] !== undefined) {

if (typeof currentDetail[nestPath[i]] !== "string") {

currentDetail = currentDetail[nestPath[i]];

}

}

if (!['undefined', 'string'].includes(typeof currentDetail[nestPath[i]])) {

currentDetail = currentDetail[nestPath[i]];

}

MindFreeze · 2024-11-06T13:40:27Z

src/components/trace/ha-trace-path-details.ts

+              ? currentDetail.alias !== undefined
+                ? html`<h2>${currentDetail.alias}</h2>`
+                : ""


Suggested change

? currentDetail.alias !== undefined

? html`<h2>${currentDetail.alias}</h2>`

: ""

? currentDetail.alias

? html`<h2>${currentDetail.alias}</h2>`

: nothing

src/components/trace/ha-trace-path-details.ts

home-assistant · 2024-11-06T13:44:09Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

…automation-step-details

boern99 · 2024-11-07T12:45:26Z

thank you
Screenshot before:

and using the pull request:

Co-authored-by: Petar Petrov <[email protected]>

Add describeCondition and entity_ids as additional information to aut…

a5555a4

…omation step details

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

MindFreeze requested changes Nov 6, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 6, 2024 13:44

Merge branch 'home-assistant:dev' into Add-additional-information-to-…

6181089

…automation-step-details

Update src/components/trace/ha-trace-path-details.ts

15674d9

Co-authored-by: Petar Petrov <[email protected]>

boern99 marked this pull request as ready for review November 7, 2024 12:46

home-assistant bot requested a review from MindFreeze November 7, 2024 12:46

tested suggestions

e41428d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add describeCondition and entity_ids as additional information to automation step details #21965

Add describeCondition and entity_ids as additional information to automation step details #21965

boern99 commented Sep 12, 2024 •

edited by MindFreeze

Loading

coderabbitai bot commented Sep 12, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

jeeftor commented Oct 2, 2024

MindFreeze left a comment

MindFreeze Nov 6, 2024 •

edited

Loading

MindFreeze Nov 6, 2024

home-assistant bot commented Nov 6, 2024

boern99 commented Nov 7, 2024

Add describeCondition and entity_ids as additional information to automation step details #21965

Are you sure you want to change the base?

Add describeCondition and entity_ids as additional information to automation step details #21965

Conversation

boern99 commented Sep 12, 2024 • edited by MindFreeze Loading

Breaking change

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

coderabbitai bot commented Sep 12, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

jeeftor commented Oct 2, 2024

MindFreeze left a comment

Choose a reason for hiding this comment

MindFreeze Nov 6, 2024 • edited Loading

Choose a reason for hiding this comment

MindFreeze Nov 6, 2024

Choose a reason for hiding this comment

home-assistant bot commented Nov 6, 2024

boern99 commented Nov 7, 2024

boern99 commented Sep 12, 2024 •

edited by MindFreeze

Loading

coderabbitai bot commented Sep 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

MindFreeze Nov 6, 2024 •

edited

Loading