[Breaking change] Properly escape snapshots (#2482)

* [Breaking change] Properly escape snapshots

There were many issues with snapshot test escaping:
- When escaping backtick, it didn't escape backslash
- Double quote escaping was overzealous and also escaped single quotes
- JSX text didn't use HTML escaping
- Regex escaping didn't escape all the control characters that should be

Because of the first one, you couldn't do eval(snapshot) and get the correct value, in order to make it kind of work, an unescape function was created that did ... something. Now that escaping is done properly we don't need it anymore.

This is a breaking change as all the double quotes now need to be escaped which triggers a ton of failures.

* Update snapshots

Author: vjeux

integration_tests/__tests__/__snapshots__/failures-test.js.snap

@@ -3,14 +3,14 @@ Object {
   "rest": " FAIL  __tests__/throw-number-test.js
   ● Test suite failed to run
 
-    Expected an Error, but \"1\" was thrown
+    Expected an Error, but \\"1\\" was thrown
 
 ",
   "summary": "Test Suites: 1 failed, 1 total
 Tests:       0 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"throw-number-test.js\".
+Ran all test suites matching \\"throw-number-test.js\\".
 ",
 }
 `;
@@ -28,7 +28,7 @@ Object {
 Tests:       0 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"throw-string-test.js\".
+Ran all test suites matching \\"throw-string-test.js\\".
 ",
 }
 `;
@@ -45,7 +45,7 @@ Object {
 Tests:       0 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"throw-object-test.js\".
+Ran all test suites matching \\"throw-object-test.js\\".
 ",
 }
 `;
@@ -97,7 +97,7 @@ Object {
 Tests:       3 failed, 3 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"assertion-count-test.js\".
+Ran all test suites matching \\"assertion-count-test.js\\".
 ",
 }
 `;

integration_tests/__tests__/__snapshots__/snapshot-serializers-test.js.snap

@@ -2,15 +2,15 @@ exports[`Snapshot serializers renders snapshot 1`] = `
 Object {
   "snapshot serializers works with default serializers 1": "
 <div
-  id="foo" />
+  id=\\"foo\\" />
 ",
   "snapshot serializers works with first plugin 1": "foo: 1",
   "snapshot serializers works with nested serializable objects 1": "foo: bar: 2",
   "snapshot serializers works with prepended plugins and default serializers 1": "
 <div
   aProp={
     Object {
-      "a": 6,
+      \\"a\\": 6,
     }
   }
   bProp={foo: 8} />

integration_tests/__tests__/__snapshots__/snapshot-test.js.snap

@@ -66,7 +66,7 @@ exports[`Snapshot works with escaped characters 1`] = `
 Tests:       1 passed, 1 total
 Snapshots:   1 added, 1 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-test.js\".
+Ran all test suites matching \\"snapshot-test.js\\".
 "
 `;
 
@@ -75,7 +75,7 @@ exports[`Snapshot works with escaped characters 2`] = `
 Tests:       2 passed, 2 total
 Snapshots:   1 added, 1 passed, 2 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-test.js\".
+Ran all test suites matching \\"snapshot-test.js\\".
 "
 `;
 
@@ -84,7 +84,7 @@ exports[`Snapshot works with escaped characters 3`] = `
 Tests:       2 passed, 2 total
 Snapshots:   2 passed, 2 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-test.js\".
+Ran all test suites matching \\"snapshot-test.js\\".
 "
 `;
 
@@ -93,7 +93,7 @@ exports[`Snapshot works with escaped regex 1`] = `
 Tests:       2 passed, 2 total
 Snapshots:   2 added, 2 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-escape-regex.js\".
+Ran all test suites matching \\"snapshot-escape-regex.js\\".
 "
 `;
 
@@ -102,7 +102,7 @@ exports[`Snapshot works with escaped regex 2`] = `
 Tests:       2 passed, 2 total
 Snapshots:   2 passed, 2 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-escape-regex.js\".
+Ran all test suites matching \\"snapshot-escape-regex.js\\".
 "
 `;
 
@@ -111,7 +111,7 @@ exports[`Snapshot works with template literal subsitutions 1`] = `
 Tests:       1 passed, 1 total
 Snapshots:   1 added, 1 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-escape-substitution-test.js\".
+Ran all test suites matching \\"snapshot-escape-substitution-test.js\\".
 "
 `;
 
@@ -120,6 +120,6 @@ exports[`Snapshot works with template literal subsitutions 2`] = `
 Tests:       1 passed, 1 total
 Snapshots:   1 passed, 1 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"snapshot-escape-substitution-test.js\".
+Ran all test suites matching \\"snapshot-escape-substitution-test.js\\".
 "
 `;

integration_tests/__tests__/__snapshots__/stack_trace-test.js.snap

@@ -3,7 +3,7 @@ exports[`Stack Trace does not print a stack trace for errors when --noStackTrace
 Tests:       3 failed, 3 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"test-error-test.js\".
+Ran all test suites matching \\"test-error-test.js\\".
 "
 `;
 
@@ -12,7 +12,7 @@ exports[`Stack Trace does not print a stack trace for matching errors when --noS
 Tests:       1 failed, 1 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"stack-trace-test.js\".
+Ran all test suites matching \\"stack-trace-test.js\\".
 "
 `;
 
@@ -21,7 +21,7 @@ exports[`Stack Trace does not print a stack trace for runtime errors when --noSt
 Tests:       0 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"runtime-error-test.js\".
+Ran all test suites matching \\"runtime-error-test.js\\".
 "
 `;
 
@@ -30,7 +30,7 @@ exports[`Stack Trace prints a stack trace for errors 1`] = `
 Tests:       3 failed, 3 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"test-error-test.js\".
+Ran all test suites matching \\"test-error-test.js\\".
 "
 `;
 
@@ -39,7 +39,7 @@ exports[`Stack Trace prints a stack trace for matching errors 1`] = `
 Tests:       1 failed, 1 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"stack-trace-test.js\".
+Ran all test suites matching \\"stack-trace-test.js\\".
 "
 `;
 
@@ -48,6 +48,6 @@ exports[`Stack Trace prints a stack trace for runtime errors 1`] = `
 Tests:       0 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites matching \"runtime-error-test.js\".
+Ran all test suites matching \\"runtime-error-test.js\\".
 "
 `;

integration_tests/__tests__/__snapshots__/testNamePattern-test.js.snap

@@ -3,6 +3,6 @@ exports[`test testNamePattern 1`] = `
 Tests:       2 skipped, 2 passed, 4 total
 Snapshots:   0 total
 Time:        <<REPLACED>>
-Ran all test suites with tests matching \"should match\".
+Ran all test suites with tests matching \\"should match\\".
 "
 `;

packages/jest-config/src/__tests__/__snapshots__/normalize-test.js.snap

@@ -1,11 +1,11 @@
 exports[`Upgrade help logs a warning when \`scriptPreprocessor\` and/or \`preprocessorIgnorePatterns\` are used 1`] = `
 "● Deprecation Warning:
 
-  Option [1m\"preprocessorIgnorePatterns\"[22m was replaced by [1m\"transformIgnorePatterns\"[22m, which support multiple preprocessors.
+  Option [1m\\"preprocessorIgnorePatterns\\"[22m was replaced by [1m\\"transformIgnorePatterns\\"[22m, which support multiple preprocessors.
 
   Jest now treats your current configuration as:
   {
-    [1m\"transformIgnorePatterns\"[22m: [1m[\"bar/baz\", \"qux/quux\"][22m
+    [1m\\"transformIgnorePatterns\\"[22m: [1m[\\"bar/baz\\", \\"qux/quux\\"][22m
   }
 
   Please update your configuration.

packages/jest-diff/src/__tests__/__snapshots__/diff-test.js.snap

@@ -23,9 +23,9 @@ Printing internal object structure without calling \`toJSON\` instead.
 + Received
 
   Object {
-[32m-[39m [32m  \"line\": 1,[39m
-[31m+[39m [31m  \"line\": 2,[39m
-[2m [22m [2m  \"toJSON\": [Function toJSON],[22m
+[32m-[39m [32m  \\"line\\": 1,[39m
+[31m+[39m [31m  \\"line\\": 2,[39m
+[2m [22m [2m  \\"toJSON\\": [Function toJSON],[22m
   }"
 `;
 

