release: SDK 3.2.0

Author: arnaud-roland

Sources/gradle/libs.versions.toml

@@ -1,19 +1,19 @@
 [versions]
-agp = "8.12.0"
+agp = "8.13.1"
 android = "4.1.1.4"
 androidCompileSdk = "36"
 androidMinSdk = "21"
-androidLint = "31.12.0"
+androidLint = "31.13.1"
 androidxJunit = "1.2.1"
 androidXCoreKtx = "1.16.0"
 androidXLibraryVersion = "1.0.0"
 androidXTestCoreKtx = "1.6.1"
 androidXTestRunner = "1.6.2"
 androidXTestTruth = "1.6.0"
 assertjCore = "3.24.2"
-batchSdk = "3.1.1"
-batchApiLevel = "311"
-batchMessagingApiLevel = "31"
+batchSdk = "3.2.0"
+batchApiLevel = "320"
+batchMessagingApiLevel = "32"
 batchResourcePrefix = "com_batchsdk_"
 batchNamespace = "com.batch.android"
 batchTestNamespace = "com.batch.android.test"

Sources/sdk/src/main/java/com/batch/android/BatchEventAttributes.java

@@ -79,7 +79,7 @@ public String getLabel() {
      * Add a string attribute for the specified key
      *
      * @param key   Attribute key. Should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
-     * @param value String value to add. Can't be longer than 64 characters, and can't be empty or null. For better results, you should trim/lowercase your strings, and use slugs when possible.
+     * @param value String value to add. Can't be longer than 300 characters, and can't be empty or null. For better results, you should trim/lowercase your strings, and use slugs when possible.
      * @return Same BatchEventAttributes instance, for chaining
      */
     public BatchEventAttributes put(@NonNull String key, @NonNull String value) {

Sources/sdk/src/main/java/com/batch/android/BatchProfileAttributeEditor.java

@@ -275,24 +275,14 @@ public BatchProfileAttributeEditor setAttribute(final @NonNull String key, @NonN
      * Set a custom profile attribute for a key.
      *
      * @param key   Attribute key, can't be null. It should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
-     * @param value Attribute value, can't be null or empty. Must be a string not longer than 64 characters. For better results, you should make them upper/lowercase and trim the whitespaces.
+     * @param value Attribute value, can't be null or empty. Must be a string not longer than 300 characters. For better results, you should make them upper/lowercase and trim the whitespaces.
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor setAttribute(final @NonNull String key, final @NonNull String value) {
         try {
             ProfileDataHelper.assertNotNull(value);
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringValue(value)) {
-                Logger.error(
-                    TAG,
-                    "String attributes can't be null or longer than " +
-                    ProfileDataHelper.ATTR_STRING_MAX_LENGTH +
-                    " characters. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
+            ProfileDataHelper.validateCEPStringValue(value);
             this.profileUpdateOperation.addAttribute(normalizedKey, new UserAttribute(value, AttributeType.STRING));
         } catch (AttributeValidationException e) {
             e.printErrorMessage(TAG, key);
@@ -349,21 +339,13 @@ public BatchProfileAttributeEditor setAttribute(final @NonNull String key, final
      * Set a custom profile attribute for a key.
      *
      * @param key   Attribute key, can't be null. It should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
-     * @param value Attribute value, can't be null or empty. Must be a valid List not longer than X items.
+     * @param value Attribute value, can't be null or empty. Must be a valid List not longer than 25 items.
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor setAttribute(final @NonNull String key, final @NonNull List<String> value) {
         try {
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringArray(value)) {
-                Logger.error(
-                    TAG,
-                    "Array of string attributes must not be longer than 25 items, only values of type String and must respect the string attribute limitations. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
+            ProfileDataHelper.validateStringArray(value);
             this.profileUpdateOperation.addAttribute(
                     normalizedKey,
                     new UserAttribute(new ArrayList<>(value), AttributeType.STRING_ARRAY)
@@ -406,23 +388,12 @@ public BatchProfileAttributeEditor removeAttribute(@NonNull String key) {
      * Add a string value in the specified array attribute. If empty, the collection will automatically be created.
      *
      * @param key The array attribute to add the value to. Cannot be null. Must be a string of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
-     * @param value The value to add. Cannot be null or empty. Must be a string no longer than 64 characters.
+     * @param value The value to add. Cannot be null or empty. Must be a string no longer than 300 characters.
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor addToArray(final @NonNull String key, final @NonNull String value) {
         try {
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringValue(value)) {
-                Logger.error(
-                    TAG,
-                    "Strings in Array attributes can't be null or longer than " +
-                    ProfileDataHelper.ATTR_STRING_MAX_LENGTH +
-                    " characters. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
             this.profileUpdateOperation.addToList(normalizedKey, new ArrayList<>(Collections.singletonList(value)));
         } catch (AttributeValidationException e) {
             e.printErrorMessage(TAG, key);
@@ -436,21 +407,12 @@ public BatchProfileAttributeEditor addToArray(final @NonNull String key, final @
      * Add a list of strings in the specified array attribute. If empty, the collection will automatically be created.
      *
      * @param key The array attribute to add the value to. Cannot be null. Must be a string of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
-     * @param values The strings to add. Cannot be null or empty. Must be strings no longer than 64 characters and max 25 items
+     * @param values The strings to add. Cannot be null or empty. Must be strings no longer than 300 characters and max 25 items
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor addToArray(final @NonNull String key, final @NonNull List<String> values) {
         try {
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringArray(values)) {
-                Logger.error(
-                    TAG,
-                    "Array of string attributes must not be longer than 25 items, only values of type String and must respect the string attribute limitations. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
             this.profileUpdateOperation.addToList(normalizedKey, new ArrayList<>(values));
         } catch (AttributeValidationException e) {
             e.printErrorMessage(TAG, key);
@@ -464,26 +426,15 @@ public BatchProfileAttributeEditor addToArray(final @NonNull String key, final @
 
     /**
      * Removes a string from an array attribute.
-     * Does nothing if the tag does not exist.
+     * Does nothing if the value does not exist.
      *
-     * @param key Array attribute name
-     * @param value The value to remove
+     * @param key The array attribute to remove the value to. Cannot be null. Must be a string of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
+     * @param value The value to remove. Cannot be null or empty. Must be a string no longer than 300 characters.
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor removeFromArray(final @NonNull String key, final @NonNull String value) {
         try {
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringValue(value)) {
-                Logger.error(
-                    TAG,
-                    "Strings in Array attributes can't be null or longer than " +
-                    ProfileDataHelper.ATTR_STRING_MAX_LENGTH +
-                    " characters. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
             this.profileUpdateOperation.removeFromList(
                     normalizedKey,
                     new ArrayList<>(Collections.singletonList(value))
@@ -498,24 +449,15 @@ public BatchProfileAttributeEditor removeFromArray(final @NonNull String key, fi
 
     /**
      * Removes a list of strings from an array attribute.
-     * Does nothing if the tag does not exist.
+     * Does nothing if an item does not exist.
      *
-     * @param key Array attribute name
-     * @param values The values to remove
+     * @param key The array attribute to remove the value from. Cannot be null. Must be a string of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
+     * @param values The strings to remove. Cannot be null or empty. Must be strings no longer than 300 characters and max 25 items
      * @return This object instance, for method chaining
      */
     public BatchProfileAttributeEditor removeFromArray(final @NonNull String key, final @NonNull List<String> values) {
         try {
             String normalizedKey = ProfileDataHelper.normalizeAttributeKey(key);
-            if (ProfileDataHelper.isNotValidStringArray(values)) {
-                Logger.error(
-                    TAG,
-                    "Array of string attributes must not be longer than 25 items, only values of type String and must respect the string attribute limitations. Ignoring attribute '" +
-                    key +
-                    "'"
-                );
-                return this;
-            }
             this.profileUpdateOperation.removeFromList(normalizedKey, new ArrayList<>(values));
         } catch (AttributeValidationException e) {
             e.printErrorMessage(TAG, key);

Sources/sdk/src/main/java/com/batch/android/MetricWebservice.java

@@ -2,41 +2,50 @@
 
 import android.content.Context;
 import com.batch.android.core.Logger;
-import com.batch.android.core.MessagePackWebservice;
 import com.batch.android.core.ParameterKeys;
+import com.batch.android.core.Parameters;
 import com.batch.android.core.TaskRunnable;
+import com.batch.android.core.Webservice;
 import com.batch.android.core.domain.DomainURLBuilder;
 import com.batch.android.post.MetricPostDataProvider;
 import com.batch.android.webservice.listener.MetricWebserviceListener;
 import java.net.MalformedURLException;
+import java.util.HashMap;
+import java.util.Map;
 
-class MetricWebservice extends MessagePackWebservice implements TaskRunnable {
+class MetricWebservice extends Webservice implements TaskRunnable {
 
     private static final String TAG = "MetricWebservice";
 
     private final MetricWebserviceListener listener;
+    private final MetricPostDataProvider dataProvider;
 
     protected MetricWebservice(
         Context context,
         MetricWebserviceListener listener,
         MetricPostDataProvider dataProvider,
         String... parameters
     ) throws MalformedURLException {
-        super(context, dataProvider, DomainURLBuilder.METRIC_WS_URL, parameters);
+        super(context, RequestType.POST, DomainURLBuilder.METRIC_WS_URL, parameters);
         if (listener == null) {
             throw new NullPointerException("Listener is null");
         }
+        if (dataProvider == null || dataProvider.isEmpty()) {
+            throw new NullPointerException("Provider is empty");
+        }
+
         this.listener = listener;
+        this.dataProvider = dataProvider;
     }
 
     @Override
     public void run() {
         Logger.internal(TAG, "Webservice started");
         try {
             executeRequest();
-            this.listener.onSuccess();
+            listener.onSuccess();
         } catch (WebserviceError error) {
-            this.listener.onFailure(error);
+            listener.onFailure(error);
         }
     }
 
@@ -45,6 +54,53 @@ public String getTaskIdentifier() {
         return "Batch/metricsws";
     }
 
+    @Override
+    protected MetricPostDataProvider getPostDataProvider() {
+        return dataProvider;
+    }
+
+    @Override
+    protected Map<String, String> getHeaders() {
+        Map<String, String> headers = new HashMap<>();
+        headers.put("x-batch-sdk-version", Parameters.SDK_VERSION);
+        return headers;
+    }
+
+    @Override
+    protected String getURLSorterPatternParameterKey() {
+        return ParameterKeys.METRIC_WS_URLSORTER_PATTERN_KEY;
+    }
+
+    @Override
+    protected String getCryptorTypeParameterKey() {
+        return ParameterKeys.METRIC_WS_CRYPTORTYPE_KEY;
+    }
+
+    @Override
+    protected String getCryptorModeParameterKey() {
+        return ParameterKeys.METRIC_WS_CRYPTORMODE_KEY;
+    }
+
+    @Override
+    protected String getPostCryptorTypeParameterKey() {
+        return ParameterKeys.METRIC_WS_POST_CRYPTORTYPE_KEY;
+    }
+
+    @Override
+    protected String getReadCryptorTypeParameterKey() {
+        return ParameterKeys.METRIC_WS_READ_CRYPTORTYPE_KEY;
+    }
+
+    @Override
+    protected String getSpecificConnectTimeoutKey() {
+        return ParameterKeys.METRIC_WS_CONNECT_TIMEOUT_KEY;
+    }
+
+    @Override
+    protected String getSpecificReadTimeoutKey() {
+        return ParameterKeys.METRIC_WS_READ_TIMEOUT_KEY;
+    }
+
     @Override
     protected String getSpecificRetryCountKey() {
         return ParameterKeys.METRIC_WS_RETRYCOUNT_KEY;