[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/Config.java

@@ -367,7 +367,7 @@ public boolean restore(byte[] data, Log L) {
      * Maximum amount of time in seconds between two update requests to the server
      * reporting session duration and other parameters if any added between update requests.
      *
-     * Update request is also sent when number of unsent events reached {@link #eventsBufferSize}.
+     * Update request is also sent when number of unsent events reached {@link #eventQueueThreshold}.
      *
      * Set to 0 to disable update requests based on time.
      */
@@ -380,7 +380,7 @@ public boolean restore(byte[] data, Log L) {
      *
      * Set to 0 to disable buffering.
      */
-    protected int eventsBufferSize = 10;
+    protected int eventQueueThreshold = 10;
 
     /**
      * {@link CrashProcessor}-implementing class which is instantiated when application
@@ -911,12 +911,12 @@ public Config setUpdateSessionTimerDelay(int delay) {
      *
      * Update request is also sent when last update request was sent more than {@link #setSendUpdateEachSeconds(int)} seconds ago.
      *
-     * @param eventsBufferSize max number of events between two update requests, set to 0 to disable update requests based on events.
+     * @param eventQueueThreshold max number of events between two update requests, set to 0 to disable update requests based on events.
      * @return {@code this} instance for method chaining
      * @deprecated this will be removed, please use {@link #setEventQueueSizeToSend(int)}
      */
-    public Config setEventsBufferSize(int eventsBufferSize) {
-        return setEventQueueSizeToSend(eventsBufferSize);
+    public Config setEventsBufferSize(int eventQueueThreshold) {
+        return setEventQueueSizeToSend(eventQueueThreshold);
     }
 
     /**
@@ -933,7 +933,7 @@ public Config setEventQueueSizeToSend(int eventsQueueSize) {
                 configLog.e("[Config] eventsQueueSize cannot be negative");
             }
         } else {
-            this.eventsBufferSize = eventsQueueSize;
+            this.eventQueueThreshold = eventsQueueSize;
         }
         return this;
     }
@@ -1414,12 +1414,13 @@ public int getSendUpdateEachSeconds() {
     }
 
     /**
-     * Getter for {@link #eventsBufferSize}
+     * Getter for {@link #eventQueueThreshold}
      *
-     * @return {@link #eventsBufferSize} value
+     * @return {@link #eventQueueThreshold} value
+     * @deprecated
      */
     public int getEventsBufferSize() {
-        return eventsBufferSize;
+        return eventQueueThreshold;
     }
 
     /**

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

@@ -7,6 +7,7 @@
 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;
 
 /**
@@ -132,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()) {
@@ -148,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.
      *
@@ -315,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;
 
@@ -10,15 +11,19 @@
 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()}.
+     * is equal or bigger than {@link Config#eventQueueThreshold} 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();
 
     /**
      * Set timed {@link Event} duration as difference between moment {@link Event} was created
      * 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()}.
+     * than {@link Config#eventQueueThreshold} 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 +33,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 +44,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 +53,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 +62,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 +71,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 +80,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 +92,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) {