Show local network URL used in Home Assistant URL settings #22379

MindFreeze · 2024-10-15T09:45:04Z

Proposed change

Show the resolved local URL for easier debugging

Depends on Core PR home-assistant/core#128432

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:

Documentation added/updated for www.home-assistant.io

piitaya

We are using a full width alert for cloud alert. Can we use the same UX for that one?

balloob · 2024-10-15T15:33:07Z

Can we add a button to copy it to your clipboard?

MindFreeze · 2024-10-17T14:31:03Z

Made the url inputs always visible with masking when not editing and copy buttons

cc @matthiasdebaat

matthiasdebaat · 2024-10-21T13:29:39Z

May I suggest the following changes:

Change the labels Internet and Local into subtitles, to make a clear distinction.
Move the toggle/switches to the end of the row and move the labels at the beginning. This is the default pattern for switches.
Change the Automatic label, of Local network, into something that explains it a bit more. For example Use network settings.
Add examples to the input when enabled.
Change the copy link buttons into the text variant, as there can be only one primary button on a page.
When Home Assistant Cloud is enabled, add a link to the settings.
Always show the URL, even when Cloud is enabled.
Can we add the port number to link?
Show the ha-alert with a configure button, so that the user can enabled it on the Cloud settings.

MindFreeze · 2024-10-21T13:41:41Z

I don't think "Use network settings" is more descriptive. "Automatic" tells me I don't need to worry about it.

The port number is included in the link if configured but it is obfuscated with the rest of the url right now. I wondered whether to leave it visible but it's the same level of info as the local address and we obfuscate that

matthiasdebaat · 2024-10-21T14:24:46Z

I don't think "Use network settings" is more descriptive. "Automatic" tells me I don't need to worry about

Lets keep the label Automatic and add a description what this is. So it's easy and gives an insight in the magic box.

The port number is included in the link if configured but it is obfuscated with the rest of the url right now. I wondered whether to leave it visible but it's the same level of info as the local address and we obfuscate that

If we copy it in the link I would also show the input. We can show it as below for editable and read-only inputs.

MindFreeze · 2024-10-21T16:13:29Z

balloob · 2024-10-23T19:33:23Z

There is no need to censor the internal IP, as it cannot be reached externally.

frenck · 2024-10-23T19:42:21Z

There is no need to censor the internal IP, as it cannot be reached externally.

We discussed this, as there actually is a need for it. As in, people with loopback issues van use different URLs, and split DNS peeps will probably use the same as the external URL.

From that perspective, it is hard to make external masked, and internal not.

wendevlin

Thank you, looks great 🎉

One main point is missing, disallow empty values.
For both internal and external you come into a strange state when you leave the text input empty and hit save. Please don't allow to hit save when one of them is empty and show a validation info.

src/components/ha-settings-row.ts

src/panels/config/network/ha-config-url-form.ts

wendevlin · 2024-10-25T12:26:53Z

src/panels/config/network/ha-config-url-form.ts

