Merge pull request #165 from appdevforall/feat/ADFA-4533-glitchtip-crash-reporting

ADFA-4533: wire GlitchTip (Sentry SDK) crash reporting (DSN-only, con…

Author: luisguzman-adfa

.github/workflows/android-release-build.yml

@@ -65,6 +65,8 @@ jobs:
           KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
           KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
           KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
+          # ADFA-4533: GlitchTip DSN for release builds
+          SENTRY_DSN_RELEASE: ${{ secrets.SENTRY_DSN_RELEASE }}
         run: |
           ./gradlew assembleRelease \
             -Pandroid.injected.signing.store.file=$(pwd)/keystore.jks \

.github/workflows/firebase-distribution.yml

@@ -89,6 +89,8 @@ jobs:
           KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
           KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
           KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
+          # ADFA-4533: GlitchTip DSN for release builds distributed to testers
+          SENTRY_DSN_RELEASE: ${{ secrets.SENTRY_DSN_RELEASE }}
         run: |
           # TODO: Add gradle start/end timers here for the CI performance script
           # echo "gradle_time_start=$(date +%s)" >> $GITHUB_ENV

controller/app/build.gradle

@@ -68,10 +68,14 @@ android {
         release {
             minifyEnabled false
             signingConfig signingConfigs.release
+            // ADFA-4533: GlitchTip (Sentry) DSN from -PsentryDsnRelease or $SENTRY_DSN_RELEASE (empty -> SDK inert)
+            manifestPlaceholders = [sentryDsn: (project.findProperty('sentryDsnRelease') ?: System.getenv('SENTRY_DSN_RELEASE') ?: '')]
         }
         debug {
             minifyEnabled false
             //signingConfig signingConfigs.release
+            // ADFA-4533: GlitchTip (Sentry) DSN from -PsentryDsnDebug or $SENTRY_DSN_DEBUG (empty -> SDK inert)
+            manifestPlaceholders = [sentryDsn: (project.findProperty('sentryDsnDebug') ?: System.getenv('SENTRY_DSN_DEBUG') ?: '')]
         }
     }
 
@@ -157,6 +161,9 @@ android {
 }
 
 dependencies {
+    // ADFA-4533: GlitchTip (Sentry-compatible) crash reporting SDK.
+    implementation 'io.sentry:sentry-android-core:8.29.0'
+
     // 10. Core dependencies
     implementation 'androidx.appcompat:appcompat:1.7.1'
     implementation 'com.google.android.material:material:1.13.0'

controller/app/src/main/AndroidManifest.xml

@@ -36,6 +36,11 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:theme="@style/Theme.IIABController">
 
+        <!-- ADFA-4533: GlitchTip (Sentry) crash reporting. DSN injected per build type via the
+             ${sentryDsn} placeholder; auto-init disabled so init is consent-gated in code. -->
+        <meta-data android:name="io.sentry.dsn" android:value="${sentryDsn}" />
+        <meta-data android:name="io.sentry.auto-init" android:value="false" />
+
         <provider
             android:name="androidx.core.content.FileProvider"
             android:authorities="${applicationId}.provider"

controller/app/src/main/java/org/iiab/controller/IIABApplication.java

@@ -35,6 +35,20 @@ public void onCreate() {
             Log.e("IIABApplication", "Error initializing Conscrypt", e);
         }
 
+        // ADFA-4533: crash reporting to GlitchTip (Sentry SDK), gated by its OWN opt-in
+        // (CrashReportConsent, default ON) -- independent of usage-analytics consent, since error
+        // reports are operational, not behavioural telemetry, and carry no PII
+        // (io.sentry.send-default-pii=false). No-op unless a DSN was built in (empty DSN -> SDK
+        // stays inert); manifest sets io.sentry.auto-init=false, so this is the only init path.
+        // Init here (before our handler) so K2GoUncaughtExceptionHandler wraps Sentry: save -> report.
+        try {
+            if (org.iiab.controller.delivery.data.CrashReportConsent.isEnabled(this)) {
+                io.sentry.android.core.SentryAndroid.init(this);
+            }
+        } catch (Throwable t) {
+            Log.e("IIABApplication", "Sentry init skipped", t);
+        }
+
         // Capture uncaught exceptions into a crash report, offered on next launch.
         Thread.UncaughtExceptionHandler previous = Thread.getDefaultUncaughtExceptionHandler();
         Thread.setDefaultUncaughtExceptionHandler(

controller/app/src/main/java/org/iiab/controller/delivery/data/CrashReportConsent.java

@@ -0,0 +1,26 @@
+package org.iiab.controller.delivery.data;
+
+import android.content.Context;
+
+/**
+ * Opt-in flag for crash / error reporting (GlitchTip via the Sentry SDK). Separate from
+ * {@link AnalyticsConsent} on purpose: error reports are operational (not behavioural
+ * telemetry) and carry no PII, so they can follow a different policy. Default ON; flip the
+ * default here if administration decides error reports must also be opt-in.
+ */
+public final class CrashReportConsent {
+
+    private static final String PREFS = "iiab_delivery";
+    private static final String KEY = "crash_reports_opt_in";
+
+    private CrashReportConsent() {
+    }
+
+    public static boolean isEnabled(Context ctx) {
+        return ctx.getSharedPreferences(PREFS, Context.MODE_PRIVATE).getBoolean(KEY, true);
+    }
+
+    public static void setEnabled(Context ctx, boolean enabled) {
+        ctx.getSharedPreferences(PREFS, Context.MODE_PRIVATE).edit().putBoolean(KEY, enabled).apply();
+    }
+}

controller/build.gradle

@@ -47,6 +47,7 @@ allprojects {
 	repositories {
 		google()
 		jcenter()
+		mavenCentral()
 		maven { url 'https://jitpack.io' }
 	}
 }