Skip to content

Reduce logbook websocket payload size and parse json attributes via the DBM#71895

Merged
balloob merged 9 commits intohome-assistant:devfrom
bdraco:offload_logbook_attribute_json_extraction_to_the_database
May 16, 2022
Merged

Reduce logbook websocket payload size and parse json attributes via the DBM#71895
balloob merged 9 commits intohome-assistant:devfrom
bdraco:offload_logbook_attribute_json_extraction_to_the_database

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented May 15, 2022

Requires home-assistant/frontend#12667

Breaking change

  • The entity name in logbook is now always shown with the
    current name instead of the old name if it
    was renamed. If the entity no longer exists
    we now show the original entity_id instead which
    aligns with the warning icon we already display on
    the frontend when a state is missing or removed.

Proposed change

  • The name of the entity is no longer sent to the websocket
    api. Not a breaking change since the websocket api is new
    in 2022.6

  • We no longer parse attributes in python. This
    task is offloaded to the database since we only
    need it for the icon.

JSON type is supported on the DBMs we supported since 2015 (and 2016 for MSSQL but thats not supported)

MySQL 5.7+ ~2015 https://docs.sqlalchemy.org/en/14/dialects/mysql.html?highlight=json#sqlalchemy.dialects.mysql.JSON
SQLite 3.9+ ~2015 https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#sqlalchemy.dialects.sqlite.JSON
MSSQL 2016+ https://docs.sqlalchemy.org/en/14/dialects/mssql.html#sqlalchemy.dialects.mssql.JSON
PostgreSQL 9.2+ ~2012 https://www.postgresql.org/docs/9.2/datatype-json.html

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

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

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:

bdraco added 5 commits May 15, 2022 07:33
Breaking:

- The entity name is now always shown with the
  current name instead of the old name if it
  was renamed. If the entity no longer exists
  we now show the original entity_id instead
  Requires home-assistant/frontend#12667

- The name of the entity is no longer sent, and
  the current name in the state machine is now
  used

- We no longer parse attributes in python. This
  task is offloaded to the database since we only
  need it for the icon.
@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (logbook) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@bdraco bdraco marked this pull request as ready for review May 15, 2022 18:32
@bdraco bdraco requested a review from a team as a code owner May 15, 2022 18:32
@balloob balloob merged commit 089eb99 into home-assistant:dev May 16, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants