BasicQuery.fields().include() doesn't stick, even though Query.fields().include() does [DATAMONGO-1387]

[spring-projects-issues]

John W opened DATAMONGO-1387 and commented

I am attempting to use BasicQuery with a defined list of fields. It appears that the fields list is being ignored.

String queryString = ... // json-formatted string
Query query = new BasicQuery(queryString);
query.fields().include("myField");
final List<MyObject> results = mongoOps.find(query, MyObject.class);
// MyObject includes all fields, not just myField

I was digging through the source and it looks like org.springframework.data.mongodb.core.query.Query and org.springframework.data.mongodb.core.query.BasicQuery do things a little differently. Query defines fields() and BasicQuery does not, but getFieldsObject is different in the two implementations.

public DBObject getFieldsObject() {
     return this.fieldSpec == null ? null : fieldSpec.getFieldsObject();
}

public DBObject getFieldsObject() {
     return fieldsObject;
}

It looks like when I use BasicQuery.fields() it does successfully create a fieldspec in the object. But later, when I pass that BasicQuery object into MongoOps, it calls query.getFieldsObject() and it's null, because I never set an explicit fieldsObject.

Am I using BasicQuery incorrectly? I am not clear why BasicQuery needs to override getFieldsObject as the behavior in the parent class seems to be the one that you'd want.

Thanks!

---

Affects: 1.8.2 (Gosling SR2)

Referenced from: commits 7b29a87, ece655f, 6e45386, 2354b66, 06bc4fd, 119692c, f36baf2, aa5bdcd

Backported to: 1.8.4 (Gosling SR4), 1.7.3 (Fowler SR3)

[spring-projects-issues]

Christoph Strobl commented

good catch! thanks. will take care

[spring-projects-issues]

John W commented

I would be happy to submit a merge request :)

[spring-projects-issues]

Christoph Strobl commented

John W that would be great. Please do not forget to sign the Contributors License Agreement and add your CLA Number to the PR. Thanks!

[spring-projects-issues]

John W commented

Pull request submitted. Go easy on me, first time pushing to Spring :)

#345

[spring-projects-issues]

John W commented

Hi - quick question on this fix. It's tagged as 1.8.4 and 1.9.1 above, but it does not appear to be in 1.8.4 and appears to be in 1.9.0.

Here is the 1.8.4.RELEASE tag, with what looks like the old getFieldsObject
https://github.com/spring-projects/spring-data-mongodb/blob/1.8.4.RELEASE/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/BasicQuery.java

Here is the 1.8.x branch, with the fix for this issue
https://github.com/spring-projects/spring-data-mongodb/blob/1.8.x/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/BasicQuery.java

Here is the 1.9.0.RELEASE tag, with the fix for this issue
https://github.com/spring-projects/spring-data-mongodb/blob/1.9.0.RELEASE/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/BasicQuery.java

Here is the 1.9.1.RELEASE tag, also with the fix for this issue
https://github.com/spring-projects/spring-data-mongodb/blob/1.9.1.RELEASE/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/BasicQuery.java

Thanks!