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

Handle waveform with peaks prop as a blank array #1100

Merged
merged 4 commits into from
Mar 11, 2022
Merged

Handle waveform with peaks prop as a blank array #1100

merged 4 commits into from
Mar 11, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Mar 11, 2022

Fixes

Fixes #1074 by @sarayourfriend

Description

This PR updates the peaks prop to use the default value even when given a truthy value of []. This prevents the peaks from showing up as blank.

Testing Instructions

  1. Check out the PR and run the Storybook.
  2. Visit a Waveform story and change the control for peaks to a blank array.
  3. See the waveform become random.

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 a team as a code owner March 11, 2022 07:59
@dhruvkb dhruvkb requested review from krysal and obulat March 11, 2022 07:59
@dhruvkb dhruvkb added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Mar 11, 2022
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.

Nice solution 👌

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 did like the suggestion you had before and am curious what your thought process was evaluating the trade offs between this solution and the other you suggested 🙂

src/components/VAudioTrack/VWaveform.vue Show resolved Hide resolved
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Can some tests be included here? I noticed that the waveform component has none and it is important.

@zackkrida
Copy link
Member

I'm okay with tests being added in a separate high-priority issue, in case we want to deploy this change this week or next.

@krysal
Copy link
Member

krysal commented Mar 11, 2022

There is no set date for a release the next week so I don't see a reason to rush here, as long as it is handled before the release as mentioned in the linked issue.

@dhruvkb
Copy link
Member Author

dhruvkb commented Mar 11, 2022

I can add a couple of tests today and then merge it. Won't delay any releases!

@sarayourfriend
Copy link
Contributor

I'm okay with tests being added in a separate high-priority issue, in case we want to deploy this change this week or next.

I don't think we can/should deploy this week anyway, it's Friday after all 🙂

@dhruvkb dhruvkb changed the title Handle [] as the value of the peaks prop Handle waveform with peaks prop as a blank array Mar 11, 2022
@dhruvkb dhruvkb merged commit e8325bc into main Mar 11, 2022
@dhruvkb dhruvkb deleted the decode_peaks branch March 11, 2022 19:16
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: critical Must be addressed ASAP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Empty waveform peaks data renders an empty waveform; should render placeholder instead.
5 participants