Still issues with broadcast-channel dependency and svelte-kit

[frederikhors]

@amen-souissi @benmccann I tried 1.4.1 now.

We still have a problem with broadcast-channel if I remove these lines from svelte.config.js:

vite: {
  optimizeDeps: {
    include: ['broadcast-channel']
  },
}

This is the log:

1:22:06 AM [vite] Error when evaluating SSR module /node_modules/broadcast-channel/dist/es/method-chooser.js:
ReferenceError: require is not defined
    at eval (/node_modules/broadcast-channel/dist/es/method-chooser.js:26:20)
    at instantiateModule (C:\kit\node_modules\vite\dist\node\chunks\dep-e9a16784.js:68197:166)

Do you have any idea?

Maybe this is related to "type": "module" in package.json which is the default in a new SvelteKit project, right?

[benmccann]

@frederikhors can you provide a small sample project to reproduce? I can try taking a look to see what the issue is then

[frederikhors]

• npm init svelte@next my-app
• cd my-app
• npm install
• npm install --save @sveltestack/svelte-query
• npm run dev

I'm using Windows 10.

[benmccann]

I have no issue on Linux. Maybe you're hitting the Vite Windows bug vitejs/vite#2393

[frederikhors]

Oh. Although the error is slightly different.

We wait for that bug to be closed so check back here, please.

[marcomonsanto]

Hi, I have the same issue. I'm using macOS.

500
require is not defined

ReferenceError: require is not defined
at /node_modules/broadcast-channel/dist/es/method-chooser.js:19:20
at instantiateModule (/Users/marcomonsanto/Documents/pessoal/crypto-wallet-svelte/node_modules/vite/dist/node/chunks/dep-e9a16784.js:68197:166)

My dep:
"@sveltestack/svelte-query": "^1.4.1",

[benmccann]

@marcomonsanto can you provide a repo and instructions to reproduce? I just tried the steps above again that @frederikhors provided and still don't see any error

[darekaze]

Hi, I don't think this is a window-only bug, cuz I also got this error using Ubuntu Linux. Even I tested a basic repo running in codesandbox, I still got the same error.

Here is a reproduce repo made in Code Sandbox, hope this help: https://codesandbox.io/s/svelte-query-bug-141-f0ksh

Updates: For workaround, make sure broadcast-channel is presented in vite.optimizeDeps.include.

vite: {
  optimizeDeps: {
    include: ['broadcast-channel']
  },
}

[benmccann]

Thanks for providing the repo. That's a bug in broadcast-channel: https://github.com/pubkey/broadcast-channel/issues/636

[dimfeld]

This isn't a real solution that can be merged into broadcast-channel, but as the relevant issue on that repo was closed, I made a fork that removes NodeJS support and the related call to require.

https://github.com/dimfeld/broadcast-channel

I'm not using the broadcast functionality in svelte-query, so can't guarantee that it still works, but the changes were minor. Hopefully it helps someone until a proper solution arrives:

You can use pnpm overrides, yarn resolutions, or a similar mechanism to force svelte-query to use it.

[derolf]

I am getting

XXX/node_modules/.pnpm/broadcast-channel@4.2.0/node_modules/broadcast-channel/dist/esnode/index.js:1
export { BroadcastChannel, clearNodeFolder, enforceOptions } from './broadcast-channel';

using adapter-static

[benmccann]

There needs to be a new release of the library. There was an improvement committed, but not released yet: #51 (comment)

[SomaticIT]

Hello,

A new version (v1.5.0) of this library has been published today.
This version makes broadcast-channel an optional dependency.
This should fix all problems with svelte-kit.

If you need to use the experimental broadcastQueryClient, you now need to install it manually (see: broadcastQueryClient).

If you still encounter issues with v1.5.0. Please open a new issue.