feat: add auth api. (#9)

* feat: add auth api.

* ci: delete unsupported event for commit title lint.

---------

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

Author: zhu-xiaowei

.github/workflows/lint.yml

@@ -1,8 +1,6 @@
 name: Commit Title Lint
 
 on:
-  push:
-    branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
 

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

@@ -34,6 +34,7 @@ public class ClickstreamConfiguration {
     private boolean isTrackAppLifecycleEvents;
     private boolean isTrackAppExceptionEvents;
     private boolean isLogEvents;
+    private String authCookie;
 
     /**
      * Create an {@link ClickstreamConfiguration} object with the specified parameters.
@@ -90,15 +91,6 @@ public String getEndpoint() {
         return this.endpoint;
     }
 
-    /**
-     * For get the Clickstream Okhttp3 dns.
-     *
-     * @return the dns.
-     */
-    public Dns getDns() {
-        return this.dns;
-    }
-
     /**
      * The endpoint for Clickstream.
      *
@@ -110,6 +102,15 @@ public ClickstreamConfiguration withEndpoint(final String endpoint) {
         return this;
     }
 
+    /**
+     * For get the Clickstream Okhttp3 dns.
+     *
+     * @return the dns.
+     */
+    public Dns getDns() {
+        return this.dns;
+    }
+
     /**
      * The Custom Okhttp3 dns for Clickstream.
      *
@@ -130,15 +131,6 @@ public long getSendEventsInterval() {
         return this.sendEventsInterval;
     }
 
-    /**
-     * The time out of entire http call.
-     *
-     * @return callTimeOut.
-     */
-    public Long getCallTimeOut() {
-        return this.callTimeOut;
-    }
-
     /**
      * The interval of events sent at once.
      *
@@ -150,6 +142,15 @@ public ClickstreamConfiguration withSendEventsInterval(final long sendEventsInte
         return this;
     }
 
+    /**
+     * The time out of entire http call.
+     *
+     * @return callTimeOut.
+     */
+    public Long getCallTimeOut() {
+        return this.callTimeOut;
+    }
+
     /**
      * The http call time out.
      *
@@ -190,6 +191,17 @@ public boolean isTrackAppLifecycleEvents() {
         return this.isTrackAppLifecycleEvents;
     }
 
+    /**
+     * Is track app lifecycle events.
+     *
+     * @param isTrackAppLifecycleEvents Is track app lifecycle events.
+     * @return the current ClickstreamConfiguration instance.
+     */
+    public ClickstreamConfiguration withTrackAppLifecycleEvents(final boolean isTrackAppLifecycleEvents) {
+        this.isTrackAppLifecycleEvents = isTrackAppLifecycleEvents;
+        return this;
+    }
+
     /**
      * Is track app exception events.
      *
@@ -199,6 +211,17 @@ public boolean isTrackAppExceptionEvents() {
         return this.isTrackAppExceptionEvents;
     }
 
+    /**
+     * Is track app exception events.
+     *
+     * @param isTrackAppExceptionEvents Is track app exception events.
+     * @return the current ClickstreamConfiguration instance.
+     */
+    public ClickstreamConfiguration withTrackAppExceptionEvents(final boolean isTrackAppExceptionEvents) {
+        this.isTrackAppExceptionEvents = isTrackAppExceptionEvents;
+        return this;
+    }
+
     /**
      * Is log events.
      *
@@ -209,35 +232,33 @@ public boolean isLogEvents() {
     }
 
     /**
-     * Is track app lifecycle events.
+     * Is log events json when record event, set true for debug mode.
      *
-     * @param isTrackAppLifecycleEvents Is track app lifecycle events.
+     * @param isLogEvents Is log events json.
      * @return the current ClickstreamConfiguration instance.
      */
-    public ClickstreamConfiguration withTrackAppLifecycleEvents(final boolean isTrackAppLifecycleEvents) {
-        this.isTrackAppLifecycleEvents = isTrackAppLifecycleEvents;
+    public ClickstreamConfiguration withLogEvents(final boolean isLogEvents) {
+        this.isLogEvents = isLogEvents;
         return this;
     }
 
     /**
-     * Is track app exception events.
+     * Get The Clickstream authCookie.
      *
-     * @param isTrackAppExceptionEvents Is track app exception events.
-     * @return the current ClickstreamConfiguration instance.
+     * @return the authCookie.
      */
-    public ClickstreamConfiguration withTrackAppExceptionEvents(final boolean isTrackAppExceptionEvents) {
-        this.isTrackAppExceptionEvents = isTrackAppExceptionEvents;
-        return this;
+    public String getAuthCookie() {
+        return this.authCookie;
     }
 
     /**
-     * Is log events json when record event, set true for debug mode.
+     * Set the auth cookie for Clickstream.
      *
-     * @param isLogEvents Is log events json.
+     * @param authCookie The authCookie.
      * @return the current ClickstreamConfiguration instance.
      */
-    public ClickstreamConfiguration withLogEvents(final boolean isLogEvents) {
-        this.isLogEvents = isLogEvents;
+    public ClickstreamConfiguration withAuthCookie(final String authCookie) {
+        this.authCookie = authCookie;
         return this;
     }
 }

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

@@ -69,8 +69,7 @@ public static boolean uploadEvents(String eventJson, ClickstreamConfiguration co
                 LOG.debug("submitEvents success. \n" + response);
                 return true;
             } else {
-                LOG.warn(
-                    String.format(Locale.US, "submitEvents onResponse fail %d-%s", response.code(), response.body()));
+                LOG.error("submitEvents fail. \n" + response);
             }
         } catch (final Exception exception) {
             LOG.error("submitEvents error: " + exception.getMessage());
@@ -109,7 +108,11 @@ private static Response request(@NonNull String eventJson, @NonNull ClickstreamC
             .addQueryParameter("appId", appId)
             .addQueryParameter("compression", compression)
             .build();
-        request = request.newBuilder().url(url).post(body).build();
+        Request.Builder builder = request.newBuilder().url(url).post(body);
+        if (!StringUtil.isNullOrEmpty(configuration.getAuthCookie())) {
+            builder.addHeader("cookie", configuration.getAuthCookie());
+        }
+        request = builder.build();
 
         final OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
         okHttpClientBuilder.connectTimeout(HTTP_CONNECT_TIME_OUT, TimeUnit.SECONDS);

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

@@ -46,7 +46,10 @@
 
 import java.util.Map;
 
+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.header;
 import static com.github.dreamhead.moco.Moco.httpServer;
 import static com.github.dreamhead.moco.Moco.status;
 import static com.github.dreamhead.moco.Moco.text;
@@ -63,6 +66,7 @@
 public class IntegrationTest {
     private static final String COLLECT_SUCCESS = "/collect/success";
     private static final String COLLECT_SUCCESS1 = "/collect/success1";
+    private static final String COLLECT_FOR_AUTH = "/collect/auth";
     private static final String COLLECT_FAIL = "/collect/fail";
     private static final String COLLECT_HOST = "http://localhost:8082";
     private static Runner runner;
@@ -81,6 +85,8 @@ public static void beforeClass() {
         final HttpServer server = httpServer(8082);
         server.request(by(uri(COLLECT_SUCCESS))).response(status(200), text("success"));
         server.request(by(uri(COLLECT_SUCCESS1))).response(status(200), text("success"));
+        server.request(and(by(uri(COLLECT_FOR_AUTH)), eq(header("cookie"), "testCookie")))
+            .response(status(200), text("success"));
         server.request(by(uri(COLLECT_FAIL))).response(status(403), text("fail"));
         runner = runner(server);
         runner.start();
@@ -582,6 +588,52 @@ public void testCustomDnsForUnKnowHostFail() throws Exception {
         assertEquals(0, dbUtil.getTotalNumber());
     }
 
+    /**
+     * test set auth cookie success.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testSetAuthCookieSuccess() throws Exception {
+        String authCookie = "testCookie";
+        ClickstreamAnalytics.getClickStreamConfiguration()
+            .withAuthCookie(authCookie)
+            .withEndpoint(assembleEndpointUrl(COLLECT_FOR_AUTH));
+
+        assertEquals(authCookie, this.analyticsClient.getClickstreamConfiguration().getAuthCookie());
+
+        ClickstreamAnalytics.recordEvent("testRecordEventForAuth");
+        assertEquals(1, dbUtil.getTotalNumber());
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
+
+    /**
+     * test set auth cookie fail.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testSetAuthCookieFail() throws Exception {
+        String authCookie = "testCookieFail";
+        ClickstreamAnalytics.getClickStreamConfiguration()
+            .withAuthCookie(authCookie)
+            .withEndpoint(assembleEndpointUrl(COLLECT_FOR_AUTH));
+
+        assertEquals(authCookie, this.analyticsClient.getClickstreamConfiguration().getAuthCookie());
+
+        ClickstreamAnalytics.recordEvent("testRecordEventFailForAuth");
+        assertEquals(1, dbUtil.getTotalNumber());
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(1, dbUtil.getTotalNumber());
+
+        ClickstreamAnalytics.getClickStreamConfiguration().withAuthCookie("testCookie");
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
 
     /**
      * test enable.