Fix kodi media_player unavailable at start by mvn23 · Pull Request #41714 · home-assistant/core

mvn23 · 2020-10-12T13:08:10Z

Proposed change

After the recent overhaul of the kodi integration, the media player entity is unavailable when Home Assistant starts until the related kodi instance comes online. This prevents the power button from showing up on the media player card.
This PR changes the behavior so the media player entities are off at startup, allowing for power-on actions through the UI.
The changes are largely based on changes made by alexanv1@571780f with some additional fixes as mentioned in the discussion of the issue at #40450

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 Since 0.115 Kodi goes "unavailable" state if turned off when HA restarts #40450 and fixes Kodi entity is "off" for long time after kodi is back online #43269 and fixes Kodi integration spams HA log with Not Ready messages #40970 and fixes With 0.115 kodi.call_method calls only work a few minutes after Kodi has started #40482
This PR is related to issue: Since 0.115 Kodi goes "unavailable" state if turned off when HA restarts #40450
Link to documentation pull request: N/A

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][dev-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:

(N/A) Documentation added/updated for [www.home-assistant.io][docs-repository]

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

The [manifest file][manifest-docs] 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][quality-scale]:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

homeassistant · 2020-10-12T13:08:13Z

Hi @alexanv1,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

homeassistant · 2020-10-12T13:42:39Z

Hi @alexanv1,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

OnFreund

Thanks @mvn23
Left some minor comments.

homeassistant/components/kodi/__init__.py

homeassistant/components/kodi/media_player.py

homeassistant · 2020-10-13T02:50:54Z

Hi @alexanv1,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

homeassistant · 2020-10-13T10:23:07Z

Hi @alexanv1,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

mvn23 · 2020-10-13T10:38:08Z

@alexanv1 are you planning to sign the CLA? If not, then do you mind if I remove you from the history in this PR to make sure we can proceed here?

…ting, reduce watchdog timeout

homeassistant/components/kodi/media_player.py

rschuiling · 2020-11-14T10:53:05Z

Can this be merged? It seems a lot of people are waiting for it (including me :-).

bdraco · 2020-11-16T06:04:16Z

homeassistant/components/kodi/media_player.py

+        def start_watchdog(event=None):
+            """Start websocket watchdog."""


Suggested change

def start_watchdog(event=None):

"""Start websocket watchdog."""

async def start_websocket(event=None):

"""Start websocket."""

await self._async_connect_websocket_if_disconnected()

While this may get the initial state 10 seconds (WEBSOCKET_WATCHDOG_INTERVAL) faster if kodi is available and responding, it will block HA startup longer than necessary if the kodi instance does not respond.
In my opinion, it's better to wait a bit and let HA start up before making the first connection attempt.

Since its not happing until after the start event and its async, it shouldn't block anything since I/O is being awaited. We don't call async_block_till_done after the STARTED event.

What am I missing here?

My mistake, it should indeed be possible to connect right away. I will make the change soon.

bdraco · 2020-11-16T06:04:28Z

homeassistant/components/kodi/media_player.py

+        # If Home Assistant is already in a running state, start the watchdog
+        # immediately, else trigger it after Home Assistant has finished starting.
+        if self.hass.state == CoreState.running:
+            start_watchdog()


Suggested change

start_watchdog()

await start_websocket()

bdraco

You should be able to start the websocket right away after the started event is fired without having to wait.

Suggested change above (untested)

bdraco · 2020-11-17T17:28:07Z

Thanks

* 'dev' of https://github.com/home-assistant/core: (77 commits) Fix kodi media_player unavailable at start (home-assistant#41714) Add an option to template delay_on/off in template binary sensor (home-assistant#43259) Bump hatasmota to 0.0.31 (home-assistant#43319) Update cloud integration to 0.38.0 (home-assistant#43314) Add progress translation key to hassfest (home-assistant#43311) Bump codecov/codecov-action from v1.0.14 to v1.0.15 (home-assistant#43304) Improvement to allow parsing of station ID in vasttrafik integration. Addresses home-assistant#34851 (home-assistant#43136) Abort vizio discovery flow without unique ID (home-assistant#43303) Update directv to 0.4.0 (home-assistant#43302) Add notification binary_sensor to Plugwise integration (home-assistant#41473) [ci skip] Translation update Bump bimmer_connected to 0.7.13 (home-assistant#43294) Bump aioguardian to 1.0.4 (home-assistant#43299) Refactor how entities are created for homekit_controller services (home-assistant#43242) Updated frontend to 20201111.1 (home-assistant#43298) Update pytradfri to 7.0.4 (home-assistant#43297) Remove pts adjustments in stream (home-assistant#42399) Fix Enigma2 available entity property (home-assistant#43292) Make MQTT climate return PRESET_NONE when no preset is set (home-assistant#43257) Bump env_canada to 0.2.4, fix config validation (home-assistant#43251) ...

