Add duration and category to ES mappings

[sarayourfriend]

Fixes

Fixes #212 by @krysal

Description

Adds the duration and category fields to the ES mappings. Also adds the category to the AudioSerializer. Duration was already present there (though doesn't appear to be working in my tests of the audio results endpoint).

Testing Instructions

Run just down && just init then inspect the response of the http://localhost:8000/v1/audio?format=json endpoint and verify that the expected fields are all present.

As I said above, the duration is still missing but I'm unsure why.

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.

[AetherUnbound]

Looks good, though I don't have any advice on the missing duration piece 😅

[dhruvkb]

The addition of duration did not work because it also needs to be added here:

openverse-api/ingestion_server/ingestion_server/elasticsearch_models.py

Line 322 in 65a624f

return Audio(

This is the code that transforms a DB cursor row dict into an elasticsearch_dsl.Document. category by weird chance is already present there but duration isn't.

[sarayourfriend]

@dhruvkb Thank you so much! That worked perfectly! I've update the PR with that change and the testing instructions pass now.

[zackkrida]

It looks like to make the audio tests pass, the sample responses in the tests need to be updated with the new fields. Other than that this already looks great 👍

[obulat]

I think this needs to be moved to the MediaSerializer now: in the Catalog, we have changed the Category for Audio to match Image Category, i.e. now it's an Array field that can contain several categories.

[dhruvkb]

I'm skeptical about having categories being an array. We already have genres for many-to-many classification and tags for attributes. Furthermore, if we look at the example categories (namely music, sound_effect, podcast, news & audiobook), it's hard to see any overlap between them. Even in our sample data, none of the files belong to more than one category.

Anyway if we do decide to change it, here's the Django model for reference. It'll need to be updated.

openverse-api/openverse_api/catalog/api/models/audio.py

Line 103 in 65a624f

category = models.CharField(

[zackkrida]

As discussed this will stay a string and can be move to the MediaSerializer later.

[sarayourfriend]

Should this stay for the time being until the images are converted to a single category? Or is it possible to update it now already?

[zackkrida]

Maybe @dhruvkb can confirm, I think it'd be better for this to stay where it is for now and for us to update it later but not sure.

[dhruvkb]

The category can be separate for audio and images for the time being. We can merge the fields later when we clean up the existing image catalog.