trackProperties method in immutableStateInvariantMiddleware.ts is not correctly managing the circularity

[paztis]

https://github.com/reduxjs/redux-toolkit/blob/master/packages/toolkit/src/immutableStateInvariantMiddleware.ts#L57

function trackProperties(
  isImmutable: IsImmutableFunc,
  ignorePaths: IgnorePaths = [],
  obj: Record<string, any>,
  path: string = '',
  checkedObjects: Set<Record<string, any>> = new Set(),
) {
  const tracked: Partial<TrackedProperty> = { value: obj }

  if (!isImmutable(obj) && !checkedObjects.has(obj)) {
    checkedObjects.add(obj)
    tracked.children = {}

    for (const key in obj) {
      const childPath = path ? path + '.' + key : key
      if (ignorePaths.length && ignorePaths.indexOf(childPath) !== -1) {
        continue
      }

      tracked.children[key] = trackProperties(
        isImmutable,
        ignorePaths,
        obj[key],
        childPath,
      )
    }
  }
  return tracked as TrackedProperty
}

recursive call to trackProperties (line 57) is not passing down the checkedObjects argument.
It means all the circularity check you do in your code is totally bypass.

That's why immutable is not working with circular references

[paztis]

I create a PR to fix this: #4844

[paztis]

Hi. No approval or reject ?
This problem is important to fix

[markerikson]

It's low on the priority list atm - all of us maintainers have been busy with other things the last few weeks. We'll try to take a look when we get a chance!

In the meantime, you could disable the default version of the immutability middleware, paste the modified version into your app, and add that to the store instead.