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 demo when there's no recorder available #21519

Closed
wants to merge 1 commit into from

Conversation

silamon
Copy link
Contributor

@silamon silamon commented Aug 1, 2024

Proposed change

The demo doesn't have a recorder available, and no longer loads. This is an attempt to fix.
https://demo.home-assistant.io/

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

  • Bug Fixes
    • Improved the database migration process by ensuring it only proceeds when the necessary recorder component is active, enhancing application stability.

Copy link
Contributor

coderabbitai bot commented Aug 1, 2024

Walkthrough

Walkthrough

This change enhances the database migration process in the Home Assistant application by adding a conditional check for the presence of the recorder component. If the recorder is not included in the configuration, the migration process is halted early, improving robustness by preventing unnecessary attempts to migrate when the required component is inactive. This update refines the control flow within the checkDataBaseMigration method.

Changes

Files Change Summary
src/layouts/home-assistant.ts Added a conditional check in checkDataBaseMigration to ensure recorder is active before proceeding with database migration.

Sequence Diagram(s)

sequenceDiagram
    participant App as HomeAssistantAppEl
    participant DB as Database
    participant Config as Configuration

    App->>Config: Check components
    alt If `recorder` is present
        App->>DB: Proceed with migration
    else If `recorder` is absent
        App-->>Config: Set _databaseMigration to false
        Note over App: Early exit from migration
    end
Loading

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

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: 0

Outside diff range, codebase verification and nitpick comments (1)
src/layouts/home-assistant.ts (1)

203-203: Add a comment to explain the conditional check.

Consider adding a comment to explain why the presence of the recorder component is being checked.

+    // Check if the recorder component is present before proceeding with the database migration
    if (!this.hass?.config?.components.includes("recorder")) {

Comment on lines +203 to +206
if (!this.hass?.config?.components.includes("recorder")) {
this._databaseMigration = false;
return;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This won't be the correct fix since the PR introducing it mentions:
We can't check for recorder in hass.config.components, it won't be added until after the migration has completed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The code mentions that people would have been able to run Home Assistant without recorder in earlier versions. Since it checked upon recorder and putted database migration on false if it doesn't exist. That no longer happens, therefore doesn't load the frontend anymore. (But I'm not sure if people run HA without recorder...)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From theory to practice: It definitely runs pretty decent if you have no recorder set up. Graphs and everything related is taken away. Broken on current dev.

Copy link
Member

@bramkragten bramkragten Aug 1, 2024

Choose a reason for hiding this comment

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

Line 215 should have handled this, but for demo this is a bit different, so we can just skip all of this for __DEMO__ or mock the command.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've retested this, checked the code and it works with no recorder as well. All good.

@silamon
Copy link
Contributor Author

silamon commented Aug 1, 2024

The demo is further broken down the line with #18934, since it reloads every 5 seconds as there's no websocket available.

@silamon silamon added this to the 2024.8 milestone Aug 1, 2024
@silamon silamon marked this pull request as draft August 1, 2024 06:42
@silamon
Copy link
Contributor Author

silamon commented Aug 1, 2024

For demo: we probably need to mock more. But for now, I'm going to do something else. :P

@bramkragten
Copy link
Member

#21525

@bramkragten
Copy link
Member

The demo is further broken down the line with #18934, since it reloads every 5 seconds as there's no websocket available.

#21526

@bramkragten bramkragten closed this Aug 1, 2024
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