Skip to content

fix(firestore): Corrected misleading error message when doc() is called with undefined. #9386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

fix(firestore): Corrected misleading error message when doc() is called with undefined. #9386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1c9d060
Corrected misleading error message when doc() is called with undefined.
cherylEnkidu Nov 17, 2025
60f0c83
add changeset
cherylEnkidu Nov 17, 2025
c127909
Update packages/firestore/test/lite/integration.test.ts
cherylEnkidu Nov 17, 2025
30962d2
remove any
cherylEnkidu Nov 17, 2025
6e0db18
merge
cherylEnkidu Nov 17, 2025
e7262aa
add ts-ignore
cherylEnkidu Nov 18, 2025
0e0e8f9
fix error message
cherylEnkidu Nov 18, 2025
3124bc9
improve code
cherylEnkidu Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/thin-sheep-smoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/firestore': patch
---

Fix: Corrected misleading error message when doc() is called with undefined.
2 changes: 1 addition & 1 deletion packages/firestore/src/lite-api/reference.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ export function doc<AppModelType, DbModelType extends DocumentData>(
) {
throw new FirestoreError(
Code.INVALID_ARGUMENT,
'Expected first argument to collection() to be a CollectionReference, ' +
'Expected first argument to doc() to be a CollectionReference, ' +
'a DocumentReference or FirebaseFirestore'
);
}
Expand Down
6 changes: 6 additions & 0 deletions packages/firestore/test/lite/integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,12 @@ describe('doc', () => {

it('validates path', () => {
return withTestDb(db => {
expect(() =>
// @ts-expect-error
doc({}, 'coll/doc')
).to.throw(
'Expected first argument to doc() to be a CollectionReference, a DocumentReference or FirebaseFirestore'
);
expect(() => doc(db, 'coll')).to.throw(
'Invalid document reference. Document references must have an even ' +
'number of segments, but coll has 1.'
Expand Down
Loading