useFirestoreCollectionData infinite loop when using a Query withConvertor about reactfire HOT 2 OPEN

I tried to use the library for the first time today and hit upon this issue. I think the cause is due to the call to queryEqual here:

In my case, I am minting new converter objects on each render, which breaks the equality check, with something like:

Firestore.collection(firestore, prefix, 'doc').withConverter(
      docConverter<Doc>()
    ),

If I instead save off the converter to a top-level constant, which means the equality check can presumably rely on identity for the converter part, I can see the collection promise gets fulfilled and my app renders correctly.

It's something like this saved off outside of the component lifecycle, in my case at the top level of a module:

const docConverter = docConverter<Doc>()

Then during a render, it's reusing the object:

Firestore.collection(firestore, prefix, 'doc').withConverter(
      docConverter
    ),

I think this is not a reactfire bug, but I think a common use-case that should be documented as I wasted hours on it and I imagine others would, too.

from reactfire.

Another approach to consider is to allow users to pass in a query key override, like react-query (the lib I was coming from), if it's too difficult to track whether equality will work out from reading subtle code changes.

from reactfire.