Add push notifications feature

.github/workflows/build.yml

@@ -23,10 +23,29 @@ jobs:
   build-android-app:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-java@v5
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Setup java
+        uses: actions/setup-java@v5
         with:
           distribution: 'zulu'
           java-version: 21
-      - uses: gradle/actions/setup-gradle@v4
-      - run: ./gradlew assembleRelease
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Create Google services file
+        shell: bash
+        env:
+          GOOGLE_SERVICES_ENCODED: ${{ secrets.GOOGLE_SERVICES_BASE_64 }}
+        run: |
+          # Create the directory structure
+          mkdir -p "composeApp/src/release/"
+
+          # Decode the env variable into the file
+          echo "$GOOGLE_SERVICES_ENCODED" | openssl base64 -d -A \
+            -out "composeApp/src/release/google-services.json"
+
+      - name: Build App
+        run: ./gradlew assembleRelease

.github/workflows/publish.yml

@@ -22,12 +22,28 @@ jobs:
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
 
+      - name: Create Google services file
+        shell: bash
+        env:
+          # Map the secret to a shell variable here
+          GOOGLE_SERVICES_ENCODED: ${{ secrets.GOOGLE_SERVICES_BASE_64 }}
+        run: |
+          # Create the directory structure
+          mkdir -p "composeApp/src/release/"
+
+          # Decode the env variable into the file
+          echo "$GOOGLE_SERVICES_ENCODED" | openssl base64 -d -A \
+            -out "composeApp/src/release/google-services.json"
+
       - name: Build Unsigned AAB
+        env:
+          HERON_ENDPOINT: ${{ secrets.HERON_ENDPOINT }}
         run: |
           ./gradlew spotlessCheck \
             bundleRelease \
             -Pheron.versionCode=${{ github.run_number }} \
             -Pheron.isPlayStore=true
+            -Pheron.endpoint="$HERON_ENDPOINT"
 
       - name: Sign AAB
         uses: r0adkll/sign-android-release@v1

.github/workflows/release.yml

@@ -27,15 +27,31 @@ jobs:
         shell: bash
         run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
         id: extract_branch
+
       - name: Checkout repo
         uses: actions/checkout@v5
+
       - name: Setup java
         uses: actions/setup-java@v5
         with:
           distribution: 'zulu'
           java-version: 21
+
       - name: Setup gradle
         uses: gradle/actions/setup-gradle@v4
+
+      - name: Create Google services file
+        shell: bash
+        env:
+          GOOGLE_SERVICES_ENCODED: ${{ secrets.GOOGLE_SERVICES_BASE_64 }}
+        run: |
+          # Create the directory structure
+          mkdir -p "composeApp/src/release/"
+
+          # Decode the env variable into the file
+          echo "$GOOGLE_SERVICES_ENCODED" | openssl base64 -d -A \
+            -out "composeApp/src/release/google-services.json"
+
       - name: Tag release
         run: |
           ./gradlew release \

.gitignore

@@ -17,6 +17,8 @@ captures
 !*.xcworkspace/contents.xcworkspacedata
 **/xcshareddata/WorkspaceSettings.xcsettings
 /composeApp/release/composeApp-release.aab
+/composeApp/src/release/google-services.json
+/composeApp/src/staging/google-services.json
 /iosApp/iosApp.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 /dependencies.txt
 /dependency-tree-diff.jar

build.gradle.kts

