Skip to content
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

Jump to bottom

fix(firestore): allow null value to isEqualsTo & isNotEqualsTo in where() query #11896

Merged
merged 12 commits into from
Nov 21, 2023
Merged

fix(firestore): allow null value to isEqualsTo & isNotEqualsTo in where() query #11896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
38519fc
fix(firestore): allow `null` value to `isEqualsTo` `isNotEqualsTo` & …
russellwheatley Nov 15, 2023
67bc52d
test(firestore): allow `null` value to `isEqualsTo` `isNotEqualsTo` &…
russellwheatley Nov 15, 2023
1003e06
chore: analyze and format issues
russellwheatley Nov 15, 2023
9dc3496
refactor: cannot use `null` with `arrayContains` to query. doesn't work
russellwheatley Nov 15, 2023
3e2e341
chore: fix typo
rrousselGit Nov 16, 2023
5468766
feat: export the "where" sentinel value for usage in the ODM
rrousselGit Nov 16, 2023
ea91d84
fix(firestore): revert named param types back to original
russellwheatley Nov 16, 2023
4d5ac7b
Merge branch 'firestore-11874' of https://github.com/firebase/flutter…
rrousselGit Nov 16, 2023
0e7b99e
feat: Support `whereField(isEqualTo: null)` and similar
rrousselGit Nov 16, 2023
0bb4c01
chore: Revert header removal
rrousselGit Nov 16, 2023
64070bd
chore: fix analyze
rrousselGit Nov 16, 2023
ab8dd1c
chore: header again....
rrousselGit Nov 16, 2023
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
50 changes: 50 additions & 0 deletions packages/cloud_firestore/cloud_firestore/example/integration_test/query_e2e.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1813,6 +1813,56 @@ void runQueryTests() {
expect(snapshot.docs.length, equals(1));
expect(snapshot.docs[0].get('foo'), equals(ref));
});

testWidgets('pass `null` to `isEqualTo`', (_) async {
CollectionReference<Map<String, dynamic>> collection =
await initializeTest('where-null-isEqualTo');

await Future.wait([
collection.add({
'foo': 1,
}),
collection.add({'foo': 2}),
collection.add({
'foo': null,
}),
collection.add({
'foo': null,
}),
]);

QuerySnapshot<Map<String, dynamic>> snapshot =
await collection.where('foo', isEqualTo: null).get();

expect(snapshot.docs.length, equals(2));
expect(snapshot.docs[0].get('foo'), equals(null));
expect(snapshot.docs[1].get('foo'), equals(null));
});

testWidgets('pass `null` to `isNotEqualTo`', (_) async {
CollectionReference<Map<String, dynamic>> collection =
await initializeTest('where-null-isNotEqualTo');

await Future.wait([
collection.add({
'foo': 11,
}),
collection.add({'foo': 11}),
collection.add({
'foo': null,
}),
collection.add({
'foo': null,
}),
]);

QuerySnapshot<Map<String, dynamic>> snapshot =
await collection.where('foo', isNotEqualTo: null).get();

expect(snapshot.docs.length, equals(2));
expect(snapshot.docs[0].get('foo'), equals(11));
expect(snapshot.docs[1].get('foo'), equals(11));
});
});

