Fix: invalid array length in renderer

[katspaugh]

Short description

Resolves #3923

Implementation details

If singleCanvasWidth is 0, do an early return w/o rendering anything.

Summary by CodeRabbit

• Bug Fixes
  • Improved rendering logic to prevent errors when there is nothing to render.

[coderabbitai]

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/renderer.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 pull request introduces a defensive check in the renderMultiCanvas method of the Renderer class to prevent potential rendering errors when singleCanvasWidth is zero. This change aims to address an issue where the method could potentially enter an infinite loop or cause a RangeError when attempting to render canvases with an invalid width. The modification ensures early return if no valid rendering width is available, improving the method's robustness.

Changes

File	Change Summary
src/renderer.ts	Added a check to return early if singleCanvasWidth is zero in the renderMultiCanvas method

Assessment against linked issues

Objective	Addressed	Explanation
Prevent RangeError during wavesurfer recreation [#3923]	✅
Handle zero canvas width scenario	✅

Possibly related PRs

• Fix: (Renderer) splitChannels memory leak #3959: Modifications to the Renderer class in src/renderer.ts, potentially addressing similar rendering-related issues

Poem

🐰 In the realm of canvas and sound,
A rabbit's fix, carefully found!
Where zeros once caused despair,
Now rendering flows without a care
Wavesurfer dances, smooth and bright! 🎵

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/renderer.ts (1)

531-533: LGTM! Consider adding debug logging.

The defensive check prevents potential errors when attempting to render with zero width. This is a good addition that improves the robustness of the renderer.

Consider adding debug logging to help diagnose why nothing was rendered:

    // Nothing to render
-   if (singleCanvasWidth === 0) return
+   if (singleCanvasWidth === 0) {
+     console.debug('Skipping render: Canvas width is zero')
+     return
+   }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 329c849 and e07db35.

📒 Files selected for processing (1)

• src/renderer.ts (1 hunks)

[cloudflare-workers-and-pages]

Deploying wavesurfer-js with    Cloudflare Pages

Latest commit:	e07db35
Status:	✅  Deploy successful!
Preview URL:	https://d439a694.wavesurfer-js.pages.dev
Branch Preview URL:	https://rangeerror.wavesurfer-js.pages.dev

View logs

[chensongtao]

create({with: 200}), set width fix this bug