Add support for the Spotify DJ

[BTMorton]

Proposed change

Add support for the new Spotify DJ feature by mocking the playlist response. The Spotify Web API currently doesn't support the DJ feature and returns a 404 error when trying to lookup the playlist details. If the context contains the URI for the DJ playlist, instead of performing a playlist lookup, a mock playlist object will be used to provide the minimal set of required playlist data.

I've also added some extra error handling around the playlist lookup to prevent a failing playlist request breaking the current playback state update. This error handling by itself could fix the issue, but I wanted to also have the media_playlist property be populated if the DJ URI is detected.

I've used this URI as the DJ playlist URI as it seems to be the same in my testing and from other users requesting support on the Spotify Community website:

spotify:playlist:37i9dQZF1EYkqdzj48dyYq

Spotify Community support requests:

• https://community.spotify.com/t5/Spotify-for-Developers/What-Spotify-Web-API-does-the-DJ-button-use/td-p/5660189
• https://community.spotify.com/t5/Spotify-for-Developers/Spotify-DJ-playlist-info-images/m-p/5587781

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)
• Deprecation (breaking change to happen in the future)
• 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 Spotify DJ AI not working with the Spotify integration on HA #94670
• 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
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format 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.
• 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.

To help with the load of incoming pull requests:

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

[home-assistant]

Hey there @frenck, @joostlek, mind taking a look at this pull request as it has been labeled with an integration (spotify) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of spotify can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign spotify Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.