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

Fix API endpoints for related media and provider stats #509

Merged
merged 3 commits into from
Dec 11, 2021

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented Dec 11, 2021

Fixes

This PR fixes the endpoints to fetch related media, updates to use the new endpoints for provider stats, and removes fallback default provider data that was hardcoded into the repo, which can give false assurances that things are working.

We'll need to test API changes on the front-end much more closely moving forward.

Noting that in production, the related API endpoint is still seemingly broken, although my local instance of the API is working.

Description

Some additional low-hanging cleanup here:

  • Fix audio endpoints from 'audios' to 'audio'
  • Remove unused provider collection endpoints
  • Add some jsdoc annotations for axios
  • Fix error handling of getProviderStats, which wouldn't actually catch exceptions
  • Start the work to make the Sources page media-type agnostic (it still doesn't actually fetch the audio providers)

Testing Instructions

  • Run locally and observe the provider list on the 'sources' page and in the results filter sidebar is visible.
  • Run tests and ensure they work
  • Bonus: Run a local instance of the API and change the nuxt.config.js to point to it (don't forget v1 at the end of the endpoint!). Confirm that locally configured sources are visible.

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.

@zackkrida zackkrida requested a review from a team as a code owner December 11, 2021 13:39
@zackkrida zackkrida requested review from obulat and dhruvkb December 11, 2021 13:39
@zackkrida zackkrida changed the title Fix sources page and associated data Fix API endpoints for related images and provider stats Dec 11, 2021
@zackkrida zackkrida changed the title Fix API endpoints for related images and provider stats Fix API endpoints for related media and provider stats Dec 11, 2021
@zackkrida zackkrida added 🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP labels Dec 11, 2021
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM, tests great. Hopefully we can figure out why related images are broken but at least the critical path is fixed.

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.

Looks good!

src/data/api-service.js Outdated Show resolved Hide resolved
src/store/provider.js Outdated Show resolved Hide resolved
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.

I tried it with the local API, and everything works great!
I added code suggestions to remove a stray log statement and a small change.

@obulat
Copy link
Contributor

obulat commented Dec 11, 2021

I get the 400 error for related endpoint, it is caused by pagination error in the API:
https://github.com/WordPress/openverse-api/blob/13673ee8c196c9a6b786a1322d6d65b97c6ca708/openverse_api/catalog/api/utils/pagination.py#L29

Co-authored-by: Olga Bulat <obulat@gmail.com>
@zackkrida zackkrida merged commit 92240e4 into main Dec 11, 2021
@zackkrida zackkrida deleted the fix-sources-page branch December 11, 2021 19:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants