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

Use primary config entry for device #21903

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Use primary config entry for device #21903

merged 2 commits into from
Sep 6, 2024

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Sep 5, 2024

Proposed change

Use primary config entry for device instead of checking if it's an helper

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:

Summary by CodeRabbit

  • New Features

    • Introduced a prioritization system for configuration entries based on a designated primary entry, enhancing the organization of config entries.
    • Added a new property for device registry entries to represent a primary configuration entry, improving device management capabilities.
  • Bug Fixes

    • Updated logic for processing device configuration entries to utilize the primary configuration entry, ensuring more accurate data handling.

Copy link
Contributor

coderabbitai bot commented Sep 5, 2024

Walkthrough

Walkthrough

The changes involve a shift in how configuration entries are prioritized and processed within the application. The sortConfigEntries function now emphasizes a specified primary configuration entry rather than employing a sorting mechanism based on integration types. Additionally, a new property, primary_config_entry, has been introduced to the DeviceRegistryEntry interface, enhancing the representation of device configurations. Related components have been updated to reflect these changes in device management.

Changes

Files Change Summary
src/data/config_entries.ts The sortConfigEntries function now prioritizes a specified primaryConfigEntry instead of using a scoring mechanism. The import of IntegrationManifest was removed.
src/data/device_registry.ts Added a new property primary_config_entry to the DeviceRegistryEntry interface, allowing representation of a primary configuration entry for devices.
src/panels/config/devices/ha-config-device-page.ts Modified the return statement of a function to use device.primary_config_entry instead of manifestLookup, changing how configuration entries are processed.
src/panels/config/devices/ha-config-devices-dashboard.ts Changed the method of accessing configuration entries to use device.primary_config_entry, streamlining the retrieval process.
gallery/src/pages/misc/integration-card.ts Introduced a new property primary_config_entry initialized to null in the object created within the createDeviceRegistryEntries function.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4e002ee and adcf979.

Files selected for processing (3)
  • gallery/src/pages/components/ha-form.ts (3 hunks)
  • gallery/src/pages/components/ha-selector.ts (3 hunks)
  • gallery/src/pages/misc/integration-card.ts (1 hunks)
Additional comments not posted (3)
gallery/src/pages/misc/integration-card.ts (1)

235-235: Verify integration of new property primary_config_entry.

The addition of primary_config_entry to DeviceRegistryEntry is a significant change. Please ensure that all parts of the application that process DeviceRegistryEntry objects are updated to handle this new property appropriately.

gallery/src/pages/components/ha-form.ts (1)

67-67: Approve addition of primary_config_entry.

The systematic addition of primary_config_entry to each DeviceRegistryEntry in the DEVICES array is consistent and well-implemented. Consider initializing primary_config_entry with more specific values if applicable in future updates.

Also applies to: 90-90, 113-113

gallery/src/pages/components/ha-selector.ts (1)

67-67: Approve addition of primary_config_entry.

The addition of primary_config_entry to each DeviceRegistryEntry in the DEVICES array is consistent with the changes in other parts of the application. This enhancement aligns with the PR's objectives to improve device management. Monitor the usage of this property to ensure it effectively contributes to the system's functionality.

Also applies to: 90-90, 113-113


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.

@piitaya piitaya requested a review from balloob September 5, 2024 21:24
balloob
balloob previously approved these changes Sep 5, 2024
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

src/data/config_entries.ts Show resolved Hide resolved
@github-actions github-actions bot added the Design Related to Home Assistant design gallery label Sep 5, 2024
@piitaya piitaya requested a review from balloob September 6, 2024 11:42
@piitaya piitaya merged commit cd74367 into dev Sep 6, 2024
13 checks passed
@piitaya piitaya deleted the primary_config_entry branch September 6, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Design Related to Home Assistant design gallery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants