fix(Awala): Migrate to bindAutomatically() (#265)

See: relaycorp/relaynet-gateway-android#724
relaycorp · Apr 19, 2024 · 494aa11 · 494aa11
1 parent c349879
commit 494aa11
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 25 deletions.
diff --git a/app/build.gradle b/app/build.gradle
@@ -77,7 +77,7 @@ dependencies {
     implementation 'androidx.sharetarget:sharetarget:1.2.0'
 
     // Awala-powered messaging
-    implementation 'com.github.relaycorp:awala-endpoint-android:1.15.4'
+    implementation 'com.github.relaycorp:awala-endpoint-android:1.16.2'
     def bouncy_castle_version = "1.70"
     implementation "org.bouncycastle:bcprov-jdk15on:$bouncy_castle_version"
     implementation "org.bouncycastle:bcpkix-jdk15on:$bouncy_castle_version"

diff --git a/app/lint.xml b/app/lint.xml
@@ -23,10 +23,10 @@
     <issue id="InvalidPackage">
         <!-- Ignore errors about BC importing javax.naming because we don't use those modules -->
         <ignore path="**/bcpkix-*.jar" />
+        <!-- It reports that the Awala SDK is using IntellijIdeaDebugDetector indirectly, which isn't the case -->
+        <ignore path="**/ktor-utils-jvm-*.jar" />
     </issue>
     <issue id="IconDuplicates">
         <ignore path="**/awala_initialization_error.webp" />
     </issue>
-    <!-- TODO: remove after uploading https://letro.app/.well-known/assetlinks.json -->
-    <issue id="AppLinksAutoVerify" severity="warning" />
 </lint>
diff --git a/app/src/main/java/tech/relaycorp/letro/awala/AwalaManager.kt b/app/src/main/java/tech/relaycorp/letro/awala/AwalaManager.kt
@@ -6,6 +6,7 @@ import dagger.hilt.android.qualifiers.ApplicationContext
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.DelicateCoroutinesApi
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.flow.MutableSharedFlow
@@ -17,7 +18,6 @@ import kotlinx.coroutines.newSingleThreadContext
 import kotlinx.coroutines.withContext
 import tech.relaycorp.awaladroid.AwaladroidException
 import tech.relaycorp.awaladroid.EncryptionInitializationException
-import tech.relaycorp.awaladroid.GatewayBindingException
 import tech.relaycorp.awaladroid.endpoint.FirstPartyEndpoint
 import tech.relaycorp.awaladroid.endpoint.PrivateThirdPartyEndpoint
 import tech.relaycorp.awaladroid.endpoint.PublicThirdPartyEndpoint
@@ -141,7 +141,7 @@ class AwalaManagerImpl @Inject constructor(
                     return@withContext
                 }
                 _awalaInitializationState.emit(AWALA_SET_UP)
-                initializeGateway()
+                initializeGatewayAsync()
                 awalaSetupJob = null
             }
         }
