Collect and send custom attributes for capture feature

plugins/library/src/main/java/com/deploygate/plugins/BaseSdkPlugin.kt

@@ -16,7 +16,7 @@ abstract class BaseSdkPlugin : Plugin<Project> {
         /**
          * sdk/java/com/deploygate/sdk/HostAppTest.java needs to be changed for a new release
          */
-        const val ARTIFACT_VERSION = "4.7.1"
+        const val ARTIFACT_VERSION = "4.8.0"
 
         val JAVA_VERSION = JavaVersion.VERSION_1_7
     }

sample/src/main/AndroidManifest.xml

@@ -15,6 +15,9 @@
     <!-- only for sample app -->
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
 
+    <!-- collecting stats data from app&device -->
+    <uses-permission android:name="com.deploygate.permission.ACCESS_SDK" />
+
     <!--
       If you have multiple processes in your application, or you want to customize SDK initializer,
       you need to add your own Application class here. In this example, the class is
@@ -67,4 +70,8 @@
         <!-- SDK will be initialized through ContentProvider by default -->
         <!-- Please refer to stablereal/AndroidManifest.xml -->
     </application>
+
+    <queries>
+        <provider android:authorities="com.deploygate.external.sdk" />
+    </queries>
 </manifest>

sample/src/main/java/com/deploygate/sample/App.java

@@ -1,9 +1,11 @@
 package com.deploygate.sample;
 
 import android.app.Application;
+import android.content.res.Configuration;
 import android.os.Bundle;
 import android.util.Log;
 
+import com.deploygate.sdk.CustomAttributes;
 import com.deploygate.sdk.DeployGate;
 import com.deploygate.sdk.DeployGateCallback;
 
