test_runner: allow special characters in snapshot keys

Fixes: #56836 PR-URL: #57017 Reviewed-By: Pietro Marchini <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Chemi Atlow <[email protected]>
nodejs · Feb 19, 2025 · baa60ce · baa60ce
1 parent a724a9e
commit baa60ce
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 1 deletion.
diff --git a/lib/internal/test_runner/snapshot.js b/lib/internal/test_runner/snapshot.js
@@ -77,7 +77,7 @@ class SnapshotFile {
   }
 
   setSnapshot(id, value) {
-    this.snapshots[templateEscape(id)] = value;
+    this.snapshots[escapeSnapshotKey(id)] = value;
   }
 
   nextId(name) {
@@ -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, '\\', '\\\\');

diff --git a/test/fixtures/test-runner/snapshots/special-character.js b/test/fixtures/test-runner/snapshots/special-character.js
@@ -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' });
+});
diff --git a/test/parallel/test-runner-snapshot-tests.js b/test/parallel/test-runner-snapshot-tests.js
@@ -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');
   });
 
   test('throws if snapshot file cannot be resolved', (t) => {
@@ -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],
+    { 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();