Skip to content

RESTWS-979 - Custom representations are not parsed correctly #655

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

Merged
merged 2 commits into from
May 7, 2025
Merged

RESTWS-979 - Custom representations are not parsed correctly #655

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fdc27a
RESTWS-979 - Custom representations are not parsed correctly
mseaton May 7, 2025
3741f4b
Update omod-common/src/main/java/org/openmrs/module/webservices/rest/…
ibacher May 7, 2025
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
55 changes: 55 additions & 0 deletions omod-1.9/src/test/java/org/openmrs/module/webservices/rest/web/ConversionUtil1_9Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,30 @@
import org.openmrs.Drug;
import org.openmrs.Encounter;
import org.openmrs.Obs;
import org.openmrs.api.ConceptService;
import org.openmrs.module.webservices.rest.SimpleObject;
import org.openmrs.module.webservices.rest.web.representation.CustomRepresentation;
import org.openmrs.module.webservices.rest.web.representation.Representation;
import org.openmrs.module.webservices.rest.web.resource.impl.DelegatingResourceDescription;
import org.openmrs.module.webservices.rest.web.v1_0.resource.openmrs1_8.EncounterResource1_8;
import org.openmrs.web.test.BaseModuleWebContextSensitiveTest;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.List;

import static org.hamcrest.core.Is.is;
import static org.hibernate.validator.util.Contracts.assertNotNull;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.openmrs.module.webservices.rest.web.representation.Representation.DEFAULT;
import static org.openmrs.module.webservices.rest.web.representation.Representation.REF;

public class ConversionUtil1_9Test extends BaseModuleWebContextSensitiveTest {

@Autowired
ConceptService conceptService;

@Test
public void convertToRepresentation_shouldConvertObsDrugValueAsNull() {
Expand Down Expand Up @@ -82,4 +91,50 @@ public void convertToRepresentation_shouldConvertObsDrugValueAsNull() {
}

}

@Test
public void convert_shouldConvertObjectWithNestedCustomRepresentations() {
String customRep = "(concepts:(creator:(person:(uuid),username),datatype:ref,uuid))";
DelegatingResourceDescription fullDesc = ConversionUtil.getCustomRepresentationDescription(new CustomRepresentation(customRep));
assertThat(fullDesc.getProperties().size(), is(1));
DelegatingResourceDescription.Property conceptsProperty = fullDesc.getProperties().get("concepts");
assertNotNull(conceptsProperty);
assertCustomRepresentation(conceptsProperty.getRep(), "(creator:(person:(uuid),username),datatype:ref,uuid)");

DelegatingResourceDescription conceptDesc = ConversionUtil.getCustomRepresentationDescription((CustomRepresentation) conceptsProperty.getRep());
assertThat(conceptDesc.getProperties().size(), is(3));
DelegatingResourceDescription.Property creatorProperty = conceptDesc.getProperties().get("creator");
assertNotNull(creatorProperty);
assertCustomRepresentation(creatorProperty.getRep(), "(person:(uuid),username)");

DelegatingResourceDescription creatorDesc = ConversionUtil.getCustomRepresentationDescription((CustomRepresentation) creatorProperty.getRep());
assertThat(creatorDesc.getProperties().size(), is(2));
DelegatingResourceDescription.Property personProperty = creatorDesc.getProperties().get("person");
assertNotNull(personProperty);

DelegatingResourceDescription.Property usernameProperty = creatorDesc.getProperties().get("username");
assertNotNull(usernameProperty);
assertEquals(DEFAULT, usernameProperty.getRep());

DelegatingResourceDescription personDesc = ConversionUtil.getCustomRepresentationDescription((CustomRepresentation) personProperty.getRep());
assertThat(personDesc.getProperties().size(), is(1));
DelegatingResourceDescription.Property personUuidProperty = personDesc.getProperties().get("uuid");
assertNotNull(personUuidProperty);
assertEquals(DEFAULT, personUuidProperty.getRep());

DelegatingResourceDescription.Property datatypeProperty = conceptDesc.getProperties().get("datatype");
assertNotNull(datatypeProperty);
assertEquals(REF, datatypeProperty.getRep());

DelegatingResourceDescription.Property uuidProperty = conceptDesc.getProperties().get("uuid");
assertNotNull(uuidProperty);
assertEquals(DEFAULT, uuidProperty.getRep());
}

public void assertCustomRepresentation(Representation representation, String rep) {
assertNotNull(representation);
assertTrue(representation instanceof CustomRepresentation);
CustomRepresentation customRepresentation = (CustomRepresentation) representation;
assertEquals(rep, customRepresentation.getRepresentation());
}
}
128 changes: 61 additions & 67 deletions omod-common/src/main/java/org/openmrs/module/webservices/rest/web/ConversionUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,6 @@
*/
package org.openmrs.module.webservices.rest.web;

