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

Disable beta menu instead of hiding #20906

Merged
merged 1 commit into from
May 30, 2024
Merged

Conversation

balloob
Copy link
Member

@balloob balloob commented May 29, 2024

Breaking change

Proposed change

So, I was on nightly and couldn't find the beta menu when someone asked me where it was. Realized it was hidden when you're on nightly.

To avoid confusion, I think it's better to disable it so users can still know where it is.

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

  • Improvements
    • Updated configuration section to disable specific list items when the supervisor channel is set to "dev," enhancing clarity and preventing unintended actions.

@balloob balloob changed the title Disable beta menu instead of hiding Disable beta menu instead of hiding on dev May 29, 2024
Copy link
Contributor

coderabbitai bot commented May 29, 2024

Walkthrough

Walkthrough

This update modifies the HaConfigSectionUpdates class to adjust the rendering logic for a list item within a configuration section. Specifically, it disables the list item when the supervisor channel is set to "dev" and refines the conditional rendering of elements based on supervisor information.

Changes

File Path Change Summary
src/panels/config/core/ha-config-section-updates.ts Updated rendering logic for a list item based on supervisor information, disabling the item when the supervisor channel is "dev" and refining conditional rendering.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant HaConfigSectionUpdates
    participant Supervisor

    User->>HaConfigSectionUpdates: Access Configuration Section
    HaConfigSectionUpdates->>Supervisor: Fetch Supervisor Info
    Supervisor-->>HaConfigSectionUpdates: Return Channel Info
    alt Channel is "dev"
        HaConfigSectionUpdates-->>User: Display Disabled List Item
    else Channel is not "dev"
        HaConfigSectionUpdates-->>User: Display Enabled List Item
    end
Loading

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits Files that changed from the base of the PR and between c0e0480 and 746f09e.
Files selected for processing (1)
  • src/panels/config/core/ha-config-section-updates.ts (1 hunks)
Additional Context Used
Biome (6)
src/panels/config/core/ha-config-section-updates.ts (6)

147-147: Forbidden non-null assertion.


165-165: Unexpected any. Specify a different type.


1-1: All these imports are only used as types.


2-3: All these imports are only used as types.


3-4: Some named imports are only used as types.


15-22: Some named imports are only used as types.

Additional comments not posted (1)
src/panels/config/core/ha-config-section-updates.ts (1)

85-91: Ensure the beta menu is disabled correctly based on the supervisor channel.

This change aligns with the PR's objective to make the beta menu visible but disabled for users on the "dev" channel, reducing user confusion. The implementation uses a conditional to disable the menu item, which is a clean and direct approach.


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.

@coderabbitai coderabbitai bot changed the title Disable beta menu instead of hiding on dev Disable beta menu instead of hiding May 29, 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: 0

Outside diff range comments (3)
src/panels/config/core/ha-config-section-updates.ts (3)

Line range hint 147-147: Avoid using non-null assertions.

Using non-null assertions can lead to runtime errors if the object is null. Consider adding proper checks or handling potential null values gracefully.


Line range hint 165-165: Specify a more specific type than any.

Using any type defeats the purpose of TypeScript's static type checking. Try to specify a more accurate type for the error object to enhance code robustness and maintainability.


Line range hint 1-1: Optimize import statements.

Consider using TypeScript's import type syntax for imports that are only used for type annotations. This can help clarify the intent and potentially optimize the bundling process.

- import { RequestSelectedDetail } from "@material/mwc-list/mwc-list-item";
+ import type { RequestSelectedDetail } from "@material/mwc-list/mwc-list-item";
- import { mdiDotsVertical, mdiRefresh } from "@mdi/js";
+ import type { mdiDotsVertical, mdiRefresh } from "@mdi/js";
- import { HassEntities } from "home-assistant-js-websocket";
+ import type { HassEntities } from "home-assistant-js-websocket";
- import { LitElement, TemplateResult, css, html } from "lit";
+ import type { LitElement, TemplateResult, css, html } from "lit";
- import { customElement, property, state } from "lit/decorators";
+ import type { customElement, property, state } from "lit/decorators";
- import memoizeOne from "memoize-one";
+ import type memoizeOne from "memoize-one";
- import { isComponentLoaded } from "../../../common/config/is_component_loaded";
+ import type { isComponentLoaded } from "../../../common/config/is_component_loaded";
- import { shouldHandleRequestSelectedEvent } from "../../../common/mwc/handle-request-selected-event";
+ import type { shouldHandleRequestSelectedEvent } from "../../../common/mwc/handle-request-selected-event";

Also applies to: 2-3, 3-4, 15-22

@silamon silamon added this to the 2024.6 milestone May 29, 2024
@frenck
Copy link
Member

frenck commented May 30, 2024

Some alternatives:

  1. When on nightly, allow for enabling beta (leaving dev)
  2. When on nightly, allow for enabling beta or stable (leaving dev)
  3. When on beta, allow for enabling nightly & leaving beta
  4. Add nightly to it, make it possible to jump between any release channel.

@matthiasdebaat
Copy link
Collaborator

Some alternatives:

  1. When on nightly, allow for enabling beta (leaving dev)
  2. When on nightly, allow for enabling beta or stable (leaving dev)
  3. When on beta, allow for enabling nightly & leaving beta
  4. Add nightly to it, make it possible to jump between any release channel.

I like the idea to pick the release channel, regardless of which release you're on. To be consistent this would mean you can select all: stable, beta and nightly. Question is, does bringing nightly to the UI give enough benefit compared to the effort? For example, I assume that if we add nightly as an option in the UI, it would cause some support load.

If we add it, I would suggest in changing the labels in the UI to:

  • Beta > Public beta, as it for the general public.
  • Nightly > Developer test, as it explains more to a non developer that its not for daily use. Alternative is to call it Developer alpha.

@piitaya
Copy link
Member

piitaya commented May 30, 2024

I agree for leaving nightly to beta to stable using the UI but I'm not sure to join nightly using UI. As @matthiasdebaat said, it's only for dev so cli is not an issue.

@bramkragten
Copy link
Member

I agree, it shouldnt be too easy to join nightly.

@bramkragten bramkragten merged commit b38a348 into dev May 30, 2024
14 checks passed
@bramkragten bramkragten deleted the disable-updates-instead-of-hiding branch May 30, 2024 13:29
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.

6 participants