@@ -34,6 +36,10 @@ public void onInitialized(boolean isServiceAvailable) {
                 if (isServiceAvailable) {
                     Log.i(TAG, "SDK is available");
                     DeployGate.logInfo("SDK is available");
+
+                    CustomAttributes attrs = DeployGate.getBuildEnvironment();
+                    attrs.putString("build_type", BuildConfig.BUILD_TYPE);
+                    attrs.putString("flavor", BuildConfig.FLAVOR);
                 } else {
                     Log.i(TAG, "SDK is unavailable");
                     DeployGate.logInfo("SDK is unavailable"); // this fails silently
@@ -84,4 +90,14 @@ public void onUpdateAvailable(
         //
         // You can use DeployGate.isAuthorized() later to check the installation is valid or not.
     }
+
+    @Override
+    public void onConfigurationChanged(Configuration newConfig) {
+        super.onConfigurationChanged(newConfig);
+
+        CustomAttributes attrs = DeployGate.getRuntimeExtra();
+        attrs.putString("locale", newConfig.locale.toString());
+        attrs.putInt("orientation", newConfig.orientation);
+        attrs.putFloat("font_scale", newConfig.fontScale);
+    }
 }

sample/src/main/java/com/deploygate/sample/SampleActivity.java

@@ -14,6 +14,7 @@
 import android.widget.TextView;
 import android.widget.Toast;
 
+import com.deploygate.sdk.CustomAttributes;
 import com.deploygate.sdk.DeployGate;
 import com.deploygate.sdk.DeployGateCallback;
 
@@ -53,6 +54,15 @@ public void onCreate(Bundle savedInstanceState) {
         mUpdateButton = (Button) findViewById(R.id.updateButton);
         mLogMessage = (EditText) findViewById(R.id.message);
         mDistributionComments = (LinearLayout) findViewById(R.id.distributionComments);
+
+
+        CustomAttributes attrs = DeployGate.getRuntimeExtra();
+        attrs.putString("string", "value");
+        attrs.putInt("int", 123);
+        attrs.putBoolean("boolean", true);
+        attrs.putFloat("float", 1.23f);
+        attrs.putDouble("double", 1.23);
+        attrs.putLong("long", 123L);
     }
 
     @Override

sdk/src/main/java/com/deploygate/sdk/CustomAttributes.java

@@ -0,0 +1,193 @@
+package com.deploygate.sdk;
+
+import com.deploygate.sdk.internal.Logger;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.util.regex.Pattern;
+
+/**
+ * This class provides store key-value pairs.
+ * These methods are thread-safe.
+ */
+public final class CustomAttributes {
+
+  private static final String TAG = "CustomAttributes";
+
+  private static final int MAX_ATTRIBUTES_SIZE = 8;
+  private static final Pattern VALID_KEY_PATTERN = Pattern.compile("^[a-z][_a-z0-9]{2,31}$");
+  private static final int MAX_VALUE_LENGTH = 64;
+
+  private final Object mLock;
+  private JSONObject attributes;
+
+  CustomAttributes() {
+    mLock = new Object();
+    attributes = new JSONObject();
+  }
+
+  /**
+   * Put a string value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value value must be non-null and its length must be less than 64.
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putString(String key, String value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Put an int value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value int value
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putInt(String key, int value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Put a long value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value long value
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putLong(String key, long value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Put a float value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value float value
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putFloat(String key, float value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Put a double value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value double value
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putDouble(String key, double value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Put a boolean value with the key.
+   * If the key already exists, the value will be overwritten.
+   * @param key key must be non-null and match the valid pattern.
+   * @param value boolean value
+   * @return true if the value is put successfully, otherwise false.
+   * @see CustomAttributes#VALID_KEY_PATTERN
+   */
+  public boolean putBoolean(String key, boolean value) {
+    return putInternal(key, value);
+  }
+
+  /**
+   * Remove the value with the key.
+   * @param key name of the key to be removed.
+   */
+  public void remove(String key) {
+    synchronized (mLock) {
+      attributes.remove(key);
+    }
+  }
+
+  /**
+   * Remove all key-value pairs.
+   */
+  public void removeAll() {
+    synchronized (mLock) {
+      // recreate new object instead of removing all keys
+      attributes = new JSONObject();
+    }
+  }
+
+  int size() {
+    synchronized (mLock) {
+      return attributes.length();
+    }
+  }
+
+  String getJSONString() {
+    synchronized (mLock) {
+      return attributes.toString();
+    }
+  }
+
+  private boolean putInternal(String key, Object value) {
+    if (!isValidKey(key)) {
+      return false;
+    }
+
+    if (!isValidValue(value)) {
+      return false;
+    }
+
+    synchronized (mLock) {
+      try {
+        attributes.put(key, value);
+
+        if (attributes.length() > MAX_ATTRIBUTES_SIZE) {
+          // rollback put operation
+          attributes.remove(key);
+          Logger.w(TAG, "Attributes already reached max size. Ignored: " + key);
+          return false;
+        }
+      } catch (JSONException e) {
+        Logger.w(TAG, "Failed to put attribute: " + key, e);
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  private boolean isValidKey(String key) {
+    if (key == null || key.equals("true") || key.equals("false") || key.equals("null")) {
+      Logger.w(TAG, "Not allowed key: " + key);
+      return false;
+    }
+
+    if (!VALID_KEY_PATTERN.matcher(key).matches()) {
+      Logger.w(TAG, "Invalid key: " + key);
+      return false;
+    }
+
+    return true;
+  }
+
+  private boolean isValidValue(Object value) {
+    if (value == null) {
+      Logger.w(TAG, "Value is null");
+      return false;
+    }
+
+    if (value instanceof String && ((String) value).length() > MAX_VALUE_LENGTH) {
+      Logger.w(TAG, "Value too long: " + value);
+      return false;
+    } else if (value instanceof String || value instanceof Number || value instanceof Boolean) {
+      return true;
+    } else {
+      // dead code
+      Logger.w(TAG, "Invalid value: " + value);
+      return false;
+    }
+  }
+}