Show local network URL used in Home Assistant URL settings
Proposed change
Show the resolved local URL for easier debugging
Depends on Core PR https://github.com/home-assistant/core/pull/128432
Type of change
- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [x] 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
- [x] The code change is tested and works locally.
- [x] 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
Can we add a button to copy it to your clipboard?
Made the url inputs always visible with masking when not editing and copy buttons
cc @matthiasdebaat
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.
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
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.
There is no need to censor the internal IP, as it cannot be reached externally.
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.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:
[!IMPORTANT]
Review skipped
Auto reviews are disabled on this repository.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein 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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
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
Empty is a valid value. You need to be able to remove the custom urls
Okay, yeah make sense.
Then please recheck the logic when you clear the url to "" and then get it with private get _externalUrlValue() (or internal)
It always fallback to the this._urls?.external when this._external_url is falsy. But then you are never able to clear it. After refresh the old value is still there.
Something else: we should remove the advanced flag here. The plan is to remove it completely from the settings and at first step by step where it is in use. So this would be the perfect time for the url form :+1: