Merge pull request #139 from jodinathan/master

adding the cursor option to aggregate
mongo-dart · Dec 19, 2018 · 6e59aa3 · 6e59aa3
2 parents 181472e + 64aaf1f
commit 6e59aa3
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 9 deletions.
diff --git a/lib/src/database/dbcollection.dart b/lib/src/database/dbcollection.dart
@@ -126,9 +126,9 @@ class DbCollection {
           db, collectionName, field, _selectorBuilder2Map(selector)));
 
   Future<Map<String, dynamic>> aggregate(List pipeline,
-      {bool allowDiskUse: false}) {
+      {bool allowDiskUse: false, Map<String, dynamic> cursor}) {
     var cmd = DbCommand.createAggregateCommand(db, collectionName, pipeline,
-        allowDiskUse: allowDiskUse);
+        allowDiskUse: allowDiskUse, cursor: cursor);
     return db.executeDbCommand(cmd);
   }
 

diff --git a/lib/src/database/dbcommand.dart b/lib/src/database/dbcommand.dart
@@ -164,9 +164,11 @@ class DbCommand extends MongoQueryMessage {
 
   static DbCommand createAggregateCommand(
       Db db, String collectionName, List pipeline,
-      {bool allowDiskUse: false}) {
+      {bool allowDiskUse: false, Map<String, dynamic> cursor}) {
     var query = {'aggregate': collectionName, 'pipeline': pipeline};
 
+    if (cursor != null) query['cursor'] = cursor;
+
     if (db._masterConnection.serverCapabilities.aggregationCursor) {
       query["allowDiskUse"] = allowDiskUse;
     }

diff --git a/test/authentication_test.dart b/test/authentication_test.dart
@@ -41,12 +41,10 @@ main() {
       err = e;
     }
 
-    bool result = (
-      (err['ok'] == expectedError['ok']) &&
-      (err['errmsg'] == expectedError['errmsg']) &&
-      (err['code'] == expectedError['code']) &&
-      (err['codeName'] == expectedError['codeName'])
-    );
+    bool result = ((err['ok'] == expectedError['ok']) &&
+        (err['errmsg'] == expectedError['errmsg']) &&
+        (err['code'] == expectedError['code']) &&
+        (err['codeName'] == expectedError['codeName']));
 
     expect(result, true);
   });

diff --git a/test/database_test.dart b/test/database_test.dart
@@ -376,6 +376,97 @@ db.runCommand(
   expect(result[0]["avgRating"], 3);
 }
 
+Future testAggregateWithCursor() async {
+  String collectionName = getRandomCollectionName();
+  var collection = db.collection(collectionName);
+
+  List<Map<String, dynamic>> toInsert = [];
+
+  // Avg 1 with 1 rating
+  toInsert.add({
+    "game": "At the Gates of Loyang",
+    "player": "Dallas",
+    "rating": 1,
+    "v": 1
+  });
+
+  // Avg 3 with 1 rating
+  toInsert.add({"game": "Age of Steam", "player": "Paul", "rating": 3, "v": 1});
+
+  // Avg 2 with 2 ratings
+  toInsert.add({"game": "Fresco", "player": "Erin", "rating": 3, "v": 1});
+  toInsert.add({"game": "Fresco", "player": "Dallas", "rating": 1, "v": 1});
+
+  // Avg 3.5 with 4 ratings
+  toInsert
+      .add({"game": "Ticket To Ride", "player": "Paul", "rating": 4, "v": 1});
+  toInsert
+      .add({"game": "Ticket To Ride", "player": "Erin", "rating": 5, "v": 1});
+  toInsert
+      .add({"game": "Ticket To Ride", "player": "Dallas", "rating": 4, "v": 1});
+  toInsert.add(
+      {"game": "Ticket To Ride", "player": "Anthony", "rating": 2, "v": 1});
+
+  // Avg 4.5 with 4 ratings (counting only highest v)
+  toInsert.add({"game": "Dominion", "player": "Paul", "rating": 5, "v": 2});
+  toInsert.add({"game": "Dominion", "player": "Erin", "rating": 4, "v": 1});
+  toInsert.add({"game": "Dominion", "player": "Dallas", "rating": 4, "v": 1});
+  toInsert.add({"game": "Dominion", "player": "Anthony", "rating": 5, "v": 1});
+
+  // Avg 5 with 2 ratings
+  toInsert.add({"game": "Pandemic", "player": "Erin", "rating": 5, "v": 1});
+  toInsert.add({"game": "Pandemic", "player": "Dallas", "rating": 5, "v": 1});
+
+  await collection.insertAll(toInsert);
+
+  // Avg player ratings
+  // Dallas = 3, Anthony 3.5, Paul = 4, Erin = 4.25
+/* We want equivalent of this when used on the mongo shell.
+ * (Should be able to just copy and paste below once test is run and failed once)
+db.runCommand(
+{ aggregate : "testAggregate", pipeline : [
+{"$group": {
+      "_id": { "game": "$game", "player": "$player" },
+      "rating": { "$sum": "$rating" } } },
+{"$group": {
+        "_id": "$_id.game",
+        "avgRating": { "$avg": "$rating" } } },
+{ "$sort": { "_id": 1 } }
+]});
+ */
+  List pipeline = new List();
+  var p1 = {
+    "\$group": {
+      "_id": {"game": "\$game", "player": "\$player"},
+      "rating": {"\$sum": "\$rating"}
+    }
+  };
+  var p2 = {
+    "\$group": {
+      "_id": "\$_id.game",
+      "avgRating": {"\$avg": "\$rating"}
+    }
+  };
+  var p3 = {
+    "\$sort": {"_id": 1}
+  };
+
+  pipeline.add(p1);
+  pipeline.add(p2);
+  pipeline.add(p3);
+
+  expect(p1["\u0024group"], isNotNull);
+  expect(p1["\$group"], isNotNull);
+
+  var v = await collection.aggregate(pipeline, cursor: {'batchSize': 3});
+  Map cursor = v['cursor'];
+  expect(cursor['id'], const TypeMatcher<int>());
+  expect(cursor['firstBatch'], allOf(const TypeMatcher<List>(), hasLength(3)));
+  List firstBatch = cursor['firstBatch'];
+  expect(firstBatch[0]["_id"], "Age of Steam");
+  expect(firstBatch[0]["avgRating"], 3);
+}
+
 Future testAggregateToStream() async {
   String collectionName = getRandomCollectionName();
   var collection = db.collection(collectionName);
@@ -1233,6 +1324,7 @@ main() {
 
     group('Aggregate:', () {
       test('testAggregate', testAggregate);
+      test('testAggregateWithCursor', testAggregateWithCursor);
       test(
           'testAggregateToStream - if server older then version 2.6 test would be skipped',
           testAggregateToStream);