Entity for Tags

[gjohansson-ST]

Proposed change

According to discussion in home-assistant/architecture#1069
This creates entities for tags (tag.*).

Needs #118241 ✅
Fixes home-assistant/architecture#1069

Type of change

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

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request: Add Tag entities home-assistant.io#32193

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• 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

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @balloob, @dmulcahey, mind taking a look at this pull request as it has been labeled with an integration (tag) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tag can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign tag Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[home-assistant]

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.

[emontnemery]

As discussed on discord, tag should have an entity component which manages the entity lifecycle.

[emontnemery]

Left to do:

• Bump store version to 1.2, where 1.2 does not store the name, and implement migration of names to entity registry
• Don't use original_name in entity registry, since the tags can't be named by the integrations scanning tags, only by users
• Add tests which assert how data is stored, maybe create a couple of tags and compare store data with a snapshot

[emontnemery]

@coderabbitai review

[coderabbitai]

Walkthrough

The changes to the Home Assistant's tag component include the introduction of new classes and functions for managing tag entities, handling data storage and migration, and adding WebSocket support. Constants and logging have been added to improve maintainability and debugging. Tests have been updated and expanded to cover the new functionalities, including entity creation, migration, and WebSocket operations.

Changes

Files/Groups	Change Summaries
homeassistant/components/tag/__init__.py	Added imports, constants, new functions, and classes for tag management, storage, migration, and WebSocket support.
homeassistant/components/tag/const.py	Added constants DEFAULT_NAME and LOGGER.
homeassistant/components/tag/icons.json	Introduced JSON structure defining the default icon for tag entities.
homeassistant/components/tag/strings.json	Updated to include nested attributes for the "tag" entity specifying "tag_id" and "last_scanned_by_device_id".
tests/components/tag/__init__.py	Added test constants TEST_TAG_ID, TEST_TAG_NAME, and TEST_DEVICE_ID.
tests/components/tag/snapshots/test_init.ambr	Introduced serialized data structure for testing migration of tag-related data.
tests/components/tag/test_event.py	Updated storage setup, entity registry operations, and event data assertions.
tests/components/tag/test_init.py	Added imports, modified storage function, added fixture for storage version setup, and added tests for migration, WebSocket, and tag entities.
tests/components/tag/test_trigger.py	Updated storage data structure with new field minor_version and key-value pair.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant TagStore
    participant WebSocket

    User->>HomeAssistant: Initiate Tag Scan
    HomeAssistant->>TagStore: Store Tag Data
    TagStore-->>HomeAssistant: Confirm Storage
    HomeAssistant->>WebSocket: Notify Tag Scanned
    WebSocket-->>User: Display Tag Scanned Notification

sequenceDiagram
    participant Dev
    participant HomeAssistant
    participant TagStore

    Dev->>HomeAssistant: Trigger Migration
    HomeAssistant->>TagStore: Migrate Data to New Version
    TagStore-->>HomeAssistant: Confirm Migration
    HomeAssistant-->>Dev: Display Migration Success

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[emontnemery]

This is great, thanks a lot @gjohansson-ST 👍