worker modules import/execute with `nuxt dev`

[westhom]

Not sure if this a bug or intended behavior, but it seems that worker code gets inadvertently executed during the main nuxt dev execution.

Example worker file server/workers/send-email.ts:

console.log('worker module executed') // <---- this prints out after running `nuxt dev`

export default defineWorker<SendEmailName, SendEmailData, SendEmailResult>({
  name: 'send-email',
  async processor(job) {
    // ...
  },
  options: {
    concurrency: 10
  }
})

My expectation would be, no worker code is executed in the main nuxt process to match process isolation you would see in production env. It should only execute when running via its dedicated script .output/server/workers/index.mjs or .nuxt/dev/workers/index.mjs.

Any help is much appreciated, thank you for making this Nuxt module.

[aidanhibbard]

Nope you're absolutely right in development the expectation is that you run the workers separately or not at all :)

I'll look into this ASAP, I haven't seen it personally since first developing this.

Can I ask what version you're on just for the sake of checking?

[aidanhibbard]

@westhom

I see now, you're expectation is that /workers wouldn't be scanned by Nuxt / Nitro at all.

So the workers won't start purely because they are scanned by Nitro, the workers options have a auto-start of false under the hood.

So the workers won't run by default until started by the developer or deployment.

Let me look to see if I can configure nitro to ignore the worker files entirely :)

[aidanhibbard]

@westhom

For now, until I can update the module to set the config, and run a release. Kinda busy this week.

export default defineNuxtConfig({
  ...,
  ignored: ['server/workers/**/*.*'],
})

Or you can use a .nuxtignore

If anyone feels like opening a PR, just update the module to have the following:

  async setup(_options, nuxt) {
    nuxt.options.ignore = nuxt.options.ignore ?? []
    nuxt.options.ignore.push('server/workers')
    
    ...

    nuxt.hooks.hook('nitro:config', (nitroConfig) => {
      nitroConfig.ignore = nitroConfig.ignore ?? []
      nitroConfig.ignore.push('server/workers')
      ...
    }
  }