Skip to content

Improve mobile app template handling#41703

Merged
balloob merged 4 commits intodevfrom
improve-mobile-app-template-handling
Oct 12, 2020
Merged

Improve mobile app template handling#41703
balloob merged 4 commits intodevfrom
improve-mobile-app-template-handling

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented Oct 12, 2020

Breaking change

Proposed change

Rendering templates via the mobile app was a little cumbersome. Invalid templates would fail the payload and errors in templates would propagate up.

This makes sure we catch them all.

Note, our current template return type is a little problematic, since starting with 117 we will be able to return native values from templates, and so the user could return a similar shaped error object from a template 🤔

CC @zacwest

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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

To help with the load of incoming pull requests:

tpl.hass = hass
resp[key] = tpl.async_render(item.get(ATTR_TEMPLATE_VARIABLES))
except TemplateError as ex:
except Exception as ex: # pylint: disable=broad-except
Copy link
Copy Markdown
Member Author

@balloob balloob Oct 12, 2020

Choose a reason for hiding this comment

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

@bdraco this is a little weird I think. We need to catch all exceptions because template {{ now() | random }} raises a TypeError that crashes the websocket connection (500 error) and also here had to be caught with a generic error. Should we catch all exceptions that come out of render and wrap it in TemplateError ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Wrapping .render in template.py seems like it will also fix some other bugs where templates stop updating because the exception isn't trapped.

I'm doing testing with it now.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It also looks like {{ now() | rando }} is untrapped.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I've found a few things. I'll open a new PR to fix them, when its done trapping except TemplateError as ex will do what was originally expected here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Fixed in #41719

balloob and others added 2 commits October 12, 2020 14:38
@balloob balloob force-pushed the improve-mobile-app-template-handling branch from e07dd85 to c72aba0 Compare October 12, 2020 14:38
@balloob balloob merged commit 57996e1 into dev Oct 12, 2020
@balloob balloob deleted the improve-mobile-app-template-handling branch October 12, 2020 15:26
weissm pushed a commit to weissm/core that referenced this pull request Oct 16, 2020
Co-authored-by: J. Nick Koston <nick@koston.org>
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.

4 participants