Skip to content

Commit

Permalink
feat(ui_firestore): use aggregate query to display total rows count i…
Browse files Browse the repository at this point in the history 
…n DataTable (#10113)

* feat(ui_firestore): use aggregate query to display total rows count in datatable

* fix tests

* address PR review feedback

* drop unused arg

* Update packages/firebase_ui_firestore/lib/src/query_builder.dart

Co-authored-by: Remi Rousselet <darky12s@gmail.com>

* store snapshot

* drop value key

Co-authored-by: Remi Rousselet <darky12s@gmail.com>
  • Loading branch information
@lesnitsky @rrousselGit
lesnitsky and rrousselGit authored Dec 16, 2022
1 parent dbac24d commit bf52bcc
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 45 deletions.
43 changes: 43 additions & 0 deletions packages/firebase_ui_firestore/lib/src/query_builder.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -502,3 +502,46 @@ class FirestoreListView<Document> extends FirestoreQueryBuilder<Document> {
},
);
}

/// Listens to an aggregate query and passes the [AsyncSnapshot] to the builder.
class AggregateQueryBuilder extends StatefulWidget {
/// A query to listen to
final AggregateQuery query;

/// A builder that is called whenever the query is updated.
final Widget Function(
BuildContext context,
AsyncSnapshot<AggregateQuerySnapshot> snapshot,
) builder;

const AggregateQueryBuilder({
super.key,
required this.query,
required this.builder,
});

@override
State<AggregateQueryBuilder> createState() => _AggregateQueryBuilderState();
}

