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

Support time entities in automation time conditions/triggers selectors #21069

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

markbergsma
Copy link

@markbergsma markbergsma commented Jun 11, 2024

Proposed change

Allow the new time entities introduced in 2023.6 to be used in automation 'time' conditions, just like input_datetime helpers and sensors with timestamp device class. Add them to the selectors in the frontend.

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

condition: time
after: time.time

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 time-based automation conditions and triggers to support "time" entities.
  • Improvements

    • Updated descriptions for time-based inputs to include "time entities" for better clarity.

Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

Walkthrough

The recent changes enhance the handling of time-based conditions and triggers in the automation configuration by adding a specific filter for the "time" domain. This ensures that only relevant time entities are considered. Additionally, the description in the translation file for valid inputs has been updated to include "time entities," providing clearer guidance for users.

Changes

Files Change Summary
src/panels/config/automation/condition/types/ha-automation-condition-time.ts Added { domain: "time" } to entity filter and updated logic for conditions starting with "time.".
src/panels/config/automation/trigger/types/ha-automation-trigger-time.ts Added { domain: "time" } to entity filter and modified input mode condition for "time." prefix check.
src/translations/en.json Updated "type_input" description to include "time entity" as a valid input.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 42b5fa6 and f1ff791.

Files selected for processing (3)
  • src/panels/config/automation/condition/types/ha-automation-condition-time.ts (3 hunks)
  • src/panels/config/automation/trigger/types/ha-automation-trigger-time.ts (2 hunks)
  • src/translations/en.json (1 hunks)
Additional context used
Biome
src/panels/config/automation/trigger/types/ha-automation-trigger-time.ts

[error] 116-116: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.

src/panels/config/automation/condition/types/ha-automation-condition-time.ts

[error] 171-171: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.


[error] 172-172: Avoid the delete operator which can impact performance. (lint/performance/noDelete)

Unsafe fix: Use an undefined assignment instead.

Additional comments not posted (6)
src/panels/config/automation/trigger/types/ha-automation-trigger-time.ts (2)

33-33: The addition of { domain: "time" } to the entity filter aligns with the PR's objective to support time entities. Well done!


88-90: The updated input mode condition to check if at starts with "time." is correctly implemented to support the new feature.

src/panels/config/automation/condition/types/ha-automation-condition-time.ts (3)

70-70: The addition of { domain: "time" } to the entity filter for "after" is correctly implemented and aligns with the PR's objective.


103-103: The addition of { domain: "time" } to the entity filter for "before" is correctly implemented and aligns with the PR's objective.


131-136: The updated input mode conditions to check if before and after start with "time." are correctly implemented to support the new feature.

src/translations/en.json (1)

3005-3005: Updated description accurately reflects the new functionality of supporting time entities.


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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

Successfully merging this pull request may close these issues.

2 participants