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

Add peaks=true to all audio searches #1802

Merged
merged 3 commits into from
Sep 13, 2022
Merged

Add peaks=true to all audio searches #1802

merged 3 commits into from
Sep 13, 2022

Conversation

zackkrida
Copy link
Member

Fixes

Fixes #1800 by @krysal

Description

Wow, I struggled to work with the media services. I cannot wait to refactor some of that code.

Anyway, this PR adds a special case to add peaks=true to all audio and related audio searches. To do so I also had to upgrade the related media method to allow for query parameters. Maybe that will be a nice addition in the future.

I'm not sure about tests here. Do we have any to verify the API endpoint paths are correct? Otherwise, this is covered by the fact that the visual regression tests would change if the peak data isn't downloaded. Still, it seems like we need better test coverage around the API endpoints in general.

Testing Instructions

Check on client-rendered searches that the peaks=true is present for all audio API search requests, and on related audio searches. Finally, make sure you see the same peaks on SSR searches.

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 September 9, 2022 21:23
@github-actions
Copy link

github-actions bot commented Sep 9, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1802
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1802/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@openverse-bot openverse-bot added ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🟧 priority: high Stalls work on the project or its dependents labels Sep 9, 2022
@github-actions
Copy link

github-actions bot commented Sep 9, 2022

Size Change: -2.46 kB (0%)

Total Size: 779 kB

Filename Size Change
./.nuxt/dist/client/236.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/236.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/237.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 111 kB -169 B (0%)
./.nuxt/dist/client/app.modern.js 103 kB -460 B (0%)
./.nuxt/dist/client/components/v-modal.js 0 B -875 B (removed) 🏆
./.nuxt/dist/client/components/v-modal.modern.js 0 B -878 B (removed) 🏆
./.nuxt/dist/client/runtime.js 2.69 kB -47 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.69 kB -46 B (-2%)
./.nuxt/dist/client/vendors/app.js 47.8 kB +34 B (0%)
./.nuxt/dist/client/229.js 273 B +273 B (new file) 🆕
./.nuxt/dist/client/229.modern.js 276 B +276 B (new file) 🆕
./.nuxt/dist/client/230.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.1 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 77 kB -2 B (0%)
./.nuxt/dist/client/components/loading-icon.js 747 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 750 B -1 B (0%)
./.nuxt/dist/client/components/table-sort-icon.js 508 B -1 B (0%)
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.77 kB -2 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.75 kB -1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3 kB +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.9 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 357 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 361 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.11 kB +2 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.05 kB -3 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.js 569 B -1 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 574 B -1 B (0%)
./.nuxt/dist/client/components/v-bone.js 686 B +1 B (0%)
./.nuxt/dist/client/components/v-bone.modern.js 689 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB -1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.13 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 466 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 470 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 765 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 771 B -2 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.78 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.59 kB -2 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB -1 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.96 kB -1 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license.js 2.94 kB -3 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 2.91 kB -4 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.53 kB -2 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.51 kB -1 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.js 744 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 754 B +1 B (0%)
./.nuxt/dist/client/components/v-error-image.js 1.69 kB +1 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB +1 B (0%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB -1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB -1 B (0%)
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB -1 B (0%)
./.nuxt/dist/client/components/v-image-details.js 1.44 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB -2 B (0%)
./.nuxt/dist/client/components/v-image-grid.js 2.53 kB +2 B (0%)
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB +3 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 924 B +1 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 915 B -2 B (0%)
./.nuxt/dist/client/components/v-load-more.js 786 B -1 B (0%)
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-license.js 801 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.modern.js 810 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.08 kB -2 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.09 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.js 2.94 kB -2 B (0%)
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.modern.js 2.91 kB -4 B (0%)
./.nuxt/dist/client/components/v-media-tag.js 429 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-meta-search-form.js 3.11 kB -1 B (0%)
./.nuxt/dist/client/components/v-meta-search-form.modern.js 3.08 kB +1 B (0%)
./.nuxt/dist/client/components/v-meta-source-list.js 2.59 kB -1 B (0%)
./.nuxt/dist/client/components/v-meta-source-list.modern.js 2.56 kB +2 B (0%)
./.nuxt/dist/client/components/v-no-results.js 2.77 kB -1 B (0%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.75 kB +2 B (0%)
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB -3 B (0%)
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB -2 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.09 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 967 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.69 kB -1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 805 B +1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 809 B -1 B (0%)
./.nuxt/dist/client/components/v-search-grid.js 5.46 kB -4 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.42 kB +2 B (0%)
./.nuxt/dist/client/components/v-search-results-title.js 671 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 664 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 831 B +1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 820 B -1 B (0%)
./.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 994 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 893 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 890 B +1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 892 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.17 kB -1 B (0%)
./.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB -1 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 14.6 kB -2 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 14.7 kB -3 B (0%)
./.nuxt/dist/client/components/v-tab-panel.js 689 B +2 B (0%)
./.nuxt/dist/client/components/v-tab-panel.modern.js 684 B +1 B (0%)
./.nuxt/dist/client/components/v-tab.js 1.73 kB +1 B (0%)
./.nuxt/dist/client/components/v-tab.modern.js 1.71 kB 0 B
./.nuxt/dist/client/components/v-tabs.js 781 B +1 B (0%)
./.nuxt/dist/client/components/v-tabs.modern.js 765 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 299 B +1 B (0%)
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.05 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.06 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 6.59 kB +1 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 6.43 kB -4 B (0%)
./.nuxt/dist/client/pages/feedback.js 3.23 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.2 kB -1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 7.05 kB +3 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 6.82 kB +3 B (0%)
./.nuxt/dist/client/pages/index.js 5.13 kB +3 B (0%)
./.nuxt/dist/client/pages/index.modern.js 5.01 kB -3 B (0%)
./.nuxt/dist/client/pages/meta-search.js 1.67 kB +1 B (0%)
./.nuxt/dist/client/pages/meta-search.modern.js 1.67 kB +1 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.27 kB -1 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.27 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.55 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search.js 2.72 kB +2 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.57 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.14 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.15 kB -1 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.78 kB +2 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.99 kB -2 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 2.96 kB -1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 242 B 0 B
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./.nuxt/dist/client/pages/search/video.js 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 244 B +1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.44 kB +4 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 47.2 kB +7 B (0%)

compressed-size-action

@zackkrida
Copy link
Member Author

Thanks for the fix, @obulat!

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM, except for 1 change to meet Vue 3 + TS linting requirements. Not sure why the linting process did not flag that.

src/data/media-service.ts Outdated Show resolved Hide resolved
Co-authored-by: Dhruv Bhanushali <dhruv_b@live.com>
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.

Adds peaks to all requests, SSR and CSR!
And I agree with your remark about the services.

@krysal krysal merged commit b91e74e into main Sep 13, 2022
@krysal krysal deleted the include-peaks branch September 13, 2022 15:18
github-actions bot pushed a commit that referenced this pull request Sep 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include peaks=true param on audio requests
5 participants