📋 Firebase Android Requirements & Integration Checklist

SOL9X Threat Monitoring & Logging Mobile App

Yeh document Android platform ke liye Firebase se related sari zaroori requirements, configuration files, permissions aur code checklist provide karta hai jo [project.md] ko integrate karne ke liye chahiye.


1. Firebase Console & Project Level Requirements

A. Same Firebase Project (Crucial)

B. Android App Registration

C. Config File (google-services.json)


2. Android Native Configuration Checklist

A. Gradle Files Check

  1. Root android/build.gradle.kts: Google Services plugin dependency present honi chahiye:

    plugins {
        id("com.google.gms.google-services") version "4.4.2" apply false
    }
  2. App level android/app/build.gradle.kts: Plugin apply hona chahiye:

    plugins {
        id("com.android.application")
        id("kotlin-android")
        id("dev.flutter.flutter-gradle-plugin")
        id("com.google.gms.google-services") // Must be applied
    }

B. AndroidManifest.xml Permissions & Meta-data

Location: android/app/src/main/AndroidManifest.xml

  1. Permissions:

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/> <!-- Android 13+ (API 33+) -->
    <uses-permission android:name="android.permission.VIBRATE"/>
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
    <uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT"/>
  2. Default Notification Channel Meta-data (Inside <application> tag):

    <meta-data
        android:name="com.google.firebase.messaging.default_notification_channel_id"
        android:value="critical_alerts" />
  3. Notification Sounds (Optional):

    • Custom siren/alarm sound file (e.g., alarm_sound.mp3 ya .wav) android/app/src/main/res/raw/ folder me honi chahiye.

3. Notification Channels Required (As per project.md)

Android 8.0 (API 26+) ke liye 2 mandatory channels create karne hain:

Channel ID Channel Name Importance Sound Description
critical_alerts Critical Security Threats MAX / High Priority Alarm / High Alert Sound Server crashes, 5xx surge, DB outage
threat_alerts Threat Alerts HIGH Default Sound Intermediate severity alerts

4. App Side Firebase Integration (Code Flow)

A. Firebase Initialization

lib/main.dart ke start me initialize hona chahiye:

WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp();
FirebaseMessaging.onBackgroundMessage(firebaseMessagingBackgroundHandler);

B. Device Token Retrieval & Lifecycle (Backend Sync)


5. FCM Payload & Deep-Linking Requirement

Backend se aane wala FCM message payload:

{
  "notification": {
    "title": "🚨 [CRITICAL] Infrastructure / Database Failures",
    "body": "payment-api (production): PrismaClientKnownRequestError..."
  },
  "data": {
    "incidentId": "cmveu174i0003ithyy2twy9lp",
    "projectId": "proj_clv123456",
    "ruleId": "rule_cmi789012",
    "severity": "CRITICAL",
    "service": "payment-api",
    "environment": "production",
    "rootLogId": "log_clv654321",
    "click_action": "FLUTTER_NOTIFICATION_CLICK"
  }
}

App me 3 state handlers hone chahiye:

  1. Foreground (FirebaseMessaging.onMessage):
    • App open hone par banner ya in-app alarm display karna.
  2. Background Tap (FirebaseMessaging.onMessageOpenedApp):
    • Notification par tap hone par message.data['incidentId'] nikal kar Incident Detail screen par bhejna.
  3. Terminated / Cold Start (FirebaseMessaging.instance.getInitialMessage()):
    • App band hone par jab notification tap ho, tab app launch hone ke baad sidha incidentId screen par navigate karna.

Summary: Quick Checklist Before Starting Coding