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 onboarding with 0 found integrations #21977

Merged
merged 3 commits into from
Sep 16, 2024
Merged

Conversation

wendevlin
Copy link
Contributor

@wendevlin wendevlin commented Sep 13, 2024

Breaking change

Proposed change

If at the Home Assistant onboarding process 0 (additional to the standard ones like: sun, radio browser,...) integrations are found, show an "All set" screen instead of the integrations screen.

image

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 celebratory messaging for users completing the onboarding process without integrations, enhancing user feedback.
    • Added new translation strings to improve the interface for device integration, making it more welcoming.
  • Style

    • Implemented a new CSS class for styling the celebratory icon in the onboarding component.

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

Walkthrough

The changes introduce new conditional rendering logic in the OnboardingIntegrations class to handle scenarios where users have no integrations. When the domains array is empty, the component displays a celebratory message and prompts users to start using integrations. Additionally, three new string entries are added to the JSON translation file to enhance user interface messages related to device integration.

Changes

Files Change Summary
src/onboarding/onboarding-integrations.ts Added conditional rendering logic for empty domains array and a new CSS class .all-set-icon.
src/translations/en.json Added new strings: "all_set": "All set!", "lets_start": "Let’s start your private smart home adventure."

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OnboardingIntegrations

    User->>OnboardingIntegrations: Start onboarding
    OnboardingIntegrations->>User: Check domains array
    alt domains.length === 0
        OnboardingIntegrations->>User: Display celebratory message and prompt
    else domains.length > 0
        OnboardingIntegrations->>User: Display integrations
    end
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f1603d8 and b2e79d2.

Files selected for processing (1)
  • src/onboarding/onboarding-integrations.ts (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/onboarding/onboarding-integrations.ts

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 generate interesting stats about this repository and render them as a table.
    -- @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.

Copy link
Member

@piitaya piitaya left a comment

Choose a reason for hiding this comment

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

Nice 🎉
I only added small suggestions.

src/onboarding/onboarding-integrations.ts Outdated Show resolved Hide resolved
src/onboarding/onboarding-integrations.ts Outdated Show resolved Hide resolved
src/onboarding/onboarding-integrations.ts Outdated Show resolved Hide resolved
@wendevlin
Copy link
Contributor Author

@piitaya I added your suggestions.

@bramkragten bramkragten merged commit ab91a4b into dev Sep 16, 2024
13 checks passed
@bramkragten bramkragten deleted the fix-onboarding-0-integrations branch September 16, 2024 11:19
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.

3 participants