"Maximum call stack exceeded" with circular references

[joshkel]

🐛 Bug Report

Starting with Immer 10.0.4, if Immer is given an object that uses symbols for circular references, it generates a "Maximum call stack exceeded" error.

Link to repro

https://playcode.io/1794809

To Reproduce

Pass an object with pre-existing symbol circular references to Immer 10.0.4. (Circular references that are added within an Immer recipe do not cause problems.)

Observed behavior

"Maximum call stack exceeded"

Expected behavior

Our application uses symbols to create child-to-parent relationships. Since symbols are skipped by many JavaScript routines (e.g., JSON.stringify, Immer prior to 10.0.4), we had been able to do this without error.

Environment

• Immer version: 10.0.4
• I filed this report against the latest version of Immer

[mweststrate]

Argh, the JS world is impossible. 50% is like "non-enumerables and proxies have very specific meanings", and the other half is like "I expect non-enumerables and symbol to work just like the rest, why treat them irregularly" 🤣

[mweststrate]

Would you mind trying setting the setUseStrictShallowCopy(false) flag? Maybe in combination with version 10.0.4-beta?

[joshkel]

@mweststrate I get it. I apologize for contributing to your pain as an open-source maintainer.

setUseStrictShallowCopy(false) with 10.0.4 or 10.0.4-beta seems to have no effect.

For what it's worth, Immer 9.x's behavior seemed consistent and worked for my purposes:

• Preexisting symbol props are skipped by Immer, as consistent with Object.values, JSON.stringify, etc. (I.e., this issue.)
• If I add/set a symbol prop within Immer, it handles it well enough to avoid leaking proxies. (I.e., produce leaks proxy objects when symbols are present #1087.)

Hopefully that's too ad hoc / too much of a special case - but, if you decide it is, I understand.

[NMinhNguyen]

Another way to reproduce this is trying to modify an object that contains React context: https://codesandbox.io/p/devbox/festive-gagarin-9mkfx9

For what it’s worth, the repro seems to work using immer@6.0.9

[mweststrate]

Yeah I guess the only way to deal with this is to make all the behavior of irregular properties of any kind (enumerable x getter x proxy) all configurable. That will be a a bit bigger project though so probably more for a next major.

[joshkel]

I'm thrilled to report that 10.2.0 and #1164 fixes the case I encountered: If I use the new setUseStrictIteration(false) option, then symbol keys are skipped by Immer, so I can once again use symbol keys for circular references without causing issues in Immer.

@NMinhNguyen, I think that your issue is different from what I encountered. From what I can tell, Immer has prohibited "plain" circular references for a long time (since at least 9.x). The issue I encountered was caused by changes in how Immer handled unusual cases (symbol properties, non-enumerable properties, etc.) from 9.x to 10.0.0 to 10.0.4.

I'll leave this issue open in case I'm mistaken about the React context test case or in case there's still any desire to make all irregular properties configurable to cover any other use cases. But, as far as I'm concerned, my issue is resolved.

Thanks for all your work on this library, @mweststrate.