Fix Webpack bundling of recorder worklet

[steverep]

Proposed change

Webpack is not currently parsing the audio recorder worklet for imports or creating a proper chunk. It happened to work prior to #20676 for the modern build because there were luckily no imports of polyfills or Babel helpers. The legacy version never could have worked.

This adjusts the code which adds the worklet and the Webpack config to fix that problem. Also, it keeps the worklet from splitting because of several bugs in Webpack related to loading any external chunks. The worklet is small enough that this doesn't really matter.

So this fixes the regression for the modern build and also gets it working for the legacy build. A follow up could better transpile the worklet similar to #21177 and also implement better feature detection instead of a try/catch.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes Unable to use voice input microphone, prompt”. /“bug, 7.0b5 #21234
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• Bug Fixes

  • Improved audio recording reliability by updating the AudioRecorder context creation logic and module loading syntax.

• Refactor

  • Streamlined webpack configuration for better support of web workers and worklets, enhancing overall build performance.

• Style

  • Updated naming conventions for audio worklet processors to ensure consistency and compatibility.

[coderabbitai]

Walkthrough

Walkthrough

The changes focus on addressing issues with the AudioRecorder class and its integration with Webpack, specifically concerning worker and worklet configurations. Adjustments were made to improve compatibility with Webpack's module loading and chunk splitting, ensuring proper functionality across different browsers and environments.

Changes

File	Change Summary
build-scripts/webpack.cjs	Adjusted the parser settings for workers and refined chunk splitting behavior for web workers and worklets.
src/util/audio-recorder.ts	Updated context creation logic, modified worklet module loading syntax, and refined context variable assignment.
src/util/recorder-worklet.js	Updated the registration name for the audio worklet processor to match the new format.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure audio recorder can load modules correctly to fix the voice input microphone issue. (#21234)	✅
Resolve the TypeError related to module specifiers in audio-recorder.ts. (#21234)	✅

---

Overall, the updates ensure compatibility with Webpack's configurations and resolve the issue related to module specifiers, thereby fixing the voice input microphone issue outlined in the linked issue #21234.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 62a09aa and 869e257.

Files selected for processing (1)

• src/util/audio-recorder.ts (1 hunks)

Additional comments not posted (5)

src/util/audio-recorder.ts (5)

73-73: LGTM! Comment is informative.

The comment about parser.worker in Webpack config is informative and aligns with the PR objectives.

---

74-74: LGTM! Syntax for context creation is correct.

The usage of AudioContext or webkitAudioContext is correct and ensures compatibility across different browsers.

---

76-77: Improve the comment for clarity.

The comment about matching the Webpack config can be made clearer for future maintainers.

-    // Syntax here must match an item of `parser.worker` in Webpack config in
-    // order for module to be parsed and a chunk to be properly created.
+    // Ensure this syntax matches an item in `parser.worker` in the Webpack config
+    // for the module to be parsed and a chunk to be properly created.

---

82-84: LGTM! Worklet node and connection logic is correct.

The logic for creating the AudioWorkletNode and connecting the source to the recorder is correct.

---

78-80: Verify if recorder-worklet.js file exists.

Ensure that the recorder-worklet.js file exists at the specified path to avoid runtime errors.

Verification successful

---

The recorder-worklet.js file exists at the specified path.

• src/util/recorder-worklet.js

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify if `recorder-worklet.js` file exists at the specified path.

# Test: Check for the existence of the file. Expect: The file should exist.
fd --type f 'recorder-worklet.js'

Length of output: 62

---

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are currently opted into early access features by default.

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[steverep]

PS - I was only able to do limited testing here and also just manually examine the Webpack output. It would help if someone could verify voice input works for both the modern and legacy builds.

cc @silamon

[steverep]

NM.... found my headset and fully tested now. Errors are gone and both builds load the worklet.