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

feat: override blob MIME type #3995

Merged
merged 2 commits into from
Jan 13, 2025
Merged

Conversation

wfk007
Copy link
Contributor

@wfk007 wfk007 commented Jan 13, 2025

Short description

Add a new option(mimeType) to override the blob MIME when the server doesn't send the correct MIME in content-type.

discussion: #3621
related pr: #3471

Implementation details

After fetchBlob in loadAudio, if there there is mimeType option, override the Blob MIME.

How to test it

Screenshots

Checklist

  • This PR is covered by e2e tests
  • It introduces no breaking API changes

Summary by CodeRabbit

  • New Features
    • Enhanced audio loading configuration by adding optional MIME type specification for audio files.

Copy link

coderabbitai bot commented Jan 13, 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/wavesurfer.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 new optional property blobMimeType to the WaveSurferOptions type in the wavesurfer.ts file. This addition allows users to specify a MIME type for the Blob when loading audio. The loadAudio method has been modified to check for the presence of blobMimeType and wrap the fetched Blob in a new Blob with the specified MIME type if provided. These changes extend the configuration options for the WaveSurfer instance without affecting existing functionality.

Changes

File Change Summary
src/wavesurfer.ts Added optional blobMimeType?: string to WaveSurferOptions type and updated loadAudio method to support custom MIME type specification.

Poem

🎵 A wavey tale of audio delight,
Where MIME types dance with byte-sized might!
A rabbit's code, so sleek and neat,
Makes audio loading a flexible feat! 🐰🎧
Hop along, sound waves, with type so bright!


📜 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 cf667a3 and 69694be.

📒 Files selected for processing (1)
  • src/wavesurfer.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/wavesurfer.ts

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.

@wfk007 wfk007 changed the title feat: blob mime type feat: override blob MIME type Jan 13, 2025
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: 1

🧹 Nitpick comments (2)
src/wavesurfer.ts (2)

81-82: Enhance the documentation comment

While the documentation is clear, it would be helpful to add more context about when this option should be used and provide an example of a valid MIME type.

-  /** Override the Blob MIME type */
+  /** Override the Blob MIME type when the server's content-type header is incorrect.
+   * Example: 'audio/wav' or 'audio/mpeg'
+   */

440-443: Fix grammatical error in variable name

The variable name overridedMimeType is grammatically incorrect.

-      const overridedMimeType = this.options.mimeType
+      const overriddenMimeType = this.options.mimeType
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e519c20 and cf667a3.

📒 Files selected for processing (1)
  • src/wavesurfer.ts (2 hunks)
🔇 Additional comments (2)
src/wavesurfer.ts (2)

440-443: Implementation looks good overall!

The implementation correctly addresses the issue mentioned in the PR objectives, allowing users to override the MIME type when the server's content-type header is incorrect. The changes are minimal and maintain backward compatibility.


440-443: Consider adding tests for the new mimeType option

The PR objectives mention that this should be covered by end-to-end tests, but it would be beneficial to add unit tests as well.

Would you like me to help create unit tests for this new feature?

Comment on lines 440 to 443
const overridedMimeType = this.options.mimeType
if (overridedMimeType) {
blob = new Blob([blob], { type: overridedMimeType })
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add MIME type validation

The current implementation doesn't validate the provided MIME type, which could lead to runtime errors if an invalid value is provided.

       const overriddenMimeType = this.options.mimeType
       if (overriddenMimeType) {
+        // Validate that the MIME type starts with 'audio/'
+        if (!overriddenMimeType.startsWith('audio/')) {
+          throw new Error(`Invalid MIME type: ${overriddenMimeType}. Must be an audio MIME type starting with 'audio/'`)
+        }
         blob = new Blob([blob], { type: overriddenMimeType })
       }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const overridedMimeType = this.options.mimeType
if (overridedMimeType) {
blob = new Blob([blob], { type: overridedMimeType })
}
const overridedMimeType = this.options.mimeType
if (overridedMimeType) {
// Validate that the MIME type starts with 'audio/'
if (!overridedMimeType.startsWith('audio/')) {
throw new Error(`Invalid MIME type: ${overridedMimeType}. Must be an audio MIME type starting with 'audio/'`)
}
blob = new Blob([blob], { type: overridedMimeType })
}

@@ -78,6 +78,8 @@ export type WaveSurferOptions = {
backend?: 'WebAudio' | 'MediaElement'
/** Nonce for CSP if necessary */
cspNonce?: string
/** Override the Blob MIME type */
mimeType?: string
Copy link
Owner

Choose a reason for hiding this comment

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

Since it's only for Blobs, should we call it blobMimeType?

Comment on lines 441 to 443
if (overridedMimeType) {
blob = new Blob([blob], { type: overridedMimeType })
}
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
if (overridedMimeType) {
blob = new Blob([blob], { type: overridedMimeType })
}
if (overridenMimeType) {
blob = new Blob([blob], { type: overridenMimeType })
}

@katspaugh
Copy link
Owner

Tbh I'm not sure wavesurfer should be handling this. As mentioned in the linked discussion, your server should send the right content-type header.
Alternatively, you could fetch and set the mime in your own code, then call loadBlob.

@wfk007
Copy link
Contributor Author

wfk007 commented Jan 13, 2025

Tbh I'm not sure wavesurfer should be handling this. As mentioned in the linked discussion, your server should send the right content-type header. Alternatively, you could fetch and set the mime in your own code, then call loadBlob.

Yes, fetch the blob and call loadBlob in my code can solve this issue. But We need to implement the progress and abortController logic again. Not all backend services will follow the specification and return the correct MIME in content-type, and the adding of this configuration can also prevent other users from encountering the above breaking changes during the upgrade with the minimal changes.

@katspaugh katspaugh merged commit 5655929 into katspaugh:main Jan 13, 2025
3 checks passed
@katspaugh
Copy link
Owner

Thank you! Will release it now.

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.

2 participants