Add image proxy to Kodi media browser #47315

cgtobi · 2021-03-03T17:05:11Z

Proposed change

Add the image proxy to the Kodi media browser.

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 Media Library no images #43742 and fixes Kodi media browser fails to load images with a deprecation notice for embedded login #39873
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:

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

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

probot-home-assistant · 2021-03-03T17:05:18Z

Hey there @OnFreund, mind taking a look at this pull request as its been labeled with an integration (kodi) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

cgtobi · 2021-03-04T14:34:15Z

This requires OnFreund/PyKodi#9 to be merged and released.

dshokouhi · 2021-03-04T23:56:15Z

will this also fix #39873 ? I saw it mentioned in the original issue :)

OnFreund · 2021-03-05T09:06:08Z

@cgtobi I released 0.2.3

cgtobi · 2021-03-05T16:53:03Z

will this also fix #39873 ? I saw it mentioned in the original issue :)

I don't have such an instance to test this. I'd kindly ask you to spin up an instance from this branch if possible. Feedback would be greatly appreciated.

dshokouhi · 2021-03-06T00:36:47Z

will this also fix #39873 ? I saw it mentioned in the original issue :)

I don't have such an instance to test this. I'd kindly ask you to spin up an instance from this branch if possible. Feedback would be greatly appreciated.

So yes and no. My TV Show library sometimes loads and sometimes does not. My Movies library never seems to load. Both errors look identical to me when it does not load. I have also included some logs so you can see it is indeed loading and working at one point. One thing I am not sure of if this is a separate error or not. The good news is that it does seem to be working to some extent!

Error when loading TV show or Movies

Registered

2021-03-05 16:19:05 INFO (MainThread) [homeassistant.components.media_player] Setting up media_player.kodi
2021-03-05 16:19:05 INFO (MainThread) [homeassistant.helpers.entity_registry] Registered new media_player.kodi entity: media_player.kodi_436f5f609b8668c5afb42276a4737847

Error when attempting to load Movies

2021-03-05 16:19:33 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [140615827876592] Error handling message: Unknown error
Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 128, in wait
    await self._event.wait()
  File "/usr/local/lib/python3.8/asyncio/locks.py", line 309, in wait
    await fut
asyncio.exceptions.CancelledError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 42, in send_message
    response = await pending_message.wait(self._timeout)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 129, in wait
    return self._response
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 45, in __exit__
    self._do_exit(exc_type)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 92, in _do_exit
    raise asyncio.TimeoutError
