Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

esm: fix cache collision on JSON files using file: URL #49887

Merged
merged 4 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lib/internal/modules/esm/translators.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const {
SafeArrayIterator,
SafeMap,
SafeSet,
StringPrototypeIncludes,
StringPrototypeReplaceAll,
StringPrototypeSlice,
StringPrototypeStartsWith,
Expand Down Expand Up @@ -443,9 +444,11 @@ translators.set('json', function jsonStrategy(url, source) {
debug(`Loading JSONModule ${url}`);
const pathname = StringPrototypeStartsWith(url, 'file:') ?
fileURLToPath(url) : null;
const shouldCheckAndPopulateCJSModuleCache =
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
pathname && !StringPrototypeIncludes(url, '?') && !StringPrototypeIncludes(url, '#');
let modulePath;
let module;
if (pathname) {
if (shouldCheckAndPopulateCJSModuleCache) {
modulePath = isWindows ?
StringPrototypeReplaceAll(pathname, '/', '\\') : pathname;
module = CJSModule._cache[modulePath];
Expand All @@ -457,7 +460,7 @@ translators.set('json', function jsonStrategy(url, source) {
}
}
source = stringify(source);
if (pathname) {
if (shouldCheckAndPopulateCJSModuleCache) {
// A require call could have been called on the same file during loading and
// that resolves synchronously. To make sure we always return the identical
// export, we have to check again if the module already exists or not.
Expand All @@ -484,7 +487,7 @@ translators.set('json', function jsonStrategy(url, source) {
err.message = errPath(url) + ': ' + err.message;
throw err;
}
if (pathname) {
if (shouldCheckAndPopulateCJSModuleCache) {
CJSModule._cache[modulePath] = module;
}
cjsCache.set(url, module);
Expand Down
41 changes: 40 additions & 1 deletion test/es-module/test-esm-json.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ import { spawnPromisified } from '../common/index.mjs';
import * as fixtures from '../common/fixtures.mjs';
import assert from 'node:assert';
import { execPath } from 'node:process';
import { describe, it } from 'node:test';
import { describe, it, test } from 'node:test';

import { mkdir, rm, writeFile } from 'node:fs/promises';
import * as tmpdir from '../common/tmpdir.js';

import secret from '../fixtures/experimental.json' assert { type: 'json' };

Expand All @@ -21,4 +24,40 @@ describe('ESM: importing JSON', () => {
assert.strictEqual(code, 0);
assert.strictEqual(signal, null);
});

test('should load different modules when the URL is different', async (t) => {
const root = tmpdir.fileURL(`./test-esm-json-${Math.random()}/`);
try {
await mkdir(root, { recursive: true });

await t.test('json', async () => {
const url = new URL('./foo.json', root);
await writeFile(url, JSON.stringify({ firstJson: true }));
const firstJson = await import(`${url}?a=1`, {
LiviaMedeiros marked this conversation as resolved.
Show resolved Hide resolved
assert: { type: 'json' },
});
await writeFile(url, JSON.stringify({ firstJson: false }));
const secondJson = await import(`${url}?a=2`, {
assert: { type: 'json' },
});

assert.notDeepStrictEqual(firstJson, secondJson);
});

await t.test('js', async () => {
const url = new URL('./foo.mjs', root);
await writeFile(url, `
export const firstJS = true
`);
const firstJS = await import(`${url}?a=1`);
await writeFile(url, `
export const firstJS = false
`);
const secondJS = await import(`${url}?a=2`);
assert.notDeepStrictEqual(firstJS, secondJS);
});
} finally {
await rm(root, { force: true, recursive: true });
}
});
});
30 changes: 30 additions & 0 deletions test/es-module/test-esm-virtual-json.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import '../common/index.mjs';
import * as fixtures from '../common/fixtures.mjs';
import { register } from 'node:module';
import assert from 'node:assert';

async function resolve(referrer, context, next) {
const result = await next(referrer, context);
const url = new URL(result.url);
url.searchParams.set('randomSeed', Math.random());
result.url = url.href;
return result;
}

function load(url, context, next) {
if (context.importAssertions.type === 'json') {
return {
shortCircuit: true,
format: 'json',
source: JSON.stringify({ data: Math.random() }),
};
}
return next(url, context);
}

register(`data:text/javascript,export ${encodeURIComponent(resolve)};export ${encodeURIComponent(load)}`);

assert.notDeepStrictEqual(
await import(fixtures.fileURL('empty.json'), { assert: { type: 'json' } }),
await import(fixtures.fileURL('empty.json'), { assert: { type: 'json' } }),
);
Loading