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]>

Author: Ceres6

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){
 }
 }
 
+functionescapeSnapshotKey(str){
+letresult=JSONStringify(str,null,2).slice(1,-1);
+result=StringPrototypeReplaceAll(result,'`','\\`');
+result=StringPrototypeReplaceAll(result,'${','\\${');
+returnresult;
+}
+
 functiontemplateEscape(str){
 letresult=String(str);
 result=StringPrototypeReplaceAll(result,'\\','\\\\');

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)=>{
+returnjoin(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'});
+});

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)=>{
+constfixture=fixtures.path(
+'test-runner','snapshots','special-character.js'
+);
+
+awaitcommon.spawnPromisified(
+process.execPath,
+['--test-update-snapshots',fixture],
+{cwd: tmpdir.path},
+);
+
+constchild=awaitcommon.spawnPromisified(
+process.execPath,
+[fixture],
+{cwd: tmpdir.path},
+);
+
+t.assert.strictEqual(child.code,0);
+t.assert.strictEqual(child.signal,null);
+t.assert.match(child.stdout,/tests3/);
+t.assert.match(child.stdout,/pass3/);
+t.assert.match(child.stdout,/fail0/);
+});
+
 test('snapshots from multiple files (isolation=none)',async(t)=>{
 tmpdir.refresh();