Allow homeassistant in MQTT configuration_url schema

[jbouwh]

Proposed change

Allow homeassistant in URL schema for configuration URL's. This can be used by add on's that use hassio_ingress and expose configuration URL's that share the Home Assistant base URL.

The frontend will automatically rewite URL's with the homeassistant schema.

Example: homeassistant::/45df7312_zigbee2mqtt/ingress?next=/#/device/0x70ac08fffe87636c/info will be rewritten in the frontend to: http://ha.local:8123/45df7312_zigbee2mqtt/ingress?next=/#/device/0x70ac08fffe87636c/info. Assuming http://ha.local:8123 is your Home Assistant base URL.

Currently there is a frontend bug with hassio_ingress that will fail ingress authentication. Other URL's should work fine.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request: Update MQTT configuration_url description home-assistant.io#28131

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Black (black --fast homeassistant tests)
• 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

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

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.

[fthiery]

Hello, i tested this feature by patching the mqtt component (with vol.Optional(CONF_CONFIGURATION_URL): cv.string,) and deploying it as custom_component, then patching the zigbee2mqtt container to announce the configuration_url with the homeassistant:// prefix.

The Visit button gets the proper URL (e.g. http://ha.local:8123/api/hassio_ingress/pqvlFsbQ9EgVr5dr7SyXhXfDePmGOxjQ6UTZWoPRy5g/#/device/0xa4c138f1f4925cce/info) but the link does not open a new window and it doesn't work (it seems to redirect to the default dashboard http://ha.local:8123/lovelace/default). However, opening the link in a new tab (e.g. middle mouse click) does work (i.e. the Z2M UI appears). [EDIT: only after using the ingress UI once, it turns out]

I re-tested with relative URLs (e.g. "configuration_url":"/api/hassio_ingress/pqvlFsbQ9EgVr5dr7SyXhXfDePmGOxjQ6UTZWoPRy5g/#/device/0x70ac08fffe87636c/info") and there the link opens in a new tab and it works as expected [EDIT: only after using the ingress UI once, it turns out].

The frontend seems to be specifically designed to do this: https://github.com/home-assistant/frontend/blob/b1a909d30299486532f7ef683566295d3a282676/src/panels/config/devices/ha-config-device-page.ts#L1074

@frenck how can we have the UI open homeassistant:// links in a new tab (e.g. for a specific sub-path, like /api/hassio_ingress/) ?

Also, after testing if i do not open the ingress URL once before cliking "Visit URL", i get a 401 error. I guess that setIngressCookie is not called when opening a /api/hassio_ingress URL, so that's probably not going to work at all until the user opens the addon's ingress page...

So that probably means that lovelace must be modified to detect that the user is clicking some ingress-related homeassistant:// link, set the cookie and open the link in a new page, or even better embed the ingress subpage.

Is there a way / API to pass a path to the ingress iframe UI URL like http://ha.local:8123/45df7312_zigbee2mqtt/ingress ? E.g. http://ha.local:8123/45df7312_zigbee2mqtt/ingress?next=/#/device/0x70ac08fffe87636c/info" ?

[frenck]

@frenck how can we have the UI open homeassistant:// links in a new tab (e.g. for a specific sub-path, like /api/hassio_ingress/) ?

We don't. They are internal URLs not external ones.

Also, after testing if i do not open the ingress URL once before cliking "Visit URL", i get a 401 error. I guess that setIngressCookie is not called when opening a /api/hassio_ingress URL, so that's probably not going to work at all until the user opens the addon's ingress page...

This is an known frontend issue, Grafana also has issues like this. See the issue tracker of the frontend for more information.

Is there a way / API to pass a path to the ingress iframe UI URL like

no.

../Frenck

[fthiery]

Also, after testing if i do not open the ingress URL once before cliking "Visit URL", i get a 401 error. I guess that setIngressCookie is not called when opening a /api/hassio_ingress URL, so that's probably not going to work at all until the user opens the addon's ingress page...
This is an known frontend issue, Grafana also has issues like this. See the issue tracker of the frontend for more information.

Which issue are you referring to ? I tried https://github.com/home-assistant/frontend/issues?q=is%3Aissue+is%3Aopen+grafana but found nothing

@jbouwh if the frontend needs heavy changes for this feature to be useful (the initial need was to target an ingress URL), should this PR still be pursued ? Or should i open a related issue on the Frontend project (related to initializing the ingress session when clicking the Visit button, and possibly displaying the iframe like when accessing the addons UI) ?

[fthiery]

Also, should this MR not be named "Allow homeassistant in mqtt configuration_url schema" ?

[jbouwh]

@jbouwh if the frontend needs heavy changes for this feature to be useful (the initial need was to target an ingress URL), should this PR still be pursued ? Or should i open a related issue on the Frontend project (related to initializing the ingress session when clicking the Visit button, and possibly displaying the iframe like when accessing the addons UI) ?

Just tested this in dev and it seems there is no frontend change needed. The frontend translates the schema correctly.

[fthiery]

@jbouwh if the frontend needs heavy changes for this feature to be useful (the initial need was to target an ingress URL), should this PR still be pursued ? Or should i open a related issue on the Frontend project (related to initializing the ingress session when clicking the Visit button, and possibly displaying the iframe like when accessing the addons UI) ?

Just tested this in dev and it seems there is no frontend change needed. The frontend translates the schema correctly.

I confirm it works, but my initial usecase which was to access an ingress URL does not work without frontend modifications. The only way it works currently is to 1) access the ingress UI at least once 2) open the "Visit" link in a new tab.

Do you see any alternative usecases for homeassistant://-prefixed configuration_urls ?

[jbouwh]

@jbouwh if the frontend needs heavy changes for this feature to be useful (the initial need was to target an ingress URL), should this PR still be pursued ? Or should i open a related issue on the Frontend project (related to initializing the ingress session when clicking the Visit button, and possibly displaying the iframe like when accessing the addons UI) ?

Just tested this in dev and it seems there is no frontend change needed. The frontend translates the schema correctly.

I confirm it works, but my initial usecase which was to access an ingress URL does not work without frontend modifications. The only way it works currently is to 1) access the ingress UI at least once 2) open the "Visit" link in a new tab.

Do you see any alternative usecases for homeassistant://-prefixed configuration_urls ?

Not directly, but we could wait merging this one till the ingress frontend issues are solved?

[fthiery]

This is an known frontend issue, Grafana also has issues like this. See the issue tracker of the frontend for more information.

Found it in discussions, i'll chime in: home-assistant/frontend#11273

Not directly, but we could wait merging this one till the ingress frontend issues are solved?

I think so too

[frenck]

Not directly, but we could wait merging this one till the ingress frontend issues are solved?

I think we could continue on this one. While there is an ingress bug, I don't see a reason to block it. One could (in theory), also link to a config panel or integration page.

[frenck]

Thanks, @jbouwh 👍

../Frenck

Comments addressed