Refactor media services

[obulat]

Fixes

Fixes #866 by @obulat

Description

This PR joins three separate modules for media-services into one generic MediaService that can be created with a mediaType parameter. All of the methods for both audio and image are the same. This change will allow us to simplify media fetching, and make the store conversion to Pinia and addition of other media types easier.

Testing Instructions

Run the app as usual, and check that you can search for all media types.

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]

This is great Olga! I haven't tested the code locally yet but I did take it for a spin to do some fun TypeScript hoop-jumping to make the MediaStore a generic class based on the mediaType in the constructor. Take it or leave it, up to you 🙂

[obulat]

This is great Olga! I haven't tested the code locally yet but I did take it for a spin to do some fun TypeScript hoop-jumping to make the MediaStore a generic class based on the mediaType in the constructor. Take it or leave it, up to you 🙂

Thank you, Sara, your PR is amazing! I've left my notes there, and added some changes from it here.

[sarayourfriend]

LGTM! Tested locally and it works great. Left a couple more subtle TypeScript things but given the files aren't added to tsconfig yet anyway it's no big deal to leave them out, we'll just have to fix them later when we add them to tsconfig.

[sarayourfriend]

@WordPress/openverse-frontend can we get a second review on this? 🙂

[zackkrida]

nice fix here.

[zackkrida]

The new abstraction is quite nice, and the types are fantastic. Some non-blocking questions:

• Should we add the peaks key here to the AudioDetail interface? Since it will be used for the waveforms soon and is already accessed in the VWaveform component implementations.
• How will we handle if a media type has a one-off endpoint, like the /waveform endpoint for audio or future endpoints that, say, 3D models might need?

[sarayourfriend]

How will we handle if a media type has a one-off endpoint, like the /waveform endpoint for audio or future endpoints that, say, 3D models might need?

Subclass the MediaService:

class Model3DService extends MediaService<'3d models'> {
  constructor() {
    super('3d models')
  }

  getCustomData() {
    // impl
  }
}