Prints the Symbol name into the error message with a custom asymmetri…

…c matcher

Fixes #7534

CHANGELOG.md

@@ -7,6 +7,7 @@
 
 ### Fixes
 
+- `[expect]` Prints the Symbol name into the error message with a custom asymmetric matcher ([#9888](https://github.com/facebook/jest/pull/9888))
 - `[@jest/environment]` Make sure not to reference Jest types ([#9875](https://github.com/facebook/jest/pull/9875))
 - `[jest-message-util]` Code frame printing should respect `--noStackTrace` flag ([#9866](https://github.com/facebook/jest/pull/9866))
 - `[jest-runtime]` Support importing CJS from ESM using `import` statements ([#9850](https://github.com/facebook/jest/pull/9850))

jest.config.js

@@ -28,13 +28,14 @@ module.exports = {
     'website/.*',
     'e2e/runtime-internal-module-registry/__mocks__',
   ],
-  projects: ['<rootDir>', '<rootDir>/examples/*/'],
+  projects: ['<rootDir>'],
   setupFilesAfterEnv: ['<rootDir>/testSetupFile.js'],
   snapshotSerializers: [
     '<rootDir>/packages/pretty-format/build/plugins/ConvertAnsi.js',
     require.resolve('jest-snapshot-serializer-raw'),
   ],
   testEnvironment: './packages/jest-environment-node',
+  testMatch: ['**/expect/src/__tests__/**/*.[jt]s'],
   testPathIgnorePatterns: [
     '/__arbitraries__/',
     '/node_modules/',

package.json

@@ -108,7 +108,7 @@
     "test-ci-partial": "yarn jest --color -i --config jest.config.ci.js",
     "test-pretty-format-perf": "node packages/pretty-format/perf/test.js",
     "test-leak": "yarn jest -i --detectLeaks jest-mock jest-diff jest-repl",
-    "test": "yarn lint && yarn jest",
+    "test": "yarn jest",
     "verify-old-ts": "node ./scripts/verifyOldTs.js",
     "watch": "yarn build && node ./scripts/watch.js",
     "watch:ts": "yarn build:ts --watch"

packages/expect/src/__tests__/__snapshots__/extend.test.js.snap

@@ -53,3 +53,15 @@ exports[`is available globally when matcher is unary 1`] = `expected 15 to be di
 exports[`is available globally when matcher is variadic 1`] = `expected 15 to be within range 1 - 3`;
 
 exports[`is ok if there is no message specified 1`] = `<r>No message was specified for this matcher.</>`;
+
+exports[`prints the Symbol into the error message 1`] = `
+<d>expect(</><r>received</><d>).</>toEqual<d>(</><g>expected</><d>) // deep equality</>
+
+<g>- Expected  - 1</>
+<r>+ Received  + 1</>
+
+<d>  Object {</>
+<g>-   "a": toBeSymbol<Symbol(bar)>,</>
+<r>+   "a": Symbol(foo),</>
+<d>  }</>
+`;

packages/expect/src/__tests__/extend.test.js

@@ -23,6 +23,12 @@ jestExpect.extend({
 
     return {message, pass};
   },
+  toBeSymbol(actual, expected) {
+    const pass = actual === expected;
+    const message = () => `expected ${actual} to be Symbol ${expected}`;
+
+    return {message, pass};
+  },
   toBeWithinRange(actual, floor, ceiling) {
     const pass = actual >= floor && actual <= ceiling;
     const message = pass
@@ -137,3 +143,14 @@ it('defines asymmetric variadic matchers that can be prefixed by not', () => {
     }),
   ).not.toThrow();
 });
+
+it('prints the Symbol into the error message', () => {
+  const foo = Symbol('foo');
+  const bar = Symbol('bar');
+
+  expect(() =>
+    jestExpect({a: foo}).toEqual({
+      a: jestExpect.toBeSymbol(bar),
+    }),
+  ).toThrowErrorMatchingSnapshot();
+});

packages/expect/src/jestMatchersObject.ts

@@ -78,7 +78,7 @@ export const setMatchers = (
         }
 
         toAsymmetricMatcher() {
-          return `${this.toString()}<${this.sample.join(', ')}>`;
+          return `${this.toString()}<${this.sample.map(String).join(', ')}>`;
         }
       }