[Java] rework event module

CHANGELOG.md

@@ -9,6 +9,20 @@
   * "removeFromCohort(key)"
 
 * In Countly class, the old "init(directory,config)" method is deprecated, use "init(config)" instead via "instance()" call.
+* Deprecated "Countly::event" call, deprecated builder pattern. Use "Countly::events" instead.
+* Deprecated "Usage::event" call, deprecated builder pattern. Use "Countly::events" instead.
+* Deprecated "Countly::stop(boolean)" call, use "Countly::halt" instead via "instance()" call.
+
+* The following methods are deprecated from the "Event" interface:
+  * "record"
+  * "endAndRecord"
+  * "addSegment"
+  * "addSegments"
+  * "setSegmentation"
+  * "setSum"
+  * "setCount"
+  * "setDuration"
+  * "isInvalid"
 
 22.09.2
 * Fixed internal log calls that did not respect the configured log level and did not work with the log listener.

build.gradle

@@ -1,37 +1,37 @@
-// Top-level build file where you can add configuration options common to all sub-projects/modules.
-
-buildscript {
-    repositories {
-        google()
-        mavenCentral()
-        jcenter()
-        maven {
-            url "https://maven.google.com"
-        }
-    }
-    dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.3'
-        classpath 'com.github.dcendents:android-maven-plugin:1.2'
-        classpath 'com.google.gms:google-services:4.3.0'
-
-        // NOTE: Do not place your application dependencies here; they belong
-        // in the individual module build.gradle files
-    }
-}
-
-allprojects {
-    ext.CLY_VERSION = "23.8.0"
-    ext.POWERMOCK_VERSION = "1.7.4"
-
-    tasks.withType(Javadoc) {
-        options.addStringOption('Xdoclint:none', '-quiet')
-    }
-    repositories {
-        google()
-        jcenter()
-        //mavenLocal()
-        maven {
-            url "https://maven.google.com" // Google's Maven repository
-        }
-    }
-}
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+        jcenter()
+        maven {
+            url "https://maven.google.com"
+        }
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.1.3'
+        classpath 'com.github.dcendents:android-maven-plugin:1.2'
+        classpath 'com.google.gms:google-services:4.3.0'
+
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+allprojects {
+    ext.CLY_VERSION = "23.8.0"
+    ext.POWERMOCK_VERSION = "1.7.4"
+
+    tasks.withType(Javadoc) {
+        options.addStringOption('Xdoclint:none', '-quiet')
+    }
+    repositories {
+        google()
+        jcenter()
+        //mavenLocal()
+        maven {
+            url "https://maven.google.com" // Google's Maven repository
+        }
+    }
+}

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.ModuleEvents;
+import ly.count.sdk.java.internal.SDKCore;
 
 /**
  * Main Countly SDK API class.
@@ -128,6 +133,7 @@ public static void init(final File sdkStorageRootDirectory, final Config config)
      * Also clears all the data if called with {@code clearData = true}.
      *
      * @param clearData whether to clear all Countly data or not
+     * @deprecated use {@link #halt()} instead via instance() call
      */
     public static void stop(boolean clearData) {
         if (isInitialized()) {
@@ -144,6 +150,13 @@ public static void stop(boolean clearData) {
         }
     }
 
+    /**
+     * Stop Countly SDK. Stops all tasks and releases resources.
+     */
+    public void halt() {
+        stop(true);
+    }
+
     /**
      * Returns whether Countly SDK has been already initialized or not.
      *
@@ -311,12 +324,34 @@ public static void onConsentRemoval(Config.Feature... features) {
         }
     }
 
+    /**
+     * Record event with provided key.
+     *
+     * @param key key for this event, cannot be null or empty
+     * @return Builder object for this event
+     * @deprecated use {@link #events()} instead via instance() call
+     */
     @Override
     public Event event(String key) {
         L.d("[Countly] event: key = " + key);
         return ((Session) sdk.session(ctx, null)).event(key);
     }
 
+    /**
+     * Event module calls
+     *
+     * @return event module otherwise null if SDK is not initialized
+     */
+    public ModuleEvents.Events events() {
+        if (!isInitialized()) {
+            if (L != null) {
+                L.e("[Countly] SDK is not initialized yet.");
+            }
+            return null;
+        }
+        return sdk.events();
+    }
+
     @Override
     public Event timedEvent(String key) {
         L.d("[Countly] timedEvent: key = " + key);

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

@@ -1,5 +1,6 @@
 package ly.count.sdk.java;
 
+import ly.count.sdk.java.internal.ModuleEvents;
 import javax.annotation.Nonnull;
 import java.util.Map;
 
@@ -11,6 +12,7 @@ public interface Event {
     /**
      * Add event to the buffer, send it to the server in case number of events in the session
      * is equal or bigger than {@link Config#eventsBufferSize} or wait until next {@link Session#update()}.
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     void record();
 
@@ -19,6 +21,7 @@ public interface Event {
      * and current time in seconds. Then add the event to its session (if they're enabled),
      * send it to the server in case number of events in the session is equal or bigger
      * than {@link Config#eventsBufferSize} or wait until next {@link Session#update()}.
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#endEvent(String, Map, int, double)} instead
      */
     void endAndRecord();
 
@@ -28,6 +31,7 @@ public interface Event {
      * @param key key of segment, must not be null or empty
      * @param value value of segment, must not be null or empty
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event addSegment(@Nonnull String key, @Nonnull String value);
 
@@ -38,6 +42,7 @@ public interface Event {
      * segmentation from; cannot contain nulls or empty strings; must have
      * even length
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event addSegments(@Nonnull String... segmentation);
 
@@ -46,6 +51,7 @@ public interface Event {
      *
      * @param segmentation map of segment pairs ({key1: value1, key2: value2}
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event setSegmentation(@Nonnull Map<String, String> segmentation);
 
@@ -54,6 +60,7 @@ public interface Event {
      *
      * @param count event count, cannot be 0
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event setCount(int count);
 
@@ -62,6 +69,7 @@ public interface Event {
      *
      * @param sum event sum
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event setSum(double sum);
 
@@ -70,6 +78,7 @@ public interface Event {
      *
      * @param duration event duration
      * @return this instance for method chaining
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent(String, int, double, Map, double)} instead
      */
     Event setDuration(double duration);
 
@@ -81,6 +90,7 @@ public interface Event {
      *     <li>Invalid data supplied (count < 0, NaN as sum, duration < 0, etc.) while in production mode</li>
      *     <li>Event has been already recorded in session, thus should be discarded</li>
      * </ul>
+     * @deprecated this function is deprecated
      */
     boolean isInvalid();
 }

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

@@ -1,5 +1,6 @@
 package ly.count.sdk.java;
 
+import ly.count.sdk.java.internal.ModuleEvents;
 import java.util.Map;
 
 /**
@@ -20,6 +21,7 @@ public interface Usage {
      * @param key key for this event, cannot be null or empty
      * @return Event instance.
      * @see Event#record()
+     * @deprecated this function is deprecated, use {@link ModuleEvents.Events#recordEvent} instead
      */
     Event event(String key);
 

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

@@ -5,7 +5,7 @@
 
 public enum CoreFeature {
     Sessions(1 << 1, ModuleSessions::new),
-    Events(1 << 2),
+    Events(1 << 2, ModuleEvents::new),
     Views(1 << 3, ModuleViews::new),
     CrashReporting(1 << 4, ModuleCrash::new),
     Location(1 << 5),

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

@@ -38,6 +38,22 @@ public interface EventRecorder {
      */
     private boolean invalid = false;
 
+    EventImpl(@Nonnull String key, int count, Double sum, Double duration, @Nonnull Map<String, Object> segmentation, @Nonnull Log givenL) {
+        L = givenL;
+
+        this.recorder = null;
+        this.key = key;
+        this.count = count;
+        this.sum = sum;
+        this.duration = duration;
+        this.segmentation = segmentation;
+        this.timestamp = Device.dev.uniqueTimestamp();
+        this.hour = Device.dev.currentHour();
+        this.dow = Device.dev.currentDayOfWeek();
+    }
+
+
+
     EventImpl(@Nonnull EventRecorder recorder, @Nonnull String key, @Nonnull Log givenL) {
         L = givenL;
         if (recorder == null) {

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

@@ -0,0 +1,86 @@
+package ly.count.sdk.java.internal;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class EventImplQueue {
+
+    static final String DELIMITER = ":::";
+    private final Log L;
+    private final InternalConfig config;
+    final List<EventImpl> eventQueueMemoryCache;
+
+    protected EventImplQueue(Log logger, InternalConfig config) {
+        L = logger;
+        this.config = config;
+        eventQueueMemoryCache = new ArrayList<>(config.getEventsBufferSize());
+    }
+
+    /**
+     * Returns the number of events currently stored in the queue.
+     */
+    protected int eqSize() {
+        return eventQueueMemoryCache.size();
+    }
+
+    void addEvent(final EventImpl event) {
+        L.d("[EventImplQueue] Adding event: " + event.key);
+        if (eventQueueMemoryCache.size() < config.getEventsBufferSize()) {
+            eventQueueMemoryCache.add(event);
+            writeEventQueueToStorage();
+        }
+    }
+
+    /**
+     * set the new value in event data storage
+     */
+    void writeEventQueueToStorage() {
+        final String eventQueue = joinEvents(eventQueueMemoryCache);
+
+        L.d("[EventImplQueue] Setting event data: " + eventQueue);
+        SDKCore.instance.sdkStorage.storeEventQueue(eventQueue);
+    }
+
+    /**
+     * Restores events from disk
+     */
+    void restore() {
+        L.d("[EventImplQueue] Restoring events from disk");
+        eventQueueMemoryCache.clear();
+
+        final String[] array = getEvents();
+        for (String s : array) {
+
+            final EventImpl event = EventImpl.fromJSON(s, (ev) -> {
+            }, L);
+            if (event != null) {
+                eventQueueMemoryCache.add(event);
+            }
+        }
+        // order the events from least to most recent
+        eventQueueMemoryCache.sort((e1, e2) -> (int) (e1.timestamp - e2.timestamp));
+    }
+
+    private String joinEvents(final Collection<EventImpl> collection) {
+        final List<String> strings = new ArrayList<>();
+        for (EventImpl e : collection) {
+            strings.add(e.toJSON(L));
+        }
+        return Utils.join(strings, EventImplQueue.DELIMITER);
+    }
+
+    /**
+     * Returns an unsorted array of the current stored event JSON strings.
+     */
+    private synchronized String[] getEvents() {
+        L.d("[EventImplQueue] Getting events from disk");
+        final String joinedEventsStr = SDKCore.instance.sdkStorage.readEventQueue();
+        return joinedEventsStr.isEmpty() ? new String[0] : joinedEventsStr.split(DELIMITER);
+    }
+
+    public void clear() {
+        SDKCore.instance.sdkStorage.storeEventQueue("");
+        eventQueueMemoryCache.clear();
+    }
+}