feat: add dns configuration.

Author: zhu-xiaowei

build.gradle

@@ -52,7 +52,6 @@ ext {
             desugartools: 'com.android.tools:desugar_jdk_libs:1.0.9',
         ],
         androidx: [
-            appcompat: 'androidx.appcompat:appcompat:1.2.0',
             test: 'androidx.test:core:1.5.0'
         ],
         amplifyframework: [

clickstream/build.gradle

@@ -17,7 +17,6 @@ apply plugin: 'com.android.library'
 apply from: rootProject.file("configuration/checkstyle.gradle")
 
 dependencies {
-    implementation dependency.androidx.appcompat
     implementation dependency.aws.mobileclient
     implementation dependency.amplifyframework.core
     implementation dependency.okhttp

clickstream/src/main/java/com/amazonaws/solution/clickstream/AWSClickstreamPluginConfiguration.java

@@ -20,11 +20,13 @@
  */
 public final class AWSClickstreamPluginConfiguration {
     private static final long DEFAULT_SEND_EVENTS_INTERVAL = 10000L;
+    private static final long DEFAULT_CALL_TIME_OUT = 15000L;
 
     // Clickstream configuration options
     private final String appId;
     private final String endpoint;
     private final long sendEventsInterval;
+    private final long callTimeOut;
     private final boolean isTrackAppLifecycleEvents;
     private final boolean isTrackAppExceptionEvents;
     private final boolean isCompressEvents;
@@ -33,6 +35,7 @@ private AWSClickstreamPluginConfiguration(Builder builder) {
         this.appId = builder.appId;
         this.isTrackAppLifecycleEvents = builder.isTrackAppLifecycleEvents;
         this.isTrackAppExceptionEvents = builder.isTrackAppExceptionEvents;
+        this.callTimeOut = builder.callTimeOut;
         this.sendEventsInterval = builder.sendEventsInterval;
         this.endpoint = builder.endpoint;
         this.isCompressEvents = builder.isCompressEvents;
@@ -56,6 +59,15 @@ long getSendEventsInterval() {
         return sendEventsInterval;
     }
 
+    /**
+     * Accessor for http call time out.
+     *
+     * @return callTimeOut.
+     */
+    long getCallTimeOut() {
+        return callTimeOut;
+    }
+
     /**
      * Is auto session tracking enabled.
      *
@@ -109,6 +121,7 @@ static final class Builder {
         private String appId;
         private String endpoint;
         private long sendEventsInterval = DEFAULT_SEND_EVENTS_INTERVAL;
+        private final long callTimeOut = DEFAULT_CALL_TIME_OUT;
         private boolean isCompressEvents = true;
         private boolean isTrackAppLifecycleEvents = true;
         private boolean isTrackAppExceptionEvents = false;

clickstream/src/main/java/com/amazonaws/solution/clickstream/ClickstreamManagerFactory.java

@@ -34,6 +34,7 @@ static ClickstreamManager create(Context context,
             new ClickstreamConfiguration(context, clickstreamPluginConfiguration.getAppId(),
                 clickstreamPluginConfiguration.getEndpoint())
                 .withSendEventsInterval(clickstreamPluginConfiguration.getSendEventsInterval())
+                .withCallTimeOut(clickstreamPluginConfiguration.getCallTimeOut())
                 .withCompressEvents(clickstreamPluginConfiguration.isCompressEvents())
                 .withTrackAppLifecycleEvents(clickstreamPluginConfiguration.isTrackAppLifecycleEvents())
                 .withTrackAppExceptionEvents(clickstreamPluginConfiguration.isTrackAppExceptionEvents());

clickstream/src/main/java/com/amazonaws/solution/clickstream/client/ClickstreamConfiguration.java

@@ -17,6 +17,8 @@
 
 import android.content.Context;
 
+import okhttp3.Dns;
+
 /**
  * Clickstream Configuration.
  */
@@ -25,7 +27,9 @@ public class ClickstreamConfiguration {
     private Context context;
     private String appId;
     private String endpoint;
+    private Dns dns;
     private long sendEventsInterval;
+    private long callTimeOut;
     private boolean isCompressEvents;
     private boolean isTrackAppLifecycleEvents;
     private boolean isTrackAppExceptionEvents;
@@ -86,6 +90,15 @@ 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.
      *
@@ -97,6 +110,17 @@ public ClickstreamConfiguration withEndpoint(final String endpoint) {
         return this;
     }
 
+    /**
+     * The Custom Okhttp3 dns for Clickstream.
+     *
+     * @param dns The custom dns.
+     * @return the current ClickstreamConfiguration instance.
+     */
+    public ClickstreamConfiguration withCustomDns(final Dns dns) {
+        this.dns = dns;
+        return this;
+    }
+
     /**
      * The interval of events sent at once.
      *
@@ -106,6 +130,15 @@ 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.
      *
@@ -117,6 +150,17 @@ public ClickstreamConfiguration withSendEventsInterval(final long sendEventsInte
         return this;
     }
 
+    /**
+     * The http call time out.
+     *
+     * @param callTimeOut call time out.
+     * @return the current ClickstreamConfiguration instance.
+     */
+    public ClickstreamConfiguration withCallTimeOut(final long callTimeOut) {
+        this.callTimeOut = callTimeOut;
+        return this;
+    }
+
     /**
      * Is compress events.
      *

clickstream/src/main/java/com/amazonaws/solution/clickstream/client/network/NetRequest.java

@@ -115,8 +115,12 @@ private static Response request(@NonNull String eventJson, @NonNull ClickstreamC
         okHttpClientBuilder.connectTimeout(HTTP_CONNECT_TIME_OUT, TimeUnit.SECONDS);
         okHttpClientBuilder.readTimeout(HTTP_READ_TIME_OUT, TimeUnit.SECONDS);
         okHttpClientBuilder.writeTimeout(HTTP_WRITE_TIME_OUT, TimeUnit.SECONDS);
+        okHttpClientBuilder.callTimeout(configuration.getCallTimeOut(), TimeUnit.SECONDS);
         okHttpClientBuilder.retryOnConnectionFailure(true);
         okHttpClientBuilder.addNetworkInterceptor(UserAgentInterceptor.using(UserAgent::string));
+        if (configuration.getDns() != null) {
+            okHttpClientBuilder.dns(configuration.getDns());
+        }
 
         OkHttpClient client = okHttpClientBuilder.build();
         LOG.debug(

clickstream/src/test/java/com/amazonaws/solution/clickstream/IntegrationTest.java

@@ -30,6 +30,7 @@
 import com.amazonaws.solution.clickstream.client.Event;
 import com.amazonaws.solution.clickstream.client.EventRecorder;
 import com.amazonaws.solution.clickstream.client.db.ClickstreamDBUtil;
+import com.amazonaws.solution.clickstream.util.CustomOkhttpDns;
 import com.amazonaws.solution.clickstream.util.ReflectUtil;
 import com.github.dreamhead.moco.HttpServer;
 import com.github.dreamhead.moco.Runner;
@@ -451,11 +452,13 @@ public void testCustomConfig() throws Exception {
             .withSendEventsInterval(15000)
             .withTrackAppExceptionEvents(false)
             .withLogEvents(true)
+            .withCustomDns(CustomOkhttpDns.getInstance())
             .withCompressEvents(true);
 
         assertEquals("23982", this.analyticsClient.getClickstreamConfiguration().getAppId());
         assertEquals(assembleEndpointUrl(COLLECT_SUCCESS1),
             this.analyticsClient.getClickstreamConfiguration().getEndpoint());
+        assertEquals(CustomOkhttpDns.getInstance(), this.analyticsClient.getClickstreamConfiguration().getDns());
         assertEquals(15000, this.analyticsClient.getClickstreamConfiguration().getSendEventsInterval());
         Assert.assertFalse(this.analyticsClient.getClickstreamConfiguration().isTrackAppExceptionEvents());
         Assert.assertTrue(this.analyticsClient.getClickstreamConfiguration().isCompressEvents());
@@ -476,6 +479,110 @@ public void testCustomConfig() throws Exception {
         assertEquals(0, dbUtil.getTotalNumber());
     }
 
+    /**
+     * test custom dns for success.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testCustomDnsSuccess() throws Exception {
+        CustomOkhttpDns dns = CustomOkhttpDns.getInstance();
+        dns.setDefaultIp("127.0.0.1");
+
+        ClickstreamAnalytics.getClickStreamConfiguration().withCustomDns(dns);
+
+        assertEquals(dns, this.analyticsClient.getClickstreamConfiguration().getDns());
+
+        ClickstreamAnalytics.recordEvent("testRecordEvent");
+        assertEquals(1, dbUtil.getTotalNumber());
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1500);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
+
+    /**
+     * test custom dns for fail.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testCustomDnsFail() throws Exception {
+        CustomOkhttpDns dns = CustomOkhttpDns.getInstance();
+        dns.setDefaultIp("192.168.1.10");
+        ClickstreamAnalytics.getClickStreamConfiguration().withCustomDns(dns);
+
+        assertEquals(dns, this.analyticsClient.getClickstreamConfiguration().getDns());
+
+        ClickstreamAnalytics.recordEvent("testRecordEvent");
+        assertEquals(1, dbUtil.getTotalNumber());
+        setHttpRequestTimeOut(1L);
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(2000);
+        assertEquals(1, dbUtil.getTotalNumber());
+
+        dns.setDefaultIp("127.0.0.1");
+        setHttpRequestTimeOut(15L);
+        ClickstreamAnalytics.flushEvents();
+        // wait for success
+        Thread.sleep(1000);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
+
+    /**
+     * test custom dns for resolution timeout fail.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testCustomDnsResolutionTimeoutFail() throws Exception {
+        CustomOkhttpDns dns = CustomOkhttpDns.getInstance();
+        dns.setDefaultIp("127.0.0.1");
+        dns.setIsResolutionTimeout(true);
+        setHttpRequestTimeOut(1L);
+
+        ClickstreamAnalytics.getClickStreamConfiguration().withCustomDns(dns);
+        assertEquals(dns, this.analyticsClient.getClickstreamConfiguration().getDns());
+
+        ClickstreamAnalytics.recordEvent("testRecordEvent");
+        assertEquals(1, dbUtil.getTotalNumber());
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1500);
+        assertEquals(1, dbUtil.getTotalNumber());
+
+        dns.setIsResolutionTimeout(false);
+        setHttpRequestTimeOut(15L);
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
+
+    /**
+     * test custom dns for unKnow host fail.
+     *
+     * @throws Exception exception
+     */
+    @Test
+    public void testCustomDnsForUnKnowHostFail() throws Exception {
+        CustomOkhttpDns dns = CustomOkhttpDns.getInstance();
+        dns.setDefaultIp("127.0.0.1");
+        dns.setIsResolutionTimeout(false);
+        dns.setIsUnKnowHost(true);
+        ClickstreamAnalytics.getClickStreamConfiguration().withCustomDns(dns);
+        assertEquals(dns, this.analyticsClient.getClickstreamConfiguration().getDns());
+
+        ClickstreamAnalytics.recordEvent("testRecordEvent");
+        assertEquals(1, dbUtil.getTotalNumber());
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(1, dbUtil.getTotalNumber());
+
+        dns.setIsUnKnowHost(false);
+        ClickstreamAnalytics.flushEvents();
+        Thread.sleep(1000);
+        assertEquals(0, dbUtil.getTotalNumber());
+    }
+
+
     /**
      * test enable.
      *
@@ -567,6 +674,10 @@ private void stopThreadSafely() throws Exception {
         ReflectUtil.modifyFiled(submitter, "handler", mock(Handler.class));
     }
 
+    private void setHttpRequestTimeOut(long timeOutSecond) throws Exception {
+        ReflectUtil.modifyFiled(ClickstreamAnalytics.getClickStreamConfiguration(), "callTimeOut", timeOutSecond);
+    }
+
     /**
      * close db and stop handler executed thread.
      *
@@ -576,6 +687,7 @@ private void stopThreadSafely() throws Exception {
     public void tearDown() throws Exception {
         dbUtil.closeDB();
         stopThreadSafely();
+        ClickstreamAnalytics.getClickStreamConfiguration().withCustomDns(null);
         Map<String, Object> globalAttribute =
             (Map<String, Object>) ReflectUtil.getFiled(analyticsClient, "globalAttributes");
         Map<String, Object> userAttributes =

clickstream/src/test/java/com/amazonaws/solution/clickstream/uniqueid/SharedPrefsUniqueIdServiceTest.java

@@ -22,15 +22,15 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mockito.Mockito;
 import org.robolectric.RobolectricTestRunner;
 import org.robolectric.annotation.Config;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
-import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.anyString;
-import static org.mockito.Matchers.eq;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -39,9 +39,9 @@
 @Config(manifest = Config.NONE)
 public class SharedPrefsUniqueIdServiceTest {
 
-    private final ClickstreamContext mockClickstreamContext = Mockito.mock(ClickstreamContext.class);
-    private final AndroidSystem mockSystem = Mockito.mock(AndroidSystem.class);
-    private final AndroidPreferences mockPreferences = Mockito.mock(AndroidPreferences.class);
+    private ClickstreamContext mockClickstreamContext;
+    private AndroidSystem mockSystem;
+    private AndroidPreferences mockPreferences;
 
     private SharedPrefsUniqueIdService serviceToTest = null;
 
@@ -50,6 +50,9 @@ public class SharedPrefsUniqueIdServiceTest {
      */
     @Before
     public void setup() {
+        mockClickstreamContext = mock(ClickstreamContext.class);
+        mockSystem = mock(AndroidSystem.class);
+        mockPreferences = mock(AndroidPreferences.class);
         when(mockClickstreamContext.getSystem()).thenReturn(mockSystem);
         when(mockSystem.getPreferences()).thenReturn(mockPreferences);
         serviceToTest = new SharedPrefsUniqueIdService();