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

Fix invalid UUID breaking related images query #766

Merged
merged 2 commits into from
Jun 23, 2022
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jun 22, 2022

Fixes

Related to #729 by @AetherUnbound

Description

This PR uses @krysal 's suggestion to add an IndexError handling for when there are no hits in the search controller:

_id = item.execute().hits[0].id

Testing Instructions

On main, if you go to http://localhost:8000/v1/images/000000000000000000000000000000000000/related/, you would get a 500 error.
On this branch, you should get a 404.

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.

obulat added 2 commits June 22, 2022 22:11
Signed-off-by: Olga Bulat <obulat@gmail.com>
Signed-off-by: Olga Bulat <obulat@gmail.com>
@obulat obulat requested a review from a team as a code owner June 22, 2022 19:19
@obulat obulat requested review from dhruvkb and sarayourfriend June 22, 2022 19:19
@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Jun 22, 2022
@github-actions
Copy link

github-actions bot commented Jun 22, 2022

API Developer Docs Preview: Ready

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

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.

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.

This is a good fix. We should still tighten up the lookup regex for good measure.

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. +1 for what Dhruv said. Also, do you know why something that looks like a valid UUID (follows the pattern) doesn't cause the 500? Why doesn't it throw an IndexError as well like the same-length-but-not-UUID-pattern string does when queried for?

@obulat
Copy link
Contributor Author

obulat commented Jun 23, 2022

Also, do you know why something that looks like a valid UUID (follows the pattern) doesn't cause the 500? Why doesn't it throw an IndexError as well like the same-length-but-not-UUID-pattern string does when queried for?

@sarayourfriend, actually, that's not the case, but it took me some time to figure it out :)
The example you gave in the issue (da5cb478-c093-4d62-b721-cda18797e3fz) looks like UUID for humans, because we don't notice that z(the last letter of the string) is not in the pattern, it's only a-f for the hex numbers.

@sarayourfriend
Copy link
Contributor

Ah!! I forgot that UUID had rules 😅 Good catch! Sorry for the false lead 😱

@obulat
Copy link
Contributor Author

obulat commented Jun 23, 2022

Ah!! I forgot that UUID had rules 😅 Good catch! Sorry for the false lead 😱

It was actually a great opportunity to learn more about what's happening when we search for something 👍

@obulat obulat merged commit 32f5a21 into main Jun 23, 2022
@obulat obulat deleted the fix/related_404 branch June 23, 2022 07:39
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: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants