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

Convert oembed to async #3458

Merged
merged 2 commits into from Dec 18, 2023
Merged

Convert oembed to async #3458

merged 2 commits into from Dec 18, 2023

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #3457 by @sarayourfriend

Description

Converts the oembed endpoint to async. This was fairly straightforward and hopefully serves as a simpler example of the concept for others to work on additional views, if they wanted.

Testing Instructions

Unit tests should pass. Test the oembed endpoint as well and confirm it works the same as in staging.

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.
  • [N/A] I ran the DAG documentation generator (if 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.

@sarayourfriend sarayourfriend requested a review from a team as a code owner December 5, 2023 05:58
@github-actions github-actions bot added the 🧱 stack: api Related to the Django API label Dec 5, 2023
@openverse-bot openverse-bot 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 Dec 5, 2023
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

LGTM, the simplification around testing with pook is great to see, and this can def be used as an example for the future on how to make routes async!

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.

LGTM! It is very pleasant to see how simple the code and tests turned out.

@sarayourfriend
Copy link
Contributor Author

@krysal Just a heads up, I had to change part of the way #3069 worked because async serializer support does not include to_internal_value, so we can't make the database call in there. The change was just to return only the identifier, and then continue to use aget_object_or_404 with the parsed identifier from the serializer.

@sarayourfriend sarayourfriend marked this pull request as draft December 12, 2023 07:52
@sarayourfriend
Copy link
Contributor Author

This needs a more careful rebase. Drafting for now.

@sarayourfriend sarayourfriend marked this pull request as ready for review December 17, 2023 22:32
Linting

Fix bad serializer reference

Fix bad serializer reference
@sarayourfriend sarayourfriend merged commit 46ed1a1 into main Dec 18, 2023
42 checks passed
@sarayourfriend sarayourfriend deleted the add/convert-oembed-to-async branch December 18, 2023 02:40
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: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Convert oembed image endpoint to async
4 participants