Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Use upstream thumbnail if available #1138

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

krysal
Copy link
Member

@krysal krysal commented Feb 10, 2023

Fixes

Fixes WordPress/openverse#675 by @stacimc

Description

Sends the URL of the upstream thumbnail to Photon if available, so we can get the thumbnail faster and prevent timing out in some extreme cases.

The code change itself is pretty simple but I'm having a hard time testing this automatically so any help in this regard is welcome here. Maybe someone can observe something I'm missing or come up with a better idea.

Testing Instructions

To manually test this you can pick any image from the database that has a thumbnail (applies for Flickr and Stocksnap) and compare the result of the http://localhost:50280/v1/images/<identifier>/thumb/ endpoint to its url. Observe the difference in sizes. On the main branch, you will get the same image.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [WIP] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@krysal krysal added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Feb 10, 2023
@krysal krysal requested a review from a team as a code owner February 10, 2023 20:30
@krysal krysal requested review from obulat and dhruvkb February 10, 2023 20:30
@github-actions
Copy link

github-actions bot commented Feb 10, 2023

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1138

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@openverse-bot
Copy link
Collaborator

Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR:

@obulat
@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was updated 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2.

@krysal, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

LGTM. Nice simple change. Hopefully someone else has testing suggestions 😄

@@ -108,17 +107,10 @@ def oembed(self, request, *_, **__):
def thumbnail(self, request, *_, **__):
image = self.get_object()

image_url = image.url
image_url = image.thumbnail or image.url
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure we should use thumbnail for all providers just yet. Do we know what kind of thumbnail URLs we have in the catalog database? I'm afraid that because we sometimes used whatever the providers gave as thumbnail, the dimensions and the quality can vary greatly, and we might end up with low-quality thumbnails for some items.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for the long delay in review, @krysal. Can we use thumbnail fallback only for the providers that we know have thumbnails of acceptable quality? @AetherUnbound, do you have any intuition/knowledge about the quality of thumbnails in the catalog database?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use thumbnail_url for thumbnail generation when present
4 participants