group('Query.where() with Filter class', () {
Expand Down
72 changes: 44 additions & 28 deletions packages/cloud_firestore/cloud_firestore/lib/src/query.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

part of cloud_firestore;

/// Sentinel value to check whether user passed values explicitly through .where() method
@internal
const notSetQueryParam = Object();

/// Represents a [Query] over the data at a particular location.
///
/// Can construct refined [Query] objects by adding filters and ordering.
Expand Down Expand Up @@ -595,13 +599,13 @@ class _JsonQuery implements Query<Map<String, dynamic>> {
@override
Query<Map<String, dynamic>> where(
Object fieldOrFilter, {
Object? isEqualTo,
Object? isNotEqualTo,
Object? isLessThan,
Object? isLessThanOrEqualTo,
Object? isGreaterThan,
Object? isGreaterThanOrEqualTo,
Object? arrayContains,
Object? isEqualTo = notSetQueryParam,
Object? isNotEqualTo = notSetQueryParam,
Object? isLessThan = notSetQueryParam,
Object? isLessThanOrEqualTo = notSetQueryParam,
Object? isGreaterThan = notSetQueryParam,
Object? isGreaterThanOrEqualTo = notSetQueryParam,
Object? arrayContains = notSetQueryParam,
Iterable<Object?>? arrayContainsAny,
Iterable<Object?>? whereIn,
Iterable<Object?>? whereNotIn,
Expand All @@ -611,13 +615,13 @@ class _JsonQuery implements Query<Map<String, dynamic>> {

if (fieldOrFilter is Filter) {
assert(
isEqualTo == null &&
isNotEqualTo == null &&
isLessThan == null &&
isLessThanOrEqualTo == null &&
isGreaterThan == null &&
isGreaterThanOrEqualTo == null &&
arrayContains == null &&
identical(isEqualTo, notSetQueryParam) &&
identical(isNotEqualTo, notSetQueryParam) &&
identical(isLessThan, notSetQueryParam) &&
identical(isLessThanOrEqualTo, notSetQueryParam) &&
identical(isGreaterThan, notSetQueryParam) &&
identical(isGreaterThanOrEqualTo, notSetQueryParam) &&
identical(arrayContains, notSetQueryParam) &&
arrayContainsAny == null &&
whereIn == null &&
whereNotIn == null &&
Expand Down Expand Up @@ -655,17 +659,29 @@ class _JsonQuery implements Query<Map<String, dynamic>> {
conditions.add(condition);
}

if (isEqualTo != null) addCondition(field, '==', isEqualTo);
if (isNotEqualTo != null) addCondition(field, '!=', isNotEqualTo);
if (isLessThan != null) addCondition(field, '<', isLessThan);
if (isLessThanOrEqualTo != null) {
if (!identical(isEqualTo, notSetQueryParam)) {
addCondition(field, '==', isEqualTo);
}

if (!identical(isNotEqualTo, notSetQueryParam)) {
addCondition(field, '!=', isNotEqualTo);
}

if (!identical(isLessThan, notSetQueryParam)) {
addCondition(field, '<', isLessThan);
}

if (!identical(isLessThanOrEqualTo, notSetQueryParam)) {
addCondition(field, '<=', isLessThanOrEqualTo);
}
if (isGreaterThan != null) addCondition(field, '>', isGreaterThan);
if (isGreaterThanOrEqualTo != null) {
if (!identical(isGreaterThan, notSetQueryParam)) {
addCondition(field, '>', isGreaterThan);
}

if (!identical(isGreaterThanOrEqualTo, notSetQueryParam)) {
addCondition(field, '>=', isGreaterThanOrEqualTo);
}
if (arrayContains != null) {
if (!identical(arrayContains, notSetQueryParam)) {
addCondition(field, 'array-contains', arrayContains);
}
if (arrayContainsAny != null) {
Expand Down Expand Up @@ -952,13 +968,13 @@ class _WithConverterQuery<T extends Object?> implements Query<T> {
@override
Query<T> where(
Object field, {
Object? isEqualTo,
Object? isNotEqualTo,
Object? isLessThan,
Object? isLessThanOrEqualTo,
Object? isGreaterThan,
Object? isGreaterThanOrEqualTo,
Object? arrayContains,
Object? isEqualTo = notSetQueryParam,
Object? isNotEqualTo = notSetQueryParam,
Object? isLessThan = notSetQueryParam,
Object? isLessThanOrEqualTo = notSetQueryParam,
Object? isGreaterThan = notSetQueryParam,
Object? isGreaterThanOrEqualTo = notSetQueryParam,
Object? arrayContains = notSetQueryParam,
Iterable<Object?>? arrayContainsAny,
Iterable<Object?>? whereIn,
Iterable<Object?>? whereNotIn,
Expand Down
Loading
Loading