Added serialization support for odp events

core-api/src/main/java/com/optimizely/ab/odp/ODPEvent.java

@@ -0,0 +1,49 @@
+package com.optimizely.ab.odp;
+
+import java.util.Map;
+
+public class ODPEvent {
+ private String type;
+ private String action;
+ private Map<String, String > identifiers;
+ private Map<String, String> data;
+
+ public ODPEvent(String type, String action, Map<String, String> identifiers, Map<String, String> data) {
+ this.type = type;
+ this.action = action;
+ this.identifiers = identifiers;
+ this.data = data;
+ }
+
+ public String getType() {
+ return type;
+ }
+
+ public void setType(String type) {
+ this.type = type;
+ }
+
+ public String getAction() {
+ return action;
+ }
+
+ public void setAction(String action) {
+ this.action = action;
+ }
+
+ public Map<String, String> getIdentifiers() {
+ return identifiers;
+ }
+
+ public void setIdentifiers(Map<String, String> identifiers) {
+ this.identifiers = identifiers;
+ }
+
+ public Map<String, String> getData() {
+ return data;
+ }
+
+ public void setData(Map<String, String> data) {
+ this.data = data;
+ }
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/ODPJsonSerializer.java

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer;
+
+import com.optimizely.ab.odp.ODPEvent;
+
+import java.util.List;
+
+public interface ODPJsonSerializer {
+ public String serializeEvents(List<ODPEvent> events);
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/ODPJsonSerializerFactory.java

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer;
+
+import com.optimizely.ab.internal.JsonParserProvider;
+import com.optimizely.ab.odp.serializer.impl.GsonSerializer;
+import com.optimizely.ab.odp.serializer.impl.JacksonSerializer;
+import com.optimizely.ab.odp.serializer.impl.JsonSerializer;
+import com.optimizely.ab.odp.serializer.impl.JsonSimpleSerializer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ODPJsonSerializerFactory {
+ private static final Logger logger = LoggerFactory.getLogger(ODPJsonSerializerFactory.class);
+
+ public static ODPJsonSerializer getSerializer() {
+ JsonParserProvider parserProvider = JsonParserProvider.getDefaultParser();
+ ODPJsonSerializer jsonSerializer = null;
+ switch (parserProvider) {
+ case GSON_CONFIG_PARSER:
+ jsonSerializer = new GsonSerializer();
+ break;
+ case JACKSON_CONFIG_PARSER:
+ jsonSerializer = new JacksonSerializer();
+ break;
+ case JSON_CONFIG_PARSER:
+ jsonSerializer = new JsonSerializer();
+ break;
+ case JSON_SIMPLE_CONFIG_PARSER:
+ jsonSerializer = new JsonSimpleSerializer();
+ break;
+ }
+ logger.info("Using " + parserProvider.toString() + " serializer");
+ return jsonSerializer;
+ }
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/impl/GsonSerializer.java

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer.impl;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.optimizely.ab.odp.ODPEvent;
+import com.optimizely.ab.odp.serializer.ODPJsonSerializer;
+
+import java.util.List;
+
+public class GsonSerializer implements ODPJsonSerializer {
+ @Override
+ public String serializeEvents(List<ODPEvent> events) {
+ Gson gson = new GsonBuilder().create();
+ return gson.toJson(events);
+ }
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/impl/JacksonSerializer.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer.impl;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.optimizely.ab.odp.ODPEvent;
+import com.optimizely.ab.odp.serializer.ODPJsonSerializer;
+
+import java.util.List;
+
+public class JacksonSerializer implements ODPJsonSerializer {
+ @Override
+ public String serializeEvents(List<ODPEvent> events) {
+ ObjectMapper objectMapper = new ObjectMapper();
+ try {
+ return objectMapper.writeValueAsString(events);
+ } catch (JsonProcessingException e) {
+ // log error here
+ }
+ return null;
+ }
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/impl/JsonSerializer.java

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer.impl;
+
+import com.optimizely.ab.odp.ODPEvent;
+import com.optimizely.ab.odp.serializer.ODPJsonSerializer;
+import org.json.JSONArray;
+
+import java.util.List;
+
+public class JsonSerializer implements ODPJsonSerializer {
+ @Override
+ public String serializeEvents(List<ODPEvent> events) {
+ return new JSONArray(events).toString();
+ }
+}

core-api/src/main/java/com/optimizely/ab/odp/serializer/impl/JsonSimpleSerializer.java

@@ -0,0 +1,55 @@
+/**
+ * Copyright 2022, Optimizely Inc. and contributors
+ *
+ * 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.
+ */
+package com.optimizely.ab.odp.serializer.impl;
+
+import com.optimizely.ab.odp.ODPEvent;
+import com.optimizely.ab.odp.serializer.ODPJsonSerializer;
+import org.json.simple.JSONArray;
+import org.json.simple.JSONObject;
+
+import java.util.List;
+import java.util.Map;
+
+public class JsonSimpleSerializer implements ODPJsonSerializer {
+ @Override
+ public String serializeEvents(List<ODPEvent> events) {
+ JSONArray jsonArray = new JSONArray();
+ for (ODPEvent event: events) {
+ JSONObject eventObject = new JSONObject();
+ eventObject.put("type", event.getType());
+ eventObject.put("action", event.getAction());
+
+ if (event.getIdentifiers() != null) {
+ JSONObject identifiers = new JSONObject();
+ for (Map.Entry<String, String> identifier : event.getIdentifiers().entrySet()) {
+ identifiers.put(identifier.getKey(), identifier.getValue());
+ }
+ eventObject.put("identifiers", identifiers);
+ }
+
+ if (event.getData() != null) {
+ JSONObject data = new JSONObject();
+ for (Map.Entry<String, String> dataEntry : event.getData().entrySet()) {
+ data.put(dataEntry.getKey(), dataEntry.getValue());
+ }
+ eventObject.put("data", data);
+ }
+
+ jsonArray.add(eventObject);
+ }
+ return jsonArray.toJSONString();
+ }
+}

core-api/src/test/java/com/optimizely/ab/odp/serializer/ODPJsonSerializerTest.java

@@ -0,0 +1,60 @@
+package com.optimizely.ab.odp.serializer;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.optimizely.ab.odp.ODPEvent;
+import com.optimizely.ab.odp.serializer.impl.*;
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+import java.util.*;
+
+import static junit.framework.TestCase.assertEquals;
+import static junit.framework.TestCase.assertTrue;
+
+@RunWith(Parameterized.class)
+public class ODPJsonSerializerTest {
+ private final ODPJsonSerializer jsonSerializer;
+
+ public ODPJsonSerializerTest(ODPJsonSerializer jsonSerializer) {
+ super();
+ this.jsonSerializer = jsonSerializer;
+ }
+
+ @Parameterized.Parameters
+ public static List<ODPJsonSerializer> input() {
+ return Arrays.asList(new GsonSerializer(), new JsonSerializer(), new JsonSimpleSerializer(), new JacksonSerializer());
+ }
+
+ @Test
+ public void serializeValidEvents() throws JsonProcessingException {
+ List<ODPEvent> events = Arrays.asList(
+ createTestEvent("1"),
+ createTestEvent("2"),
+ createTestEvent("3")
+ );
+
+ ObjectMapper mapper = new ObjectMapper();
+
+ String expectedResult = "[{\"type\":\"type-1\",\"action\":\"action-1\",\"identifiers\":{\"vuid-1-3\":\"fs-1-3\",\"vuid-1-1\":\"fs-1-1\",\"vuid-1-2\":\"fs-1-2\"},\"data\":{\"source\":\"java-sdk\",\"data-1\":\"data-value-1\"}},{\"type\":\"type-2\",\"action\":\"action-2\",\"identifiers\":{\"vuid-2-3\":\"fs-2-3\",\"vuid-2-2\":\"fs-2-2\",\"vuid-2-1\":\"fs-2-1\"},\"data\":{\"source\":\"java-sdk\",\"data-1\":\"data-value-2\"}},{\"type\":\"type-3\",\"action\":\"action-3\",\"identifiers\":{\"vuid-3-3\":\"fs-3-3\",\"vuid-3-2\":\"fs-3-2\",\"vuid-3-1\":\"fs-3-1\"},\"data\":{\"source\":\"java-sdk\",\"data-1\":\"data-value-3\"}}]";
+ String serializedString = jsonSerializer.serializeEvents(events);
+ System.out.println(serializedString);
+ assertEquals(mapper.readTree(expectedResult), mapper.readTree(serializedString));
+ }
+
+ private static ODPEvent createTestEvent(String index) {
+ Map<String, String> identifiers = new HashMap<>();
+ identifiers.put("vuid-" + index + "-1", "fs-" + index + "-1");
+ identifiers.put("vuid-" + index + "-2", "fs-" + index + "-2");
+ identifiers.put("vuid-" + index + "-3", "fs-" + index + "-3");
+
+ Map<String, String> data = new HashMap<>();
+ data.put("source", "java-sdk");
+ data.put("data-1", "data-value-" + index);
+
+ return new ODPEvent("type-" + index, "action-" + index, identifiers, data);
+ }
+}