packages/jest-matcher-utils/src/__tests__/__snapshots__/index-test.js.snap

@@ -1,23 +1,23 @@
-exports[`.stringify() reduces maxDepth if stringifying very large objects 1`] = `"{\"a\": 1, \"b\": [Object]}"`;
+exports[`.stringify() reduces maxDepth if stringifying very large objects 1`] = `"{\\"a\\": 1, \\"b\\": [Object]}"`;
 
-exports[`.stringify() reduces maxDepth if stringifying very large objects 2`] = `"{\"a\": 1, \"b\": {\"0\": \"test\", \"1\": \"test\", \"2\": \"test\", \"3\": \"test\", \"4\": \"test\", \"5\": \"test\", \"6\": \"test\", \"7\": \"test\", \"8\": \"test\", \"9\": \"test\"}}"`;
+exports[`.stringify() reduces maxDepth if stringifying very large objects 2`] = `"{\\"a\\": 1, \\"b\\": {\\"0\\": \\"test\\", \\"1\\": \\"test\\", \\"2\\": \\"test\\", \\"3\\": \\"test\\", \\"4\\": \\"test\\", \\"5\\": \\"test\\", \\"6\\": \\"test\\", \\"7\\": \\"test\\", \\"8\\": \\"test\\", \\"9\\": \\"test\\"}}"`;
 
 exports[`.stringify() toJSON errors when comparing two objects 1`] = `
 "expect(received).toEqual(expected)
 
 Expected value to equal:
-  [32m{\"b\": 1, \"toJSON\": [Function toJSON]}[39m
+  [32m{\\"b\\": 1, \\"toJSON\\": [Function toJSON]}[39m
 Received:
-  [31m{\"a\": 1, \"toJSON\": [Function toJSON]}[39m
+  [31m{\\"a\\": 1, \\"toJSON\\": [Function toJSON]}[39m
 
 Difference:
 
 - Expected
 + Received
 
  Object {
-[32m-  \"b\": 1,[39m
-[31m+  \"a\": 1,[39m
-[2m   \"toJSON\": [Function toJSON],[22m
+[32m-  \\"b\\": 1,[39m
+[31m+  \\"a\\": 1,[39m
+[2m   \\"toJSON\\": [Function toJSON],[22m
  }"
 `;