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

Handle global audio play errors #4011

Merged
merged 3 commits into from Apr 12, 2024
Merged

Handle global audio play errors #4011

merged 3 commits into from Apr 12, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 2, 2024

Fixes

Fixes #3487 by @sentry-io

Description

This PR creates a playActiveAudio function within the active media store to play the audio and correctly handle play errors for both the VAudioTrack's and the VGlobalAudioTrack's audio elements.

I'm not sure about the location of this function. At first, I wanted to put it in a separate file, something like utils/audio.ts. However, this function needs access to set the store's message and also needs to be able to send a Sentry message. That's why I put it inside the active media store, and added the html audio element as a parameter. Suggestions on better placement welcome!

I also fixed the error message showing the key instead of the string in the global audio player.

Testing Instructions

Use an iphone or an iphone simulator.
Run the app using just frontend/run dev
Search for audios and select OGG in the Extensions filters.
Play an audio. You should see "This audio format is not supported by your browser" instead of "err_unsupported" in the waveform area.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate 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.
  • I ran the DAG documentation generator (if applicable).

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.

@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Apr 2, 2024
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Apr 2, 2024
@obulat obulat force-pushed the fix/audio_unsupported branch 2 times, most recently from 492be1e to 4eb09e9 Compare April 3, 2024 08:20
@obulat obulat marked this pull request as ready for review April 3, 2024 08:32
@obulat obulat requested a review from a team as a code owner April 3, 2024 08:32
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.

I can't give any input on the placement within the code, but I tested this locally with my neighbor's iPhone and confirmed it failed as expected!

image

@obulat obulat changed the title Fix audio errors Handle global audio play errors Apr 5, 2024
@openverse-bot
Copy link
Collaborator

Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR:

@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

This is a very nice approach and super clean PR. Well done!

@zackkrida zackkrida removed the request for review from dhruvkb April 10, 2024 19:01
@obulat obulat merged commit 35be6cc into main Apr 12, 2024
40 checks passed
@obulat obulat deleted the fix/audio_unsupported branch April 12, 2024 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

NotSupportedError when trying to play audio
4 participants