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

Expose provider in the API tags response #4280

Merged
merged 6 commits into from
May 7, 2024

Conversation

AetherUnbound
Copy link
Collaborator

@AetherUnbound AetherUnbound commented May 7, 2024

Fixes

Fixes #4273 by @AetherUnbound

Description

This PR exposes the provider field within the tags attribute that is present in the database under the key unstable__provider. The core of this change is in media_serializers.py, most of the other changes in this PR revolve around making sure the field shows up in tests and documentation.

One thing that was unexpected was having to set allow_null=True on the serializer. It seems like there are some cases where we're converting results directly from Elasticsearch into serialized results rather than retrieving the full data from the database. We could alter the ingestion server to ingest this new field, but I don't think it's necessary (and I think we can leave this as nullable here, given the explanation I've provided).

Testing Instructions

Tests should pass! You can also do the following:

  1. just down -v
  2. just api/init
  3. Visit http://localhost:50280/v1/images/ and see that each of the tags arrays also sends an unstable__provider key
  4. Visit http://localhost:50280/v1/images/?q=crim and observe a result that has tags from multiple providers

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 (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or 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.

@AetherUnbound AetherUnbound requested a review from a team as a code owner May 7, 2024 03:51
@AetherUnbound AetherUnbound requested review from obulat and dhruvkb May 7, 2024 03:51
@github-actions github-actions bot added the 🧱 stack: api Related to the Django API label May 7, 2024
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository labels May 7, 2024
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Nice that the change is so small! Thank you for the explanation on allow_null. I wonder if this is only this way in the local data, or in prod, too?

@AetherUnbound
Copy link
Collaborator Author

Thank you for the explanation on allow_null. I wonder if this is only this way in the local data, or in prod, too?

Because it has to do with what we index into Elasticsearch, I assume it would affect production as well. The local data is "complete" in the sense that all of the tags have a provider in the actual database. If anything, I would imagine production to be less compliant on that front!

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!

Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com>
@AetherUnbound AetherUnbound merged commit 8e6b884 into main May 7, 2024
45 checks passed
@AetherUnbound AetherUnbound deleted the feature/expose-provider-in-tags branch May 7, 2024 21:32
obulat pushed a commit that referenced this pull request May 8, 2024
* Expose provider in TagsSerializer

* Add some machine-generated labels to sample data

* Update documentation examples

* Fix some tests

* Allow the provider field to be nullable for ES compatibility

* Update phrasing

Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com>

---------

Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com>
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: addition Addition of new 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.

Expose provider information in the tags
4 participants