feat(cjs): support query for cache busting (#37)

privatenumber · Jun 5, 2024 · e1464cf · e1464cf
1 parent 585f117
commit e1464cf
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 15 deletions.
diff --git a/src/cjs/api/module-extensions.ts b/src/cjs/api/module-extensions.ts
@@ -34,23 +34,26 @@ const transformer = (
 	module: Module,
 	filePath: string,
 ) => {
+	// Make sure __filename doesnt contain query
+	const cleanFilePath = filePath.split('?')[0];
+
 	// For tracking dependencies in watch mode
 	if (parent?.send) {
 		parent.send({
 			type: 'dependency',
-			path: filePath,
+			path: cleanFilePath,
 		});
 	}
 
-	const transformTs = typescriptExtensions.some(extension => filePath.endsWith(extension));
-	const transformJs = transformExtensions.some(extension => filePath.endsWith(extension));
+	const transformTs = typescriptExtensions.some(extension => cleanFilePath.endsWith(extension));
+	const transformJs = transformExtensions.some(extension => cleanFilePath.endsWith(extension));
 	if (!transformTs && !transformJs) {
-		return defaultLoader(module, filePath);
+		return defaultLoader(module, cleanFilePath);
 	}
 
-	let code = fs.readFileSync(filePath, 'utf8');
+	let code = fs.readFileSync(cleanFilePath, 'utf8');
 
-	if (filePath.endsWith('.cjs')) {
+	if (cleanFilePath.endsWith('.cjs')) {
 		// Contains native ESM check
 		const transformed = transformDynamicImport(filePath, code);
 		if (transformed) {
@@ -70,7 +73,7 @@ const transformer = (
 			code,
 			filePath,
 			{
-				tsconfigRaw: fileMatcher?.(filePath) as TransformOptions['tsconfigRaw'],
+				tsconfigRaw: fileMatcher?.(cleanFilePath) as TransformOptions['tsconfigRaw'],
 			},
 		);
 
@@ -81,7 +84,7 @@ const transformer = (
 		);
 	}
 
-	module._compile(code, filePath);
+	module._compile(code, cleanFilePath);
 };
 
 [

diff --git a/src/cjs/api/module-resolve-filename.ts b/src/cjs/api/module-resolve-filename.ts
@@ -62,6 +62,7 @@ export const createResolveFilename = (
 ) => {
 	// Strip query string
 	const queryIndex = request.indexOf('?');
+	const query = queryIndex === -1 ? '' : request.slice(queryIndex);
 	if (queryIndex !== -1) {
 		request = request.slice(0, queryIndex);
 	}
@@ -86,7 +87,7 @@ export const createResolveFilename = (
 		for (const possiblePath of possiblePaths) {
 			const tsFilename = resolveTsFilename(nextResolve, possiblePath, parent, isMain, options);
 			if (tsFilename) {
-				return tsFilename;
+				return tsFilename + query;
 			}
 
 			try {
@@ -95,15 +96,15 @@ export const createResolveFilename = (
 					parent,
 					isMain,
 					options,
-				);
+				) + query;
 			} catch {}
 		}
 	}
 
 	const tsFilename = resolveTsFilename(nextResolve, request, parent, isMain, options);
 	if (tsFilename) {
-		return tsFilename;
+		return tsFilename + query;
 	}
 
-	return nextResolve(request, parent, isMain, options);
+	return nextResolve(request, parent, isMain, options) + query;
 };
diff --git a/src/utils/transform/index.ts b/src/utils/transform/index.ts
@@ -39,16 +39,17 @@ export const transformSync = (
 	filePath: string,
 	extendOptions?: TransformOptions,
 ): Transformed => {
+	const [filePathWithoutQuery, query] = filePath.split('?');
 	const define: { [key: string]: string } = {};
 
-	if (!(filePath.endsWith('.cjs') || filePath.endsWith('.cts'))) {
-		define['import.meta.url'] = JSON.stringify(pathToFileURL(filePath));
+	if (!(filePathWithoutQuery.endsWith('.cjs') || filePathWithoutQuery.endsWith('.cts'))) {
+		define['import.meta.url'] = JSON.stringify(pathToFileURL(filePathWithoutQuery) + (query ? `?${query}` : ''));
 	}
 
 	const esbuildOptions = {
 		...cacheConfig,
 		format: 'cjs',
-		sourcefile: filePath,
+		sourcefile: filePathWithoutQuery,
 		define,
 		banner: '(()=>{',
 		footer: '})()',

diff --git a/tests/fixtures.ts b/tests/fixtures.ts
@@ -129,6 +129,10 @@ export const files = {
 
 	'js/index.js': outdent`
 	import assert from 'assert';
+	console.log(JSON.stringify({
+		importMetaUrl: import.meta.url,
+		__filename: typeof __filename !== 'undefined' ? __filename : undefined,
+	}));
 	${syntaxLowering}
 	${preserveName}
 	export const cjsContext = ${cjsContextCheck};

diff --git a/tests/specs/smoke.ts b/tests/specs/smoke.ts
@@ -138,6 +138,7 @@ export default testSuite(async ({ describe }, { tsx }: NodeApis) => {
 						console.error(error);
 						console.log(p);
 					});
+
 					expect(p.failed).toBe(false);
 					expect(p.stdout).toMatch(`"import.meta.url":"${pathToFileURL(fixture.getPath('import-from-js.js'))}"`);
 					expect(p.stdout).toMatch(`"js":{"cjsContext":${isCommonJs},"default":1,"named":2}`);
@@ -146,8 +147,14 @@ export default testSuite(async ({ describe }, { tsx }: NodeApis) => {
 					expect(p.stdout).toMatch('"pkgModule":{"default":1,"named":2}');
 					if (isCommonJs) {
 						expect(p.stdout).toMatch('"pkgCommonjs":{"default":1,"named":2}');
+
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js","__filename":".+?index\.js"\}/);
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js\?query=123","__filename":".+?index\.js"\}/);
 					} else {
 						expect(p.stdout).toMatch('"pkgCommonjs":{"default":{"default":1,"named":2}}');
+
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js"\}/);
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js\?query=123"\}/);
 					}
 
 					// By "require()"ing an ESM file, it forces it to be compiled in a CJS context
@@ -354,8 +361,14 @@ export default testSuite(async ({ describe }, { tsx }: NodeApis) => {
 					expect(p.stdout).toMatch('"pkgModule":{"default":1,"named":2}');
 					if (isCommonJs) {
 						expect(p.stdout).toMatch('"pkgCommonjs":{"default":1,"named":2}');
+
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js","__filename":".+?index\.js"\}/);
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js\?query=123","__filename":".+?index\.js"\}/);
 					} else {
 						expect(p.stdout).toMatch('"pkgCommonjs":{"default":{"default":1,"named":2}}');
+
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js"\}/);
+						expect(p.stdout).toMatch(/\{"importMetaUrl":"file:\/\/\/.+?\/js\/index\.js\?query=123"\}/);
 					}
 
 					// By "require()"ing an ESM file, it forces it to be compiled in a CJS context