v5: remove deprecated and dead exports
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- firebase, react, typescript
调研方向
首先阅读 src/index.ts、src/useObservable.ts 和 src/auth.tsx 中的 v5 调用点,并在处理被阻塞的 Group 1 之前检查 #740。对于 Group 3,检查 test/auth.test.tsx 及其对 AuthCheckWrapper 的使用;完成工作还需要执行 npm run docs:fork,并在 v5 upgrade-guide 中添加相应替换条目。
由索引模型根据 Issue 内容生成。
描述
Background
reactfire ships several exports that are deprecated or dead but kept because removing them breaks consumers at load time, not just at compile time. v5 is the release that can drop them. Scope widened 2026-08-03 from the two checkOptions helpers to every deprecated export, so the breaking-removals work is tracked in one place.
Corrected 2026-08-05. An earlier revision of this issue described the work as a checklist of independent deletions. Call sites were checked against
v5ate7b18c2and that is not accurate: one group is blocked on another PR, one is not dead code at all, and one requires test changes. The three groups below are sorted by what they actually cost, and they are not independent. Line references are as ofe7b18c2.
Group 1: checkOptions and checkinitialData (BLOCKED, do not start)
- Remove
checkOptionsfromsrc/index.ts(:34) - Remove
checkinitialDatafromsrc/index.ts(:43)
⚠️ These are not dead on v5 today. checkIdField (src/index.ts:47) still calls checkOptions, and so does checkinitialData. The earlier claim that they became unused "as of #740" is true of #740's branch, which rewrites checkIdField to read options?.idField directly, but #740 targets main and has not merged, so v5 has not received that rewrite.
Doing this group now would mean duplicating #740's change on v5, which then conflicts when main is forward-integrated. Blocked until #740 merges and is forward-integrated. checkIdField itself stays either way; it is still used by the Firestore and Database data hooks.
Group 2: startWithValue (NOT a deletion, it is a behavior change)
- Remove
startWithValuefromReactFireOptions(src/index.ts:30), marked@deprecated use initialData instead
⚠️ This is not dead code. It has three live call sites on v5:
src/useObservable.ts(:113):config?.initialData ?? config?.startWithValue, the actual fallback that makes the option worksrc/useObservable.ts(:78): thehasInitialDatacheck that decides whether to skiploadingsrc/auth.tsx(:34):useUserwill not seedinitialDatafromauth.currentUserif the caller passedstartWithValue
So removing it changes runtime behavior for anyone still passing it, rather than only failing their typecheck. It needs the fallback logic removed alongside the field, and an upgrade-guide entry pointing at initialData. Independent of Group 1.
Group 3: ClaimsCheck and AuthCheck (self-contained, but touches tests)
- Remove
ClaimsCheck(src/auth.tsx:215) and its exportedClaimsCheckProps(:60) - Remove
AuthCheck(src/auth.tsx:259) and its exportedAuthCheckProps(:54)
Both are @deprecated Use useSigninCheck instead, both only function in experimental Suspense mode and console.warn otherwise. They must go together: AuthCheck renders ClaimsCheck internally (src/auth.tsx:271).
⚠️ test/auth.test.tsx needs more than deletion. It defines an AuthCheckWrapper and reuses it at :285-300 and :369 inside a useUser test that is not about AuthCheck at all. That test needs rewriting to use a plain provider, not removing.
Do not also remove ClaimCheckErrors (:67), despite it sitting between the two interfaces. It is part of the SigninCheckResult shape (:81, :96) and stays.
Then, once the groups above land
- Regenerate reference docs (
npm run docs:fork, notnpm run docs) to drop the corresponding pages - Record each removal in the v5 upgrade guide with its replacement (
initialDataforstartWithValue,useSigninCheckfor both components)
Notes
- Each of these is a runtime break for plain JS importers (an ESM import error at load), not only a type error. That is why they were deferred rather than done in a patch.
- After #740's tightening,
checkinitialData's inferred return type becomesunknown(wasany). Harmless while unused, and another reason to retire it. - Deliberately not folded into #740. That PR tightens
ReactFireOptionsgenerics, its squash body becomes the changelog, and a removal buried under afix:title is how a break gets missed. Same release, separate PR. - Groups 2 and 3 can proceed while Group 1 is blocked. Splitting this into more than one PR is reasonable; a single PR mixing a behavior change with two component removals makes the changelog harder to read.
Context: #740, #741.
- 主要语言
- TypeScript
- 星标
- 3.6k
- 派生
- 403
- 平均合并
- 5 天 1 小时
- 30 天内合并 PR
- 10
环境准备
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
FirebaseExtended/reactfire 的其他 Issue
-
难度 5/5 一周以上 新手友好度 38/100
FirebaseExtended/reactfire#801 ·
-
v5
难度 4/5 3-5 天 新手友好度 48/100
FirebaseExtended/reactfire#793 ·
-
v5
难度 4/5 3-5 天 新手友好度 35/100
FirebaseExtended/reactfire#790 · 2 条评论 ·
-
v5
难度 4/5 3-5 天 新手友好度 55/100
FirebaseExtended/reactfire#789 ·
-
难度 5/5 一周以上 新手友好度 35/100
FirebaseExtended/reactfire#788 ·
查看 FirebaseExtended/reactfire 的全部 Issue
相似的 Issue
-
resources
难度 2/5 1-3 小时 新手友好度 72/100
railmapgen/rmg-palette#2445 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
danielmiessler/LifeOS#2242 ·
维护者通常 5 天内回复
-
good first issue hacktoberfest help wanted translation
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
callstackincubator/appduct#129 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 88/100