@@ -330,24 +330,29 @@ class AwalaManagerImpl @Inject constructor(
     }
 
     override fun initializeGatewayAsync() {
-        awalaScope.launch(awalaThreadContext) {
+        awalaScope.launch(Dispatchers.Main) {
             initializeGateway()
         }
     }
 
-    private suspend fun initializeGateway() {
-        withContext(awalaThreadContext) {
-            try {
-                logger.i(TAG, "GatewayClient binding...")
-                awala.bindGateway()
-                startReceivingMessages()
-                _awalaInitializationState.emit(INITIALIZED)
-            } catch (exp: GatewayBindingException) {
-                logger.i(TAG, "GatewayClient cannot be bound: $exp")
-                _awalaUnsuccessfulBindings.emit(Unit)
-                _awalaInitializationState.emit(AWALA_NOT_INSTALLED)
-            }
-        }
+    private fun initializeGateway() {
+        logger.i(TAG, "Binding to Awala gateway...")
+        awala.bindGateway(
+            onBindSuccessful = {
+                awalaScope.launch(awalaThreadContext) {
+                    startReceivingMessages()
+                    _awalaInitializationState.emit(INITIALIZED)
+                    logger.i(TAG, "Binding complete")
+                }
+            },
+            onBindFailure = {
+                awalaScope.launch(awalaThreadContext) {
+                    logger.i(TAG, "GatewayClient cannot be bound: $it")
+                    _awalaUnsuccessfulBindings.emit(Unit)
+                    _awalaInitializationState.emit(AWALA_NOT_INSTALLED)
+                }
+            },
+        )
     }
 
     @Throws(AwaladroidException::class)

diff --git a/app/src/main/java/tech/relaycorp/letro/awala/AwalaWrapper.kt b/app/src/main/java/tech/relaycorp/letro/awala/AwalaWrapper.kt
@@ -7,6 +7,7 @@ import dagger.hilt.android.qualifiers.ApplicationContext
 import kotlinx.coroutines.flow.Flow
 import tech.relaycorp.awaladroid.Awala
 import tech.relaycorp.awaladroid.AwaladroidException
+import tech.relaycorp.awaladroid.GatewayBindingException
 import tech.relaycorp.awaladroid.GatewayClient
 import tech.relaycorp.awaladroid.endpoint.FirstPartyEndpoint
 import tech.relaycorp.awaladroid.endpoint.InvalidThirdPartyEndpoint
@@ -24,7 +25,10 @@ import kotlin.Exception
 
 interface AwalaWrapper {
     suspend fun setUp()
-    suspend fun bindGateway()
+    fun bindGateway(
+        onBindSuccessful: () -> Unit,
+        onBindFailure: (GatewayBindingException) -> Unit,
+    )
     suspend fun registerFirstPartyEndpoint(): FirstPartyEndpoint
     suspend fun importServerThirdPartyEndpoint(
         connectionParams: ByteArray,
@@ -64,8 +68,11 @@ class AwalaWrapperImpl @Inject constructor(
         Awala.setUp(context)
     }
 
-    override suspend fun bindGateway() {
-        GatewayClient.bind()
+    override fun bindGateway(
+        onBindSuccessful: () -> Unit,
+        onBindFailure: (GatewayBindingException) -> Unit,
+    ) {
+        GatewayClient.bindAutomatically(onBindSuccessful, onBindFailure = onBindFailure)
     }
 
     override suspend fun registerFirstPartyEndpoint(): FirstPartyEndpoint {

diff --git a/app/src/test/java/tech/relaycorp/letro/utils/models/awala/Awala.kt b/app/src/test/java/tech/relaycorp/letro/utils/models/awala/Awala.kt
@@ -4,6 +4,7 @@ import io.mockk.ConstantAnswer
 import io.mockk.coEvery
 import io.mockk.every
 import io.mockk.mockk
+import io.mockk.slot
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.emptyFlow
 import kotlinx.coroutines.test.TestDispatcher
@@ -52,12 +53,17 @@ private fun createAwalaWrapper(awalaInitializationResult: AwalaInitializationRes
             ConstantAnswer(Unit)
         }
     }
-    coEvery { bindGateway() } answers {
+
+    val onSuccessBindCallable = slot<() -> Unit>()
+    val onFailureBindCallable = slot<(GatewayBindingException) -> Unit>()
+    every { bindGateway(capture(onSuccessBindCallable), capture(onFailureBindCallable)) } answers {
         if (awalaInitializationResult == AwalaInitializationResult.CRASH_ON_GATEAWAY_BINDING) {
-            throw GatewayBindingException("Gateway binding exception")
+            val exc = GatewayBindingException("Gateway binding exception")
+            onFailureBindCallable.captured(exc)
         } else {
-            ConstantAnswer(Unit)
+            onSuccessBindCallable.captured()
         }
+        ConstantAnswer(Unit)
     }
     coEvery { registerFirstPartyEndpoint() } answers {
         if (awalaInitializationResult == AwalaInitializationResult.CRASH_ON_FIRST_PARTY_ENDPOINT_REGISTRATION) {