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

Add a transform step after receiving data from the API #497

Merged
merged 5 commits into from Dec 9, 2021
Merged

Conversation

@dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Dec 7, 2021

Description

This PR makes some improvements to the media stores and services to improve the general code quality.

  • changes the results from an array to an object so that referencing results by ID becomes easier
  • changes the decoding to be an additional transformation step in the media service
  • cleans up the code for merging new results with the old ones

Testing Instructions

Searching and fetching more results should work as previously.

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.
@dhruvkb dhruvkb requested a review from as a code owner Dec 7, 2021
@dhruvkb dhruvkb requested review from zackkrida (assigned from WordPress/openverse-frontend) and krysal (assigned from WordPress/openverse-frontend) Dec 7, 2021
@dhruvkb dhruvkb added this to Needs review in Openverse PRs Dec 7, 2021
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Something strange is happening with this PR, I haven't pinpointed the cause yet, but it seems that the first search always results in a "no results" page, but subsequent searches (even for the exact same search term) will return the expected results.

I verified this doesn't happen on main so I believe it is a regression specific to this branch.

Loading

src/data/base-media-service.js Outdated Show resolved Hide resolved
Loading
src/data/audio-service.js Show resolved Hide resolved
Loading
@dhruvkb dhruvkb requested a review from sarayourfriend Dec 8, 2021
@dhruvkb dhruvkb marked this pull request as draft Dec 8, 2021
@dhruvkb dhruvkb moved this from Needs review to In progress in Openverse PRs Dec 8, 2021
@dhruvkb
Copy link
Member Author

@dhruvkb dhruvkb commented Dec 8, 2021

Checking the "no-results" bug from Sara's comment.
Update: reproduced
Update: fixed

Loading

@dhruvkb
Copy link
Member Author

@dhruvkb dhruvkb commented Dec 9, 2021

@sarayourfriend thanks for finding the regression! I believe 54a8efd should fix it.

Loading

@dhruvkb dhruvkb marked this pull request as ready for review Dec 9, 2021
@dhruvkb dhruvkb moved this from In progress to Needs review in Openverse PRs Dec 9, 2021
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Works great now! 🚀 🤠 🎉

Loading

Copy link
Member

@zackkrida zackkrida left a comment

Great idea and approach!

Loading

Openverse PRs automation moved this from Needs review to Reviewer approved Dec 9, 2021
@dhruvkb dhruvkb merged commit b1ddf1f into main Dec 9, 2021
8 checks passed
Loading
Openverse PRs automation moved this from Reviewer approved to Merged! Dec 9, 2021
@dhruvkb dhruvkb deleted the audio_store branch Dec 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Openverse PRs
  
Merged!
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants