Add comment to explain the use of shallow copying here

nodejs · Feb 27, 2024 · 352a556 · 352a556
1 parent e29c56e
commit 352a556
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/internal/test_runner/reporter/tap.js b/lib/internal/test_runner/reporter/tap.js
@@ -224,6 +224,9 @@ function jsToYaml(indent, name, value, seen) {
     }
 
     if (errIsAssertion) {
+      // Note that we're deliberately creating shallow copies of the `seen`
+      // set here in order to isolate the discovery of circular references
+      // within the expected and actual properties respectively.
       result += jsToYaml(indent, 'expected', errExpected, new SafeSet(seen));
       result += jsToYaml(indent, 'actual', errActual, new SafeSet(seen));
       if (errOperator) {