class _AggregateQueryBuilderState extends State<AggregateQueryBuilder> {
late var queryFuture = widget.query.get();

@override
Widget build(BuildContext context) {
return FutureBuilder<AggregateQuerySnapshot>(
future: queryFuture,
builder: (context, snapshot) {
return widget.builder(context, snapshot);
},
);
}

@override
void didUpdateWidget(covariant AggregateQueryBuilder oldWidget) {
super.didUpdateWidget(oldWidget);
if (widget.query != oldWidget.query) {
queryFuture = widget.query.get();
}
}
}
115 changes: 70 additions & 45 deletions packages/firebase_ui_firestore/lib/src/table_builder.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,6 @@ class FirestoreDataTable extends StatefulWidget {
/// If null, then [horizontalMargin] is used as the margin between the edge
/// of the table and the checkbox, as well as the margin between the checkbox
/// and the content in the first data column. This value defaults to 24.0.
final double? checkboxHorizontalMargin;

@override
Expand Down Expand Up @@ -249,47 +248,61 @@ class _FirestoreTableState extends State<FirestoreDataTable> {

@override
Widget build(BuildContext context) {
return FirestoreQueryBuilder<Map<String, Object?>>(
query: _query,
builder: (context, snapshot, child) {
source.setFromSnapshot(snapshot);

return AnimatedBuilder(
animation: source,
builder: (context, child) {
final actions = [
...?widget.actions,
if (widget.canDeleteItems && source._selectedRowIds.isNotEmpty)
IconButton(
icon: const Icon(Icons.delete),
onPressed: source.onDeleteSelectedItems,
),
];
return PaginatedDataTable(
source: source,
onSelectAll: selectionEnabled ? source.onSelectAll : null,
onPageChanged: widget.onPageChanged,
showCheckboxColumn: widget.showCheckboxColumn,
arrowHeadColor: widget.arrowHeadColor,
checkboxHorizontalMargin: widget.checkboxHorizontalMargin,
columnSpacing: widget.columnSpacing,
dataRowHeight: widget.dataRowHeight,
dragStartBehavior: widget.dragStartBehavior,
headingRowHeight: widget.headingRowHeight,
horizontalMargin: widget.horizontalMargin,
rowsPerPage: widget.rowsPerPage,
showFirstLastButtons: widget.showFirstLastButtons,
sortAscending: widget.sortAscending,
sortColumnIndex: widget.sortColumnIndex,
header:
actions.isEmpty ? null : (widget.header ?? const SizedBox()),
actions: actions.isEmpty ? null : actions,
columns: [
for (final head in widget.columnLabels.values)
DataColumn(
label: head,
)
],
return StreamBuilder(
stream: _query.snapshots(),
builder: (context, snapshot) {
return AggregateQueryBuilder(
query: _query.count(),
builder: (context, aggSsnapshot) {
return FirestoreQueryBuilder<Map<String, Object?>>(
query: _query,
builder: (context, snapshot, child) {
if (aggSsnapshot.hasData) {
source.setFromSnapshot(snapshot, aggSsnapshot.requireData);
} else {
source.setFromSnapshot(snapshot);
}

return AnimatedBuilder(
animation: source,
builder: (context, child) {
final actions = [
...?widget.actions,
if (widget.canDeleteItems &&
source._selectedRowIds.isNotEmpty)
IconButton(
icon: const Icon(Icons.delete),
onPressed: source.onDeleteSelectedItems,
),
];
return PaginatedDataTable(
source: source,
onSelectAll: selectionEnabled ? source.onSelectAll : null,
onPageChanged: widget.onPageChanged,
showCheckboxColumn: widget.showCheckboxColumn,
arrowHeadColor: widget.arrowHeadColor,
checkboxHorizontalMargin: widget.checkboxHorizontalMargin,
columnSpacing: widget.columnSpacing,
dataRowHeight: widget.dataRowHeight,
dragStartBehavior: widget.dragStartBehavior,
headingRowHeight: widget.headingRowHeight,
horizontalMargin: widget.horizontalMargin,
rowsPerPage: widget.rowsPerPage,
showFirstLastButtons: widget.showFirstLastButtons,
sortAscending: widget.sortAscending,
sortColumnIndex: widget.sortColumnIndex,
header: actions.isEmpty
? null
: (widget.header ?? const SizedBox()),
actions: actions.isEmpty ? null : actions,
columns: [
for (final head in widget.columnLabels.values)
DataColumn(label: head)
],
);
},
);
},
);
},
);
Expand Down Expand Up @@ -836,12 +849,16 @@ class _Source extends DataTableSource {
@override
int get selectedRowCount => _selectedRowIds.length;

AggregateQuerySnapshot? _aggregateSnapshot;

@override
bool get isRowCountApproximate =>
_previousSnapshot!.isFetching || _previousSnapshot!.hasMore;
_aggregateSnapshot?.count == null ||
(_previousSnapshot!.isFetching || _previousSnapshot!.hasMore);

@override
int get rowCount {
if (_aggregateSnapshot?.count != null) return _aggregateSnapshot!.count;
// Emitting an extra item during load or before reaching the end
// allows the DataTable to show a spinner during load & let the user
// navigate to next page
Expand Down Expand Up @@ -902,8 +919,16 @@ class _Source extends DataTableSource {
FirestoreQueryBuilderSnapshot<Map<String, Object?>>? _previousSnapshot;

void setFromSnapshot(
FirestoreQueryBuilderSnapshot<Map<String, Object?>> snapshot,
) {
FirestoreQueryBuilderSnapshot<Map<String, Object?>> snapshot, [
AggregateQuerySnapshot? aggregateSnapshot,
]) {
if (aggregateSnapshot != null) {
_aggregateSnapshot = aggregateSnapshot;
notifyListeners();
} else {
_aggregateSnapshot = null;
}

if (snapshot == _previousSnapshot) return;

// Try to preserve the selection status when the snapshot got updated,
Expand Down
26 changes: 26 additions & 0 deletions packages/firebase_ui_firestore/test/table_builder_test.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,23 @@ class Address {

class MockFirestore extends Mock implements FirebaseFirestore {}

class MockAggregateQuerySnapshot extends Mock
implements AggregateQuerySnapshot {
@override
int get count => 2;
}

class MockAggregateQuery extends Mock implements AggregateQuery {
@override
Future<AggregateQuerySnapshot> get({AggregateSource? source}) {
return super.noSuchMethod(
Invocation.method(#get, null),
returnValue: Future.value(MockAggregateQuerySnapshot()),
returnValueForMissingStub: Future.value(MockAggregateQuerySnapshot()),
);
}
}

class MockCollection extends Mock
implements CollectionReference<Map<String, Object?>> {
@override
Expand All @@ -342,6 +359,15 @@ class MockCollection extends Mock
);
}

@override
MockAggregateQuery count() {
return super.noSuchMethod(
Invocation.method(#count, null),
returnValue: MockAggregateQuery(),
returnValueForMissingStub: MockAggregateQuery(),
);
}

@override
Query<Map<String, Object?>> limit([int? limit]) {
return super.noSuchMethod(
Expand Down

0 comments on commit bf52bcc

Please sign in to comment.