Merge branch 'release/2.1.0'

CHANGELOG

@@ -1,3 +1,8 @@
+Java 2.1.0 (2024-02-14)
+-----------------------
+Add support for serializing DateTime in self-describing data (#378) (thanks to @stephen-murby for the contribution!)
+Add equality functions for SelfDescribing and SelfDescribingJson so that they can be compared in unit tests (#380) (thanks to @stephen-murby for the contribution!)
+
 Java 2.0.0 (2024-01-12)
 -----------------------
 Add builder methods Subject to allow method chaining (#303)

build.gradle

@@ -25,7 +25,7 @@ wrapper.gradleVersion = '6.5.0'
 
 group = 'com.snowplowanalytics'
 archivesBaseName = 'snowplow-java-tracker'
-version = '2.0.0'
+version = '2.1.0'
 sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
 
@@ -73,6 +73,7 @@ dependencies {
 
     // Jackson JSON processor
     api 'com.fasterxml.jackson.core:jackson-databind:2.16.1'
+    api 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.16.1'
 
     // Testing libraries
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.1'

src/main/java/com/snowplowanalytics/snowplow/tracker/Utils.java

@@ -20,6 +20,8 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -29,7 +31,10 @@
 public class Utils {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(Utils.class);
-    private static final ObjectMapper objectMapper = new ObjectMapper();
+    private static final ObjectMapper objectMapper
+            = new ObjectMapper()
+            .registerModule(new JavaTimeModule())
+            .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
 
     // Tracker Utils
 

src/main/java/com/snowplowanalytics/snowplow/tracker/events/SelfDescribing.java

@@ -95,4 +95,22 @@ public TrackerPayload getPayload() {
                 Parameter.SELF_DESCRIBING_ENCODED, Parameter.SELF_DESCRIBING);
         return putTrueTimestamp(payload);
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        SelfDescribing that = (SelfDescribing) o;
+
+        if (base64Encode != that.base64Encode) return false;
+        return Objects.equals(eventData, that.eventData);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = eventData != null ? eventData.hashCode() : 0;
+        result = 31 * result + (base64Encode ? 1 : 0);
+        return result;
+    }
 }

src/main/java/com/snowplowanalytics/snowplow/tracker/payload/SelfDescribingJson.java

@@ -198,4 +198,19 @@ public long getByteSize() {
     public String toString() {
         return Utils.mapToJSONString(payload);
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+
+        SelfDescribingJson that = (SelfDescribingJson) o;
+
+        return payload.equals(that.payload);
+    }
+
+    @Override
+    public int hashCode() {
+        return payload.hashCode();
+    }
 }

src/test/java/com/snowplowanalytics/snowplow/tracker/TrackerTest.java

@@ -576,7 +576,7 @@ public void testCreateWithConfiguration() {
     @Test
     public void testGetTrackerVersion() {
         Tracker tracker = new Tracker(new TrackerConfiguration("namespace", "an-app-id"), mockEmitter);
-        assertEquals("java-2.0.0", tracker.getTrackerVersion());
+        assertEquals("java-2.1.0", tracker.getTrackerVersion());
     }
 
     @Test

src/test/java/com/snowplowanalytics/snowplow/tracker/UtilsTest.java

@@ -17,6 +17,8 @@
 
 // Java
 import java.nio.charset.StandardCharsets;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
@@ -68,6 +70,14 @@ public void testMapToJSONString() {
         Map<String, Object> payload2 = new LinkedHashMap<>();
         payload2.put("k1", new Object());
         assertEquals("", Utils.mapToJSONString(payload2));
+
+        Map<String, Object> payload3 = new LinkedHashMap<>();
+        payload3.put("k1", LocalDateTime.of(2020, 1, 1, 0, 0));
+        assertEquals("{\"k1\":\"2020-01-01T00:00:00\"}", Utils.mapToJSONString(payload3));
+
+        Map<String, Object> payload4 = new LinkedHashMap<>();
+        payload4.put("k1", LocalDate.of(2020, 1, 1));
+        assertEquals("{\"k1\":\"2020-01-01\"}", Utils.mapToJSONString(payload4));
     }
 
     @Test

src/test/java/com/snowplowanalytics/snowplow/tracker/events/SelfDescribingTest.java

@@ -0,0 +1,37 @@
+package com.snowplowanalytics.snowplow.tracker.events;
+
+import com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson;
+
+// JUnit
+import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+
+public class SelfDescribingTest {
+
+    @Test
+    public void testEqualityOfTwoInstances() {
+        SelfDescribing.Builder<?> builder = SelfDescribing.builder()
+                .eventData(new SelfDescribingJson("schema-name"));
+
+        SelfDescribing a = new SelfDescribing( builder );
+        SelfDescribing b = new SelfDescribing( builder );
+
+        assertEquals(a, b);
+    }
+
+    @Test
+    public void testNegativeEqualityOfTwoInstances() {
+        SelfDescribing.Builder<?> builderOne = SelfDescribing.builder()
+                .eventData(new SelfDescribingJson("schema-name-one"));
+
+        SelfDescribing.Builder<?> builderTwo = SelfDescribing.builder()
+                .eventData(new SelfDescribingJson("schema-name-two"));
+
+        SelfDescribing a = new SelfDescribing( builderOne );
+        SelfDescribing b = new SelfDescribing( builderTwo );
+
+        assertNotEquals(a, b);
+    }
+
+}

src/test/java/com/snowplowanalytics/snowplow/tracker/payload/SelfDescribingJsonTest.java

@@ -20,6 +20,9 @@
 import org.junit.Test;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNotEquals;
+
+
 
 public class SelfDescribingJsonTest {
 
@@ -67,4 +70,64 @@ public void testMakeSdjWithSdj() {
         assertNotNull(sdj);
         assertEquals(expected, sdjString);
     }
+
+    @Test
+    public void testEqualityOfTwoInstances_withSchemaNameOnly() {
+        SelfDescribingJson a = new SelfDescribingJson("schema");
+        SelfDescribingJson b = new SelfDescribingJson("schema");
+        assertEquals(a, b);
+    }
+
+    @Test
+    public void testEqualityOfTwoInstances_withTrackerPayload() {
+        TrackerPayload nestedData = new TrackerPayload();
+        nestedData.add("key", "value");
+        SelfDescribingJson a = new SelfDescribingJson("schema", nestedData);
+        SelfDescribingJson b = new SelfDescribingJson("schema", nestedData);
+        assertEquals(a, b);
+    }
+
+    @Test
+    public void testEqualityOfTwoInstances_withNestedEvent() {
+        TrackerPayload nestedData = new TrackerPayload();
+        nestedData.add("key", "value");
+        SelfDescribingJson nestedEvent = new SelfDescribingJson("nested_event", nestedData);
+        SelfDescribingJson a = new SelfDescribingJson("schema", nestedEvent);
+        SelfDescribingJson b = new SelfDescribingJson("schema", nestedEvent);
+        assertEquals(a, b);
+    }
+
+    @Test
+    public void testNegativeEqualityOfTwoInstances_withSchemaNameOnly() {
+        SelfDescribingJson a = new SelfDescribingJson("schema-one");
+        SelfDescribingJson b = new SelfDescribingJson("schema-two");
+        assertNotEquals(a, b);
+    }
+
+    @Test
+    public void testNegativeEqualityOfTwoInstances_withTrackerPayload() {
+        TrackerPayload nestedDataOne = new TrackerPayload();
+        nestedDataOne.add("key", "value-one");
+        TrackerPayload nestedDataTwo = new TrackerPayload();
+        nestedDataTwo.add("key", "value-two");
+        SelfDescribingJson a = new SelfDescribingJson("schema", nestedDataOne);
+        SelfDescribingJson b = new SelfDescribingJson("schema", nestedDataTwo);
+        assertNotEquals(a, b);
+    }
+
+    @Test
+    public void testNegativeEqualityOfTwoInstances_withNestedEvent() {
+        TrackerPayload nestedDataOne = new TrackerPayload();
+        nestedDataOne.add("key", "value-one");
+        SelfDescribingJson nestedEventOne = new SelfDescribingJson("nested_event", nestedDataOne);
+
+        TrackerPayload nestedDataTwo = new TrackerPayload();
+        nestedDataTwo.add("key", "value-two");
+        SelfDescribingJson nestedEventTwo = new SelfDescribingJson("nested_event", nestedDataTwo);
+
+
+        SelfDescribingJson a = new SelfDescribingJson("schema", nestedEventOne);
+        SelfDescribingJson b = new SelfDescribingJson("schema", nestedEventTwo);
+        assertNotEquals(a, b);
+    }
 }