Allow plugins to add and change assertions

rollup · Oct 9, 2022 · 1fbe2a6 · 1fbe2a6
1 parent cc8d5f3
commit 1fbe2a6
Show file tree

Hide file tree

Showing 15 changed files with 86 additions and 18 deletions.
diff --git a/browser/src/resolveId.ts b/browser/src/resolveId.ts
@@ -12,7 +12,8 @@ export async function resolveId(
 	moduleLoaderResolveId: ModuleLoaderResolveId,
 	skip: readonly { importer: string | undefined; plugin: Plugin; source: string }[] | null,
 	customOptions: CustomPluginOptions | undefined,
-	isEntry: boolean
+	isEntry: boolean,
+	assertions: Record<string, string>
 ): Promise<ResolveIdResult> {
 	const pluginResult = await resolveIdViaPlugins(
 		source,
@@ -21,7 +22,8 @@ export async function resolveId(
 		moduleLoaderResolveId,
 		skip,
 		customOptions,
-		isEntry
+		isEntry,
+		assertions
 	);
 	if (pluginResult == null) {
 		throwNoFileSystem('path.resolve');

diff --git a/src/ModuleLoader.ts b/src/ModuleLoader.ts
@@ -213,7 +213,8 @@ export class ModuleLoader {
 							this.resolveId,
 							skip,
 							customOptions,
-							typeof isEntry === 'boolean' ? isEntry : !importer
+							typeof isEntry === 'boolean' ? isEntry : !importer,
+							assertions
 					  ),
 				importer,
 				source
@@ -562,9 +563,8 @@ export class ModuleLoader {
 			return null;
 		}
 		const external = resolvedId.external || false;
-		// TODO Lukas also consider assertions from resolvedId
 		return {
-			assertions,
+			assertions: resolvedId.assertions || assertions,
 			external,
 			id: resolvedId.id,
 			meta: resolvedId.meta || {},
@@ -631,7 +631,8 @@ export class ModuleLoader {
 			this.resolveId,
 			null,
 			EMPTY_OBJECT,
-			true
+			true,
+			EMPTY_OBJECT
 		);
 		if (resolveIdResult == null) {
 			return error(
@@ -651,7 +652,6 @@ export class ModuleLoader {
 			);
 		}
 		return this.fetchModule(
-			// TODO Lukas use correct assertions from input
 			this.getResolvedIdWithDefaults(
 				typeof resolveIdResult === 'object'
 					? (resolveIdResult as NormalizedResolveIdWithoutDefaults)
@@ -672,7 +672,8 @@ export class ModuleLoader {
 	): Promise<ResolvedId | string | null> {
 		const resolution = await this.pluginDriver.hookFirst('resolveDynamicImport', [
 			specifier,
-			importer
+			importer,
+			{ assertions }
 		]);
 		if (typeof specifier !== 'string') {
 			if (typeof resolution === 'string') {

diff --git a/src/rollup/types.d.ts b/src/rollup/types.d.ts
@@ -221,7 +221,7 @@ export type ResolveIdHook = (
 	this: PluginContext,
 	source: string,
 	importer: string | undefined,
-	options: { custom?: CustomPluginOptions; isEntry: boolean }
+	options: { assertions: Record<string, string>; custom?: CustomPluginOptions; isEntry: boolean }
 ) => ResolveIdResult;
 
 export type ShouldTransformCachedModuleHook = (
@@ -276,7 +276,8 @@ export type RenderChunkHook = (
 export type ResolveDynamicImportHook = (
 	this: PluginContext,
 	specifier: string | AcornNode,
-	importer: string
+	importer: string,
+	options: { assertions: Record<string, string> }
 ) => ResolveIdResult;
 
 export type ResolveImportMetaHook = (

diff --git a/src/utils/resolveId.ts b/src/utils/resolveId.ts
@@ -13,7 +13,8 @@ export async function resolveId(
 	moduleLoaderResolveId: ModuleLoaderResolveId,
 	skip: readonly { importer: string | undefined; plugin: Plugin; source: string }[] | null,
 	customOptions: CustomPluginOptions | undefined,
-	isEntry: boolean
+	isEntry: boolean,
+	assertions: Record<string, string>
 ): Promise<ResolveIdResult> {
 	const pluginResult = await resolveIdViaPlugins(
 		source,
@@ -22,7 +23,8 @@ export async function resolveId(
 		moduleLoaderResolveId,
 		skip,
 		customOptions,
-		isEntry
+		isEntry,
+		assertions
 	);
 	if (pluginResult != null) return pluginResult;
 

diff --git a/src/utils/resolveIdViaPlugins.ts b/src/utils/resolveIdViaPlugins.ts
@@ -10,7 +10,8 @@ export function resolveIdViaPlugins(
 	moduleLoaderResolveId: ModuleLoaderResolveId,
 	skip: readonly { importer: string | undefined; plugin: Plugin; source: string }[] | null,
 	customOptions: CustomPluginOptions | undefined,
-	isEntry: boolean
+	isEntry: boolean,
+	assertions: Record<string, string>
 ): Promise<ResolveIdResult> {
 	let skipped: Set<Plugin> | null = null;
 	let replaceContext: ReplaceContext | null = null;
@@ -38,7 +39,7 @@ export function resolveIdViaPlugins(
 	}
 	return pluginDriver.hookFirst(
 		'resolveId',
-		[source, importer, { custom: customOptions, isEntry }],
+		[source, importer, { assertions, custom: customOptions, isEntry }],
 		replaceContext,
 		skipped
 	);

diff --git a/test/form/samples/import-assertions/keep-dynamic-assertions/_config.js b/test/form/samples/import-assertions/keep-dynamic-assertions/_config.js
@@ -1,5 +1,4 @@
 module.exports = {
-	// solo: true,
 	description: 'keep import assertions for dynamic imports',
 	expectedWarnings: 'UNRESOLVED_IMPORT',
 	options: {

diff --git a/test/form/samples/import-assertions/keeps-static-assertions/_config.js b/test/form/samples/import-assertions/keeps-static-assertions/_config.js
@@ -1,5 +1,4 @@
 module.exports = {
-	// solo: true,
 	description: 'keeps any import assertions on input',
 	expectedWarnings: 'UNRESOLVED_IMPORT',
 	options: {

diff --git a/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/_config.js b/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/_config.js
@@ -0,0 +1,22 @@
+module.exports = {
+	description: 'allows plugins to read and write import assertions in resolveDynamicImport',
+	options: {
+		plugins: [
+			{
+				resolveDynamicImport(specifier, importer, { assertions }) {
+					const resolutionOptions = {
+						external: true,
+						assertions: Object.fromEntries(Object.keys(assertions).map(key => [key, 'changed']))
+					};
+					if (typeof specifier === 'object') {
+						if (specifier.type === 'TemplateLiteral') {
+							return { id: 'resolved-a', ...resolutionOptions };
+						}
+						return { id: 'resolved-b', ...resolutionOptions };
+					}
+					return { id: specifier, ...resolutionOptions };
+				}
+			}
+		]
+	}
+};
diff --git a/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/_expected.js b/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/_expected.js
@@ -0,0 +1,4 @@
+import('a', { assert: { type: 'changed' } });
+import('resolved-b', { assert: { type: 'changed', extra: 'changed' } });
+import('b');
+import('resolved-a');
diff --git a/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/main.js b/test/form/samples/import-assertions/plugin-assertions-resolvedynamicimport/main.js
@@ -0,0 +1,4 @@
+import('a', { assert: { type: 'special' } });
+import(globalThis.unknown, { assert: { type: 'special', extra: 'value' } });
+import('b');
+import(`external-${globalThis.unknown}`);
diff --git a/test/form/samples/import-assertions/plugin-assertions-resolveid/_config.js b/test/form/samples/import-assertions/plugin-assertions-resolveid/_config.js
@@ -0,0 +1,17 @@
+module.exports = {
+	description: 'allows plugins to read and write import assertions in resolveId',
+	options: {
+		output: { name: 'bundle' },
+		plugins: [
+			{
+				resolveId(source, importer, { assertions, isEntry }) {
+					return {
+						id: source,
+						external: !isEntry,
+						assertions: Object.fromEntries(Object.keys(assertions).map(key => [key, 'changed']))
+					};
+				}
+			}
+		]
+	}
+};
diff --git a/test/form/samples/import-assertions/plugin-assertions-resolveid/_expected.js b/test/form/samples/import-assertions/plugin-assertions-resolveid/_expected.js
@@ -0,0 +1,9 @@
+import { a } from 'a' assert { type: 'changed', extra: 'changed' };
+import * as b from 'b' assert { type: 'changed' };
+export { c } from 'c' assert { type: 'changed' };
+export * from 'd' assert { type: 'changed' };
+import 'e';
+
+console.log(a, b, d);
+import('f', { assert: { type: 'changed' } });
+import('g');
diff --git a/test/form/samples/import-assertions/plugin-assertions-resolveid/main.js b/test/form/samples/import-assertions/plugin-assertions-resolveid/main.js
@@ -0,0 +1,9 @@
+import { a } from 'a' assert { type: 'a', extra: 'extra' };
+import * as b from 'b' assert { type: 'b' };
+export { c } from 'c' assert { type: 'c' };
+export * from 'd' assert { type: 'd' };
+import 'e';
+
+console.log(a, b, d);
+import('f', { assert: { type: 'f' } });
+import('g');
diff --git a/test/form/samples/import-assertions/removes-dynamic-assertions/_config.js b/test/form/samples/import-assertions/removes-dynamic-assertions/_config.js
@@ -1,5 +1,4 @@
 module.exports = {
-	// solo: true,
 	description: 'keep import assertions for dynamic imports',
 	expectedWarnings: 'UNRESOLVED_IMPORT',
 	options: {

diff --git a/test/form/samples/import-assertions/removes-static-assertions/_config.js b/test/form/samples/import-assertions/removes-static-assertions/_config.js
@@ -1,5 +1,4 @@
 module.exports = {
-	// solo: true,
 	description: 'keeps any import assertions on input',
 	expectedWarnings: 'UNRESOLVED_IMPORT',
 	options: {