asyncio.exceptions.TimeoutError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/homeassistant/components/websocket_api/decorators.py", line 18, in _handle_async_response
    await func(hass, connection, msg)
  File "/mnt/c/dev/home-assistant/homeassistant/components/media_player/__init__.py", line 1068, in websocket_browse_media
    payload = await player.async_browse_media(media_content_type, media_content_id)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/media_player.py", line 904, in async_browse_media
    response = await build_item_response(self._kodi, payload, _get_thumbnail_url)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/browse_media.py", line 67, in build_item_response
    _, title, media = await get_media_info(media_library, search_id, search_type)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/browse_media.py", line 291, in get_media_info
    media = await media_library.get_movies(properties)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/pykodi/kodi.py", line 357, in get_movies
    return await self._server.VideoLibrary.GetMovies(
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 48, in send_message
    raise TransportError('Transport Error', message, exc)
jsonrpc_base.jsonrpc.TransportError: ("Error calling method 'VideoLibrary.GetMovies': Transport Error", TimeoutError())

Some warnings when TV show library loads:

2021-03-05 16:20:15 WARNING (MainThread) [homeassistant.components.media_player] Error retrieving proxied image from http://kodi:kodi@localhost:8080/image/image%3A%2F%2Fhttps%253a%252f%252fartworks.thetvdb.com%252fbanners%252fposters%252f295936-2.jpg%2F
2021-03-05 16:20:24 WARNING (MainThread) [homeassistant.components.media_player] Error retrieving proxied image from http://kodi:kodi@localhost:8080/image/image%3A%2F%2Fhttps%253a%252f%252fartworks.thetvdb.com%252fbanners%252fposters%252f71187-1.jpg%2F

Error when TV shows fails to load:

2021-03-05 16:20:44 ERROR (MainThread) [aiohttp.server] Error handling request
Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 128, in wait
    await self._event.wait()
  File "/usr/local/lib/python3.8/asyncio/locks.py", line 309, in wait
    await fut
asyncio.exceptions.CancelledError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 42, in send_message
    response = await pending_message.wait(self._timeout)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 129, in wait
    return self._response
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 45, in __exit__
    self._do_exit(exc_type)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 92, in _do_exit
    raise asyncio.TimeoutError
asyncio.exceptions.TimeoutError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/aiohttp/web_protocol.py", line 422, in _handle_request
    resp = await self._request_handler(request)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/aiohttp/web_app.py", line 499, in _handle
    resp = await handler(request)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/aiohttp/web_middlewares.py", line 118, in impl
    with request.match_info.set_current_app(app):
  File "/mnt/c/dev/home-assistant/homeassistant/components/http/security_filter.py", line 56, in security_filter_middleware
    return await handler(request)
  File "/mnt/c/dev/home-assistant/homeassistant/components/http/request_context.py", line 18, in request_context_middleware
    return await handler(request)
  File "/mnt/c/dev/home-assistant/homeassistant/components/http/ban.py", line 72, in ban_middleware
    return await handler(request)
  File "/mnt/c/dev/home-assistant/homeassistant/components/http/auth.py", line 129, in auth_middleware
    return await handler(request)
  File "/mnt/c/dev/home-assistant/homeassistant/components/http/view.py", line 129, in handle
    result = await result
  File "/mnt/c/dev/home-assistant/homeassistant/components/media_player/__init__.py", line 969, in get
    data, content_type = await player.async_get_browse_image(
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/media_player.py", line 915, in async_get_browse_image
    image_url, _, _ = await get_media_info(
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/browse_media.py", line 297, in get_media_info
    media = await media_library.get_seasons(
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/pykodi/kodi.py", line 369, in get_seasons
    return await self._server.VideoLibrary.GetSeasons(
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 48, in send_message
    raise TransportError('Transport Error', message, exc)
jsonrpc_base.jsonrpc.TransportError: ("Error calling method 'VideoLibrary.GetSeasons': Transport Error", TimeoutError())

TV show library working

cgtobi · 2021-03-06T00:54:10Z

@dshokouhi please try the latest changes.

dshokouhi · 2021-03-06T01:07:54Z

@dshokouhi please try the latest changes.

The TV show library has been loading every time I choose it now, the movie library is not but I think that is because I have a rather large library lol.

here is the error

2021-03-05 17:00:41 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [139817451209392] Error handling message: Unknown error
Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 128, in wait
    await self._event.wait()
  File "/usr/local/lib/python3.8/asyncio/locks.py", line 309, in wait
    await fut
asyncio.exceptions.CancelledError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 42, in send_message
    response = await pending_message.wait(self._timeout)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 129, in wait
    return self._response
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 45, in __exit__
    self._do_exit(exc_type)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/async_timeout/__init__.py", line 92, in _do_exit
    raise asyncio.TimeoutError
asyncio.exceptions.TimeoutError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/mnt/c/dev/home-assistant/homeassistant/components/websocket_api/decorators.py", line 18, in _handle_async_response
    await func(hass, connection, msg)
  File "/mnt/c/dev/home-assistant/homeassistant/components/media_player/__init__.py", line 1068, in websocket_browse_media
    payload = await player.async_browse_media(media_content_type, media_content_id)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/media_player.py", line 903, in async_browse_media
    response = await build_item_response(self._kodi, payload, _get_thumbnail_url)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/browse_media.py", line 68, in build_item_response
    _, title, media = await get_media_info(media_library, search_id, search_type)
  File "/mnt/c/dev/home-assistant/homeassistant/components/kodi/browse_media.py", line 303, in get_media_info
    media = await media_library.get_movies(properties)
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/pykodi/kodi.py", line 357, in get_movies
    return await self._server.VideoLibrary.GetMovies(
  File "/mnt/c/dev/home-assistant/venv/lib/python3.8/site-packages/jsonrpc_websocket/jsonrpc.py", line 48, in send_message
    raise TransportError('Transport Error', message, exc)
jsonrpc_base.jsonrpc.TransportError: ("Error calling method 'VideoLibrary.GetMovies': Transport Error", TimeoutError())

homeassistant added the cla-signed label Mar 3, 2021

probot-home-assistant bot added integration: kodi by-code-owner labels Mar 3, 2021

cgtobi marked this pull request as draft March 3, 2021 17:31

cgtobi added the waiting-for-upstream We're waiting for a change upstream label Mar 4, 2021

cgtobi removed the waiting-for-upstream We're waiting for a change upstream label Mar 5, 2021

cgtobi force-pushed the kodi_image_proxy branch from 74b1d9b to 2e1973c Compare March 5, 2021 21:46

cgtobi force-pushed the kodi_image_proxy branch 2 times, most recently from afde455 to 9ffd486 Compare March 7, 2021 11:21

cgtobi marked this pull request as ready for review March 7, 2021 11:21

cgtobi mentioned this pull request Mar 9, 2021

Kodi media browser fails to load images with a deprecation notice for embedded login #39873

Closed

cgtobi added 9 commits March 26, 2021 00:41

Add image proxy

02d330e

Gather tasks

ee261a8

Clean up

4d509b0

Update

78c5714

Extract movie details

edf9285

Bump pykodi to 0.2.3

86b26f7

Revert gather

9f40811

Catch errors

f913c32

Throttle requests

7494bc5

Revert attempt to throttle

5a06ff5

cgtobi force-pushed the kodi_image_proxy branch from 9ffd486 to 5a06ff5 Compare March 25, 2021 23:44

cgtobi added the bugfix label Mar 26, 2021

balloob approved these changes Mar 30, 2021

View reviewed changes

balloob merged commit 467bd91 into home-assistant:dev Mar 30, 2021

cgtobi deleted the kodi_image_proxy branch March 30, 2021 07:55

github-actions bot locked and limited conversation to collaborators Mar 31, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add image proxy to Kodi media browser #47315

Add image proxy to Kodi media browser #47315

cgtobi commented Mar 3, 2021 •

edited

Loading

probot-home-assistant bot commented Mar 3, 2021

cgtobi commented Mar 4, 2021

dshokouhi commented Mar 4, 2021

OnFreund commented Mar 5, 2021

cgtobi commented Mar 5, 2021 •

edited

Loading

dshokouhi commented Mar 6, 2021

cgtobi commented Mar 6, 2021

dshokouhi commented Mar 6, 2021

Add image proxy to Kodi media browser #47315

Add image proxy to Kodi media browser #47315

Conversation

cgtobi commented Mar 3, 2021 • edited Loading

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

probot-home-assistant bot commented Mar 3, 2021

cgtobi commented Mar 4, 2021

dshokouhi commented Mar 4, 2021

OnFreund commented Mar 5, 2021

cgtobi commented Mar 5, 2021 • edited Loading

dshokouhi commented Mar 6, 2021

cgtobi commented Mar 6, 2021

dshokouhi commented Mar 6, 2021

cgtobi commented Mar 3, 2021 •

edited

Loading

Example entry for `configuration.yaml`:

cgtobi commented Mar 5, 2021 •

edited

Loading