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

Remove MediaViewSet's lookup regex #5273

Merged
merged 5 commits into from
Dec 16, 2024
Merged

Remove MediaViewSet's lookup regex #5273

merged 5 commits into from
Dec 16, 2024

Conversation

krysal
Copy link
Member

@krysal krysal commented Dec 12, 2024

Description

Since the upstream issue (encode/django-rest-framework#6789) is fixed, it's safe to remove this workaround to handle invalid UUID-like strings. This way, DRF handles better these requests and responses are consistent with the rest.

Response in production

https://api.openverse.org/v1/images/000000000000000000000000000000000000/related/

Screenshot 2024-12-12 at 12-35-51 Not Found

Response in this branch

http://localhost:50280/v1/images/000000000000000000000000000000000000/related/

Screenshot 2024-12-12 at 12-32-37 Related – Django REST framework

Testing Instructions

Run the API, just api/up, and check other invalid UUIDs from the original issue (WordPress/openverse-api#729) if you wish.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate 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.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog PRs) or the media properties generator (ov just catalog/generate-docs media-props for the catalog or ov just api/generate-docs for the API) where applicable.

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: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Dec 12, 2024
@krysal krysal requested a review from a team as a code owner December 12, 2024 16:41
@krysal krysal requested review from obulat and dhruvkb and removed request for a team December 12, 2024 16:41
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 change looks good. I couldn't find any preexisting tests for bad regexes in the path, should we add one to api/test/unit/views/test_media_views.py?

dhruvkb

This comment was marked as duplicate.

@krysal
Copy link
Member Author

krysal commented Dec 12, 2024

@dhruvkb There is a test for the detail view:

def test_detail_view_for_invalid_uuids_returns_not_found(
media_type_config: MediaTypeConfig, bad_uuid: str, api_client
):
res = api_client.get(f"/v1/{media_type_config.url_prefix}/{bad_uuid}/")
assert res.status_code == 404

Of course, I can also add another one for the related endpoint. However, this starts to step into the realm of testing Django Rest Framework functionality.

I'll need some help with the error from the schemathesis tests, tho. It's failing because the content types are not matching, which makes sense, but I don't see where that can be fixed. Perhaps you or @obulat, who has more knowledge of these tests, can identify it more easily. Those docs tests have been highly inconsistent in my local environment, too.

E 1. Undocumented Content-Type
E
E Received: text/html; charset=utf-8
E Documented: application/json

@krysal krysal force-pushed the rm/old_regex branch 2 times, most recently from 556698e to 041735b Compare December 13, 2024 22:24
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 changes look good to me, thanks for monitoring TODOs and resolving them.

I found a few things missing, and a fix for schemathesis that I've pushed to a follow up PR #5276. Please review that PR, merge it into this and then this into main.

@krysal krysal merged commit 3fa8f30 into main Dec 16, 2024
48 checks passed
@krysal krysal deleted the rm/old_regex branch December 16, 2024 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants