add support for props with nested immutables

[mattkrick]

Background:
Sometimes, a prop might be a POJO that contains a nested immutable structure. Draft-js' editorState is a great example. Within sCU, the plain deepEqual function is used on it & breaks.

Why this is needed:

• Per Redux-form compatibility with RichText editor (draft-js) control #2798 the only way to make this work with draft-js is to serialize the editorState.
• The beauty of immutables is that we don't have to do a deep equals, comparing references is enough
• folks may use different immutable libraries so there is no safe way to ducktype an immutable
• folks may have large POJOs that they want to exclude from being deep equaled in sCU. This is a cheap, unobtrusive way to add performance.

Example:
reduxForm({form: 'linkChanger', immutables: ['editorState']})

can bump the docs if you like it

[codecov-io]

Codecov Report

Merging #3019 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #3019   +/-   ##
======================================
  Coverage     100%    100%           
======================================
  Files          67      68    +1     
  Lines        1395    1436   +41     
======================================
+ Hits         1395    1436   +41

Impacted Files	Coverage Δ
src/createReduxForm.js	100% <100%> (ø)	⬆️
src/ConnectedField.js	100% <0%> (ø)	⬆️
src/immutable.js	100% <0%> (ø)	⬆️
src/ConnectedFieldArray.js	100% <0%> (ø)	⬆️
src/structure/immutable/keys.js	100% <0%> (ø)	⬆️
src/index.js	100% <0%> (ø)	⬆️
src/createFormValues.js	100% <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 ac33570...fb031bd. Read the comment docs.

[erikras]

From your description, this sounded like a massive change, and then it only turned out to be two little lines.

So all you're doing is allowing additional "props not to update for" to be specified. It's unclear to me what this has to do with immutability or how it would help with Draft JS. Why are you passing editorState to your form as a prop?

[mattkrick]

I find small changes to be easier to get merged, and I really want this to get merged :-). With immutability: the component should update if any prop changed. That means we should deep equals all the props. The only exception would be immutable structures. I'm game for a name change if there's a better one. For my use case, my editor pops up a modal with a form and feeds it the state.

…

On Jun 6, 2017 6:44 AM, "Erik Rasmussen" ***@***.***> wrote: From your description, this sounded like a massive change, and then it only turned out to be two little lines. So all you're doing is allowing additional "props not to update for" to be specified. It's unclear to me what this has to do with immutability or how it would help with Draft JS. Why are you passing editorState to your form as a prop? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3019 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFQjv42lqZVyKmo5FkdmRmZQJzpnbohUks5sBVTtgaJpZM4NwUIM> .

[erikras]

The problem I see, though, is that you are totally ignoring changes to the props listed. It seems like you should be ===ing them, right?

Let's call it immutableProps.

[mattkrick]

you're correct, i was being selfish & just solving for my use case.
Fixed & documented! if a unit test is needed lemme know where.

[erikras]

Can you get the code coverage back up to 100%?

npm run test:cov
open coverage/lcov-report/index.html

[gustavohenke]

This comment is kinda misleading, but IMO fix it if you want 😁

[mattkrick]

good catch, i was just blindly cut & pasting 😄

[erikras]

Fantastic!

[mattkrick]

oh super duper, thank you!

[erikras]

Published in v6.8.0.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.