Skip to content

Handle query and anchors in Spotify URI's#33084

Merged
balloob merged 2 commits into
devfrom
frenck-2020-0317
Mar 21, 2020
Merged

Handle query and anchors in Spotify URI's#33084
balloob merged 2 commits into
devfrom
frenck-2020-0317

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented Mar 21, 2020

Proposed change

Using the media_player.play_media service on the Spotify integration works great, however, when using Spotify URL generated by their official client, a query string is added to the URL.

The Spotify API itself, however, does not handle query strings or anchors in the URL's and just ignores the call.

This PR ensures the requested URI to play is cleaned from query strings and anchors.

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 Service call
entity_id: media_player.spotify_frenck_nl
media_content_id: >-
  https://open.spotify.com/track/5UtXlv30WKqjlWzUaYrzZY?si=zIVafnO3RIuefyudsSoA4Q#bla
media_content_type: music

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

Copy link
Copy Markdown
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

from yarl import URL

media_id = str(URL(media_id).with_query(None).with_fragment(None))

URLs really should never be parsed by hand. It's prone to breaking on some subtile thing.

@frenck
Copy link
Copy Markdown
Member Author

frenck commented Mar 21, 2020

Adjusted, I initially avoided that approach since a media_id doesn't have to be an URL, Spotify has many other identifiers. Apparently (after testing), yarl doesn't care... (which maybe could be considered a bug IMHO).

Nevertheless, works, fine by me 🤷‍♂

@balloob balloob merged commit 8272c71 into dev Mar 21, 2020
@balloob balloob deleted the frenck-2020-0317 branch March 21, 2020 19:24
@lock lock Bot locked and limited conversation to collaborators Mar 22, 2020
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.

4 participants