Split push module into several modules: Firebase, UnifiedPush, store

2023-04-07 20:42:59 +02:00 · 2023-04-07 20:42:59 +02:00 · 7333995630
commit 7333995630
parent 9ac46aed7c
53 changed files with 768 additions and 276 deletions
--- a/libraries/pushproviders/firebase/src/main/AndroidManifest.xml
+++ b/libraries/pushproviders/firebase/src/main/AndroidManifest.xml
@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+~ Copyright (c) 2023 New Vector Ltd
+~
+~ 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.
+-->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+        <!-- Firebase components -->
+        <meta-data
+            android:name="firebase_analytics_collection_deactivated"
+            android:value="true" />
+        <service
+            android:name="io.element.android.libraries.push.providers.firebase.VectorFirebaseMessagingService"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.google.firebase.MESSAGING_EVENT" />
+            </intent-filter>
+        </service>
+    </application>
+</manifest>
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/EnsureFcmTokenIsRetrievedUseCase.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/EnsureFcmTokenIsRetrievedUseCase.kt
@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import javax.inject.Inject
+
+// TODO
+class EnsureFcmTokenIsRetrievedUseCase @Inject constructor(
+//    private val unifiedPushHelper: UnifiedPushHelper,
+//    private val fcmHelper: FcmHelper,
+        // private val activeSessionHolder: ActiveSessionHolder,
+) {
+
+//    fun execute(pushersManager: PushersManager, registerPusher: Boolean) {
+//        if (unifiedPushHelper.isEmbeddedDistributor()) {
+//            fcmHelper.ensureFcmTokenIsRetrieved(pushersManager, shouldAddHttpPusher(registerPusher))
+//        }
+//    }
+
+    private fun shouldAddHttpPusher(registerPusher: Boolean) = if (registerPusher) {
+        /*
+        TODO EAx
+        val currentSession = activeSessionHolder.getActiveSession()
+        val currentPushers = currentSession.pushersService().getPushers()
+        currentPushers.none { it.deviceId == currentSession.sessionParams.deviceId }
+         */
+        true
+    } else {
+        false
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebaseConfig.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebaseConfig.kt
@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+object FirebaseConfig {
+    /**
+     * It is the push gateway for firebase.
+     * Note: pusher_http_url should have path '/_matrix/push/v1/notify' -->
+     */
+    const val pusher_http_url: String = "https://matrix.org/_matrix/push/v1/notify"
+
+    const val internalName = "NOTIFICATION_METHOD_FIREBASE"
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushParser.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushParser.kt
@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import io.element.android.libraries.push.providers.api.PushData
+import javax.inject.Inject
+
+class FirebasePushParser @Inject constructor() {
+    fun parse(message: Map<String, String?>): PushData? {
+        val pushDataFirebase = PushDataFirebase(
+            eventId = message["event_id"],
+            roomId = message["room_id"],
+            unread = message["unread"]?.toIntOrNull(),
+            clientSecret = message["cs"],
+        )
+        return pushDataFirebase.toPushData()
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushProvider.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushProvider.kt
@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import io.element.android.libraries.core.log.logger.LoggerTag
+import io.element.android.libraries.matrix.api.MatrixClient
+import io.element.android.libraries.push.providers.api.PushProvider
+import io.element.android.libraries.push.providers.api.PusherSubscriber
+import timber.log.Timber
+import javax.inject.Inject
+
+private val loggerTag = LoggerTag("FirebasePushProvider")
+
+class FirebasePushProvider @Inject constructor(
+    private val googleFcmHelper: GoogleFcmHelper,
+    private val pusherSubscriber: PusherSubscriber,
+) : PushProvider {
+
+    override fun getDistributorNames(): List<String> {
+        // Must return an non-empty list for now
+        return listOf("unused")
+    }
+
+    override suspend fun registerWith(matrixClient: MatrixClient, distributorName: String) {
+        val pushKey = googleFcmHelper.getFcmToken() ?: return Unit.also {
+            Timber.tag(loggerTag.value).w("Unable to register pusher, Firebase token is not known.")
+        }
+        pusherSubscriber.registerPusher(matrixClient, pushKey, FirebaseConfig.pusher_http_url)
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebaseSetPusher.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/FirebaseSetPusher.kt
@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import io.element.android.libraries.core.log.logger.LoggerTag
+import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService
+import io.element.android.libraries.matrix.api.core.SessionId
+import io.element.android.libraries.push.providers.api.PusherSubscriber
+import io.element.android.libraries.pushstore.api.UserPushStoreFactory
+import io.element.android.libraries.sessionstorage.api.SessionStore
+import io.element.android.libraries.sessionstorage.api.toUserList
+import timber.log.Timber
+import javax.inject.Inject
+
+private val loggerTag = LoggerTag("FirebaseSetPusher")
+
+// TODO Rename
+class FirebaseSetPusher @Inject constructor(
+    private val pusherSubscriber: PusherSubscriber,
+    private val sessionStore: SessionStore,
+    private val userPushStoreFactory: UserPushStoreFactory,
+    private val matrixAuthenticationService: MatrixAuthenticationService,
+) {
+    suspend fun onNewFirebaseToken(firebaseToken: String) {
+        // Register the pusher for all the sessions
+        sessionStore.getAllSessions().toUserList().forEach { userId ->
+            val userDataStore = userPushStoreFactory.create(userId)
+            if (userDataStore.getNotificationMethod() == FirebaseConfig.internalName) {
+                matrixAuthenticationService.restoreSession(SessionId(userId)).getOrNull()?.use { client ->
+                    pusherSubscriber.registerPusher(client, firebaseToken, FirebaseConfig.pusher_http_url)
+                }
+            } else {
+                Timber.tag(loggerTag.value).d("This session is not using Firebase pusher")
+            }
+        }
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/GoogleFcmHelper.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/GoogleFcmHelper.kt
@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import android.content.Context
+import android.content.SharedPreferences
+import androidx.core.content.edit
+import com.google.android.gms.common.ConnectionResult
+import com.google.android.gms.common.GoogleApiAvailability
+import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.di.DefaultPreferences
+import javax.inject.Inject
+
+/**
+ * This class store the FCM token in SharedPrefs and ensure this token is retrieved.
+ * It has an alter ego in the fdroid variant.
+ */
+// TODO Rename to store?
+class GoogleFcmHelper @Inject constructor(
+    @ApplicationContext private val context: Context,
+    @DefaultPreferences private val sharedPrefs: SharedPreferences,
+) {
+    fun getFcmToken(): String? {
+        return sharedPrefs.getString(PREFS_KEY_FCM_TOKEN, null)
+    }
+
+    fun storeFcmToken(token: String?) {
+        sharedPrefs.edit {
+            putString(PREFS_KEY_FCM_TOKEN, token)
+        }
+    }
+
+    /*
+    override fun ensureFcmTokenIsRetrieved(pushersManager: PushersManager, registerPusher: Boolean) {
+        // 'app should always check the device for a compatible Google Play services APK before accessing Google Play services features'
+        if (checkPlayServices(context)) {
+            try {
+                FirebaseMessaging.getInstance().token
+                    .addOnSuccessListener { token ->
+                        storeFcmToken(token)
+                        if (registerPusher) {
+                            runBlocking {// TODO
+                                pushersManager.enqueueRegisterPusherWithFcmKey(token)
+                            }
+                        }
+                    }
+                    .addOnFailureListener { e ->
+                        Timber.e(e, "## ensureFcmTokenIsRetrieved() : failed")
+                    }
+            } catch (e: Throwable) {
+                Timber.e(e, "## ensureFcmTokenIsRetrieved() : failed")
+            }
+        } else {
+            Toast.makeText(context, R.string.push_no_valid_google_play_services_apk_android, Toast.LENGTH_SHORT).show()
+            Timber.e("No valid Google Play Services found. Cannot use FCM.")
+        }
+    }
+     */
+
+    /**
+     * Check the device to make sure it has the Google Play Services APK. If
+     * it doesn't, display a dialog that allows users to download the APK from
+     * the Google Play Store or enable it in the device's system settings.
+     */
+    private fun checkPlayServices(context: Context): Boolean {
+        val apiAvailability = GoogleApiAvailability.getInstance()
+        val resultCode = apiAvailability.isGooglePlayServicesAvailable(context)
+        return resultCode == ConnectionResult.SUCCESS
+    }
+
+    /*
+    override fun onEnterForeground(activeSessionHolder: ActiveSessionHolder) {
+        // No op
+    }
+
+    override fun onEnterBackground(activeSessionHolder: ActiveSessionHolder) {
+        // No op
+    }
+     */
+
+    companion object {
+        private const val PREFS_KEY_FCM_TOKEN = "FCM_TOKEN"
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/PushDataFirebase.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/PushDataFirebase.kt
@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import io.element.android.libraries.matrix.api.core.asEventId
+import io.element.android.libraries.matrix.api.core.asRoomId
+import io.element.android.libraries.push.providers.api.PushData
+
+/**
+ * In this case, the format is:
+ * <pre>
+ * {
+ *     "event_id":"$anEventId",
+ *     "room_id":"!aRoomId",
+ *     "unread":"1",
+ *     "prio":"high",
+ *     "cs":"<client_secret>"
+ * }
+ * </pre>
+ * .
+ */
+data class PushDataFirebase(
+    val eventId: String?,
+    val roomId: String?,
+    var unread: Int?,
+    val clientSecret: String?
+)
+
+fun PushDataFirebase.toPushData(): PushData? {
+    val safeEventId = eventId?.asEventId() ?: return null
+    val safeRoomId = roomId?.asRoomId() ?: return null
+    return PushData(
+        eventId = safeEventId,
+        roomId = safeRoomId,
+        unread = unread,
+        clientSecret = clientSecret,
+    )
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/VectorFirebaseMessagingService.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/VectorFirebaseMessagingService.kt
@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import com.google.firebase.messaging.FirebaseMessagingService
+import com.google.firebase.messaging.RemoteMessage
+import io.element.android.libraries.architecture.bindings
+import io.element.android.libraries.core.log.logger.LoggerTag
+import io.element.android.libraries.push.providers.api.PushHandler
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
+import timber.log.Timber
+import javax.inject.Inject
+
+private val loggerTag = LoggerTag("Firebase")
+
+class VectorFirebaseMessagingService : FirebaseMessagingService() {
+    @Inject lateinit var firebaseSetPusher: FirebaseSetPusher
+    @Inject lateinit var pushParser: FirebasePushParser
+    @Inject lateinit var pushHandler: PushHandler
+    @Inject lateinit var googleFcmHelper: GoogleFcmHelper
+
+    private val coroutineScope = CoroutineScope(SupervisorJob())
+
+    override fun onCreate() {
+        super.onCreate()
+        applicationContext.bindings<VectorFirebaseMessagingServiceBindings>().inject(this)
+    }
+
+    override fun onNewToken(token: String) {
+        Timber.tag(loggerTag.value).d("New Firebase token")
+        googleFcmHelper.storeFcmToken(token)
+        coroutineScope.launch {
+            firebaseSetPusher.onNewFirebaseToken(token)
+        }
+    }
+
+    override fun onMessageReceived(message: RemoteMessage) {
+        Timber.tag(loggerTag.value).d("New Firebase message")
+        coroutineScope.launch {
+            val pushData = pushParser.parse(message.data)
+            if (pushData == null) {
+                Timber.tag(loggerTag.value).w("Invalid data received from Firebase")
+            } else {
+                pushHandler.handle(pushData)
+            }
+        }
+    }
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/VectorFirebaseMessagingServiceBindings.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/VectorFirebaseMessagingServiceBindings.kt
@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import com.squareup.anvil.annotations.ContributesTo
+import io.element.android.libraries.di.AppScope
+
+@ContributesTo(AppScope::class)
+interface VectorFirebaseMessagingServiceBindings {
+    fun inject(service: VectorFirebaseMessagingService)
+}
--- a/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/di/FirebaseModule.kt
+++ b/libraries/pushproviders/firebase/src/main/kotlin/io/element/android/libraries/push/providers/firebase/di/FirebaseModule.kt
@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase.di
+
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Binds
+import dagger.Module
+import dagger.multibindings.IntoSet
+import io.element.android.libraries.di.AppScope
+import io.element.android.libraries.push.providers.api.PushProvider
+import io.element.android.libraries.push.providers.firebase.FirebasePushProvider
+
+@Module
+@ContributesTo(AppScope::class)
+interface FirebaseModule {
+    @Binds
+    @IntoSet
+    fun bind(pushProvider: FirebasePushProvider): PushProvider
+}
--- a/libraries/pushproviders/firebase/src/test/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushParserTest.kt
+++ b/libraries/pushproviders/firebase/src/test/kotlin/io/element/android/libraries/push/providers/firebase/FirebasePushParserTest.kt
@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * 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 io.element.android.libraries.push.providers.firebase
+
+import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.matrix.test.AN_EVENT_ID
+import io.element.android.libraries.matrix.test.A_ROOM_ID
+import io.element.android.libraries.push.providers.api.PushData
+import org.junit.Test
+
+class FirebasePushParserTest {
+    private val validData = PushData(
+        eventId = AN_EVENT_ID,
+        roomId = A_ROOM_ID,
+        unread = 1,
+        clientSecret = "a-secret"
+    )
+
+    @Test
+    fun `test edge cases Firebase`() {
+        val pushParser = FirebasePushParser()
+        // Empty Json
+        assertThat(pushParser.parse(emptyMap())).isNull()
+        // Bad Json
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("unread", "str"))).isEqualTo(validData.copy(unread = null))
+        // Extra data
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("extra", "5"))).isEqualTo(validData)
+    }
+
+    @Test
+    fun `test Firebase format`() {
+        val pushParser = FirebasePushParser()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA)).isEqualTo(validData)
+    }
+
+    @Test
+    fun `test empty roomId`() {
+        val pushParser = FirebasePushParser()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", null))).isNull()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", ""))).isNull()
+    }
+
+    @Test
+    fun `test invalid roomId`() {
+        val pushParser = FirebasePushParser()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("room_id", "aRoomId:domain"))).isNull()
+    }
+
+    @Test
+    fun `test empty eventId`() {
+        val pushParser = FirebasePushParser()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", null))).isNull()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", ""))).isNull()
+    }
+
+    @Test
+    fun `test invalid eventId`() {
+        val pushParser = FirebasePushParser()
+        assertThat(pushParser.parse(FIREBASE_PUSH_DATA.mutate("event_id", "anEventId"))).isNull()
+    }
+
+    companion object {
+        private val FIREBASE_PUSH_DATA = mapOf(
+            "event_id" to AN_EVENT_ID.value,
+            "room_id" to A_ROOM_ID.value,
+            "unread" to "1",
+            "prio" to "high",
+            "cs" to "a-secret",
+        )
+    }
+}
+
+private fun Map<String, String?>.mutate(key: String, value: String?): Map<String, String?> {
+    return toMutableMap().apply { put(key, value) }
+}