Optional suspense

[jhuleatt]

What's happening?

This is a proposed API change that makes it easier to use ReactFire without enabling experimental React features (Suspense & Concurrent Mode).

"Suspense Mode" will be settable in FirebaseAppProvider (in which case it will automatically apply to all children of FirebaseAppProvider), or in individual calls as part of ReactFireOptions.

<FirebaseAppProvider firebaseConfig={config} suspense={true}>
    <App />
</FirebaseAppProvider>

If you don't set suspense={true} in FirebaseAppProvider, it will default to false.

Now that Suspense won't necessarily be handling loading states, each hook will return more information about its status:

export interface ObservableStatus<T> {
  status:
    | 'loading' // waiting for first value from observable
    | 'error'
    | 'success'; // has received at least one value
  hasEmitted: boolean; // has received at least one value
  isComplete: boolean; // observable has triggered onComplete event
  data: T; // latest data from observable
  error: Error | undefined;
  firstValuePromise: Promise<void>; // promise that resolves after first emit from observable
}

Status

• Make API changes to core library
• Update tests for new API, and add new tests that don't use Suspense
• Make a sample that works without Suspense
• Ensure all Suspense samples and tests still work
• Update docs with new API:
  • README
  • Guide (just added a disclaimer that samples are for Concurrent Mode)
  • Quickstart (just added a disclaimer that samples are for Concurrent Mode)
  • Reference

[zaccharles]

Thanks for the hard work, is there anything I can do to help get this across the line?

[praneybehl]

Seems like one of the pipelines is stuck since a few months. Is this PR dead?

[kantmichel]

i'd be very keen on using this in the current stable react version. Any idea's on when this is being merged?

[mastef]

@jhuleatt @jamesdaniels Any chance this proposal may make it any time soon into ReactFire? Since it was mentioned in #260 and there's great interest in using ReactFire with the stable builds of React.

Thank you for your work on this!

[jhuleatt]

Hey there, apologies for the long silence on this. We're working on reviving this PR, and I've just pushed the latest updates.

Examples of the new api can be found here: https://github.com/FirebaseExtended/reactfire/tree/optional-suspense/example/withoutSuspense

If you want to pull this branch yourself and try things out, pull it then run:

In one terminal:

yarn
yarn start

In a second terminal:

cd example
yarn
yarn start

[no-1ne]

Hello folks,
Thank you for this, Looking forward to being able to use it in production builds of react.