Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle width and height placeholders in the thumbnail URL #136227

Merged
merged 4 commits into from
Jan 24, 2025

Conversation

Makrit
Copy link
Contributor

@Makrit Makrit commented Jan 22, 2025

Proposed change

The Twitch API does not work with the placeholders {width} and {height} still present in the URL.
The API accepts both values set as empty strings, and interprets this as a request for the maximum resolution image. Therefore we modify ".../username-{width}x{height}.jpg" into ".../username-x.jpg", in order to avoid an error.

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

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:

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.

To help with the load of incoming pull requests:

Update the stream_picture logic to remove the {width}x{height} placeholder from the thumbnail_url. The current thumbnail_url returned by the Twitch API requires {width}x{height} to be set.
@home-assistant
Copy link

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

Code owner commands

Code owners of twitch 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 twitch 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.

Copy link
Contributor

@davet2001 davet2001 left a comment

Choose a reason for hiding this comment

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

One query. Also, ideally a test should be added to verify correct behavior.

@home-assistant home-assistant bot marked this pull request as draft January 23, 2025 15:13
@home-assistant
Copy link

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.

The Twitch API does not work with the placeholders {width} and {height} still present in the URL. The API accepts both values set as empty strings, and interprets this as a request for the maximum resolution image. Therefore we modify ".../username-{width}x{height}.jpg" into ".../username-x.jpg", in order to avoid an error.

In future we may allow width & height to be specified via configuration parameters. The code is updated to reflect this intent even though there is no way of configuring it yet.
@Makrit Makrit marked this pull request as ready for review January 24, 2025 07:43
@home-assistant home-assistant bot requested a review from davet2001 January 24, 2025 07:43
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @Makrit 👍

../Frenck

@frenck frenck added this to the 2025.1.4 milestone Jan 24, 2025
@frenck frenck dismissed davet2001’s stale review January 24, 2025 07:49

Comment addressed

@frenck frenck merged commit 6a12796 into home-assistant:dev Jan 24, 2025
32 checks passed
@frenck frenck mentioned this pull request Jan 24, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jan 25, 2025
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.

Twitch Integration sensor attribute "entity_picture" URL incorrect when channel is Live
4 participants