+    this._unmaskedExternalUrl = !this._unmaskedExternalUrl;
+  }
+
+  private _obfuscateUrl(url: string) {


Why is this different then the remote url at /config/cloud/account?

Would be cool when it is synced, maybe create a util for it?

There only .ui.nabu.casa urls are handled. Here it could be anything so the logic is different

home-assistant · 2024-10-25T12:29:09Z

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.

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>

coderabbitai · 2024-10-25T12:49:41Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 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.

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>

MindFreeze · 2024-10-25T12:59:44Z

Thank you, looks great 🎉

One main point is missing, disallow empty values. For both internal and external you come into a strange state when you leave the text input empty and hit save. Please don't allow to hit save when one of them is empty and show a validation info.

Empty is a valid value. You need to be able to remove the custom urls

MindFreeze added the wait for backend label Oct 15, 2024

home-assistant bot added cla-signed hacktoberfest labels Oct 15, 2024

piitaya reviewed Oct 15, 2024

View reviewed changes

MindFreeze marked this pull request as ready for review October 15, 2024 12:18

piitaya previously approved these changes Oct 15, 2024

View reviewed changes

MindFreeze marked this pull request as draft October 16, 2024 07:59

MindFreeze dismissed piitaya’s stale review via e778c9e October 17, 2024 14:21

MindFreeze force-pushed the internal_url branch from 103fda9 to e778c9e Compare October 17, 2024 14:21

MindFreeze marked this pull request as ready for review October 17, 2024 14:31

MindFreeze mentioned this pull request Oct 17, 2024

Allow fetching HA url to display it in the network settings home-assistant/core#128432

Draft

19 tasks

MindFreeze added 7 commits October 21, 2024 17:42

Show local network URL used in Home Assistant URL settings

d3886e1

full width alert

ba59427

always display both urls and add copy buttons

b0bd575

remove mask button when editing

da69b71

fix typo

f9131e6

type fix

88a8ee7

update styling based on comments

2cb10d2

MindFreeze force-pushed the internal_url branch from a46c5fc to 2cb10d2 Compare October 21, 2024 16:12

MindFreeze requested a review from piitaya October 21, 2024 16:14

MindFreeze enabled auto-merge (squash) October 21, 2024 16:14

MindFreeze disabled auto-merge October 21, 2024 16:14

fix bad copy/paste

fdccbd2

MindFreeze requested a review from wendevlin October 25, 2024 11:30

wendevlin requested changes Oct 25, 2024

View reviewed changes

home-assistant bot marked this pull request as draft October 25, 2024 12:29

Update src/components/ha-settings-row.ts

ca3086c

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>

MindFreeze and others added 3 commits October 25, 2024 15:50

Update src/panels/config/network/ha-config-url-form.ts

3ee4f4b

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>

Update src/panels/config/network/ha-config-url-form.ts

47b3caa

Co-authored-by: Wendelin <12148533+wendevlin@users.noreply.github.com>

PR comment

e69d7cf

MindFreeze marked this pull request as ready for review October 25, 2024 13:00

home-assistant bot requested a review from wendevlin October 25, 2024 13:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show local network URL used in Home Assistant URL settings #22379

Show local network URL used in Home Assistant URL settings #22379

MindFreeze commented Oct 15, 2024 •

edited

Loading

piitaya left a comment

balloob commented Oct 15, 2024

MindFreeze commented Oct 17, 2024 •

edited

Loading

matthiasdebaat commented Oct 21, 2024 •

edited

Loading

MindFreeze commented Oct 21, 2024

matthiasdebaat commented Oct 21, 2024 •

edited

Loading

MindFreeze commented Oct 21, 2024

balloob commented Oct 23, 2024

frenck commented Oct 23, 2024

wendevlin left a comment

wendevlin Oct 25, 2024

MindFreeze Oct 25, 2024

home-assistant bot commented Oct 25, 2024

coderabbitai bot commented Oct 25, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

MindFreeze commented Oct 25, 2024

Show local network URL used in Home Assistant URL settings #22379

Are you sure you want to change the base?

Show local network URL used in Home Assistant URL settings #22379

Conversation

MindFreeze commented Oct 15, 2024 • edited Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

piitaya left a comment

Choose a reason for hiding this comment

balloob commented Oct 15, 2024

MindFreeze commented Oct 17, 2024 • edited Loading

matthiasdebaat commented Oct 21, 2024 • edited Loading

MindFreeze commented Oct 21, 2024

matthiasdebaat commented Oct 21, 2024 • edited Loading

MindFreeze commented Oct 21, 2024

balloob commented Oct 23, 2024

frenck commented Oct 23, 2024

wendevlin left a comment

Choose a reason for hiding this comment

wendevlin Oct 25, 2024

Choose a reason for hiding this comment

MindFreeze Oct 25, 2024

Choose a reason for hiding this comment

home-assistant bot commented Oct 25, 2024

coderabbitai bot commented Oct 25, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

MindFreeze commented Oct 25, 2024

MindFreeze commented Oct 15, 2024 •

edited

Loading

MindFreeze commented Oct 17, 2024 •

edited

Loading

matthiasdebaat commented Oct 21, 2024 •

edited

Loading

matthiasdebaat commented Oct 21, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)