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

Hotfix for negative values in peaks #1148

Merged
merged 3 commits into from
Mar 21, 2022
Merged

Hotfix for negative values in peaks #1148

merged 3 commits into from
Mar 21, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Mar 21, 2022

Fixes

Related to openverse-api issue#575.

Description

The front end expects all audio peaks values to be non-negative integers in the range of [0..1]. However, some of the peaks values that API sends are negative.
This PR adjust the validator for peak values, and makes all the values at least zero.
To minimize the effect of this fix on performance, I added the Math.max(0, value) to the already existing map function that handles the peaks object.

Testing Instructions

On the main branch, go to http://localhost:8443/audio/727b9979-98f1-4604-9097-0a8b6fa68f2e/. You should see a warning in the console saying "Invalid prop: custom validator check failed for prop "peaks".
When opening the same page on this branch, you should not see this warning.

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.

@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Mar 21, 2022
@obulat obulat requested a review from a team as a code owner March 21, 2022 09:23
@obulat obulat requested review from krysal and dhruvkb March 21, 2022 09:23
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.

I like it. Maybe we can add a test for this but that's not too important.

@@ -187,7 +187,7 @@ export default defineComponent({
peaks: {
type: Array,
required: false,
validator: (val) => val.every((item) => item >= 0 && item <= 1),
validator: (val) => val.every((item) => item >= -0.3 && item <= 1),
Copy link
Member

Choose a reason for hiding this comment

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

Let's not set this arbitrary limit and maybe just check for type of number.

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! I agree with Dhruv's comment to just check for typeof number in the validator for now.

@obulat obulat merged commit a469a57 into main Mar 21, 2022
@obulat obulat deleted the peaks_validation branch March 21, 2022 11:57
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: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants