Add pretty-inmutable for better error message [issue-2489]

[luiskhernandez]

When comparing against inmutable value show a more
descriptive message

Summary
This pr attempt to fix #2489 by adding pretty-inmutable to

Test plan
run this test

it('compares Immutable-js OrderedSet', () => {
  expect(Immutable.OrderedSet(['foo'])).toEqual(['foo']);
});

it('compares Immutable-js List', () => {
  expect(Immutable.List(['foo'])).toEqual(['foo']);
});

and you should see.

[codecov-io]

Current coverage is 62.18% (diff: 12.50%)

Merging #2529 into master will decrease coverage by 0.08%

@@             master      #2529   diff @@
==========================================
  Files           116        117     +1   
  Lines          4802       4810     +8   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits           2990       2991     +1   
- Misses         1812       1819     +7   
  Partials          0          0          

Powered by Codecov. Last update 742eb0b...b47927d

[cpojer]

There is a typo here and this list is not exhaustive either.

[cpojer]

This doesn't seem like an efficient way to determine what type it is.

[cpojer]

Thank you for this PR but I think there is a number of things that need to be changed here:

• We need to build our completely own pretty-printing for all immutable types. Otherwise we hand off the work to a different pretty-printer as soon as we see the first immutable item, which isn't really useful if we have other objects (like react elements) in an immutable list.
• immutable should be an optional dependency and pretty-format must not depend on it.
• Use this plugin everywhere we use prettyFormat inside of Jest.

[luiskhernandez]

Hey @cpojer. Thanks for the feedback. couple of questions and i'll try again.

Do you mean, to create a print function like printArguments, printArray, printSet that are in https://github.com/facebook/jest/blob/master/packages/pretty-format/src/index.jsbut for all the Inmutable types, and add them to the a similar printComplexValue as a pretty-print plugin?

Any hint on how to detect if it is a imputable type with out using Inmutable?

I'll keep hacking to see how can in improve the pr, thanks.

[cpojer]

Yeah, you should create one plugin for each type from immutable we'd like to pretty-print. Note: the library is called "immutable" not "inmutable".

I'll close this PR for now as it will likely need a couple of iterations to get ready. Feel free to push to this one and notify me by commenting here or create a new PR when you are ready :)

[thymikee]

I'm also not sure if we want add extra dependency of pretty-immutable.

[luiskhernandez]

@thymikee @cpojer Hey guys, i was giving this a try again, and i was wondering if we can rely on the toString method that is already built in the immutable see example

[thymikee]

I think this can be a good base. But we need to prefix this with "Immutable" and make sure it behaves well with min option

[luiskhernandez]

@thymikee can you give a example on how should behave with min option and other expected results to used them as test scenarios?

[thymikee]

Min set to true will behave like immutable.toString. When set to false it will render each value in new line. You can see this behaviour when testing arrays in Jest

[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.