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
     }

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

@@ -49,6 +49,13 @@ public class DeployGate {
     private static final String DEPLOYGATE_PACKAGE = "com.deploygate";
     private static final Object sPendingEventLock = new Object();
 
+    private static final int MAX_BUILD_ENVIRONMENTS_SIZE = 8;
+    private static final int MAX_RUNTIME_EXTRAS_SIZE = 8;
+    private static final Pattern USER_INPUT_KEY_PATTERN = Pattern.compile("^[a-z][_a-z0-9]{2,31}$");
+    private static final int MIN_USER_INPUT_KEY_LENGTH = 3;
+    private static final int MAX_USER_INPUT_KEY_LENGTH = 32;
+    private static final int MAX_USER_INPUT_VALUE_LENGTH = 64;
+
     private static DeployGate sInstance;
 
     private final Context mApplicationContext;
@@ -59,6 +66,8 @@ public class DeployGate {
     private final CustomLogInstructionSerializer mCustomLogInstructionSerializer;
     private final HashSet<DeployGateCallback> mCallbacks;
     private final HashMap<String, Bundle> mPendingEvents;
+    private final HashMap<String, Object> mBuildEnvironments;
+    private final HashMap<String, Object> mRuntimeExtras;
     private final String mExpectedAuthor;
     private String mAuthor;
 
@@ -279,6 +288,8 @@ private DeployGate(
         mCustomLogInstructionSerializer = new CustomLogInstructionSerializer(mHostApp.packageName, sdkConfiguration.customLogConfiguration);
         mCallbacks = new HashSet<>();
         mPendingEvents = new HashMap<>();
+        mBuildEnvironments = new HashMap<>();
+        mRuntimeExtras = new HashMap<>();
         mExpectedAuthor = sdkConfiguration.appOwnerName;
 
         prepareBroadcastReceiver();
@@ -1390,4 +1401,192 @@ public static String getDistributionUserName() {
 
         return sInstance.mDistributionUserName;
     }
+
+    public static boolean putBuildEnvironmentValue(String key, String value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putBuildEnvironmentValue(String key, int value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putBuildEnvironmentValue(String key, long value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putBuildEnvironmentValue(String key, float value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putBuildEnvironmentValue(String key, double value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putBuildEnvironmentValue(String key, boolean value) {
+        if (sInstance != null) {
+            return sInstance.putBuildEnvironmentValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static void removeBuildEnvironmentValue(String key) {
+        if (sInstance != null) {
+            sInstance.removeBuildEnvironmentValueInternal(key);
+        }
+    }
+
+    public static void removeAllBuildEnvironmentValues() {
+        if (sInstance != null) {
+            sInstance.removeAllBuildEnvironmentValuesInternal();
+        }
+    }
+
+    public static boolean putRuntimeExtraValue(String key, String value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putRuntimeExtraValue(String key, int value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putRuntimeExtraValue(String key, long value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putRuntimeExtraValue(String key, float value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putRuntimeExtraValue(String key, double value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static boolean putRuntimeExtraValue(String key, boolean value) {
+        if (sInstance != null) {
+            return sInstance.putRuntimeExtraValueInternal(key, value);
+        }
+        return false;
+    }
+
+    public static void removeRuntimeExtraValue(String key) {
+        if (sInstance != null) {
+            sInstance.removeRuntimeExtraValueInternal(key);
+        }
+    }
+
+    public static void removeAllRuntimeExtraValues() {
+        if (sInstance != null) {
+            sInstance.removeAllRuntimeExtraValuesInternal();
+        }
+    }
+
+    private boolean putBuildEnvironmentValueInternal(String key, Object value) {
+        if (mBuildEnvironments.size() >= MAX_BUILD_ENVIRONMENTS_SIZE && !mBuildEnvironments.containsKey(key)) {
+            Log.w(TAG, "BuildEnvironment already full. Ignored: " + key);
+            return false;
+        }
+
+        if (!isValidKey(key)) {
+            return false;
+        }
+
+        if (!isValidValue(value)) {
+            return false;
+        }
+
+        mBuildEnvironments.put(key, value);
+        return true;
+    }
+
+    private void removeBuildEnvironmentValueInternal(String key) {
+        mBuildEnvironments.remove(key);
+    }
+
+    private void removeAllBuildEnvironmentValuesInternal() {
+        mBuildEnvironments.clear();
+    }
+
+    private boolean putRuntimeExtraValueInternal(String key, Object value) {
+        if (mRuntimeExtras.size() >= MAX_RUNTIME_EXTRAS_SIZE && !mRuntimeExtras.containsKey(key)) {
+            Log.w(TAG, "RuntimeExtra already full. Ignored: " + key);
+            return false;
+        }
+
+        if (!isValidKey(key)) {
+            return false;
+        }
+
+        if (!isValidValue(value)) {
+            return false;
+        }
+
+        mRuntimeExtras.put(key, value);
+        return true;
+    }
+
+    private void removeRuntimeExtraValueInternal(String key) {
+        mRuntimeExtras.remove(key);
+    }
+
+    private void removeAllRuntimeExtraValuesInternal() {
+        mRuntimeExtras.clear();
+    }
+
+    private boolean isValidKey(String key) {
+        if (key == null || key.equals("true") || key.equals("false") || key.equals("null")) {
+            Log.w(TAG, "Not allowed key: " + key);
+            return false;
+        }
+
+        if (key.length() < MIN_USER_INPUT_KEY_LENGTH || key.length() > MAX_USER_INPUT_KEY_LENGTH || !USER_INPUT_KEY_PATTERN.matcher(key).matches()) {
+            Log.w(TAG, "Invalid key: " + key);
+            return false;
+        }
+
+        return true;
+    }
+
+    private boolean isValidValue(Object value) {
+        if (value == null) {
+            Log.w(TAG, "Value is null");
+            return false;
+        }
+
+        if (value instanceof String && ((String) value).length() > MAX_USER_INPUT_VALUE_LENGTH) {
+            Log.w(TAG, "Value too long: " + value);
+            return false;
+        }
+
+        return true;
+    }
 }

sdk/src/main/java/com/deploygate/service/DeployGateEvent.java

@@ -8,6 +8,7 @@ public interface DeployGateEvent {
     // namespace:
     //   ACTION => a
     //   EXTRA => e
+    //   KEY => k
     //
     // content:
     //   should be hyphen-separated string and be lower cases
@@ -27,6 +28,11 @@ public interface DeployGateEvent {
     public static final String ACTION_COMPOSE_COMMENT = "composeComment";
     public static final String ACTION_VISIBILITY_EVENT = "a.visibility-event";
 
+    /**
+     * @since 4.8.0
+     */
+    public static final String ACTION_COLLECT_DEVICE_STATES = "a.collect-device-states";
+
     public static final String EXTRA_AUTHOR = "author";
     public static final String EXTRA_EXPECTED_AUTHOR = "expectedAuthor";
 
@@ -121,6 +127,31 @@ public interface DeployGateEvent {
      */
     public static final String EXTRA_VISIBILITY_EVENT_ELAPSED_REAL_TIME_IN_NANOS = "e.visibility-event-elapsed-real-time";
 
+    /**
+     * @since 4.8.0
+     */
+    public static final String EXTRA_TARGET_URI_FOR_REPORT_DEVICE_STATES = "e.target-uri-for-report-device-states";
+
+    /**
+     * @since 4.8.0
+     */
+    public static final String KEY_BUILD_ENVIRONMENT = "k.build-environment";
+
+    /**
+     * @since 4.8.0
+     */
+    public static final String KEY_RUNTIME_EXTRAS = "k.runtime-extras";
+
+    /**
+     * @since 4.8.0
+     */
+    public static final String KEY_PACKAGE_NAME = "k.package-name";
+
+    /**
+     * @since 4.8.0
+     */
+    public static final String KEY_EVENT_AT = "k.event-at";
+
     interface VisibilityType {
         int BACKGROUND = 0;
         int FOREGROUND = 1;