Skip to content

test_runner: allow special characters in snapshot keys#57017

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 3 commits into from
Feb 19, 2025
Merged

test_runner: allow special characters in snapshot keys #57017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2945e44
test_runner: allow special characters in snapshot keys
Ceres6 Feb 12, 2025
3ec6510
fixup! test_runner: allow special characters in snapshot keys
Ceres6 Feb 17, 2025
02bbd1d
fixup! test_runner: allow special characters in snapshot keys
Ceres6 Feb 17, 2025
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: 8 additions & 1 deletion lib/internal/test_runner/snapshot.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ class SnapshotFile {
}

setSnapshot(id, value) {
this.snapshots[templateEscape(id)] = value;
this.snapshots[escapeSnapshotKey(id)] = value;
}

nextId(name) {
Expand DownExpand Up@@ -290,6 +290,13 @@ function validateFunctionArray(fns, name) {
}
}

function escapeSnapshotKey(str) {
let result = JSONStringify(str, null, 2).slice(1, -1);
result = StringPrototypeReplaceAll(result, '`', '\\`');
result = StringPrototypeReplaceAll(result, '${', '\\${');
return result;
}

function templateEscape(str) {
let result = String(str);
result = StringPrototypeReplaceAll(result, '\\', '\\\\');
Expand Down
19 changes: 19 additions & 0 deletions test/fixtures/test-runner/snapshots/special-character.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
'use strict';
const { snapshot, test } = require('node:test');
const { basename, join } = require('node:path');

snapshot.setResolveSnapshotPath((testFile) => {
return join(process.cwd(), `${basename(testFile)}.snapshot`);
});

test('\r', (t) => {
t.assert.snapshot({ key: 'value' });
});

test(String.fromCharCode(55296), (t) => {
t.assert.snapshot({ key: 'value' });
});

test(String.fromCharCode(57343), (t) => {
t.assert.snapshot({ key: 'value' });
});
26 changes: 26 additions & 0 deletions test/parallel/test-runner-snapshot-tests.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ suite('SnapshotManager', () => {

file.setSnapshot('foo`${x}` 1', 'test');
t.assert.strictEqual(file.getSnapshot('foo\\`\\${x}\\` 1'), 'test');
file.setSnapshot('\r 1', 'test');
t.assert.strictEqual(file.getSnapshot('\\r 1'), 'test');
Comment on lines 161 to 162

@cjihrigcjihrigFeb 13, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the bug happens while reading the snapshots back. I think for this case, it would be better to test a full round trip (write the file and then read it back) using the public APIs. It would probably be good to check a couple more cases besides just \r since in #56836 (comment), it was reported that this happens for a range of inputs (not saying we should test every single input though).

@Ceres6Ceres6Feb 14, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test was failing before the check, but I will add an e2e test

@Ceres6Ceres6Feb 14, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAICS the range in that comment is the block of high surrogate and low surrogate pairs which are reserved for utf-16 and shouldn't appear, but I'm not an expert on this, so not sure

});

test('throws if snapshot file cannot be resolved', (t) => {
Expand DownExpand Up@@ -340,6 +342,30 @@ test('t.assert.snapshot()', async (t) => {
});
});

test('special characters are allowed', async (t) => {
const fixture = fixtures.path(
'test-runner', 'snapshots', 'special-character.js'
);

await common.spawnPromisified(
process.execPath,
['--test-update-snapshots', fixture],
Comment thread
pmarchini marked this conversation as resolved.
Outdated
{ cwd: tmpdir.path },
);

const child = await common.spawnPromisified(
process.execPath,
[fixture],
{ cwd: tmpdir.path },
);

t.assert.strictEqual(child.code, 0);
t.assert.strictEqual(child.signal, null);
t.assert.match(child.stdout, /tests 3/);
t.assert.match(child.stdout, /pass 3/);
t.assert.match(child.stdout, /fail 0/);
});

test('snapshots from multiple files (isolation=none)', async (t) => {
tmpdir.refresh();

Expand Down