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

Use thumbnail as image url image_view if available #1060

Closed
wants to merge 0 commits into from

Conversation

sahil-R
Copy link
Contributor

@sahil-R sahil-R commented Dec 27, 2022

Fixes

Fixes WordPress/openverse#675 by @stacimc

Description

Some providers can link large images in their image_url, This can cause unacceptably slow response times or even timeouts when generating thumbnails via our thumbnail service.

This pr tries to tackle this by checking if there is a thumbnail URL available or not, if yes, then it uses the thumbnail URL; if not, only then it uses the image URL.

Testing Instructions

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

@sahil-R sahil-R requested a review from a team as a code owner December 27, 2022 17:46
@openverse-bot openverse-bot added ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🟨 priority: medium Not blocking but should be addressed soon labels Dec 27, 2022
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Thanks @sahil-R! The logic is sound but the code quality can be improved in some ways.

api/catalog/api/views/image_views.py Outdated Show resolved Hide resolved
api/catalog/api/views/image_views.py Outdated Show resolved Hide resolved
api/catalog/api/views/image_views.py Outdated Show resolved Hide resolved
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

The comment can use some punctuation and grammar improvements but other than that, LGTM!

api/catalog/api/views/image_views.py Outdated Show resolved Hide resolved
sarayourfriend
sarayourfriend previously approved these changes Jan 4, 2023
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for the contribution and quick changes @sahil-R.

@sarayourfriend sarayourfriend dismissed their stale review January 4, 2023 06:24

Requesting to add unit tests

@sarayourfriend
Copy link
Contributor

I approved, but prematurely. If you can please add unit tests for this change, then it will be able to be approved and merged without issue. The new tests would need to be added in media_views_test.py, however it will conflict with changes in #1056 which will make adding those new tests significantly easier as it cleans up the tedious fixtures currently present in that test module. If you'd like to wait for the Photon PR to be merged to make it simpler to add the tests, feel free. Otherwise, please note that there may be conflicts if the other PR is merged first.

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

@sahil-R, 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.

@dhruvkb dhruvkb added the 🔧 tech: django Requires familiarity with Django label Jan 10, 2023
@sahil-R sahil-R marked this pull request as draft January 12, 2023 13:43
@krysal krysal added 🟧 priority: high Stalls work on the project or its dependents and removed 🟨 priority: medium Not blocking but should be addressed soon labels Jan 12, 2023
@krysal
Copy link
Member

krysal commented Jan 12, 2023

Ups, I made the test based on the old ones, before noticing the conflict. I'll get back to this later if @sahil-R doesn't get to it firsts.

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: high Stalls work on the project or its dependents 🔧 tech: django Requires familiarity with Django
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use thumbnail_url for thumbnail generation when present
5 participants