Skip to content

fix: remove null value inclusion from != and not-in filter results #8915

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

Merged
merged 3 commits into from
Apr 11, 2025
+108 −3
Merged

fix: remove null value inclusion from != and not-in filter results #8915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d20983
fix: remove null from `!=` and `not-in` filters' result
milaGGL Apr 9, 2025
00760d7
add changeset
milaGGL Apr 10, 2025
ec521eb
add the "!= null" test case
milaGGL Apr 10, 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
6 changes: 6 additions & 0 deletions .changeset/cyan-frogs-relate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@firebase/firestore': patch
'firebase': patch
---

Fixed the `null` value handling in `!=` and `not-in` filters.
7 changes: 6 additions & 1 deletion packages/firestore/src/core/filter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ export class FieldFilter extends Filter {
if (this.op === Operator.NOT_EQUAL) {
return (
other !== null &&
other.nullValue === undefined &&
this.matchesComparison(valueCompare(other!, this.value))
);
}
Expand Down Expand Up @@ -495,7 +496,11 @@ export class NotInFilter extends FieldFilter {
return false;
}
const other = doc.data.field(this.field);
return other !== null && !arrayValueContains(this.value.arrayValue!, other);
return (
other !== null &&
other.nullValue === undefined &&
!arrayValueContains(this.value.arrayValue!, other)
);
}
}

Expand Down
94 changes: 94 additions & 0 deletions packages/firestore/test/integration/api/query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1751,6 +1751,100 @@ apiDescribe('Queries', persistence => {
);
});
});

it('sdk uses != filter same as backend', async () => {
const testDocs = {
a: { zip: Number.NaN },
b: { zip: 91102 },
c: { zip: 98101 },
d: { zip: '98101' },
e: { zip: [98101] },
f: { zip: [98101, 98102] },
g: { zip: ['98101', { zip: 98101 }] },
h: { zip: { code: 500 } },
i: { zip: null },
j: { code: 500 }
};

await withTestCollection(persistence, testDocs, async coll => {
// populate cache with all documents first to ensure getDocsFromCache() scans all docs
await getDocs(coll);

let testQuery = query(coll, where('zip', '!=', 98101));
await checkOnlineAndOfflineResultsMatch(
testQuery,
'a',
'b',
'd',
'e',
'f',
'g',
'h'
);

testQuery = query(coll, where('zip', '!=', Number.NaN));
await checkOnlineAndOfflineResultsMatch(
testQuery,
'b',
'c',
'd',
'e',
'f',
'g',
'h'
);

testQuery = query(coll, where('zip', '!=', null));
await checkOnlineAndOfflineResultsMatch(
testQuery,
'a',
'b',
'c',
'd',
'e',
'f',
'g',
'h'
);
});
});

it('sdk uses not-in filter same as backend', async () => {
const testDocs = {
a: { zip: Number.NaN },
b: { zip: 91102 },
c: { zip: 98101 },
d: { zip: '98101' },
e: { zip: [98101] },
f: { zip: [98101, 98102] },
g: { zip: ['98101', { zip: 98101 }] },
h: { zip: { code: 500 } },
i: { zip: null },
j: { code: 500 }
};

await withTestCollection(persistence, testDocs, async coll => {
// populate cache with all documents first to ensure getDocsFromCache() scans all docs
await getDocs(coll);

let testQuery = query(
coll,
where('zip', 'not-in', [98101, 98103, [98101, 98102]])
);
await checkOnlineAndOfflineResultsMatch(
testQuery,
'a',
'b',
'd',
'e',
'g',
'h'
);

testQuery = query(coll, where('zip', 'not-in', [null]));
await checkOnlineAndOfflineResultsMatch(testQuery);
});
});
});

// Reproduces https://github.com/firebase/firebase-js-sdk/issues/5873
Expand Down
4 changes: 2 additions & 2 deletions packages/firestore/test/unit/core/query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ describe('Query', () => {
document = doc('collection/1', 0, {
zip: null
});
expect(queryMatches(query1, document)).to.be.true;
expect(queryMatches(query1, document)).to.be.false;

// NaN match.
document = doc('collection/1', 0, {
Expand Down Expand Up @@ -354,7 +354,7 @@ describe('Query', () => {
expect(queryMatches(query2, doc3)).to.equal(true);
expect(queryMatches(query2, doc4)).to.equal(true);
expect(queryMatches(query2, doc5)).to.equal(true);
expect(queryMatches(query2, doc6)).to.equal(true);
expect(queryMatches(query2, doc6)).to.equal(false);
});

it('matches null for filters', () => {
Expand Down
Loading