Added trigger parameter to analytics event for integrity reporting.

Reporting heartbeat-triggered integrity reports as "Heartbeat".
Reporting failed integrity checks during start of PersonalID configuration as "PersonalID Configuration"

Author: OrangeAndGreen

app/src/org/commcare/android/integrity/IntegrityReporterWorker.kt

@@ -10,9 +10,7 @@ import androidx.work.NetworkType
 import androidx.work.OneTimeWorkRequest
 import androidx.work.WorkManager
 import androidx.work.WorkerParameters
-import com.google.android.play.core.integrity.StandardIntegrityException
 import com.google.common.base.Strings
-import org.commcare.android.database.connect.models.PersonalIdSessionData
 import org.commcare.android.integrity.IntegrityTokenApiRequestHelper.Companion.fetchIntegrityToken
 import org.commcare.android.logging.ReportingUtils
 import org.commcare.connect.network.connectId.PersonalIdApiHandler
@@ -63,13 +61,8 @@ class IntegrityReporterWorker(appContext: Context, workerParams: WorkerParameter
         val requestHash = org.commcare.utils.HashUtils.computeHash(jsonBody, org.commcare.utils.HashUtils.HashAlgorithm.SHA256)
         val tokenResult = fetchIntegrityToken(requestHash)
         val (integrityToken, hash) = tokenResult.getOrElse {
-            val errorCode: String = if(it is StandardIntegrityException) {
-                it.errorCode.toString();
-            } else {
-                it.message ?: "Unknown error"
-            }
-
-            FirebaseAnalyticsUtil.reportPersonalIdIntegritySubmission(requestId, errorCode)
+            val errorCode = IntegrityTokenApiRequestHelper.getCodeForException(it)
+            FirebaseAnalyticsUtil.reportPersonalIdHeartbeatIntegritySubmission(requestId, errorCode)
 
             body["device_error"] = errorCode
             makeReportIntegrityCall(context, null, null, body, requestId)
@@ -100,7 +93,7 @@ class IntegrityReporterWorker(appContext: Context, workerParams: WorkerParameter
                 cont.resume(success)
             }
             override fun onFailure(errorCode: PersonalIdOrConnectApiErrorCodes, t: Throwable?) {
-                FirebaseAnalyticsUtil.reportPersonalIdIntegritySubmission(requestId, "SendError")
+                FirebaseAnalyticsUtil.reportPersonalIdHeartbeatIntegritySubmission(requestId, "SendError")
                 cont.resume(false)
             }
         }

app/src/org/commcare/android/integrity/IntegrityTokenApiRequestHelper.kt

@@ -152,5 +152,13 @@ class IntegrityTokenApiRequestHelper(
                 Result.failure(e)
             }
         }
+
+        fun getCodeForException(exception: Throwable): String {
+            return if (exception is StandardIntegrityException) {
+                exception.errorCode.toString()
+            } else {
+                exception.message ?: "UnknownError"
+            }
+        }
     }
 }

app/src/org/commcare/connect/network/connectId/parser/ReportIntegrityResponseParser.java

@@ -20,7 +20,7 @@ public class ReportIntegrityResponseParser<T> implements BaseApiResponseParser<T
     @Override
     public T parse(int responseCode, @NonNull InputStream responseData, @Nullable Object anyInputObject) throws IOException,JSONException {
         JSONObject json = new JSONObject(new String(StreamsUtil.inputStreamToByteArray(responseData)));
-        FirebaseAnalyticsUtil.reportPersonalIdIntegritySubmission(((String)anyInputObject),
+        FirebaseAnalyticsUtil.reportPersonalIdHeartbeatIntegritySubmission(((String)anyInputObject),
                 json.optString("result_code", "NoCodeFromServer"));
         return (T)Boolean.TRUE;
     }

app/src/org/commcare/fragments/personalId/PersonalIdPhoneFragment.java

@@ -267,8 +267,9 @@ public void onTokenReceived(@NotNull String requestHash,
 
                     @Override
                     public void onTokenFailure(@NotNull Exception exception) {
-                        FirebaseAnalyticsUtil.reportPersonalIdConfigurationFailure(
-                                AnalyticsParamValue.START_CONFIGURATION_INTEGRITY_DEVICE_FAILURE);
+                        String errorCode = IntegrityTokenApiRequestHelper.Companion.getCodeForException(exception);
+                        FirebaseAnalyticsUtil.reportPersonalIdConfigurationIntegritySubmission(errorCode);
+
                         makeStartConfigurationCall(null, body, null);
                     }
                 });

app/src/org/commcare/google/services/analytics/CCAnalyticsParam.java

@@ -28,6 +28,7 @@ public class CCAnalyticsParam {
     static final String FORM_ID = "form_id";
     static final String REQUEST_ID = "request_id";
     static final String RESULT_CODE = "result_code";
+    static final String TRIGGER = "trigger";
 
     static final String USER_RETURNED = "user_returned";
     static final String NOTIFICATION_TYPE = "notification_type";

app/src/org/commcare/google/services/analytics/FirebaseAnalyticsUtil.java

@@ -409,9 +409,19 @@ public static void reportFormUploadAttempt(FormUploadResult first, Integer secon
                 new String[]{String.valueOf(first), String.valueOf(second)});
     }
 
-    public static void reportPersonalIdIntegritySubmission(String requestId, String responseCode) {
+    public static void reportPersonalIdConfigurationIntegritySubmission(String responseCode) {
+        String label = "PersonalID Configuration";
+        reportPersonalIdIntegritySubmission(label, label, responseCode);
+    }
+
+    public static void reportPersonalIdHeartbeatIntegritySubmission(String requestId, String responseCode) {
+        reportPersonalIdIntegritySubmission("Heartbeat", requestId, responseCode);
+    }
+
+    public static void reportPersonalIdIntegritySubmission(String trigger, String requestId, String responseCode) {
         Bundle b = new Bundle();
         b.putString(CCAnalyticsParam.REQUEST_ID, requestId);
+        b.putString(CCAnalyticsParam.TRIGGER, trigger);
         b.putString(CCAnalyticsParam.RESULT_CODE, responseCode);
         reportEvent(CCAnalyticsEvent.PERSONAL_ID_INTEGRITY_REPORTED, b);
     }