[Java] Complete the feedback widget module

CHANGELOG.md

@@ -3,6 +3,8 @@
 * Deprecated call "resetDeviceId" is removed
 * Deprecated the init time configuration of 'setEventsBufferSize(eventsBufferSize)'. Introduced replacement 'setEventQueueSizeToSend(eventsQueueSize)'
 * Deprecated the init time configuration of 'setSendUpdateEachSeconds(sendUpdateEachSeconds)'. Introduced replacement 'setUpdateSessionTimerDelay(delay)'
+* Added feedback widgets and manual reporting. Added consent for it "Config.Feature.Feedback".
+* Feedback module is accessible through "Countly::instance()::feedback()" call.
 
 * !! Major breaking change !! The following methods and their functionality are deprecated from the "UserEditor" interface and will not function anymore:
   * "addToCohort(key)"

app-java/src/main/java/ly/count/java/demo/BackendModeExample.java

@@ -1,13 +1,12 @@
 package ly.count.java.demo;
 
-import ly.count.sdk.java.Config;
-import ly.count.sdk.java.Countly;
-
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Scanner;
 import java.util.concurrent.CountDownLatch;
+import ly.count.sdk.java.Config;
+import ly.count.sdk.java.Countly;
 
 public class BackendModeExample {
     final static String DEVICE_ID = "device-id";
@@ -314,8 +313,10 @@ public static void main(String[] args) throws Exception {
         String[] sdkStorageRootPath = { System.getProperty("user.home"), "__COUNTLY", "java_test" };
         File sdkStorageRootDirectory = new File(String.join(File.separator, sdkStorageRootPath));
 
-        if(sdkStorageRootDirectory.mkdirs()){
-            System.out.println("Directory creation failed");
+        if (!(sdkStorageRootDirectory.exists() && sdkStorageRootDirectory.isDirectory())) {
+            if (!sdkStorageRootDirectory.mkdirs()) {
+                System.out.println("Directory creation failed");
+            }
         }
 
         // Main initialization call, SDK can be used after this one is done

app-java/src/main/java/ly/count/java/demo/BackendModePerformanceTests.java

@@ -1,13 +1,12 @@
 package ly.count.java.demo;
 
-import ly.count.sdk.java.Config;
-import ly.count.sdk.java.Countly;
-import ly.count.sdk.java.internal.Device;
-
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Scanner;
+import ly.count.sdk.java.Config;
+import ly.count.sdk.java.Countly;
+import ly.count.sdk.java.internal.Device;
 
 public class BackendModePerformanceTests {
     final static String DEVICE_ID = "device-id";
@@ -27,8 +26,10 @@ private static void initSDK(int eventQueueSize, int requestQueueSize) {
         String[] sdkStorageRootPath = { System.getProperty("user.home"), "__COUNTLY", "java_test" };
         File sdkStorageRootDirectory = new File(String.join(File.separator, sdkStorageRootPath));
 
-        if(sdkStorageRootDirectory.mkdirs()){
-            System.out.println("Directory creation failed");
+        if (!(sdkStorageRootDirectory.exists() && sdkStorageRootDirectory.isDirectory())) {
+            if (!sdkStorageRootDirectory.mkdirs()) {
+                System.out.println("Directory creation failed");
+            }
         }
 
         // Main initialization call, SDK can be used after this one is done

app-java/src/main/java/ly/count/java/demo/Example.java

@@ -4,7 +4,6 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Scanner;
-
 import ly.count.sdk.java.Config;
 import ly.count.sdk.java.Countly;
 import ly.count.sdk.java.internal.LogCallback;
@@ -125,8 +124,10 @@ public static void main(String[] args) throws Exception {
         String[] sdkStorageRootPath = { System.getProperty("user.home"), "__COUNTLY", "java_test" };
         File sdkStorageRootDirectory = new File(String.join(File.separator, sdkStorageRootPath));
 
-        if(sdkStorageRootDirectory.mkdirs()){
-            System.out.println("Directory creation failed");
+        if (!(sdkStorageRootDirectory.exists() && sdkStorageRootDirectory.isDirectory())) {
+            if (!sdkStorageRootDirectory.mkdirs()) {
+                System.out.println("Directory creation failed");
+            }
         }
 
         Config config = new Config(COUNTLY_SERVER_URL, COUNTLY_APP_KEY, sdkStorageRootDirectory)

sdk-java/src/main/java/ly/count/sdk/java/Config.java

@@ -12,8 +12,13 @@
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
-
-import ly.count.sdk.java.internal.*;
+import ly.count.sdk.java.internal.Byteable;
+import ly.count.sdk.java.internal.CoreFeature;
+import ly.count.sdk.java.internal.ImmediateRequestGenerator;
+import ly.count.sdk.java.internal.Log;
+import ly.count.sdk.java.internal.LogCallback;
+import ly.count.sdk.java.internal.ModuleBase;
+import ly.count.sdk.java.internal.Utils;
 
 /**
  * Countly configuration object.
@@ -76,7 +81,8 @@ public enum Feature {
         Views(CoreFeature.Views.getIndex()),
         CrashReporting(CoreFeature.CrashReporting.getIndex()),
         Location(CoreFeature.Location.getIndex()),
-        UserProfiles(CoreFeature.UserProfiles.getIndex());
+        UserProfiles(CoreFeature.UserProfiles.getIndex()),
+        Feedback(CoreFeature.Feedback.getIndex());
         //        StarRating(1 << 12),
         //        RemoteConfig(1 << 13),
         //        PerformanceMonitoring(1 << 14);
@@ -110,6 +116,8 @@ public static Config.Feature byIndex(int index) {
                 //                return RemoteConfig;
                 //            } else if (index == PerformanceMonitoring.index) {
                 //                return PerformanceMonitoring;
+            } else if (index == Feedback.index) {
+                return Feedback;
             } else {
                 return null;
             }
@@ -462,6 +470,8 @@ public boolean restore(byte[] data, Log L) {
      */
     File sdkStorageRootDirectory = null;
 
+    protected ImmediateRequestGenerator immediateRequestGenerator = null;
+
     //    /**
     //    * Maximum size of all string keys
     //    */

sdk-java/src/main/java/ly/count/sdk/java/Countly.java

@@ -2,8 +2,13 @@
 
 import java.io.File;
 import java.util.Map;
-
-import ly.count.sdk.java.internal.*;
+import ly.count.sdk.java.internal.CtxCore;
+import ly.count.sdk.java.internal.Device;
+import ly.count.sdk.java.internal.InternalConfig;
+import ly.count.sdk.java.internal.Log;
+import ly.count.sdk.java.internal.ModuleBackendMode;
+import ly.count.sdk.java.internal.ModuleFeedback;
+import ly.count.sdk.java.internal.SDKCore;
 
 /**
  * Main Countly SDK API class.
@@ -311,6 +316,16 @@ public static void onConsentRemoval(Config.Feature... features) {
         }
     }
 
+    /**
+     * <code>Feedback</code> interface to use feedback widgets nps,rating and forms.
+     * And do manual reporting of feedbacks.
+     *
+     * @return {@link ModuleFeedback.Feedback} instance.
+     */
+    public ModuleFeedback.Feedback feedback() {
+        return sdk.feedback();
+    }
+
     @Override
     public Event event(String key) {
         L.d("[Countly] event: key = " + key);

sdk-java/src/main/java/ly/count/sdk/java/internal/CountlyFeedbackWidget.java

@@ -0,0 +1,22 @@
+package ly.count.sdk.java.internal;
+
+import java.util.Arrays;
+
+public class CountlyFeedbackWidget {
+    public String widgetId;
+    public FeedbackWidgetType type;
+    public String name;
+    public String[] tags;
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof CountlyFeedbackWidget)) {
+            return false;
+        }
+        CountlyFeedbackWidget gonnaCompare = (CountlyFeedbackWidget) o;
+
+        String str = widgetId + type + name + Arrays.toString(tags);
+        String str2 = gonnaCompare.widgetId + gonnaCompare.type + gonnaCompare.name + Arrays.toString(gonnaCompare.tags);
+        return str.equals(str2);
+    }
+}

sdk-java/src/main/java/ly/count/sdk/java/internal/DefaultNetworking.java

@@ -69,4 +69,9 @@ public void stop(CtxCore ctx) {
         shutdown = true;
         tasks.shutdown();
     }
+
+    @Override
+    public Transport getTransport() {
+        return transport;
+    }
 }

sdk-java/src/main/java/ly/count/sdk/java/internal/FeedbackWidgetType.java

@@ -0,0 +1,13 @@
+package ly.count.sdk.java.internal;
+
+public enum FeedbackWidgetType {
+    survey("[CLY]_survey"),
+    nps("[CLY]_nps"),
+    rating("[CLY]_star_rating");
+
+    final String eventKey;
+
+    FeedbackWidgetType(String eventKey) {
+        this.eventKey = eventKey;
+    }
+}

sdk-java/src/main/java/ly/count/sdk/java/internal/ImmediateRequestGenerator.java

@@ -0,0 +1,17 @@
+package ly.count.sdk.java.internal;
+
+/**
+ * Interface for creating ImmediateRequestMaker
+ * a basic factory pattern implementation
+ *
+ * @see ImmediateRequestI
+ */
+public interface ImmediateRequestGenerator {
+    /**
+     * Create a new instance of ImmediateRequestI
+     * and override when needed
+     *
+     * @return new instance of ImmediateRequestI
+     */
+    ImmediateRequestI createImmediateRequestMaker();
+}

sdk-java/src/main/java/ly/count/sdk/java/internal/ImmediateRequestI.java

@@ -0,0 +1,17 @@
+package ly.count.sdk.java.internal;
+
+public interface ImmediateRequestI {
+
+    /**
+     * Do the work of making the request directly without waiting for the queue.
+     *
+     * @param requestData query parameters
+     * @param customEndpoint custom endpoint to use instead of the default one
+     * @param cp transport to use when making the request
+     * @param requestShouldBeDelayed whether the request should be delayed or not
+     * @param networkingIsEnabled whether networking is enabled or not
+     * @param callback callback to call when the request is done
+     * @param log logger to use
+     */
+    void doWork(String requestData, String customEndpoint, Transport cp, boolean requestShouldBeDelayed, boolean networkingIsEnabled, ImmediateRequestMaker.InternalImmediateRequestCallback callback, Log log);
+}

sdk-java/src/main/java/ly/count/sdk/java/internal/ImmediateRequestMaker.java

@@ -0,0 +1,116 @@
+package ly.count.sdk.java.internal;
+
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.util.concurrent.CompletableFuture;
+import org.json.JSONObject;
+
+/**
+ * Async task for making immediate server requests
+ */
+class ImmediateRequestMaker implements ImmediateRequestI {
+
+    @Override
+    public void doWork(String requestData, String customEndpoint, Transport cp, boolean requestShouldBeDelayed, boolean networkingIsEnabled, InternalImmediateRequestCallback callback, Log log) {
+        CompletableFuture.supplyAsync(() -> doInBackground(requestData, customEndpoint, cp, requestShouldBeDelayed, networkingIsEnabled, callback, log))
+            .thenAcceptAsync(this::onFinished);
+    }
+
+    /**
+     * Used for callback from async task
+     */
+    protected interface InternalImmediateRequestCallback {
+        void callback(JSONObject checkResponse);
+    }
+
+    private InternalImmediateRequestCallback callback;
+    private Log L;
+
+    /**
+     * params fields:
+     * 0 - requestData
+     * 1 - custom endpoint
+     * 2 - connection processor
+     * 3 - requestShouldBeDelayed
+     * 4 - networkingIsEnabled
+     * 5 - callback
+     * 6 - log module
+     */
+    private JSONObject doInBackground(String requestData, String customEndpoint, Transport cp, boolean requestShouldBeDelayed, boolean networkingIsEnabled, InternalImmediateRequestCallback callback, Log log) {
+        this.callback = callback;
+        L = log;
+        if (!networkingIsEnabled) {
+            L.w("[ImmediateRequestMaker] ImmediateRequestMaker, Networking config is disabled, request cancelled. Endpoint[" + customEndpoint + "] request[" + requestData + "]");
+
+            return null;
+        }
+
+        L.v("[ImmediateRequestMaker] Starting request");
+
+        HttpURLConnection connection = null;
+
+        try {
+            L.d("[ImmediateRequestMaker] delayed[" + requestShouldBeDelayed + "] hasCallback[" + (callback != null) + "] endpoint[" + customEndpoint + "] request[" + requestData + "]");
+
+            if (requestShouldBeDelayed) {
+                //used in cases after something has to be done after a device id change
+                L.v("[ImmediateRequestMaker] request should be delayed, waiting for 0.5 seconds");
+
+                try {
+                    Thread.sleep(500);
+                } catch (InterruptedException e) {
+                    L.w("[ImmediateRequestMaker] While waiting for 0.5 seconds in ImmediateRequestMaker, sleep was interrupted");
+                }
+            }
+            Request request = new Request();
+            request.params.add(requestData);
+            request.endpoint(customEndpoint);
+            //getting connection ready
+            try {
+                connection = cp.connection(request);
+            } catch (IOException e) {
+                L.e("[ImmediateRequestMaker] IOException while preparing remote config update request :[" + e.toString() + "]");
+                return null;
+            }
+            //connecting
+            connection.connect();
+
+            int code = connection.getResponseCode();
+            String receivedBuffer = cp.response(connection);
+
+            if (receivedBuffer == null) {
+                L.e("[ImmediateRequestMaker] Encountered problem while making a immediate server request, received result was null");
+                return null;
+            }
+
+            char firstChar = receivedBuffer.trim().charAt(0);
+            if (code >= 200 && code < 300 && (firstChar == '[' || receivedBuffer.contains("result"))) {
+                L.d("[ImmediateRequestMaker] Received the following response, :[" + receivedBuffer + "]");
+
+                // we check if the result was a json array or json object and convert the array into an object if necessary
+                if (firstChar == '[') {
+                    return new JSONObject("{\"jsonArray\":" + receivedBuffer + "}");
+                }
+                return new JSONObject(receivedBuffer);
+            } else {
+                L.e("[ImmediateRequestMaker] Encountered problem while making a immediate server request, :[" + receivedBuffer + "]");
+                return null;
+            }
+        } catch (Exception e) {
+            L.e("[ImmediateRequestMaker] Received exception while making a immediate server request " + e.getMessage());
+        } finally {
+            if (connection != null) {
+                connection.disconnect();
+            }
+        }
+        L.v("[ImmediateRequestMaker] Finished request");
+        return null;
+    }
+
+    private void onFinished(JSONObject result) {
+        L.v("[ImmediateRequestMaker] onPostExecute");
+        if (callback != null) {
+            callback.callback(result);
+        }
+    }
+}