Gerben321 · 2020-11-19T13:31:35Z

Is this in 0.118? Still getting this error.

mvn23 · 2020-11-19T18:34:22Z

Nope, only in dev at the moment. Should be in 0.119.0 though.

Gerben321 · 2020-11-19T18:35:03Z

Allright thanks for the update. Great job!

homeassistant added the cla-needed label Oct 12, 2020

probot-home-assistant bot added Hacktoberfest bugfix integration: kodi labels Oct 12, 2020

probot-home-assistant bot assigned cgtobi Oct 12, 2020

OnFreund reviewed Oct 12, 2020

View reviewed changes

homeassistant/components/kodi/__init__.py Outdated Show resolved Hide resolved

homeassistant/components/kodi/media_player.py Outdated Show resolved Hide resolved

bdraco added the cla-recheck label Oct 13, 2020

homeassistant removed the cla-recheck label Oct 13, 2020

mvn23 added 3 commits October 14, 2020 12:47

Fix 'Unavailable' state on HA startup if Kodi is not running

ba241c9

Delay websocket watchdog until after Home Assistant has finished star…

fb3e69b

…ting, reduce watchdog timeout

Move all sw_version related code to _on_ws_connected()

5d98ded

mvn23 force-pushed the kodi-unavailable-fix branch from 177ab01 to 5d98ded Compare October 14, 2020 10:49

homeassistant added cla-signed and removed cla-needed labels Oct 14, 2020

OnFreund reviewed Oct 14, 2020

View reviewed changes

homeassistant/components/kodi/media_player.py Show resolved Hide resolved

OnFreund approved these changes Oct 14, 2020

View reviewed changes

MartinHjelmare added the hacktoberfest-accepted label Oct 31, 2020

bdraco reviewed Nov 16, 2020

View reviewed changes

bdraco requested changes Nov 16, 2020

View reviewed changes

bdraco mentioned this pull request Nov 16, 2020

Kodi entity is "off" for long time after kodi is back online #43269

Closed

Attempt to connect websocket without delay

8f79683

bdraco approved these changes Nov 17, 2020

View reviewed changes

bdraco merged commit 212fb57 into home-assistant:dev Nov 17, 2020

mvn23 deleted the kodi-unavailable-fix branch November 17, 2020 17:37

rccoleman pushed a commit to rccoleman/core that referenced this pull request Dec 4, 2020

Fix kodi media_player unavailable at start (home-assistant#41714)

ddd70b3

fermulator mentioned this pull request Dec 12, 2020

spammy log messages when a configured device is not available at HA start and spams until device comes on #44128

Closed

chumbazoid mentioned this pull request Jun 3, 2022

Kodi player power button absent when 'unavailable' #72945

Closed

		def start_watchdog(event=None):
		"""Start websocket watchdog."""

-        def start_watchdog(event=None):
-            """Start websocket watchdog."""
+        async def start_websocket(event=None):
+            """Start websocket."""
+            await self._async_connect_websocket_if_disconnected()

Uh oh!

Conversation

mvn23 commented Oct 12, 2020 • edited by bdraco Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

homeassistant commented Oct 12, 2020

Uh oh!

homeassistant commented Oct 12, 2020

Uh oh!

OnFreund left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

homeassistant commented Oct 13, 2020

Uh oh!

homeassistant commented Oct 13, 2020

Uh oh!

mvn23 commented Oct 13, 2020

Uh oh!

Uh oh!

rschuiling commented Nov 14, 2020

Uh oh!

bdraco Nov 16, 2020

Choose a reason for hiding this comment

Uh oh!

mvn23 Nov 16, 2020

Choose a reason for hiding this comment

Uh oh!

bdraco Nov 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mvn23 Nov 16, 2020

Choose a reason for hiding this comment

Uh oh!

bdraco Nov 16, 2020

Choose a reason for hiding this comment

Uh oh!

bdraco left a comment

Choose a reason for hiding this comment

Uh oh!

bdraco commented Nov 17, 2020

Uh oh!

Gerben321 commented Nov 19, 2020

Uh oh!

mvn23 commented Nov 19, 2020

Uh oh!

Gerben321 commented Nov 19, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

mvn23 commented Oct 12, 2020 •

edited by bdraco

Loading

OnFreund left a comment •

edited

Loading

bdraco Nov 16, 2020 •

edited

Loading