From d2e69c0d689596033a9c35aa98d37a44e2cc88cb Mon Sep 17 00:00:00 2001 From: Rob Daugherty Date: Tue, 15 May 2018 13:23:01 -0400 Subject: WorkflowResponse json issues This commit adds some robustness to the interface between the API-H and BPMN, specifically, in how the response is handled. I don't have proof, but there appears to be some randomness to the json provider behavior when used with the jax-rs. Sometimes, the serializer is adding the root element, and sometimes it is not. Maybe there's something wrong with the configuration. Maybe we have competing json providers. I couldn't pin this down. I'm almost certain it is the presence of the root element in the content that causes the API-H code to fail parsing of the BPMN response. This doesn't kill the request, as you might expect, but rather, the API-H passes the BPMN response through to the client (VID, or policy, or whatever). The original problem (SO-586) was "fixed" by "removing the wrapper". This "wrapper" is a needed feature of the interface between BPMN and the API-H. We shouldn't have removed it. The fact that the "fix" appeared to work is due to the behavior I described in the previous paragraph. The API-H chokes on the message, and it passes it through unchanged. Not really what we want. So, I don't know why the jackson/json behavior is flaky and different now, but I can (and did) modify the API-H so it can parse a json message whether or not it has a root element. Note that WorkflowResponse.java (in BPMN) and CamundaResponse.java (in the API-H) are basically the same bean representing the message format. Seems less than ideal to have two different classes. Also note that I changed the name of the "response" attribute of the WorkflowResponse and CamundaResponse classes to "content". Got tired of seeing this nonsense everywhere in the code: response.getResponse() Change-Id: Icaf70f8457de99e493cf882170fe778c620308c9 Issue-ID: SO-586 Issue-ID: SO-618 Signed-off-by: Rob Daugherty --- .../mso/utils/RootIgnoringJsonDeserializer.java | 67 +++++++++++++++ .../mso/utils/RootIgnoringObjectMapper.java | 39 +++++++++ .../mso/utils/RootIgnoringObjectMapperTest.java | 94 ++++++++++++++++++++++ 3 files changed, 200 insertions(+) create mode 100644 common/src/main/java/org/openecomp/mso/utils/RootIgnoringJsonDeserializer.java create mode 100644 common/src/main/java/org/openecomp/mso/utils/RootIgnoringObjectMapper.java create mode 100644 common/src/test/java/org/openecomp/mso/utils/RootIgnoringObjectMapperTest.java (limited to 'common') diff --git a/common/src/main/java/org/openecomp/mso/utils/RootIgnoringJsonDeserializer.java b/common/src/main/java/org/openecomp/mso/utils/RootIgnoringJsonDeserializer.java new file mode 100644 index 0000000000..95f72c4dd4 --- /dev/null +++ b/common/src/main/java/org/openecomp/mso/utils/RootIgnoringJsonDeserializer.java @@ -0,0 +1,67 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP - SO + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.mso.utils; + +import java.io.IOException; +import java.util.Map; + +import com.fasterxml.jackson.annotation.JsonRootName; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +/** + * A JSON deserializer that ignores the root element if it is present. + */ +public class RootIgnoringJsonDeserializer extends JsonDeserializer { + + private final ObjectMapper mapper = new ObjectMapper(); + private final Class clazz; + private final String jsonRootName; + + public RootIgnoringJsonDeserializer(Class clazz) { + this.clazz = clazz; + + JsonRootName annotation = clazz.getAnnotation(JsonRootName.class); + + if (annotation == null || annotation.value() == null || annotation.value().equals("")) { + jsonRootName = clazz.getSimpleName(); + } else { + jsonRootName = annotation.value(); + } + } + + @Override + public T deserialize(JsonParser jp, DeserializationContext dc) + throws IOException, JsonProcessingException { + JsonNode rootNode = jp.getCodec().readTree(jp); + Map.Entry field = rootNode.fields().next(); + + if (jsonRootName.equals(field.getKey())) { + rootNode = field.getValue(); + } + + return mapper.convertValue(rootNode, clazz); + } +} \ No newline at end of file diff --git a/common/src/main/java/org/openecomp/mso/utils/RootIgnoringObjectMapper.java b/common/src/main/java/org/openecomp/mso/utils/RootIgnoringObjectMapper.java new file mode 100644 index 0000000000..6f3c5b7d99 --- /dev/null +++ b/common/src/main/java/org/openecomp/mso/utils/RootIgnoringObjectMapper.java @@ -0,0 +1,39 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP - SO + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.mso.utils; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.module.SimpleModule; + +/** + * An ObjectMapper for a specific class that ignores the root element + * if it is present. + */ +public class RootIgnoringObjectMapper extends ObjectMapper { + + private static final long serialVersionUID = 6812584067195377395L; + + public RootIgnoringObjectMapper(Class clazz) { + SimpleModule module = new SimpleModule(); + module.addDeserializer(clazz, new RootIgnoringJsonDeserializer(clazz)); + registerModule(module); + } +} \ No newline at end of file diff --git a/common/src/test/java/org/openecomp/mso/utils/RootIgnoringObjectMapperTest.java b/common/src/test/java/org/openecomp/mso/utils/RootIgnoringObjectMapperTest.java new file mode 100644 index 0000000000..1c7e845f16 --- /dev/null +++ b/common/src/test/java/org/openecomp/mso/utils/RootIgnoringObjectMapperTest.java @@ -0,0 +1,94 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP - SO + * ================================================================================ + * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.mso.utils; + +import static org.junit.Assert.assertEquals; + +import org.junit.Test; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonRootName; +import com.fasterxml.jackson.databind.ObjectMapper; + +public class RootIgnoringObjectMapperTest { + + @Test + public void someObjectWithoutRootTest() throws Exception { + ObjectMapper mapper = new RootIgnoringObjectMapper(SomeObject.class); + + String content = "{" + + "\"attribute\":\"charm\"" + + "}"; + + SomeObject response = mapper.readValue(content, SomeObject.class); + assertEquals("SomeObject[attribute=charm]", response.toString()); + } + + @Test + public void someObjectWithRootTest() throws Exception { + ObjectMapper mapper = new RootIgnoringObjectMapper(SomeObject.class); + + String content = "{\"SomeObject\":{" + + "\"attribute\":\"charm\"" + + "}}"; + + SomeObject response = mapper.readValue(content, SomeObject.class); + assertEquals("SomeObject[attribute=charm]", response.toString()); + } + + @Test + public void annotatedObjectWithoutRootTest() throws Exception { + ObjectMapper mapper = new RootIgnoringObjectMapper(AnnotatedObject.class); + + String content = "{" + + "\"attribute\":\"charm\"" + + "}"; + + AnnotatedObject response = mapper.readValue(content, AnnotatedObject.class); + assertEquals("AnnotatedObject[attribute=charm]", response.toString()); + } + + @Test + public void annotatedObjectWithRootTest() throws Exception { + ObjectMapper mapper = new RootIgnoringObjectMapper(AnnotatedObject.class); + + String content = "{\"annotated-object\":{" + + "\"attribute\":\"charm\"" + + "}}"; + + AnnotatedObject response = mapper.readValue(content, AnnotatedObject.class); + assertEquals("AnnotatedObject[attribute=charm]", response.toString()); + } + + public static class SomeObject { + + @JsonProperty("attribute") + private String attribute; + + public String toString() { + return getClass().getSimpleName() + "[attribute=" + attribute + "]"; + } + } + + @JsonRootName(value = "annotated-object") + public static class AnnotatedObject extends SomeObject { + } +} \ No newline at end of file -- cgit 1.2.3-korg