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

Move page and page_size query param validation into serializer #868

Merged
merged 9 commits into from Sep 16, 2022

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Aug 9, 2022

Fixes

Related to #857 and #843

Description

In this PR I move scattered query parameter validation into the query serializer, where it probably belongs. This has two benefits:

  1. It removes code in favour of using built-in Django Rest Framework serializer validation
  2. It removes usages of the bespoke get_api_exception
  3. It reduces instances of a loose pattern of scattered validation where parameter validation happens multiple times and deep into the runtime of a search query, rather than once at the top (where it is expected to happen and easier to find)

None of these changes change the API surface.

The lines changed is also deceptive on this PR as something like 85 of the lines added or changed were in the tests.

Testing Instructions

Ensure CI passes. Checkout the branch, set up the local API following the README instructions and make some smoke test requests to ensure everything works as expected.

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.

@sarayourfriend sarayourfriend added 🟩 priority: low Low priority and doesn't need to be rushed 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Aug 9, 2022
@sarayourfriend sarayourfriend requested a review from a team as a code owner August 9, 2022 14:05
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Aug 9, 2022
@github-actions
Copy link

github-actions bot commented Aug 9, 2022

API Developer Docs Preview: Ready

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

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.

@sarayourfriend sarayourfriend marked this pull request as draft August 9, 2022 14:10
@openverse-bot openverse-bot moved this from Needs review to In progress in Openverse PRs Aug 9, 2022
@sarayourfriend
Copy link
Contributor Author

Keeping this PR as a draft as it should not be merged until we've fixed the production ES CPU usage.

@dhruvkb
Copy link
Member

dhruvkb commented Sep 8, 2022

@sarayourfriend since the ES CPU usage is under control now, should we push to update, undraft and get this PR merged?

@dhruvkb dhruvkb self-assigned this Sep 13, 2022
@dhruvkb

This comment was marked as off-topic.

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 can be compared against an earlier (approved) implementation in #778, so this PR should be too!

@dhruvkb dhruvkb marked this pull request as ready for review September 15, 2022 08:36
@dhruvkb dhruvkb requested a review from a team as a code owner September 15, 2022 08:36
@openverse-bot openverse-bot moved this from In progress to Needs review in Openverse PRs Sep 15, 2022
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.

Looks great using the test instructions from the prior PR.

Openverse PRs automation moved this from Needs review to Reviewer approved Sep 16, 2022
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Thank you both @sarayourfriend & @dhruvkb for working on this! Looks great 💯

@krysal krysal merged commit a44f8d1 into main Sep 16, 2022
Openverse PRs automation moved this from Reviewer approved to Merged! Sep 16, 2022
@krysal krysal deleted the remove/custom-page-param-validation branch September 16, 2022 19:47
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: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

None yet

4 participants