import java.lang.reflect.Array;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand All @@ -53,6 +33,30 @@
import org.openmrs.util.HandlerUtil;
import org.openmrs.util.LocaleUtility;

import java.lang.reflect.Array;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import static org.openmrs.module.webservices.rest.web.representation.Representation.DEFAULT;
import static org.openmrs.module.webservices.rest.web.representation.Representation.FULL;
import static org.openmrs.module.webservices.rest.web.representation.Representation.REF;

public class ConversionUtil {

static final Log log = LogFactory.getLog(ConversionUtil.class);
Expand Down Expand Up @@ -539,56 +543,46 @@ public static DelegatingResourceDescription getCustomRepresentationDescription(C
String def = representation.getRepresentation();
def = def.startsWith("(") ? def.substring(1) : def;
def = def.endsWith(")") ? def.substring(0, def.length() - 1) : def;
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know where this original code came from - I am shown on the blame in github, but I have no recollection writing this and it doesn't look like my style, so I probably moved it from somewhere and that history is lost.

In any event, this seems to work in some cases (obviously it must), but does not work for certain combinations of nested properties. As can be seen below, the original parsing was pretty brittle, splitting on commas even though commas can be used to separate fields both at the top level and within nested objects, and the code is not resilient to all cases.

Copy link
Member

Choose a reason for hiding this comment

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

I think from the history, you moved it into this class pretty much wholesale from BaseDelegatingResource The bulk of the code is from the initial implementation and then this support for nested properties.

String[] fragments = def.split(",");
for (int i = 0; i < fragments.length; i++) {
String[] field = fragments[i].split(":"); //split into field and representation
if (field.length == 1) {
if (!field[0].equals("links"))
desc.addProperty(field[0]);
if (field[0].equals("links")) {

int startIndex = 0;
List<String> properties = new ArrayList<String>();
int nestingLevel = 0;
for (int i=0; i<def.length(); i++) {
char c = def.charAt(i);
if (c == '(') {
nestingLevel++;
}
else if (c == ')') {
nestingLevel--;
}
else if (c == ',' && nestingLevel == 0) {
properties.add(def.substring(startIndex, i));
startIndex = i + 1;
}
}
properties.add(def.substring(startIndex));

for (String propertyDefinition : properties) {
if (propertyDefinition.contains(":")) {
String[] propertyAndRepresentation = propertyDefinition.split(":", 2);
String property = propertyAndRepresentation[0];
String rep = propertyAndRepresentation[1];
Representation r;
if (rep.startsWith("(")) {
r = new CustomRepresentation(rep);
}
else {
r = rep.equalsIgnoreCase("REF") ? REF : rep.equalsIgnoreCase("FULL") ? FULL : DEFAULT;
}
desc.addProperty(property, r);
}
else {
if (propertyDefinition.equals("links")) {
desc.addSelfLink();
desc.addLink("default", ".?v=" + RestConstants.REPRESENTATION_DEFAULT);
}
} else {
String property = field[0];
String rep = field[1];

// if custom representation
if (rep.startsWith("(")) {
StringBuilder customRep = new StringBuilder();
customRep.append(rep);
if (!rep.endsWith(")")) {
for (int j = 2; j < field.length; j++) {
customRep.append(":").append(field[j]);
}
int open = 1;
for (i = i + 1; i < fragments.length; i++) {
for (char fragment : fragments[i].toCharArray()) {
if (fragment == '(') {
open++;
} else if (fragment == ')') {
open--;
}
}

customRep.append(",");
customRep.append(fragments[i]);

if (open == 0) {
break;
}
}
}
desc.addProperty(property, new CustomRepresentation(customRep.toString()));
} else {
rep = rep.toUpperCase(); //normalize
if (rep.equals("REF")) {
desc.addProperty(property, Representation.REF);
} else if (rep.equals("FULL")) {
desc.addProperty(property, Representation.FULL);
} else if (rep.equals("DEFAULT")) {
desc.addProperty(property, Representation.DEFAULT);
}
else {
desc.addProperty(propertyDefinition);
}
}
}
Expand Down
Loading