Skip to content
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

fix: json patch throw error when remove null property [DHIS2-16299] (38) #15924

Merged
merged 2 commits into from
Dec 13, 2023
Merged

fix: json patch throw error when remove null property [DHIS2-16299] (38) #15924

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
a083747
fix: json patch throw error when remove null property
vietnguyen Dec 12, 2023
337249e
fix backport conflict
vietnguyen Dec 13, 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
16 changes: 16 additions & 0 deletions ...is-services/dhis-service-core/src/main/java/org/hisp/dhis/jsonpatch/JsonPatchManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import org.hisp.dhis.commons.collection.CollectionUtils;
import org.hisp.dhis.commons.jackson.jsonpatch.JsonPatch;
import org.hisp.dhis.commons.jackson.jsonpatch.JsonPatchException;
import org.hisp.dhis.commons.jackson.jsonpatch.JsonPatchOperation;
import org.hisp.dhis.schema.Property;
import org.hisp.dhis.schema.Schema;
import org.hisp.dhis.schema.SchemaService;
Expand Down Expand Up @@ -87,6 +88,8 @@ public <T> T apply(JsonPatch patch, T object) throws JsonPatchException {
// correctly made into json nodes.
handleCollectionUpdates(object, schema, (ObjectNode) node);

validatePatchPath(patch, schema);

node = patch.apply(node);
return (T)
jsonToObject(
Expand Down Expand Up @@ -137,4 +140,17 @@ private BaseIdentifiableObject shallowCopyIdentifiableObject(BaseIdentifiableObj
clone.setUid(source.getUid());
return clone;
}

/** Check if all patch paths are valid for the given schema. */
private void validatePatchPath(JsonPatch patch, Schema schema) throws JsonPatchException {
for (JsonPatchOperation op : patch.getOperations()) {
if (!schema.haveProperty(op.getPath().getMatchingProperty())) {
throw new JsonPatchException(
"Property "
+ op.getPath().getMatchingProperty()
+ " does not exist on "
+ schema.getClass().getSimpleName());
}
}
}
}
68 changes: 68 additions & 0 deletions ...ervices/dhis-service-core/src/test/java/org/hisp/dhis/jsonpatch/JsonPatchManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand All @@ -42,6 +43,7 @@
import org.hisp.dhis.dataelement.DataElement;
import org.hisp.dhis.dataelement.DataElementGroup;
import org.hisp.dhis.user.User;
import org.hisp.dhis.user.UserRole;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;

Expand Down Expand Up @@ -198,4 +200,70 @@ void testAddAndRemoveSharingUser() throws JsonProcessingException, JsonPatchExce
DataElement removedPatchedDE = jsonPatchManager.apply(removePatch, patchedDE);
assertEquals(0, removedPatchedDE.getSharing().getUsers().size());
}

@Test
void testReplaceNullProperty() throws JsonProcessingException, JsonPatchException {
UserRole userRole = createUserRole("test", "ALL");
userRole.setCode(null);
manager.save(userRole);
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"replace\", \"path\": \"/code\", \"value\": \"updated\"}" + "]",
JsonPatch.class);
assertNotNull(patch);
UserRole patchedUserRole = jsonPatchManager.apply(patch, userRole);
assertEquals("updated", patchedUserRole.getCode());
}

@Test
void testReplaceNotExistProperty() throws JsonProcessingException {
UserRole userRole = createUserRole("test", "ALL");
userRole.setCode(null);
manager.save(userRole);
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"replace\", \"path\": \"/notexist\", \"value\": \"updated\"}" + "]",
JsonPatch.class);
assertNotNull(patch);
assertThrows(JsonPatchException.class, () -> jsonPatchManager.apply(patch, userRole));
}

@Test
void testAddNotExistProperty() throws JsonProcessingException {
UserRole userRole = createUserRole("test", "ALL");
userRole.setCode(null);
manager.save(userRole);
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"add\", \"path\": \"/notexist\", \"value\": \"updated\"}" + "]",
JsonPatch.class);
assertNotNull(patch);
assertThrows(JsonPatchException.class, () -> jsonPatchManager.apply(patch, userRole));
}

@Test
void testRemoveNotExistProperty() throws JsonProcessingException {
UserRole userRole = createUserRole("test", "ALL");
userRole.setCode(null);
manager.save(userRole);
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"remove\", \"path\": \"/notexist\", \"value\": \"updated\"}" + "]",
JsonPatch.class);
assertNotNull(patch);
assertThrows(JsonPatchException.class, () -> jsonPatchManager.apply(patch, userRole));
}

@Test
void testRemoveByIdNotExistProperty() throws JsonProcessingException {
UserRole userRole = createUserRole("test", "ALL");
userRole.setCode(null);
manager.save(userRole);
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"remove\", \"path\": \"/notexist\", \"id\": \"uid\"}" + "]",
JsonPatch.class);
assertNotNull(patch);
assertThrows(JsonPatchException.class, () -> jsonPatchManager.apply(patch, userRole));
}
}
13 changes: 0 additions & 13 deletions ...dhis-support-commons/src/test/java/org/hisp/dhis/commons/jackson/RemoveOperationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
Expand All @@ -55,17 +53,6 @@ class RemoveOperationTest {
private final ObjectMapper jsonMapper = JacksonObjectMapperConfig.staticJsonMapper();

@Disabled("for now we will allow 'removal' of invalid path keys")
@Test
void testRemoveInvalidKeyShouldThrowException() throws JsonProcessingException {
JsonPatch patch =
jsonMapper.readValue(
"[" + "{\"op\": \"remove\", \"path\": \"/aaa\"}" + "]", JsonPatch.class);
assertNotNull(patch);
JsonNode root = jsonMapper.createObjectNode();
assertFalse(root.has("aaa"));
assertThrows(JsonPatchException.class, () -> patch.apply(root));
}

@Test
void testRemoveProperty() throws JsonProcessingException, JsonPatchException {
JsonPatch patch =
Expand Down