Audio Worklet Support (11.1, Webpack 5)

[mcrthy]

What version of Next.js are you using?

11.1.2

What version of Node.js are you using?

16.9.1

What browser are you using?

Latest Chrome and Safari (14.5)

What operating system are you using?

Windows 10, and macOS Big Sur

How are you deploying your application?

next start

Describe the Bug

Our application is built on top of Next. We recently upgraded from Next 10 to Next 11, which involved a necessary upgrade from Webpack 4 to Webpack 5.

We have been unable to get audio worklets fully working after the upgrade.

We are using the following plugin for worklets:

https://github.com/popelenkow/worker-url

We can get the worklets working in dev mode, however when trying to use them in production, we are greeted with the following error:

ReferenceError: importScripts is not defined

In dev mode, the bundle for the worklet contains all of its imports, but in prod, it is split into chunks and importScripts seems to be injected, which doesn't work in the worklet scope.

For more information, please also see this previous issue that deals with Webpack importing scripts from chunks:

#24907

Expected Behavior

Load the worklet processor chunk properly without being impeded by importScripts

To Reproduce

1. Install the following package: npm i --save-dev worker-url

2. Import plugin from package, push new plugin to next.config plugin list.

const WorkerUrlPlugin = require("worker-url/plugin");

...

config.plugins.push(
      new WorkerUrlPlugin(),
    );

3. Add module to audio worklet using WorkerUrl imported from plugin.

import { WorkerUrl } from 'worker-url';

const workletUrl = new WorkerUrl(new URL('./worklet.ts', import.meta.url), {
  name: 'worklet',
});

audioContext.audioWorklet.addModule(workletUrl);

4. Build and run app in production mode.

5. Initiate audio recording using audio worklet.

[alexander-akait]

audioWorklet is not statically analyzable, why do not use webpack/webpack#11543 (comment)? It is from vendor code?

[thecynicalpaul]

audioWorklet is not statically analyzable, why do not use webpack/webpack#11543 (comment)? It is from vendor code?

@alexander-akait This is exactly what we are doing. And this issue occurs only in production build, because it tries to split everything that was imported inside the worklet processor file into chunks, and then runs importScripts on it. I imagine this is happening because the above workaround is treating it as a worker, not a worklet.

[thecynicalpaul]

audioWorklet is not statically analyzable, why do not use webpack/webpack#11543 (comment)? It is from vendor code?

@alexander-akait This is exactly what we are doing. And this issue occurs only in production build, because it tries to split everything that was imported inside the worklet processor file into chunks, and then runs importScripts on it. I imagine this is happening because the above workaround is treating it as a worker, not a worklet.

Please take a look at this issue outlining a more detailed scope here: #24907
And here's a reproduction repo: https://github.com/thecynicalpaul/test-audio-worklet-webpack5 (the behaviour and errors are the same across all Next versions that have webpack 5)

We've tried using the parser config as well as the plugin made by someone at the end of the thread. Everything compiles and runs fine, until the Worklet Processor is loaded by Audio Context. Then it crashes with the importScripts being an unrecognized directive.

[github-actions]

Please verify that your issue can be recreated with next@canary.

Why was this issue marked with the please verify canary label?

We noticed the provided reproduction was using an older version of Next.js, instead of canary.

The canary version of Next.js ships daily and includes all features and fixes that have not been released to the stable version yet. You can think of canary as a public beta. Some issues may already be fixed in the canary version, so please verify that your issue reproduces by running npm install next@canary and test it in your project, using your reproduction steps.

If the issue does not reproduce with the canary version, then it has already been fixed and this issue can be closed.

How can I quickly verify if my issue has been fixed in canary?

The safest way is to install next@canary in your project and test it, but you can also search through closed Next.js issues for duplicates or check the Next.js releases.

My issue has been open for a long time, why do I need to verify canary now?

Next.js does not backport bug fixes to older versions of Next.js. Instead, we are trying to introduce only a minimal amount of breaking changes between major releases.

What happens if I don't verify against the canary version of Next.js?

An issue with the please verify canary that receives no meaningful activity (e.g. new comments that acknowledge verification against canary) will be automatically closed and locked after 30 days.

If your issue has not been resolved in that time and it has been closed/locked, please open a new issue, with the required reproduction, using next@canary.

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps. Furthermore, you can upvote the issue using the 👍 reaction on the topmost comment (please do not comment "I have the same issue" without repro steps). Then, we can sort issues by votes to prioritize.

I think my reproduction is good enough, why aren't you looking into it quicker?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources

• How to Contribute to Open Source (Next.js)
• How to create a Minimal, Complete, and Verifiable example
• Reporting a Next.js bug
• Next.js Triaging issues

[balazsorban44]

This issue has been automatically closed because it wasn't verified against next@canary. If you think it was closed by accident, please leave a comment. If you are running into a similar issue, please open a new issue with a reproduction. Thank you.

[github-actions]

This closed issue has been automatically locked because it had no new activity for a month. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.