JAVA-2635: Add restrictSearchWithMatch to GraphLookupOptions (#422)

fhassak · jyemin · commit e045c7597267 · 2017-11-08T17:49:27.000-05:00
diff --git a/docs/reference/content/builders/aggregation.md b/docs/reference/content/builders/aggregation.md
@@ -180,6 +180,14 @@ graphLookup("contacts", "$friends", "friends", "name", "socialNetwork",
 
 Using `GraphLookupOptions`, the output can be tailored to restrict the depth of the recursion as well to inject a field containing the depth of the recursion at which a document was included.
 
+The recursive search can be filtered by specifying additional conditions.
+
+```java
+graphLookup("contacts", "$friends", "friends", "name", "socialNetwork",
+	new GraphLookupOptions().maxDepth(1).restrictSearchWithMatch(Filters.eq("hobbies","golf"))
+```
+
+
 ### SortByCount
 
 The [`$sortByCount`]({{< docsref "reference/operator/aggregation/sortByCount/" >}}) stage groups documents by a given expression and then sorts these groups by count in descending order. The `sortByCount` outputs documents that contains an `_id` field, which contains the discrete values of the given expression, and the `count` field that contains the number of documents that fall into that group.
diff --git a/driver-core/src/main/com/mongodb/client/model/Aggregates.java b/driver-core/src/main/com/mongodb/client/model/Aggregates.java
@@ -580,6 +580,10 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> tDocumentC
             if (options.getDepthField() != null) {
                 writer.writeString("depthField", options.getDepthField());
             }
+            if (options.getRestrictSearchWithMatch() != null) {
+                writer.writeName("restrictSearchWithMatch");
+                BuildersHelper.encodeValue(writer, options.getRestrictSearchWithMatch(), codecRegistry);
+            }
 
             writer.writeEndDocument();
 
diff --git a/driver-core/src/main/com/mongodb/client/model/GraphLookupOptions.java b/driver-core/src/main/com/mongodb/client/model/GraphLookupOptions.java
@@ -16,6 +16,8 @@
 
 package com.mongodb.client.model;
 
+import org.bson.conversions.Bson;
+
 /**
  * The options for a graphLookup aggregation pipeline stage
  *
@@ -26,6 +28,7 @@
 public final class GraphLookupOptions {
     private Integer maxDepth;
     private String depthField;
+    private Bson restrictSearchWithMatch;
 
     /**
      * The name of the field in which to store the depth value
@@ -63,6 +66,26 @@ public Integer getMaxDepth() {
         return maxDepth;
     }
 
+    /**
+     * A document specifying additional conditions for the recursive search
+     *
+     * @param filter the filter expression
+     * @return this
+     * @since 3.6
+     */
+    public GraphLookupOptions restrictSearchWithMatch(final Bson filter) {
+        restrictSearchWithMatch = filter;
+        return this;
+    }
+
+    /**
+     * @return the filter expression
+     * @since 3.6
+     */
+    public Bson getRestrictSearchWithMatch() {
+        return restrictSearchWithMatch;
+    }
+
     @Override
     public String toString() {
         StringBuilder stringBuilder = new StringBuilder()
@@ -79,7 +102,16 @@ public String toString() {
             stringBuilder
                 .append("maxDepth=")
                 .append(maxDepth);
+            if (restrictSearchWithMatch != null) {
+                stringBuilder.append(", ");
+            }
+        }
+        if (restrictSearchWithMatch != null) {
+            stringBuilder
+                .append("restrictSearchWithMatch=")
+                .append(restrictSearchWithMatch);
         }
+
         return stringBuilder
             .append('}')
             .toString();
diff --git a/driver-core/src/test/functional/com/mongodb/client/model/AggregatesFunctionalSpecification.groovy b/driver-core/src/test/functional/com/mongodb/client/model/AggregatesFunctionalSpecification.groovy
@@ -52,6 +52,7 @@ import static com.mongodb.client.model.Aggregates.skip
 import static com.mongodb.client.model.Aggregates.sort
 import static com.mongodb.client.model.Aggregates.sortByCount
 import static com.mongodb.client.model.Aggregates.unwind
+import static com.mongodb.client.model.Filters.eq
 import static com.mongodb.client.model.Filters.exists
 import static com.mongodb.client.model.Projections.computed
 import static com.mongodb.client.model.Projections.exclude
@@ -339,7 +340,7 @@ class AggregatesFunctionalSpecification extends OperationFunctionalSpecification
     }
 
     @IgnoreIf({ !serverVersionAtLeast(3, 4) })
-    def '$graphLookup with options'() {
+    def '$graphLookup with depth options'() {
         given:
         def fromCollectionName = 'contacts'
         def fromHelper = getCollectionHelper(new MongoNamespace(getDatabaseName(), fromCollectionName))
@@ -379,6 +380,57 @@ class AggregatesFunctionalSpecification extends OperationFunctionalSpecification
         fromHelper?.drop()
     }
 
+    @IgnoreIf({ !serverVersionAtLeast(3, 4) })
+    def '$graphLookup with query filter option'() {
+        given:
+        def fromCollectionName = 'contacts'
+        def fromHelper = getCollectionHelper(new MongoNamespace(getDatabaseName(), fromCollectionName))
+
+        fromHelper.drop()
+
+        fromHelper.insertDocuments(
+            Document.parse('''{ _id: 0, name: "Bob Smith", friends: ["Anna Jones", "Chris Green"],
+                hobbies : ["tennis", "unicycling", "golf"] }'''),
+            Document.parse('''{ _id: 1, name: "Anna Jones", friends: ["Bob Smith", "Chris Green", "Joe Lee"],
+                 hobbies : ["archery", "golf", "woodworking"] }'''),
+            Document.parse('''{ _id: 2, name: "Chris Green", friends: ["Anna Jones", "Bob Smith"],
+                hobbies : ["knitting", "frisbee"] }'''),
+            Document.parse('''{ _id: 3, name: "Joe Lee", friends: ["Anna Jones", "Fred Brown"],
+                hobbies : [ "tennis", "golf", "topiary" ] }'''),
+            Document.parse('''{ _id: 4, name: "Fred Brown", friends: ["Joe Lee"],
+                hobbies : [ "travel", "ceramics", "golf" ] }'''))
+
+
+        def lookupDoc = graphLookup('contacts', new BsonString('$friends'), 'friends', 'name', 'golfers',
+                new GraphLookupOptions()
+                        .restrictSearchWithMatch(eq('hobbies', 'golf')))
+
+        when:
+        def results = fromHelper.aggregate([lookupDoc,
+                                            unwind('$golfers'),
+                                            sort(new Document('_id', 1)
+                                                    .append('golfers._id', 1))])
+
+        then:
+        results.subList(0, 4) == [
+                Document.parse('''{ _id: 0, name: "Bob Smith", friends: ["Anna Jones", "Chris Green"],
+                        hobbies : ["tennis", "unicycling", "golf"], golfers: {_id: 0, name: "Bob Smith",
+                        friends: ["Anna Jones", "Chris Green"], hobbies : ["tennis", "unicycling", "golf"] } }'''),
+                Document.parse('''{ _id: 0, name: "Bob Smith", friends: ["Anna Jones", "Chris Green"],
+                       hobbies: ["tennis", "unicycling", "golf"], golfers:{ _id: 1, name: "Anna Jones",
+                       friends: ["Bob Smith", "Chris Green", "Joe Lee"], hobbies : ["archery", "golf", "woodworking"] } } }'''),
+                Document.parse('''{ _id: 0, name: "Bob Smith", friends: ["Anna Jones", "Chris Green"],
+                       hobbies: ["tennis", "unicycling", "golf"], golfers: { _id: 3, name: "Joe Lee",
+                       friends: ["Anna Jones", "Fred Brown"], hobbies : [ "tennis", "golf", "topiary" ] } }'''),
+                Document.parse('''{ _id: 0, name: "Bob Smith", friends: ["Anna Jones", "Chris Green"],
+                       hobbies: ["tennis", "unicycling", "golf"], golfers:{ _id: 4, name: "Fred Brown", friends: ["Joe Lee"],
+                       hobbies : [ "travel", "ceramics", "golf" ] } }''')
+        ]
+
+        cleanup:
+        fromHelper?.drop()
+    }
+
     @IgnoreIf({ !serverVersionAtLeast(3, 4) })
     def '$bucket'() {
         given:
diff --git a/driver-core/src/test/unit/com/mongodb/client/model/AggregatesSpecification.groovy b/driver-core/src/test/unit/com/mongodb/client/model/AggregatesSpecification.groovy
@@ -233,21 +233,38 @@ class AggregatesSpecification extends Specification {
 
     def 'should render $graphLookup'() {
         expect:
+        //without options
         toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork')) ==
         parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
             as: "socialNetwork" } }''')
+
+        //with maxDepth
         toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork', new GraphLookupOptions().maxDepth(1))) ==
         parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
             as: "socialNetwork", maxDepth: 1 } }''')
+
+        // with depthField
+        toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork', new GraphLookupOptions().depthField('master'))) ==
+                parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
+            as: "socialNetwork", depthField: "master" } }''')
+
+        // with restrictSearchWithMatch
         toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork', new GraphLookupOptions()
-                .maxDepth(1)
-                .depthField('master'))) ==
+                .restrictSearchWithMatch(Filters.eq('hobbies', 'golf')))) ==
+                parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
+            as: "socialNetwork", restrictSearchWithMatch : { "hobbies" : "golf" } } }''')
+
+        // with maxDepth and depthField
+        toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork', new GraphLookupOptions()
+                .maxDepth(1).depthField('master'))) ==
         parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
             as: "socialNetwork", maxDepth: 1, depthField: "master" } }''')
+
+        // with all options
         toBson(graphLookup('contacts', '$friends', 'friends', 'name', 'socialNetwork', new GraphLookupOptions()
-                .depthField('master'))) ==
-        parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
-            as: "socialNetwork", depthField: "master" } }''')
+                .maxDepth(1).depthField('master').restrictSearchWithMatch(Filters.eq('hobbies', 'golf')))) ==
+                parse('''{ $graphLookup: { from: "contacts", startWith: "$friends", connectFromField: "friends", connectToField: "name",
+            as: "socialNetwork", maxDepth: 1, depthField: "master", restrictSearchWithMatch : { "hobbies" : "golf" } } }''')
     }
 
     def 'should render $skip'() {
diff --git a/driver-core/src/test/unit/com/mongodb/client/model/GraphLookupOptionsSpecification.groovy b/driver-core/src/test/unit/com/mongodb/client/model/GraphLookupOptionsSpecification.groovy
@@ -18,15 +18,19 @@ package com.mongodb.client.model
 
 import spock.lang.Specification
 
+import static org.bson.BsonDocument.parse
+
 class GraphLookupOptionsSpecification extends Specification {
     def "should return new options with the same property values"() {
         when:
         def options = new GraphLookupOptions()
                 .maxDepth(10)
                 .depthField('field')
+                .restrictSearchWithMatch(parse('{x : 1}'))
 
         then:
         options.maxDepth == 10
         options.depthField == 'field'
+        options.restrictSearchWithMatch == parse('{x : 1}')
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -580,6 +580,10 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> tDocumentC`
`580`	`580`	`if (options.getDepthField() != null) {`
`581`	`581`	`writer.writeString("depthField", options.getDepthField());`
`582`	`582`	`}`
	`583`	`+ if (options.getRestrictSearchWithMatch() != null) {`
	`584`	`+ writer.writeName("restrictSearchWithMatch");`
	`585`	`+ BuildersHelper.encodeValue(writer, options.getRestrictSearchWithMatch(), codecRegistry);`
	`586`	`+ }`
`583`	`587`
`584`	`588`	`writer.writeEndDocument();`
`585`	`589`