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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Frontend: deprecate extra_html_url #37843

Merged
merged 5 commits into from Jul 14, 2020
Merged

Frontend: deprecate extra_html_url #37843

merged 5 commits into from Jul 14, 2020

Conversation

bramkragten
Copy link
Member

@bramkragten bramkragten commented Jul 14, 2020

Breaking change

We used to allow the user to specify HTML files via extra_html_url that we would import into the page. When it became clear that HTML imports were not going to make it, we replaced that with extra_module_url and extra_js_url_es5 (#24675 by @thomasloven, June 21, 2019).

HTML imports are no longer supported by any browser, and we have to polyfill it to make it work, this is expensive.

extra_html_url is now deprecated and support will be removed in 0.115. You can switch to the new extra_module_url or extra_js_url_es5 by changing your imported file to JavaScript.

Proposed change

home-assistant/frontend#6028

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

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
  • 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:

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

@probot-home-assistant
Copy link

Hey there @home-assistant/frontend, mind taking a look at this pull request as its been labeled with an integration (frontend) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

@@ -85,6 +85,8 @@
CONFIG_SCHEMA = vol.Schema(
{
DOMAIN: vol.Schema(
cv.deprecated(CONF_EXTRA_HTML_URL, invalidation_version="0.115"),
Copy link
Member

Choose a reason for hiding this comment

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

You have to wrap it like so:

CONFIG_SCHEMA = vol.Schema(
    {
        DOMAIN: vol.All(
            cv.deprecated(CONF_EXTRA_HTML_URL, invalidation_version="0.115"),
            cv.deprecated(CONF_EXTRA_HTML_URL_ES5, invalidation_version="0.115"),
            vol.Schema(
                {
                    vol.Optional(CONF_FRONTEND_REPO): cv.isdir,
                    vol.Optional(CONF_THEMES): vol.Schema(
                        {cv.string: {cv.string: cv.string}}
                    ),
                    vol.Optional(CONF_EXTRA_HTML_URL): vol.All(cv.ensure_list, [cv.string]),
                    vol.Optional(CONF_EXTRA_MODULE_URL): vol.All(
                        cv.ensure_list, [cv.string]
                    ),
                    vol.Optional(CONF_EXTRA_JS_URL_ES5): vol.All(
                        cv.ensure_list, [cv.string]
                    ),
                    # We no longer use these options.
                    vol.Optional(CONF_EXTRA_HTML_URL_ES5): cv.match_all,
                    vol.Optional(CONF_JS_VERSION): cv.match_all,
                },
            )
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Dev automation moved this from Needs review to Reviewer approved Jul 14, 2020
@bramkragten bramkragten merged commit ea17d36 into dev Jul 14, 2020
Dev automation moved this from Reviewer approved to Done Jul 14, 2020
@bramkragten bramkragten deleted the deprecate-extra-html branch July 14, 2020 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants