Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(web-worker): refactor into small peaces, add SharedWorker support
- Loading branch information
1 parent
54bf045
commit 8bb6b80
Showing
14 changed files
with
540 additions
and
262 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| import { defineWebWorker } from './pure' | ||
| import { defineWebWorkers } from './pure' | ||
|
|
||
| defineWebWorker() | ||
| defineWebWorkers() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,253 +1,19 @@ | ||
| /* eslint-disable no-restricted-imports */ | ||
| import { VitestRunner } from 'vitest/node' | ||
| import type { WorkerGlobalState } from 'vitest' | ||
| import ponyfillStructuredClone from '@ungap/structured-clone' | ||
| import { toFilePath } from 'vite-node/utils' | ||
| import createDebug from 'debug' | ||
| import { createWorkerConstructor } from './worker' | ||
| import type { DefineWorkerOptions } from './types' | ||
| import { assertGlobalExists } from './utils' | ||
| import { createSharedWorkerConstructor } from './shared-worker' | ||
|
|
||
| const debug = createDebug('vitest:web-worker') | ||
| export function defineWebWorkers(options?: DefineWorkerOptions) { | ||
| if (typeof Worker === 'undefined' || !('__VITEST_WEB_WORKER__' in globalThis.Worker)) { | ||
| assertGlobalExists('EventTarget') | ||
| assertGlobalExists('MessageEvent') | ||
|
|
||
| function getWorkerState(): WorkerGlobalState { | ||
| // @ts-expect-error untyped global | ||
| return globalThis.__vitest_worker__ | ||
| } | ||
|
|
||
| type Procedure = (...args: any[]) => void | ||
| type CloneOption = 'native' | 'ponyfill' | 'none' | ||
|
|
||
| interface DefineWorkerOptions { | ||
| clone: CloneOption | ||
| } | ||
|
|
||
| interface InlineWorkerContext { | ||
| onmessage: Procedure | null | ||
| name?: string | ||
| close: () => void | ||
| dispatchEvent: (e: Event) => void | ||
| addEventListener: (e: string, fn: Procedure) => void | ||
| removeEventListener: (e: string, fn: Procedure) => void | ||
| postMessage: (data: any, transfer?: Transferable[] | StructuredSerializeOptions) => void | ||
| self: InlineWorkerContext | ||
| global: InlineWorkerContext | ||
| importScripts?: any | ||
| } | ||
|
|
||
| class InlineWorkerRunner extends VitestRunner { | ||
| constructor(options: any, private context: InlineWorkerContext) { | ||
| super(options) | ||
| } | ||
|
|
||
| prepareContext(context: Record<string, any>) { | ||
| const ctx = super.prepareContext(context) | ||
| // not supported for now, we can't synchronously load modules | ||
| const importScripts = () => { | ||
| throw new Error('[vitest] `importScripts` is not supported in Vite workers. Please, consider using `import` instead.') | ||
| } | ||
| return Object.assign(ctx, this.context, { | ||
| importScripts, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| function assertGlobalExists(name: string) { | ||
| if (!(name in globalThis)) | ||
| throw new Error(`[@vitest/web-worker] Cannot initiate a custom Web Worker. "${name}" is not supported in this environment. Please, consider using jsdom or happy-dom environment.`) | ||
| } | ||
|
|
||
| function createClonedMessageEvent(data: any, transferOrOptions: StructuredSerializeOptions | Transferable[] | undefined, clone: CloneOption) { | ||
| const transfer = Array.isArray(transferOrOptions) ? transferOrOptions : transferOrOptions?.transfer | ||
|
|
||
| debug('clone worker message %o', data) | ||
| const origin = typeof location === 'undefined' ? undefined : location.origin | ||
|
|
||
| if (typeof structuredClone === 'function' && clone === 'native') { | ||
| debug('create message event, using native structured clone') | ||
| return new MessageEvent('message', { | ||
| data: structuredClone(data, { transfer }), | ||
| origin, | ||
| }) | ||
| } | ||
| if (clone !== 'none') { | ||
| debug('create message event, using polifylled structured clone') | ||
| transfer?.length && console.warn( | ||
| '[@vitest/web-worker] `structuredClone` is not supported in this environment. ' | ||
| + 'Falling back to polyfill, your transferable options will be lost. ' | ||
| + 'Set `VITEST_WEB_WORKER_CLONE` environmental variable to "none", if you don\'t want to loose it,' | ||
| + 'or update to Node 17+.', | ||
| ) | ||
| return new MessageEvent('message', { | ||
| data: ponyfillStructuredClone(data, { lossy: true }), | ||
| origin, | ||
| }) | ||
| } | ||
| debug('create message event without cloning an object') | ||
| return new MessageEvent('message', { | ||
| data, | ||
| origin, | ||
| }) | ||
| } | ||
|
|
||
| function createMessageEvent(data: any, transferOrOptions: StructuredSerializeOptions | Transferable[] | undefined, clone: CloneOption) { | ||
| try { | ||
| return createClonedMessageEvent(data, transferOrOptions, clone) | ||
| } | ||
| catch (error) { | ||
| debug('failed to clone message, dispatch "messageerror" event: %o', error) | ||
| return new MessageEvent('messageerror', { | ||
| data: error, | ||
| }) | ||
| globalThis.Worker = createWorkerConstructor(options) | ||
| } | ||
| } | ||
|
|
||
| export function defineWebWorker(options?: DefineWorkerOptions) { | ||
| if (typeof Worker !== 'undefined' && '__VITEST_WEB_WORKER__' in globalThis.Worker) | ||
| return | ||
|
|
||
| assertGlobalExists('EventTarget') | ||
| assertGlobalExists('MessageEvent') | ||
|
|
||
| const { config, rpc, mockMap, moduleCache } = getWorkerState() | ||
|
|
||
| const runnerOptions = { | ||
| fetchModule(id: string) { | ||
| return rpc.fetch(id) | ||
| }, | ||
| resolveId(id: string, importer?: string) { | ||
| return rpc.resolveId(id, importer) | ||
| }, | ||
| moduleCache, | ||
| mockMap, | ||
| interopDefault: config.deps.interopDefault ?? true, | ||
| root: config.root, | ||
| base: config.base, | ||
| } | ||
|
|
||
| const cloneType = () => (options?.clone ?? process.env.VITEST_WEB_WORKER_CLONE ?? 'native') as CloneOption | ||
|
|
||
| globalThis.Worker = class Worker extends EventTarget { | ||
| static __VITEST_WEB_WORKER__ = true | ||
|
|
||
| private _vw_workerTarget = new EventTarget() | ||
| private _vw_insideListeners = new Map<string, EventListenerOrEventListenerObject>() | ||
| private _vw_outsideListeners = new Map<string, EventListenerOrEventListenerObject>() | ||
| private _vw_name: string | ||
| private _vw_messageQueue: any[] | null = [] | ||
|
|
||
| public onmessage: null | Procedure = null | ||
| public onmessageerror: null | Procedure = null | ||
| public onerror: null | Procedure = null | ||
|
|
||
| constructor(url: URL | string, options?: WorkerOptions) { | ||
| super() | ||
|
|
||
| // should be equal to DedicatedWorkerGlobalScope | ||
| const context: InlineWorkerContext = { | ||
| onmessage: null, | ||
| name: options?.name, | ||
| close: () => this.terminate(), | ||
| dispatchEvent: (event: Event) => { | ||
| return this._vw_workerTarget.dispatchEvent(event) | ||
| }, | ||
| addEventListener: (...args) => { | ||
| if (args[1]) | ||
| this._vw_insideListeners.set(args[0], args[1]) | ||
| return this._vw_workerTarget.addEventListener(...args) | ||
| }, | ||
| removeEventListener: this._vw_workerTarget.removeEventListener, | ||
| postMessage: (...args) => { | ||
| if (!args.length) | ||
| throw new SyntaxError('"postMessage" requires at least one argument.') | ||
|
|
||
| debug('posting message %o from the worker %s to the main thread', args[0], this._vw_name) | ||
| const event = createMessageEvent(args[0], args[1], cloneType()) | ||
| this.dispatchEvent(event) | ||
| }, | ||
| get self() { | ||
| return context | ||
| }, | ||
| get global() { | ||
| return context | ||
| }, | ||
| } | ||
|
|
||
| this._vw_workerTarget.addEventListener('message', (e) => { | ||
| context.onmessage?.(e) | ||
| }) | ||
|
|
||
| this.addEventListener('message', (e) => { | ||
| this.onmessage?.(e) | ||
| }) | ||
|
|
||
| this.addEventListener('messageerror', (e) => { | ||
| this.onmessageerror?.(e) | ||
| }) | ||
|
|
||
| const runner = new InlineWorkerRunner(runnerOptions, context) | ||
|
|
||
| const id = (url instanceof URL ? url.toString() : url).replace(/^file:\/+/, '/') | ||
|
|
||
| const fsPath = toFilePath(id, config.root) | ||
|
|
||
| this._vw_name = options?.name ?? fsPath | ||
|
|
||
| debug('initialize worker %s', this._vw_name) | ||
|
|
||
| runner.executeFile(fsPath) | ||
| .then(() => { | ||
| // worker should be new every time, invalidate its sub dependency | ||
| moduleCache.invalidateSubDepTree([fsPath, `mock:${fsPath}`]) | ||
| const q = this._vw_messageQueue | ||
| this._vw_messageQueue = null | ||
| if (q) | ||
| q.forEach(([data, transfer]) => this.postMessage(data, transfer), this) | ||
| debug('worker %s successfully initialized', this._vw_name) | ||
| }).catch((e) => { | ||
| debug('worker %s failed to initialize: %o', this._vw_name, e) | ||
| const EventConstructor = globalThis.ErrorEvent || globalThis.Event | ||
| const error = new EventConstructor('error', { | ||
| error: e, | ||
| message: e.message, | ||
| }) | ||
| this.dispatchEvent(error) | ||
| this.onerror?.(e) | ||
| console.error(e) | ||
| }) | ||
| } | ||
|
|
||
| addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: boolean | AddEventListenerOptions): void { | ||
| if (callback) | ||
| this._vw_outsideListeners.set(type, callback) | ||
| return super.addEventListener(type, callback, options) | ||
| } | ||
|
|
||
| postMessage(...args: [any, StructuredSerializeOptions | Transferable[] | undefined]): void { | ||
| if (!args.length) | ||
| throw new SyntaxError('"postMessage" requires at least one argument.') | ||
|
|
||
| const [data, transferOrOptions] = args | ||
| if (this._vw_messageQueue != null) { | ||
| debug('worker %s is not yet initialized, queue message %s', this._vw_name, data) | ||
| this._vw_messageQueue.push([data, transferOrOptions]) | ||
| return | ||
| } | ||
|
|
||
| debug('posting message %o from the main thread to the worker %s', data, this._vw_name) | ||
|
|
||
| const event = createMessageEvent(data, transferOrOptions, cloneType()) | ||
| if (event.type === 'messageerror') | ||
| this.dispatchEvent(event) | ||
| else | ||
| this._vw_workerTarget.dispatchEvent(event) | ||
| } | ||
| if (typeof SharedWorker === 'undefined' || !('__VITEST_WEB_WORKER__' in globalThis.SharedWorker)) { | ||
| assertGlobalExists('EventTarget') | ||
|
|
||
| terminate() { | ||
| debug('terminating worker %s', this._vw_name) | ||
| this._vw_outsideListeners.forEach((fn, type) => { | ||
| this.removeEventListener(type, fn) | ||
| }) | ||
| this._vw_insideListeners.forEach((fn, type) => { | ||
| this._vw_workerTarget.removeEventListener(type, fn) | ||
| }) | ||
| } | ||
| globalThis.SharedWorker = createSharedWorkerConstructor() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { VitestRunner } from 'vitest/node' | ||
|
|
||
| export class InlineWorkerRunner extends VitestRunner { | ||
| constructor(options: any, private context: any) { | ||
| super(options) | ||
| } | ||
|
|
||
| prepareContext(context: Record<string, any>) { | ||
| const ctx = super.prepareContext(context) | ||
| // not supported for now, we can't synchronously load modules | ||
| const importScripts = () => { | ||
| throw new Error('[vitest] `importScripts` is not supported in Vite workers. Please, consider using `import` instead.') | ||
| } | ||
| return Object.assign(ctx, this.context, { | ||
| importScripts, | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.