v5: remove deprecated and dead exports
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tái cấu trúc
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- firebase, react, typescript
- Lĩnh vực
- authentication, documentation, frontend
Hướng nghiên cứu
Bắt đầu bằng cách đọc các điểm gọi v5 trong src/index.ts, src/useObservable.ts và src/auth.tsx, đồng thời kiểm tra #740 trước khi chạm vào Group 1 đang bị chặn. Đối với Group 3, hãy kiểm tra test/auth.test.tsx và cách sử dụng AuthCheckWrapper; để hoàn thành cũng cần npm run docs:fork và các mục trong v5 upgrade-guide cho những phần thay thế.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 3.6k
- Fork
- 403
- Merge trung bình
- 5 ngày 1 giờ
- Pull request đã merge (30 ngày)
- 10
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của FirebaseExtended/reactfire
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 38/100
FirebaseExtended/reactfire#801 ·
-
v5
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
FirebaseExtended/reactfire#793 ·
-
v5
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
FirebaseExtended/reactfire#790 · 2 bình luận ·
-
v5
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
FirebaseExtended/reactfire#789 ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
FirebaseExtended/reactfire#788 ·
Tất cả issue của FirebaseExtended/reactfire
Issue tương tự
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Crush Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
ElementsProject/cln-application#167 · 1 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Quantco/pnpm-licenses#17 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100