Improve chai support (with detailed output, to match jest exceptions)

[rpgeeganage]

Summary

This PR is an initial attempt to solve #8152.

Test plan

Before the change Chai output was as follows.

 FAIL  ./chai.spec.js
  a chai test
    ✕ tests something (4ms)

  ● a chai test › tests something

    AssertionError: expected 'hello world' to equal 'hello sunshine'

      3 | describe('a chai test', () => {
      4 |   it('tests something', () => {
    > 5 |     chai.expect('hello world').to.equal('hello sunshine');
        |                                   ^
      6 |   });
      7 | });

      at Object.equal (chai.spec.js:5:35)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 total
Snapshots:   0 total
Time:        1.361s
Ran all test suites matching /chai.spec.js/i.

With modification:

  FAIL  ./chai.spec.js
  a chai test
    ✕ tests something (8ms)

  ● a chai test › tests something

    assert.(received, expected)

    Expected value   "hello sunshine"
    Received:
      "hello world"

    Message:
      expected 'hello world' to equal 'hello sunshine'

    Difference:

    - Expected
    + Received

    - hello sunshine
    + hello world

      3 | describe('a chai test', () => {
      4 |   it('tests something', () => {
    > 5 |     chai.expect('hello world').to.equal('hello sunshine');
        |                                   ^
      6 |   });
      7 | });

      at Object.equal (chai.spec.js:5:35)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 total
Snapshots:   0 total
Time:        1.534s
Ran all test suites matching /chai.spec.js/i.

[rpgeeganage]

@thymikee ,
I have added the tests.
Now still, CI is failing. The failure output is as follows.

$ yarn jest-coverage --color -i --config jest.config.ci.js && yarn test-leak && node scripts/mapCoverage.js && codecov
$ yarn jest --coverage --color -i --config jest.config.ci.js
$ node ./packages/jest-cli/bin/jest.js --coverage --color -i --config jest.config.ci.js
........(node:291) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 exit listeners added. Use emitter.setMaxListeners() to increase limit
.................................................Too long with no output (exceeded 10m0s)

I can't figure out why.
Can you please give me a hint regarding this ?

[jeysal]

@rpgeeganage Hmm, I don't see anything suspicious in the diff that might cause tests to stall. Weird that circus passes, must be the change to jasmine2 I guess?
@thymikee seems to be short on time atm, maybe @SimenB has an idea?
Your e2e test passes locally for me as well...

[jeysal]

Maybe it broke some other test that waits for a certain output and for some reason doesn't timeout normally? @rpgeeganage have you tried running all tests (yarn jest) locally with your changes? (Will take a looooong time unless you're on Linux)

[rpgeeganage]

@jeysal
Thanks a lot. I'll dig deep.

[SimenB]

Looks like some sort of hanging test, yes. Not sure why it doesn't time out, probably a bug.

Running yarn jest locally is a good idea :)

[rpgeeganage]

@SimenB , @jeysal
I tried and I think I located the error. It's in https://github.com/facebook/jest/blob/master/e2e/failures/__tests__/duringTests.test.js#L18
I think it is because of a bug in my modification. I'm looking into it now.
Thanks a lot.

[codecov-io]

Codecov Report

Merging #8454 into master will decrease coverage by 0.06%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master    #8454      +/-   ##
==========================================
- Coverage   62.32%   62.26%   -0.07%     
==========================================
  Files         266      266              
  Lines       10735    10746      +11     
  Branches     2614     2624      +10     
==========================================
  Hits         6691     6691              
- Misses       3460     3471      +11     
  Partials      584      584

Impacted Files	Coverage Δ
...ackages/jest-jasmine2/src/assertionErrorMessage.ts	0% <0%> (ø)	⬆️
packages/jest-jasmine2/src/jasmine/Spec.ts	0% <0%> (ø)	⬆️
packages/jest-circus/src/formatNodeAssertErrors.ts	12.96% <0%> (-1.33%)	⬇️
packages/jest-jasmine2/src/jasmine/Env.ts	0% <0%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 15e2cc6...de3815f. Read the comment docs.

[rpgeeganage]

@jeysal ,
I have fixed the comments. Please review the new change.
Thanks a lot.

[jeysal]

Really nice work @rpgeeganage ❤️
Hope the change to chai also goes through for an even better integration 😎

[rpgeeganage]

@jeysal ,
Thanks a lot and I'm honored to contribute to this project.
I'm planning to dive into possible chai modification during the weekend.

[lucasfcosta]

Hello everyone, I've just seen the related issue in Chai's repo, I'll do my best to get it merged there this week. I think the code is pretty much g2g.

[lucasfcosta]

Just FYI, we've just merged @rpgeeganage's amazing work in chaijs/chai#1257 and we'll try to separate some time for a release with that change this weekend.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.