lib/dependencies/WorkerDependency.js - main - githubmirror/webpack

lib/dependencies/WorkerDependency.js
244 строки9 KB
Alexander Akait
feat(esm): bake templated public paths and hashed wasm names into analyzable output (#21669)
9 часов назад
9 часов назадbc65f6b
/*
	MIT License http://www.opensource.org/licenses/mit-license.php
	Author Ivan Kopeykin @vankop
*/

"use strict";

const Dependency = require("../Dependency");
const RuntimeGlobals = require("../RuntimeGlobals");
const makeSerializable = require("../util/makeSerializable");
const ModuleDependency = require("./ModuleDependency");

/** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
/** @typedef {import("../AsyncDependenciesBlock")} AsyncDependenciesBlock */
/** @typedef {import("../Chunk")} Chunk */
/** @typedef {import("../Dependency").ReferencedExports} ReferencedExports */
/** @typedef {import("../Dependency").UpdateHashContext} UpdateHashContext */
/** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
/** @typedef {import("../Entrypoint")} Entrypoint */
/** @typedef {import("../ModuleGraph")} ModuleGraph */
/** @typedef {import("../javascript/JavascriptParser").Range} Range */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext<[WorkerDependencyOptions]>} ObjectDeserializerContext */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[WorkerDependencyOptions]>} ObjectSerializerContext */
/** @typedef {import("../util/Hash")} Hash */
/** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */

/**
 * @typedef {object} ResourceHint
 * @property {true=} prefetch emit `<link rel="prefetch">`
 * @property {true=} preload emit `<link rel="preload">` (wins over prefetch when both are set)
 * @property {("high" | "low" | "auto")=} fetchPriority value for the `fetchpriority` attribute
 * @property {string=} as override for the `as` attribute (defaults to `"script"`)
 * @property {string=} type value for the `type` attribute
 * @property {string=} media value for the `media` attribute
 */

/**
 * Represents the worker dependency runtime component.
 * @typedef {object} WorkerDependencyOptions
 * @property {string=} publicPath public path for the worker
 * @property {boolean=} needNewUrl true when need generate `new URL(...)`, otherwise false
 * @property {Range=} workerConstructorRange range of the global `Worker` constructor, set only for the `new Worker()` global syntax that needs a node-target rewrite
 * @property {ResourceHint=} resourceHint resource hint to inject for the worker chunk
 */

class WorkerDependency extends ModuleDependency {
	/**
	 * Creates an instance of WorkerDependency.
	 * @param {string} request request
	 * @param {Range} range range
	 * @param {WorkerDependencyOptions} workerDependencyOptions options
	 */
	constructor(request, range, workerDependencyOptions) {
		super(request);
		this.range = range;
		// If options are updated, don't forget to update the hash and serialization functions
		/** @type {WorkerDependencyOptions} */
		this.options = workerDependencyOptions;
		/** Cache the hash */
		/** @type {undefined | string} */
		this._hashUpdate = undefined;
	}

	/**
	 * Returns list of exports referenced by this dependency
	 * @param {ModuleGraph} moduleGraph module graph
	 * @param {RuntimeSpec} runtime the runtime for which the module is analysed
	 * @returns {ReferencedExports} referenced exports
	 */
	getReferencedExports(moduleGraph, runtime) {
		return Dependency.NO_EXPORTS_REFERENCED;
	}

	get type() {
		return "new Worker()";
	}

	get category() {
		return "worker";
	}

	/**
	 * Updates the hash with the data contributed by this instance.
	 * @param {Hash} hash hash to be updated
	 * @param {UpdateHashContext} context context
	 * @returns {void}
	 */
	updateHash(hash, context) {
		if (this._hashUpdate === undefined) {
			this._hashUpdate = JSON.stringify(this.options);
		}
		hash.update(this._hashUpdate);
	}

	/**
	 * Serializes this instance into the provided serializer context.
	 * @param {ObjectSerializerContext} context context
	 */
	serialize(context) {
		context.write(this.options);
		super.serialize(context);
	}

	/**
	 * Restores this instance from the provided deserializer context.
	 * @param {ObjectDeserializerContext} context context
	 */
	deserialize(context) {
		this.options = context.read();
		super.deserialize(context.rest);
	}
}

