Skip to content

Fix string to objectId mapping error when using query method. #4519

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

Closed
wants to merge 2 commits into from
Closed

Fix string to objectId mapping error when using query method. #4519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcb6124
Fix string to objectId mapping error when using query method.
grwang91 Oct 4, 2023
37c53bc
added author
grwang91 Oct 4, 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
71 changes: 40 additions & 31 deletions ...data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
* @author Mark Paluch
* @author David Julia
* @author Divya Srivastava
* @author Gyungrai Wang
*/
public class QueryMapper {

Expand Down Expand Up @@ -459,44 +460,18 @@ public <T> T getPropertyValue(MongoPersistentProperty property) {
}

if (documentField.isIdField() && !documentField.isAssociation()) {

if (isDBObject(value)) {
DBObject valueDbo = (DBObject) value;
Document resultDbo = new Document(valueDbo.toMap());

if (valueDbo.containsField("$in") || valueDbo.containsField("$nin")) {
String inKey = valueDbo.containsField("$in") ? "$in" : "$nin";
List<Object> ids = new ArrayList<>();
for (Object id : (Iterable<?>) valueDbo.get(inKey)) {
ids.add(convertId(id, getIdTypeForField(documentField)));
}
resultDbo.put(inKey, ids);
} else if (valueDbo.containsField("$ne")) {
resultDbo.put("$ne", convertId(valueDbo.get("$ne"), getIdTypeForField(documentField)));
} else {
return getMappedObject(resultDbo, Optional.empty());
}
return resultDbo;
Document valueDbo = new Document(((DBObject) value).toMap());
Document resultDbo = new Document(valueDbo);

return convertIdField(valueDbo, resultDbo, documentField);
}

else if (isDocument(value)) {
Document valueDbo = (Document) value;
Document resultDbo = new Document(valueDbo);

if (valueDbo.containsKey("$in") || valueDbo.containsKey("$nin")) {
String inKey = valueDbo.containsKey("$in") ? "$in" : "$nin";
List<Object> ids = new ArrayList<>();
for (Object id : (Iterable<?>) valueDbo.get(inKey)) {
ids.add(convertId(id, getIdTypeForField(documentField)));
}
resultDbo.put(inKey, ids);
} else if (valueDbo.containsKey("$ne")) {
resultDbo.put("$ne", convertId(valueDbo.get("$ne"), getIdTypeForField(documentField)));
} else {
return getMappedObject(resultDbo, Optional.empty());
}
return resultDbo;

return convertIdField(valueDbo, resultDbo, documentField);
} else {
return convertId(value, getIdTypeForField(documentField));
}
Expand All @@ -517,10 +492,44 @@ else if (isDocument(value)) {
return convertSimpleOrDocument(value, documentField.getPropertyEntity());
}

private Document convertIdField(Document valueDbo, Document resultDbo, Field documentField) {
if (valueDbo.containsKey("$in") || valueDbo.containsKey("$nin")) {
String inKey = valueDbo.containsKey("$in") ? "$in" : "$nin";
List<Object> ids = new ArrayList<>();
for (Object id : (Iterable<?>) valueDbo.get(inKey)) {
ids.add(convertId(id, getIdTypeForField(documentField)));
}
resultDbo.put(inKey, ids);
} else if (valueDbo.containsKey("$ne")) {
resultDbo.put("$ne", convertId(valueDbo.get("$ne"), getIdTypeForField(documentField)));
} else if (containsCompareOperator(valueDbo)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious if we need to explicitly check on the presence of certain keys here. What might also work would be to check if the key is a keyword and then call convertIdField with the value.

private Object convertIdField(Field documentField, Object source) {

    // ... logic for $in,...

    for(Entry<String,Object> entry : valueDbo.entrySet()) {
        if(isKeyword(entry.getKey())) {
            resultDbo.put(entry.getKey(), convertIdField(documentField, entry.getValue()));
        } else {
            resultDbo.put(entry.getKey(), getMappedValue(documentField, entry.getValue()));
        }
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for suggestion. I will apply it!

if (valueDbo.containsKey("$gt")) {
resultDbo.put("$gt", convertId(valueDbo.get("$gt"), getIdTypeForField(documentField)));
}
if (valueDbo.containsKey("$gte")) {
resultDbo.put("$gte", convertId(valueDbo.get("$gte"), getIdTypeForField(documentField)));
}
if (valueDbo.containsKey("$lt")) {
resultDbo.put("$lt", convertId(valueDbo.get("$lt"), getIdTypeForField(documentField)));
}
if (valueDbo.containsKey("$lte")) {
resultDbo.put("$lte", convertId(valueDbo.get("$lte"), getIdTypeForField(documentField)));
}
} else {
return getMappedObject(resultDbo, Optional.empty());
}
return resultDbo;
}

private boolean isIdField(Field documentField) {
return documentField.getProperty() != null && documentField.getProperty().isIdProperty();
}

private boolean containsCompareOperator(Document document) {
return document.containsKey("$gt") || document.containsKey("$gte") || document.containsKey("$lt")
|| document.containsKey("$lte");
}

private Class<?> getIdTypeForField(Field documentField) {
return isIdField(documentField) ? documentField.getProperty().getFieldType() : ObjectId.class;
}
Expand Down
75 changes: 75 additions & 0 deletions ...odb/src/test/java/org/springframework/data/mongodb/core/convert/QueryMapperUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
* @author Christoph Strobl
* @author Mark Paluch
* @author David Julia
* @author Gyungrai Wang
*/
public class QueryMapperUnitTests {

Expand Down Expand Up @@ -127,6 +128,80 @@ void handlesObjectIdCapableBigIntegerIdsCorrectly() {
assertThat(result).containsEntry("_id", id);
}

@Test // ISSUE-4490
void translates$GtCorrectly() {

Criteria criteria = where("id").gt(new ObjectId().toString());

org.bson.Document query = new org.bson.Document("id", new ObjectId().toString());
org.bson.Document result = mapper.getMappedObject(criteria.getCriteriaObject(),
context.getPersistentEntity(IdWrapper.class));
Object object = result.get("_id");
assertThat(object).isInstanceOf(org.bson.Document.class);
org.bson.Document document = (org.bson.Document) object;
assertThat(document.get("$gt")).isInstanceOf(ObjectId.class);
}

@Test // ISSUE-4490
void translates$GteCorrectly() {

Criteria criteria = where("id").gte(new ObjectId().toString());

org.bson.Document query = new org.bson.Document("id", new ObjectId().toString());
org.bson.Document result = mapper.getMappedObject(criteria.getCriteriaObject(),
context.getPersistentEntity(IdWrapper.class));
Object object = result.get("_id");
assertThat(object).isInstanceOf(org.bson.Document.class);
org.bson.Document document = (org.bson.Document) object;
assertThat(document.get("$gte")).isInstanceOf(ObjectId.class);
}

@Test // ISSUE-4490
void translates$LteCorrectly() {

Criteria criteria = where("id").lte(new ObjectId().toString());

org.bson.Document query = new org.bson.Document("id", new ObjectId().toString());
org.bson.Document result = mapper.getMappedObject(criteria.getCriteriaObject(),
context.getPersistentEntity(IdWrapper.class));
Object object = result.get("_id");
assertThat(object).isInstanceOf(org.bson.Document.class);
org.bson.Document document = (org.bson.Document) object;
assertThat(document.get("$lte")).isInstanceOf(ObjectId.class);
}

@Test // ISSUE-4490
void translates$LtCorrectly() {

Criteria criteria = where("id").lt(new ObjectId().toString());

org.bson.Document query = new org.bson.Document("id", new ObjectId().toString());
org.bson.Document result = mapper.getMappedObject(criteria.getCriteriaObject(),
context.getPersistentEntity(IdWrapper.class));
Object object = result.get("_id");
assertThat(object).isInstanceOf(org.bson.Document.class);
org.bson.Document document = (org.bson.Document) object;
assertThat(document.get("$lt")).isInstanceOf(ObjectId.class);
}

@Test // ISSUE-4490
void translatesMultipleCompareOperatorsCorrectly() {

Criteria criteria = where("id").lt(new ObjectId().toString()).lte(new ObjectId().toString())
.gt(new ObjectId().toString()).gte(new ObjectId().toString());

org.bson.Document query = new org.bson.Document("id", new ObjectId().toString());
org.bson.Document result = mapper.getMappedObject(criteria.getCriteriaObject(),
context.getPersistentEntity(IdWrapper.class));
Object object = result.get("_id");
assertThat(object).isInstanceOf(org.bson.Document.class);
org.bson.Document document = (org.bson.Document) object;
assertThat(document.get("$lt")).isInstanceOf(ObjectId.class);
assertThat(document.get("$lte")).isInstanceOf(ObjectId.class);
assertThat(document.get("$gt")).isInstanceOf(ObjectId.class);
assertThat(document.get("$gte")).isInstanceOf(ObjectId.class);
}

@Test // DATAMONGO-278
void translates$NeCorrectly() {

Expand Down