feat: add hash code to request query parameter (#40)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>

Author: zhu-xiaowei

build.gradle

@@ -65,7 +65,7 @@ ext {
         ],
         okhttp: 'com.squareup.okhttp3:okhttp:4.9.1',
         junit: 'junit:junit:4.13.2',
-        mockito: 'org.mockito:mockito-core:3.1.0',
+        mockito: 'org.mockito:mockito-core:4.11.0',
         moco: 'com.github.dreamhead:moco-core:1.4.0',
         robolectric: 'org.robolectric:robolectric:4.9.2',
     ]

clickstream/src/main/java/software/aws/solution/clickstream/client/AnalyticsEvent.java

@@ -423,7 +423,7 @@ public JSONObject toJSONObject() {
         final String carrier = this.deviceDetails.carrier();
         final String carrierString = carrier != null ? carrier : "UNKNOWN";
 
-        final JSONBuilder builder = new JSONBuilder(this);
+        final JSONBuilder builder = new JSONBuilder();
 
         // ****************************************************
         // ==================System Attributes=================

clickstream/src/main/java/software/aws/solution/clickstream/client/EventRecorder.java

@@ -90,7 +90,7 @@ public Uri recordEvent(@NonNull final AnalyticsEvent event) {
             if (clickstreamContext.getClickstreamConfiguration() != null &&
                 clickstreamContext.getClickstreamConfiguration().isLogEvents()) {
                 LOG.info("save event: " + event.getEventType() + " success, event json:");
-                LOG.info(event.toJSONObject().toString());
+                LOG.info(event.toString());
             }
             while (this.dbUtil.getTotalSize() > DEFAULT_MAX_DB_SIZE) {
                 try (Cursor cursor = this.dbUtil.queryOldestEvents(QUERY_OLDEST_EVENT_LIMIT)) {

clickstream/src/main/java/software/aws/solution/clickstream/client/network/NetRequest.java

@@ -108,6 +108,7 @@ private static Response request(@NonNull String eventJson, @NonNull ClickstreamC
         HttpUrl url = request.url().newBuilder()
             .addQueryParameter("platform", "Android")
             .addQueryParameter("appId", appId)
+            .addQueryParameter("hashCode", StringUtil.getHashCode(curStr))
             .addQueryParameter("event_bundle_sequence_id", String.valueOf(bundleSequenceId))
             .addQueryParameter("compression", compression)
             .build();

clickstream/src/main/java/software/aws/solution/clickstream/client/util/JSONBuilder.java

@@ -32,24 +32,22 @@ public class JSONBuilder implements JSONSerializable {
 
     /**
      * The constructor of JSONBuilder with parameters.
-     * @param component the instance of component.
+     *
      */
-    public JSONBuilder(Object component) {
-        if (null != component) {
-            this.withAttribute("hashCode", Integer.toHexString(component.hashCode()));
-        }
+    public JSONBuilder() {
     }
 
     /**
      * Get the instance of JSONBuilder with key and value.
-     * @param key The key.
+     *
+     * @param key   The key.
      * @param value The value.
      * @return The instance of JSONBuilder.
      */
     public JSONBuilder withAttribute(String key, Object value) {
         final Object jsonValue = value instanceof JSONSerializable
-                ? ((JSONSerializable) value).toJSONObject()
-                : value;
+            ? ((JSONSerializable) value).toJSONObject()
+            : value;
         try {
             json.putOpt(key, jsonValue);
         } catch (final JSONException jsonException) {
@@ -60,6 +58,7 @@ public JSONBuilder withAttribute(String key, Object value) {
 
     /**
      * Convert to JSON format.
+     *
      * @return The JSON object.
      */
     @Override
@@ -69,6 +68,7 @@ public JSONObject toJSONObject() {
 
     /**
      * Convert to string.
+     *
      * @return The string.
      */
     @NonNull

clickstream/src/main/java/software/aws/solution/clickstream/client/util/StringUtil.java

@@ -23,13 +23,17 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 import java.util.zip.GZIPOutputStream;
 
 /**
  * String utility methods.
  */
 public final class StringUtil {
     private static final Log LOG = LogFactory.getLog(StringUtil.class);
+    private static final int HASH_CODE_BYTE_LENGTH = 4;
+    private static final int HASH_CODE_PREFIX = 0xFF;
 
     /**
      * Default constructor.
@@ -134,5 +138,35 @@ public static String trimOrPadString(String str, int len, final char pad) {
 
         return s.toString();
     }
+
+    /**
+     * method for get event hash code.
+     *
+     * @param str event json string
+     * @return the first 8 sha256 character of the event json
+     */
+    public static String getHashCode(String str) {
+        MessageDigest digest;
+        try {
+            digest = MessageDigest.getInstance("SHA-256");
+            digest.update(str.getBytes());
+            return bytesToHexString(digest.digest());
+        } catch (NoSuchAlgorithmException error) {
+            LOG.error("Failed to get sha256 for str:" + str);
+        }
+        return "";
+    }
+
+    private static String bytesToHexString(byte[] bytes) {
+        StringBuilder sb = new StringBuilder();
+        for (int i = 0; i < HASH_CODE_BYTE_LENGTH; i++) {
+            String hex = Integer.toHexString(HASH_CODE_PREFIX & bytes[i]);
+            if (hex.length() == 1) {
+                sb.append('0');
+            }
+            sb.append(hex);
+        }
+        return sb.toString();
+    }
 }
 

clickstream/src/test/java/software/aws/solution/clickstream/AnalyticsEventTest.java

@@ -62,9 +62,11 @@ public static AnalyticsClient getAnalyticsClient() {
 
     /**
      * test the analyticsClient with createEvent.
+     *
+     * @throws JSONException the json exception
      */
     @Test
-    public void createEvent() {
+    public void createEvent() throws JSONException {
         AnalyticsEvent event = analyticsClient.createEvent("testEvent");
         Assert.assertNotNull(event.getEventId());
         Assert.assertEquals(event.getEventType(), "testEvent");

clickstream/src/test/java/software/aws/solution/clickstream/EventRecorderTest.java

@@ -42,6 +42,8 @@
 import software.aws.solution.clickstream.client.Event;
 import software.aws.solution.clickstream.client.EventRecorder;
 import software.aws.solution.clickstream.client.db.ClickstreamDBUtil;
+import software.aws.solution.clickstream.client.network.NetRequest;
+import software.aws.solution.clickstream.client.util.StringUtil;
 import software.aws.solution.clickstream.util.ReflectUtil;
 
 import java.lang.reflect.Method;
@@ -50,8 +52,11 @@
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 
+import static com.github.dreamhead.moco.Moco.and;
 import static com.github.dreamhead.moco.Moco.by;
+import static com.github.dreamhead.moco.Moco.eq;
 import static com.github.dreamhead.moco.Moco.httpServer;
+import static com.github.dreamhead.moco.Moco.query;
 import static com.github.dreamhead.moco.Moco.status;
 import static com.github.dreamhead.moco.Moco.text;
 import static com.github.dreamhead.moco.Moco.uri;
@@ -70,8 +75,10 @@
 public class EventRecorderTest {
     private static final String COLLECT_SUCCESS = "/collect/success";
     private static final String COLLECT_FAIL = "/collect/fail";
+    private static final String COLLECT_FOR_VERIFY_HASH_CODE = "/collect/hashcode";
     private static Runner runner;
     private static String jsonString;
+    private static HttpServer server;
 
     private ClickstreamDBUtil dbUtil;
     private EventRecorder eventRecorder;
@@ -87,7 +94,7 @@ public class EventRecorderTest {
     @BeforeClass
     public static void beforeClass() {
         //config and start server
-        final HttpServer server = httpServer(8082);
+        server = httpServer(8082);
         server.request(by(uri(COLLECT_SUCCESS))).response(status(200), text("success"));
         server.request(by(uri(COLLECT_FAIL))).response(status(403), text("fail"));
         runner = runner(server);
@@ -164,6 +171,7 @@ public void testRecordEventForReachedMaxDbSize() throws Exception {
 
     /**
      * test insert single event when exceed attribute number limit.
+     *
      * @throws JSONException the json exception
      */
     @Test
@@ -528,6 +536,23 @@ public void testSubmitAllEventForReachTheQueueLimit() throws Exception {
         assertEquals(1001, ((ThreadPoolExecutor) executorService).getTaskCount());
     }
 
+    /**
+     * test record event with request parameter hash code.
+     *
+     * @throws Exception exception.
+     */
+    @Test
+    public void testRecordEventRequestWithHashCode() throws Exception {
+        clickstreamContext.getClickstreamConfiguration().withCompressEvents(false);
+        setRequestPath(COLLECT_FOR_VERIFY_HASH_CODE);
+        String eventJson = "[" + event.toJSONObject().toString() + "]";
+        String eventHashCode = StringUtil.getHashCode(eventJson);
+        server.request(and(by(uri(COLLECT_FOR_VERIFY_HASH_CODE)), eq(query("hashCode"), eventHashCode)))
+            .response(status(200), text("success"));
+        boolean requestResult = NetRequest.uploadEvents(eventJson, clickstreamContext.getClickstreamConfiguration(), 1);
+        assertTrue(requestResult);
+    }
+
     /**
      * common method to set request path.
      *