example/: kitchen-sink demo cannot be installed, and its Suspense path cannot run
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 55/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- react, typescript
- Ambito
- build-system, frontend
Direzione di ricerca
Inizia da example/package.json e dal relativo lockfile, quindi esamina example/index.tsx:45 e example/withSuspense/Firestore.tsx:2,87. Per prima cosa esegui un’installazione pulita in example/ e decidi se la demo debba usare il workspace, un tarball generato o una versione pubblicata; il lavoro è completato quando le dipendenze vengono installate e il percorso Suspense viene compilato ed eseguito senza i problemi di React 17/18 descritti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Two pre-existing defects in example/, both surfaced by @armando-navarro while reviewing #781 and both verified against main. Neither was caused by that PR and neither was fixed by it, so they are filed here rather than left in a review thread on a merged PR.
They are filed together because the fix for the second requires the first: there is no way to check that the Suspense path runs without being able to install the demo.
1. The demo cannot be installed as checked out
example/package.json depends on:
"reactfire": "file:../reactfire-4.0.1.tgz"
That tarball is not in the repository, so npm install inside example/ fails from a clean checkout. Whatever produced it was never committed and no script regenerates it.
Worth deciding rather than patching blindly: the fix could be a file:.. reference to the workspace, a documented npm pack step, or a published version range. They differ in whether the demo is meant to exercise the local working tree or the last release.
2. The Suspense path cannot run, on either the old instructions or the new ones
example/index.tsx ships a commented-out Suspense variant. #781 corrected the comment to say the path does not run as checked in, which is accurate, but the underlying reason is worth recording.
example/package.json pins the runtime to React 17 while the types are already on 18:
"react": "^17.0.0",
"react-dom": "^17.0.0",
"@types/react": "^18.0.15",
"@types/react-dom": "^18.0.6",
"typescript": "^4.7.4"
That skew produces two distinct failures.
example/index.tsx:45, the commentedReactDOM.createRoot(rootElement). On react-dom 17 this isundefinedat runtime, and under@types/react-dom@18it is also a type error, becausecreateRootis declared inclient.d.tsand not on the root entry. The example'sbuildistsc && vite build, so uncommenting it breaks the build as well as the app.example/withSuspense/Firestore.tsx:2, which importsuseTransition(used at:87). This one type-checks cleanly because@types/reactis already 18, and fails only at runtime on React 17. It is the more dangerous of the two for exactly that reason.
Those are the only React 18 APIs anywhere under example/, which bounds the work:
example/index.tsx:45: // ReactDOM.createRoot(rootElement).render(
example/withSuspense/Firestore.tsx:2: import { useState, useTransition } from 'react';
example/withSuspense/Firestore.tsx:87: const [isPending, startTransition] = useTransition();
The instructions that #781 replaced did not work either. Verified on react@experimental: createRoot, unstable_createRoot and render are all undefined on the root react-dom entry. So this is long-standing, and #781 regressed nothing.
What the fix involves
- Bump
reactandreact-domto 18 inexample/package.json, and the lockfile. - Import
createRootfromreact-dom/client, not the root entry. It is not on the root entry under@types/react-dom@18either, so the currently commented specifier would still be wrong after the bump. - Word the comment as replacing the existing
ReactDOM.rendercall, not uncommenting alongside it. Leaving both produces React 18'sYou are calling ReactDOMClient.createRoot() on a container that was previously passed to ReactDOM.render()warning. - Rename
ConcurrentModeApp/NonConcurrentModeApp. "Concurrent mode" has not been the name for this since React 18 shipped, and #781 removed that framing from the surrounding prose but deliberately left the identifiers, since renaming them is not a comments-only change.
#781 also deliberately left the commented ReactDOM.createRoot specifier uncorrected. Fixing it in isolation would make the block look runnable, which is the opposite of what the caveat it sits under is for. It should be corrected as part of the bump, not before.
Not a ReactFire bug
Worth stating explicitly so this is not mistaken for a library problem: ReactFire itself works fine on React 17. @armando-navarro ran useObservable with suspense: true under the legacy render path and it suspends, resolves and keeps updating. The React 18 requirement belongs to the demo, not to the library.
Refs #781.
- Lingua principale
- TypeScript
- Stelle
- 3.6k
- Fork
- 403
- Merge medio
- 5g 1h
- PR unite (30g)
- 10
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di FirebaseExtended/reactfire
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 38/100
FirebaseExtended/reactfire#801 ·
-
v5
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
FirebaseExtended/reactfire#793 ·
-
v5
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
FirebaseExtended/reactfire#790 · 2 commenti ·
-
v5
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
FirebaseExtended/reactfire#789 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
FirebaseExtended/reactfire#788 ·
Tutte le issue di FirebaseExtended/reactfire
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
bcgov/bc-wallet-mobile#4761 · 1 commento ·
-
external-issue to-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
area-deployment area-integrations triage:bot-seen
Difficoltà 2/5 Mezza giornata Idoneità per principianti 86/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
refactor
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100