WorkerDependency.Template = class WorkerDependencyTemplate extends (
	ModuleDependency.Template
) {
	/**
	 * Applies the plugin by registering its hooks on the compiler.
	 * @param {Dependency} dependency the dependency for which the template should be applied
	 * @param {ReplaceSource} source the current replace source which can be modified
	 * @param {DependencyTemplateContext} templateContext the context object
	 * @returns {void}
	 */
	apply(dependency, source, templateContext) {
		const { chunkGraph, moduleGraph, runtimeRequirements, runtimeTemplate } =
			templateContext;
		const dep = /** @type {WorkerDependency} */ (dependency);
		const block = /** @type {AsyncDependenciesBlock} */ (
			moduleGraph.getParentBlock(dependency)
		);
		const entrypoint = /** @type {Entrypoint} */ (
			chunkGraph.getBlockChunkGroup(block)
		);
		const chunk = entrypoint.getEntrypointChunk();

		// For ESM module output emit the analyzable `new URL("./worker.<name>.js",
		// import.meta.url)` form (literal specifier, no runtime helpers) so other bundlers
		// and webpack itself can statically follow the worker. A resource hint doesn't
		// block it: the `<link>` is emitted at chunk startup instead of wrapping the href,
		// which would turn the specifier into a non-analyzable expression.
		const analyzableSpecifier = runtimeTemplate.supportsAnalyzableEsm(
			chunkGraph,
			templateContext.module
		)
			? runtimeTemplate._getAnalyzableChunkSpecifier(
					dep.options.publicPath,
					chunk,
					templateContext.module,
					chunkGraph,
					runtimeRequirements
				)
			: null;

		if (analyzableSpecifier !== null) {
			const startupHint = dep.options.resourceHint;
			if (startupHint && (startupHint.preload || startupHint.prefetch)) {
				// Declared here, not in the runtime module: requirements added during
				// `generate()` are too late for the corresponding modules to be created.
				runtimeRequirements.add(RuntimeGlobals.startupAssetHints);
				runtimeRequirements.add(
					startupHint.preload
						? RuntimeGlobals.preloadAsset
						: RuntimeGlobals.prefetchAsset
				);
				runtimeRequirements.add(RuntimeGlobals.getChunkScriptFilename);
				if (!dep.options.publicPath) {
					runtimeRequirements.add(RuntimeGlobals.publicPath);
				}
			}
			const urlArgs = `/* worker import */ ${analyzableSpecifier}, ${runtimeTemplate.outputOptions.importMetaName}.url`;
			source.replace(
				dep.range[0],
				dep.range[1] - 1,
				dep.options.needNewUrl ? `new URL(${urlArgs})` : urlArgs
			);
		} else {
			// We use the workerPublicPath option if provided, else we fallback to the RuntimeGlobal publicPath
			const workerImportBaseUrl = dep.options.publicPath
				? `"${dep.options.publicPath}"`
				: RuntimeGlobals.publicPath;

			runtimeRequirements.add(RuntimeGlobals.publicPath);
			runtimeRequirements.add(RuntimeGlobals.baseURI);
			runtimeRequirements.add(RuntimeGlobals.getChunkScriptFilename);

			const hrefExpr = `${workerImportBaseUrl} + ${
				RuntimeGlobals.getChunkScriptFilename
			}(${JSON.stringify(chunk.id)})`;

			const hint = dep.options.resourceHint;
			const rel =
				hint && hint.preload
					? "preload"
					: hint && hint.prefetch
						? "prefetch"
						: null;
			let wrappedHref;
			if (rel && hint) {
				const fn =
					rel === "preload"
						? RuntimeGlobals.preloadAsset
						: RuntimeGlobals.prefetchAsset;
				runtimeRequirements.add(fn);
				const as = hint.as || "script";
				const args = [
					hrefExpr,
					JSON.stringify(as),
					hint.type ? JSON.stringify(hint.type) : "undefined",
					hint.media ? JSON.stringify(hint.media) : "undefined",
					hint.fetchPriority ? JSON.stringify(hint.fetchPriority) : "undefined"
				];
				wrappedHref = `${fn}(${args.join(", ")})`;
			} else {
				wrappedHref = hrefExpr;
			}

			const workerImportStr = `/* worker import */ ${wrappedHref}, ${RuntimeGlobals.baseURI}`;

			source.replace(
				dep.range[0],
				dep.range[1] - 1,
				dep.options.needNewUrl ? `new URL(${workerImportStr})` : workerImportStr
			);
		}

		// `Worker` is global only on the web, so route node (universal or node-only) through `worker_threads`
		const { platform } = runtimeTemplate.compilation.compiler;
		const ctorRange = dep.options.workerConstructorRange;
		if (
			ctorRange &&
			(runtimeTemplate.isUniversalTarget() || (platform.node && !platform.web))
		) {
			// `__webpack_require__.wc` attaches to `__webpack_require__`; the analyzable
			// branch adds no other requirement that would emit it, so require it here.
			runtimeRequirements.add(RuntimeGlobals.require);
			runtimeRequirements.add(RuntimeGlobals.worker);
			source.replace(ctorRange[0], ctorRange[1] - 1, RuntimeGlobals.worker);
		}
	}
};

makeSerializable(WorkerDependency, "webpack/lib/dependencies/WorkerDependency");

module.exports = WorkerDependency;