@@ -21,8 +21,11 @@ plugins {
     // in each subproject's classloader
     alias(libs.plugins.androidApplication) apply false
     alias(libs.plugins.androidLibrary) apply false
+    alias(libs.plugins.axionRelease) apply false
+    alias(libs.plugins.buildConfig) apply false
     alias(libs.plugins.composeMultiplatform) apply false
     alias(libs.plugins.composeCompiler) apply false
+    alias(libs.plugins.googleServices) apply false
     alias(libs.plugins.kotlinMultiplatform) apply false
     alias(libs.plugins.kotlinSerialization) apply false
     alias(libs.plugins.androidxRoom) apply false
@@ -33,7 +36,6 @@ plugins {
     alias(libs.plugins.spotless) apply false
     alias(libs.plugins.aboutLibraries) apply false
     alias(libs.plugins.burst) apply false
-    alias(libs.plugins.axionRelease) apply false
 }
 
 allprojects {

composeApp/build.gradle.kts

@@ -25,6 +25,7 @@ plugins {
     alias(libs.plugins.composeMultiplatform)
     alias(libs.plugins.composeCompiler)
     alias(libs.plugins.axionRelease)
+    alias(libs.plugins.googleServices)
     id("ksp-convention")
     id("kotlin-jvm-convention")
 }
@@ -72,6 +73,9 @@ kotlin {
             implementation(libs.connectivity.device)
             implementation(libs.androidx.activity.compose)
             implementation(libs.androidx.core.splashscreen)
+
+            implementation(project.dependencies.platform(libs.firebase.bom))
+            implementation(libs.firebase.messaging)
         }
         commonMain.dependencies {
             implementation(project(":data:models"))

composeApp/src/androidMain/AndroidManifest.xml

@@ -15,6 +15,7 @@
   -->
 
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
 
     <application
         android:name=".HeronApplication"
@@ -25,6 +26,18 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/Theme.Heron">
+        <service
+          android:name=".NotificationsService"
+          android:exported="false">
+          <intent-filter>
+            <action android:name="com.google.firebase.MESSAGING_EVENT" />
+          </intent-filter>
+        </service>
+        <receiver android:name=".NotificationDismissReceiver" android:exported="false">
+          <intent-filter>
+            <action android:name="com.tunjid.heron.ACTION_NOTIFICATION_DISMISS" />
+          </intent-filter>
+        </receiver>
         <activity
             android:name=".MainActivity"
             android:configChanges="uiMode"

composeApp/src/androidMain/kotlin/com/tunjid/heron/HeronApplication.kt

@@ -17,10 +17,16 @@
 package com.tunjid.heron
 
 import android.app.Application
+import com.tunjid.heron.scaffold.scaffold.AppState
 
 class HeronApplication : Application() {
 
-    val appState by lazy {
-        createAppState(this)
+    // This needs to be lateinit instead of lazy to ensure it is
+    // instantiated on the main thread
+    lateinit var appState: AppState
+
+    override fun onCreate() {
+        super.onCreate()
+        appState = createAppState(this)
     }
 }

composeApp/src/androidMain/kotlin/com/tunjid/heron/MainActivity.kt

@@ -28,10 +28,13 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.snapshotFlow
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.tooling.preview.Preview
+import androidx.core.app.NotificationManagerCompat
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
 import androidx.core.splashscreen.SplashScreenViewProvider
 import androidx.core.view.WindowCompat
+import com.google.firebase.messaging.FirebaseMessaging
 import com.tunjid.heron.data.core.types.GenericUri
+import com.tunjid.heron.scaffold.notifications.NotificationAction
 import com.tunjid.heron.scaffold.scaffold.App
 import com.tunjid.heron.scaffold.scaffold.isShowingSplashScreen
 import kotlinx.coroutines.delay
@@ -75,9 +78,34 @@ class MainActivity : ComponentActivity() {
             }
         }
 
+        updateNotificationPermissions()
         handleDeepLink(intent)
     }
 
+    override fun onResume() {
+        super.onResume()
+        updateNotificationPermissions()
+
+        FirebaseMessaging.getInstance()
+            .getToken()
+            .addOnSuccessListener { token ->
+                // appState will check if notification permissions are available
+                appState.onNotificationAction(NotificationAction.RegisterToken(token))
+            }
+    }
+
+    private fun updateNotificationPermissions() {
+        NotificationManagerCompat.from(this)
+            .areNotificationsEnabled()
+            .let {
+                appState.onNotificationAction(
+                    NotificationAction.UpdatePermissions(
+                        hasNotificationPermissions = it,
+                    ),
+                )
+            }
+    }
+
     private fun handleDeepLink(intent: Intent) {
         intent.data
             ?.let { uri ->

composeApp/src/androidMain/kotlin/com/tunjid/heron/NotificationsService.kt

@@ -0,0 +1,84 @@
+/*
+ *    Copyright 2024 Adetunji Dahunsi
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+package com.tunjid.heron
+
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+import com.google.firebase.messaging.FirebaseMessagingService
+import com.google.firebase.messaging.RemoteMessage
+import com.tunjid.heron.scaffold.notifications.AndroidNotifier.Companion.DISMISSAL_ACTION
+import com.tunjid.heron.scaffold.notifications.AndroidNotifier.Companion.DISMISSAL_INSTANT_EXTRA
+import com.tunjid.heron.scaffold.notifications.NotificationAction
+import com.tunjid.heron.scaffold.scaffold.AppState
+import kotlin.time.ExperimentalTime
+import kotlin.time.Instant
+import kotlinx.coroutines.runBlocking
+import kotlinx.coroutines.withTimeout
+
+class NotificationsService : FirebaseMessagingService() {
+
+    override fun onNewToken(token: String) =
+        appState.onNotificationAction(NotificationAction.RegisterToken(token = token))
+
+    override fun onMessageReceived(message: RemoteMessage) {
+        val action = NotificationAction.HandleNotification(payload = message.data)
+        action.senderDid ?: return
+        val recordUri = action.recordUri ?: return
+
+        appState.onNotificationAction(action)
+
+        // await processing completion or timeout to prevent the app from being
+        // killed due to background execution limits.
+        try {
+            runBlocking {
+                withTimeout(AppState.NOTIFICATION_PROCESSING_TIMEOUT_SECONDS) {
+                    appState.awaitNotificationProcessing(recordUri)
+                }
+            }
+        } catch (e: Exception) {
+            // No logging utilities in the app at the moment due to its open source nature.
+            e.printStackTrace()
+        } finally {
+            appState.onNotificationAction(
+                NotificationAction.NotificationProcessedOrDropped(recordUri),
+            )
+        }
+    }
+}
+
+class NotificationDismissReceiver : BroadcastReceiver() {
+    @OptIn(ExperimentalTime::class)
+    override fun onReceive(context: Context, intent: Intent) {
+        if (intent.action != DISMISSAL_ACTION) return
+
+        val dismissedAtEpoch = intent.getLongExtra(
+            /* name = */
+            DISMISSAL_INSTANT_EXTRA,
+            /* defaultValue = */
+            0,
+        )
+        if (dismissedAtEpoch > 0) context.appState.onNotificationAction(
+            NotificationAction.NotificationDismissed(
+                dismissedAt = Instant.fromEpochMilliseconds(dismissedAtEpoch),
+            ),
+        )
+    }
+}
+
+private val Context.appState
+    get() = (applicationContext as HeronApplication).appState

composeApp/src/androidMain/kotlin/com/tunjid/heron/Platform.android.kt

@@ -22,6 +22,7 @@ import com.tunjid.heron.data.database.getDatabaseBuilder
 import com.tunjid.heron.data.di.DataBindingArgs
 import com.tunjid.heron.images.imageLoader
 import com.tunjid.heron.media.video.ExoplayerController
+import com.tunjid.heron.scaffold.notifications.AndroidNotifier
 import com.tunjid.heron.scaffold.scaffold.AppState
 import dev.jordond.connectivity.Connectivity
 import kotlinx.coroutines.Dispatchers
@@ -40,6 +41,9 @@ fun createAppState(context: Context): AppState =
         imageLoader = {
             imageLoader(context)
         },
+        notifier = {
+            AndroidNotifier(context)
+        },
         videoPlayerController = { appScope ->
             ExoplayerController(
                 context = context,

composeApp/src/commonMain/kotlin/com/tunjid/heron/Platform.kt

@@ -55,6 +55,7 @@ import com.tunjid.heron.profiles.di.ProfilesBindings
 import com.tunjid.heron.profiles.di.ProfilesNavigationBindings
 import com.tunjid.heron.scaffold.di.ScaffoldBindingArgs
 import com.tunjid.heron.scaffold.di.ScaffoldBindings
+import com.tunjid.heron.scaffold.notifications.Notifier
 import com.tunjid.heron.scaffold.scaffold.AppState
 import com.tunjid.heron.search.di.SearchBindings
 import com.tunjid.heron.search.di.SearchNavigationBindings
@@ -77,6 +78,7 @@ expect fun getPlatform(): Platform
 
 fun createAppState(
     imageLoader: () -> ImageLoader,
+    notifier: (appScope: CoroutineScope) -> Notifier,
     videoPlayerController: (appScope: CoroutineScope) -> VideoPlayerController,
     args: (appScope: CoroutineScope) -> DataBindingArgs,
 ): AppState {
@@ -111,6 +113,7 @@ fun createAppState(
     val scaffoldBindings = ScaffoldBindings(
         args = ScaffoldBindingArgs(
             imageLoader = imageLoader(),
+            notifier = notifier(appScope),
             videoPlayerController = videoPlayerController(appScope),
             routeMatchers = navigationComponent.allRouteMatchers,
         ),