Skip to content

Commit 0d04351

Browse files
authored
feat(bundled-dev): support worker file update accepted by HMR (#23068)
1 parent 51207ba commit 0d04351

10 files changed

Lines changed: 149 additions & 2 deletions

File tree

‎packages/vite/src/node/plugins/worker.ts‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import path from 'node:path'
22
import MagicString from 'magic-string'
3-
import type { RolldownOutput, RollupError } from 'rolldown'
3+
import type { PluginContext, RolldownOutput, RollupError } from 'rolldown'
44
import colors from 'picocolors'
55
import { type ImportSpecifier, init, parse } from 'es-module-lexer'
66
import { viteWebWorkerPostPlugin as nativeWebWorkerPostPlugin } from 'rolldown/experimental'
@@ -325,6 +325,29 @@ export async function workerFileToUrl(
325325
return bundle
326326
}
327327

328+
/**
329+
* Emit the bundled worker files during `load` / `transform`.
330+
*
331+
* They normally reach the output through `generateBundle`, which an HMR patch
332+
* skips, so without this a patched worker points at a file that was never
333+
* emitted.
334+
*/
335+
export function emitWorkerAssetsForBundledDev(
336+
pluginContext: { emitFile: PluginContext['emitFile'] },
337+
config: ResolvedConfig,
338+
): void {
339+
if (config.isWorker) return
340+
341+
const workerOutput = workerOutputCaches.get(config.mainConfig || config)!
342+
for (const asset of workerOutput.getAssets()) {
343+
pluginContext.emitFile({
344+
type: 'asset',
345+
fileName: asset.fileName,
346+
source: asset.source,
347+
})
348+
}
349+
}
350+
328351
export function webWorkerPostPlugin(_config: ResolvedConfig): Plugin {
329352
return {
330353
name: 'vite:worker-post',
@@ -485,6 +508,7 @@ export function webWorkerPlugin(config: ResolvedConfig): Plugin {
485508
this.environment.config.command === 'serve' &&
486509
this.environment.config.isBundled
487510
) {
511+
emitWorkerAssetsForBundledDev(this, config)
488512
url = toOutputFilePathInJSForBundledDev(
489513
this.environment,
490514
result.entryFilename,

‎packages/vite/src/node/plugins/workerImportMetaUrl.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ import { createBackCompatIdResolver } from '../idResolver'
1111
import type { ResolveIdFn } from '../idResolver'
1212
import { cleanUrl, slash } from '../../shared/utils'
1313
import type { WorkerType } from './worker'
14-
import { WORKER_FILE_ID, workerFileToUrl } from './worker'
14+
import {
15+
WORKER_FILE_ID,
16+
emitWorkerAssetsForBundledDev,
17+
workerFileToUrl,
18+
} from './worker'
1519
import { fileToUrl, toOutputFilePathInJSForBundledDev } from './asset'
1620
import type { InternalResolveOptions } from './resolve'
1721
import { tryFsResolve } from './resolve'
@@ -257,6 +261,7 @@ export function workerImportMetaUrlPlugin(config: ResolvedConfig): Plugin {
257261
if (isBundled) {
258262
const result = await workerFileToUrl(config, file)
259263
if (this.environment.config.command === 'serve') {
264+
emitWorkerAssetsForBundledDev(this, config)
260265
builtUrl = toOutputFilePathInJSForBundledDev(
261266
this.environment,
262267
result.entryFilename,

‎playground/hmr-full-bundle-mode/__tests__/hmr-full-bundle-mode.spec.ts‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,71 @@ if (isBuild) {
231231
await expect.poll(() => page.textContent('.worker-url')).toBe('worker-url')
232232
})
233233

234+
// The importer self-accepts, so this update arrives as an HMR patch. A patch
235+
// skips the generate phase, so without the worker files being emitted earlier
236+
// it ships a URL for a file that was never written.
237+
test('worker updated through an HMR patch is served', async () => {
238+
const original = readFile('worker-accept-src.js')
239+
onTestFinished(async () => {
240+
addFile('worker-accept-src.js', original)
241+
await expect
242+
.poll(() => page.textContent('.worker-accept'))
243+
.toBe('worker-accept')
244+
})
245+
246+
await expect
247+
.poll(() => page.textContent('.worker-accept'))
248+
.toBe('worker-accept')
249+
250+
// survives an HMR patch, but not a page reload
251+
await page.evaluate(() => {
252+
;(window as any).__workerAcceptKeptAlive = true
253+
})
254+
255+
editFile('worker-accept-src.js', (code) =>
256+
code.replace("'worker-accept'", "'worker-accept-updated'"),
257+
)
258+
await expect
259+
.poll(() => page.textContent('.worker-accept'))
260+
.toBe('worker-accept-updated')
261+
262+
expect(
263+
await page.evaluate(() => (window as any).__workerAcceptKeptAlive),
264+
).toBe(true)
265+
})
266+
267+
// The inner worker is bundled on its own, so a patch that emits only the
268+
// worker it just resolved leaves one of the two files unserved.
269+
test('nested worker updated through an HMR patch is served', async () => {
270+
const original = readFile('worker-nested-inner.js')
271+
onTestFinished(async () => {
272+
addFile('worker-nested-inner.js', original)
273+
await expect
274+
.poll(() => page.textContent('.worker-nested'))
275+
.toBe('nested-outer+nested-inner')
276+
})
277+
278+
await expect
279+
.poll(() => page.textContent('.worker-nested'))
280+
.toBe('nested-outer+nested-inner')
281+
282+
// survives an HMR patch, but not a page reload
283+
await page.evaluate(() => {
284+
;(window as any).__workerNestedKeptAlive = true
285+
})
286+
287+
editFile('worker-nested-inner.js', (code) =>
288+
code.replace("'nested-inner'", "'nested-inner-updated'"),
289+
)
290+
await expect
291+
.poll(() => page.textContent('.worker-nested'))
292+
.toBe('nested-outer+nested-inner-updated')
293+
294+
expect(
295+
await page.evaluate(() => (window as any).__workerNestedKeptAlive),
296+
).toBe(true)
297+
})
298+
234299
test('lazy bundling', async () => {
235300
await page.click('#load-dynamic')
236301
await expect.poll(() => page.textContent('.dynamic')).toBe('loaded')

‎playground/hmr-full-bundle-mode/index.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ <h1>HMR Full Bundle Mode</h1>
88
<div class="worker-url"></div>
99
<div class="invalidation-parent"></div>
1010
<div class="worker-plain"></div>
11+
<div class="worker-accept"></div>
12+
<div class="worker-nested"></div>
1113
<div class="dead-accept"></div>
1214
<div class="cycle"></div>
1315
<div class="data-count"></div>

‎playground/hmr-full-bundle-mode/main.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ import './hmr-asset.js'
33
import './invalidation-parent.js'
44
import './dead-accept.js'
55
import './cycle-a.js'
6+
import './worker-accept.js'
7+
import './worker-nested.js'
68
import './data.js'
79
import assetUrl from './asset.png'
810
import WorkerQuery from './worker-query.js?worker'
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
const msg = 'worker-accept'
2+
3+
self.onmessage = (e) => {
4+
if (e.data === 'ping') {
5+
self.postMessage(msg)
6+
}
7+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import WorkerAccept from './worker-accept-src.js?worker'
2+
3+
const worker = new WorkerAccept()
4+
worker.postMessage('ping')
5+
worker.addEventListener('message', (e) => {
6+
document.querySelector('.worker-accept').textContent = e.data
7+
})
8+
9+
import.meta.hot?.accept()
10+
import.meta.hot?.dispose(() => worker.terminate())
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
self.onmessage = () => {
2+
self.postMessage('nested-inner')
3+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
const inner = new Worker(new URL('./worker-nested-inner.js', import.meta.url), {
2+
type: 'module',
3+
})
4+
5+
self.onmessage = () => {
6+
inner.postMessage('ping')
7+
}
8+
inner.onmessage = (e) => {
9+
self.postMessage(`nested-outer+${e.data}`)
10+
}
11+
inner.onerror = () => {
12+
self.postMessage('nested-inner-error')
13+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
const worker = new Worker(
2+
new URL('./worker-nested-outer.js', import.meta.url),
3+
{
4+
type: 'module',
5+
},
6+
)
7+
worker.postMessage('ping')
8+
worker.addEventListener('message', (e) => {
9+
document.querySelector('.worker-nested').textContent = e.data
10+
})
11+
worker.addEventListener('error', () => {
12+
document.querySelector('.worker-nested').textContent = 'nested-outer-error'
13+
})
14+
15+
import.meta.hot?.accept()
16+
import.meta.hot?.dispose(() => worker.terminate())

0 commit comments

Comments
 (0)