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

Fix: reset media element on load #4010

Merged
merged 2 commits into from
Jan 24, 2025
Merged

Fix: reset media element on load #4010

merged 2 commits into from
Jan 24, 2025

Conversation

katspaugh
Copy link
Owner

@katspaugh katspaugh commented Jan 24, 2025

Short description

Resolves #4009

Implementation details

The media element has to be reset when setting a new src.

Summary by CodeRabbit

  • Bug Fixes
    • Improved media source handling to prevent potential playback issues when changing sources.

Copy link

coderabbitai bot commented Jan 24, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/player.ts

Oops! Something went wrong! :(

ESLint: 9.17.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

"""

Walkthrough

The changes in the src/player.ts file focus on improving the source management within the media player. A new block of code is introduced in the setSrc method to reset the media element's source before setting a new one. This modification ensures that when a new source is assigned, the previous source is cleared, potentially addressing issues with source retention during media playback.

Changes

File Change Summary
src/player.ts Modified setSrc method to reset media element source before setting a new source

Assessment against linked issues

Objective Addressed Explanation
Hot replacement audio source [#4009]

Poem

🎵 In the realm of audio's dance,
A rabbit's code takes a swift stance
Clearing sources with gentle might
Ensuring tracks play just right
Hop, hop, wavesurfer's new delight! 🐰🎧
"""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93972b4 and f5c7aa8.

📒 Files selected for processing (1)
  • src/player.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/player.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

cloudflare-workers-and-pages bot commented Jan 24, 2025

Deploying wavesurfer-js with  Cloudflare Pages  Cloudflare Pages

Latest commit: f5c7aa8
Status: ✅  Deploy successful!
Preview URL: https://b8626bd4.wavesurfer-js.pages.dev
Branch Preview URL: https://fix-src.wavesurfer-js.pages.dev

View logs

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/player.ts (1)

76-80: Consider pausing the media before resetting.

Currently, this block sets this.media.src to an empty string and calls load() to reset the player, which is valid. However, if the media is actively playing, it might abruptly interrupt or cause a playback glitch. For clarity and user experience, consider pausing the media first. Here's a possible approach:

77     if (src) {
+        if (!this.media.paused) {
+          this.media.pause()
+        }
         this.media.src = ''
         this.media.load()
       }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f56ea15 and 93972b4.

📒 Files selected for processing (1)
  • src/player.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: eslint
  • GitHub Check: E2E tests
  • GitHub Check: Cloudflare Pages

@katspaugh katspaugh merged commit ef522ee into main Jan 24, 2025
5 checks passed
@katspaugh katspaugh deleted the fix-src branch January 24, 2025 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hot replacement audio source
1 participant