Remove client from serializable objects (#365)

nplasterer · web-flow · commit 4b9d152e16a4 · 2025-01-13T17:05:17.000-08:00
* remove client from serializable objects

* dont require context for static methods
diff --git a/library/src/androidTest/java/org/xmtp/android/library/ClientTest.kt b/library/src/androidTest/java/org/xmtp/android/library/ClientTest.kt
@@ -86,7 +86,6 @@ class ClientTest {
                     notOnNetwork.address,
                     fixtures.bo.walletAddress
                 ),
-                context,
                 ClientOptions.Api(XMTPEnvironment.LOCAL, false)
             )
         }
@@ -109,7 +108,6 @@ class ClientTest {
         val states = runBlocking {
             Client.inboxStatesForInboxIds(
                 listOf(fixtures.boClient.inboxId, fixtures.caroClient.inboxId),
-                context,
                 ClientOptions.Api(XMTPEnvironment.LOCAL, false)
             )
         }
diff --git a/library/src/main/java/org/xmtp/android/library/Client.kt b/library/src/main/java/org/xmtp/android/library/Client.kt
@@ -91,22 +91,16 @@ class Client() {
             codecRegistry.register(codec = codec)
         }
 
-        suspend fun <T> withFfiClient(
-            appContext: Context,
+        private suspend fun <T> withFfiClient(
             api: ClientOptions.Api,
             useClient: suspend (ffiClient: FfiXmtpClient) -> T,
         ): T {
             val accountAddress = "0x0000000000000000000000000000000000000000"
             val inboxId = getOrCreateInboxId(api, accountAddress)
-            val alias = "xmtp-${api.env}-$inboxId"
-
-            val directoryFile = File(appContext.filesDir.absolutePath, "xmtp_db")
-            directoryFile.mkdir()
-            val dbPath = directoryFile.absolutePath + "/$alias.db3"
 
             val ffiClient = createClient(
                 api = connectToApiBackend(api),
-                db = dbPath,
+                db = null,
                 encryptionKey = null,
                 accountAddress = accountAddress.lowercase(),
                 inboxId = inboxId,
@@ -115,30 +109,23 @@ class Client() {
                 historySyncUrl = null
             )
 
-            return try {
-                useClient(ffiClient)
-            } finally {
-                ffiClient.releaseDbConnection()
-                File(dbPath).delete()
-            }
+            return useClient(ffiClient)
         }
 
         suspend fun inboxStatesForInboxIds(
             inboxIds: List<String>,
-            appContext: Context,
             api: ClientOptions.Api,
         ): List<InboxState> {
-            return withFfiClient(appContext, api) { ffiClient ->
+            return withFfiClient(api) { ffiClient ->
                 ffiClient.addressesFromInboxId(true, inboxIds).map { InboxState(it) }
             }
         }
 
         suspend fun canMessage(
             accountAddresses: List<String>,
-            appContext: Context,
             api: ClientOptions.Api,
         ): Map<String, Boolean> {
-            return withFfiClient(appContext, api) { ffiClient ->
+            return withFfiClient(api) { ffiClient ->
                 ffiClient.canMessage(accountAddresses)
             }
         }
@@ -332,7 +319,7 @@ class Client() {
 
     fun findGroup(groupId: String): Group? {
         return try {
-            Group(this, ffiClient.conversation(groupId.hexToByteArray()))
+            Group(this.inboxId, ffiClient.conversation(groupId.hexToByteArray()))
         } catch (e: Exception) {
             null
         }
@@ -342,8 +329,8 @@ class Client() {
         return try {
             val conversation = ffiClient.conversation(conversationId.hexToByteArray())
             when (conversation.conversationType()) {
-                FfiConversationType.GROUP -> Conversation.Group(Group(this, conversation))
-                FfiConversationType.DM -> Conversation.Dm(Dm(this, conversation))
+                FfiConversationType.GROUP -> Conversation.Group(Group(this.inboxId, conversation))
+                FfiConversationType.DM -> Conversation.Dm(Dm(this.inboxId, conversation))
                 else -> null
             }
         } catch (e: Exception) {
@@ -358,8 +345,8 @@ class Client() {
         return try {
             val conversation = ffiClient.conversation(conversationId.hexToByteArray())
             when (conversation.conversationType()) {
-                FfiConversationType.GROUP -> Conversation.Group(Group(this, conversation))
-                FfiConversationType.DM -> Conversation.Dm(Dm(this, conversation))
+                FfiConversationType.GROUP -> Conversation.Group(Group(this.inboxId, conversation))
+                FfiConversationType.DM -> Conversation.Dm(Dm(this.inboxId, conversation))
                 else -> null
             }
         } catch (e: Exception) {
@@ -369,7 +356,7 @@ class Client() {
 
     fun findDmByInboxId(inboxId: String): Dm? {
         return try {
-            Dm(this, ffiClient.dmConversation(inboxId))
+            Dm(this.inboxId, ffiClient.dmConversation(inboxId))
         } catch (e: Exception) {
             null
         }
diff --git a/library/src/main/java/org/xmtp/android/library/Conversation.kt b/library/src/main/java/org/xmtp/android/library/Conversation.kt
@@ -141,14 +141,6 @@ sealed class Conversation {
         }
     }
 
-    val client: Client
-        get() {
-            return when (this) {
-                is Group -> group.client
-                is Dm -> dm.client
-            }
-        }
-
     fun streamMessages(): Flow<Message> {
         return when (this) {
             is Group -> group.streamMessages()
diff --git a/library/src/main/java/org/xmtp/android/library/Conversations.kt b/library/src/main/java/org/xmtp/android/library/Conversations.kt
@@ -42,8 +42,8 @@ data class Conversations(
     suspend fun fromWelcome(envelopeBytes: ByteArray): Conversation {
         val conversation = ffiConversations.processStreamedWelcomeMessage(envelopeBytes)
         return when (conversation.conversationType()) {
-            FfiConversationType.DM -> Conversation.Dm(Dm(client, conversation))
-            else -> Conversation.Group(Group(client, conversation))
+            FfiConversationType.DM -> Conversation.Dm(Dm(client.inboxId, conversation))
+            else -> Conversation.Group(Group(client.inboxId, conversation))
         }
     }
 
@@ -118,7 +118,7 @@ data class Conversations(
                     customPermissionPolicySet = permissionsPolicySet
                 )
             )
-        return Group(client, group)
+        return Group(client.inboxId, group)
     }
 
     // Sync from the network the latest list of conversations
@@ -152,7 +152,7 @@ data class Conversations(
         var dm = client.findDmByAddress(peerAddress)
         if (dm == null) {
             val dmConversation = ffiConversations.createDm(peerAddress.lowercase())
-            dm = Dm(client, dmConversation)
+            dm = Dm(client.inboxId, dmConversation)
         }
         return dm
     }
@@ -174,7 +174,7 @@ data class Conversations(
         )
 
         return ffiGroups.map {
-            Group(client, it.conversation(), it.lastMessage())
+            Group(client.inboxId, it.conversation(), it.lastMessage())
         }
     }
 
@@ -195,7 +195,7 @@ data class Conversations(
         )
 
         return ffiDms.map {
-            Dm(client, it.conversation(), it.lastMessage())
+            Dm(client.inboxId, it.conversation(), it.lastMessage())
         }
     }
 
@@ -220,8 +220,8 @@ data class Conversations(
 
     private suspend fun FfiConversationListItem.toConversation(): Conversation {
         return when (conversation().conversationType()) {
-            FfiConversationType.DM -> Conversation.Dm(Dm(client, conversation(), lastMessage()))
-            else -> Conversation.Group(Group(client, conversation(), lastMessage()))
+            FfiConversationType.DM -> Conversation.Dm(Dm(client.inboxId, conversation(), lastMessage()))
+            else -> Conversation.Group(Group(client.inboxId, conversation(), lastMessage()))
         }
     }
 
@@ -234,13 +234,13 @@ data class Conversations(
                             FfiConversationType.DM -> trySend(
                                 Conversation.Dm(
                                     Dm(
-                                        client,
+                                        client.inboxId,
                                         conversation
                                     )
                                 )
                             )
 
-                            else -> trySend(Conversation.Group(Group(client, conversation)))
+                            else -> trySend(Conversation.Group(Group(client.inboxId, conversation)))
                         }
                     }
                 }
diff --git a/library/src/main/java/org/xmtp/android/library/Dm.kt b/library/src/main/java/org/xmtp/android/library/Dm.kt
@@ -22,7 +22,7 @@ import uniffi.xmtpv3.FfiMessageCallback
 import uniffi.xmtpv3.FfiSubscribeException
 import java.util.Date
 
-class Dm(val client: Client, private val libXMTPGroup: FfiConversation, private val ffiLastMessage: FfiMessage? = null) {
+class Dm(private val clientInboxId: String, private val libXMTPGroup: FfiConversation, private val ffiLastMessage: FfiMessage? = null) {
     val id: String
         get() = libXMTPGroup.id().toHex()
 
@@ -150,7 +150,7 @@ class Dm(val client: Client, private val libXMTPGroup: FfiConversation, private
     }
 
     suspend fun isCreator(): Boolean {
-        return metadata().creatorInboxId() == client.inboxId
+        return metadata().creatorInboxId() == clientInboxId
     }
 
     suspend fun members(): List<Member> {
diff --git a/library/src/main/java/org/xmtp/android/library/Group.kt b/library/src/main/java/org/xmtp/android/library/Group.kt
@@ -29,7 +29,7 @@ import uniffi.xmtpv3.FfiSubscribeException
 import java.util.Date
 
 class Group(
-    val client: Client,
+    private val clientInboxId: String,
     private val libXMTPGroup: FfiConversation,
     private val ffiLastMessage: FfiMessage? = null,
 ) {
@@ -193,7 +193,7 @@ class Group(
     }
 
     suspend fun isCreator(): Boolean {
-        return metadata().creatorInboxId() == client.inboxId
+        return metadata().creatorInboxId() == clientInboxId
     }
 
     suspend fun addMembers(addresses: List<String>) {
@@ -234,7 +234,7 @@ class Group(
 
     suspend fun peerInboxIds(): List<String> {
         val ids = members().map { it.inboxId }.toMutableList()
-        ids.remove(client.inboxId)
+        ids.remove(clientInboxId)
         return ids
     }
 

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,6 @@ class ClientTest {`
`86`	`86`	`notOnNetwork.address,`
`87`	`87`	`fixtures.bo.walletAddress`
`88`	`88`	`),`
`89`		`- context,`
`90`	`89`	`ClientOptions.Api(XMTPEnvironment.LOCAL, false)`
`91`	`90`	`)`
`92`	`91`	`}`
`@@ -109,7 +108,6 @@ class ClientTest {`
`109`	`108`	`val states = runBlocking {`
`110`	`109`	`Client.inboxStatesForInboxIds(`
`111`	`110`	`listOf(fixtures.boClient.inboxId, fixtures.caroClient.inboxId),`
`112`		`- context,`
`113`	`111`	`ClientOptions.Api(XMTPEnvironment.LOCAL, false)`
`114`	`112`	`)`
`115`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -141,14 +141,6 @@ sealed class Conversation {`
`141`	`141`	`}`
`142`	`142`	`}`
`143`	`143`
`144`		`- val client: Client`
`145`		`- get() {`
`146`		`- return when (this) {`
`147`		`- is Group -> group.client`
`148`		`- is Dm -> dm.client`
`149`		`- }`
`150`		`- }`
`151`		`-`
`152`	`144`	`fun streamMessages(): Flow<Message> {`
`153`	`145`	`return when (this) {`
`154`	`146`	`is Group -> group.streamMessages()`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,8 @@ data class Conversations(`
`42`	`42`	`suspend fun fromWelcome(envelopeBytes: ByteArray): Conversation {`
`43`	`43`	`val conversation = ffiConversations.processStreamedWelcomeMessage(envelopeBytes)`
`44`	`44`	`return when (conversation.conversationType()) {`
`45`		`- FfiConversationType.DM -> Conversation.Dm(Dm(client, conversation))`
`46`		`- else -> Conversation.Group(Group(client, conversation))`
	`45`	`+ FfiConversationType.DM -> Conversation.Dm(Dm(client.inboxId, conversation))`
	`46`	`+ else -> Conversation.Group(Group(client.inboxId, conversation))`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`@@ -118,7 +118,7 @@ data class Conversations(`
`118`	`118`	`customPermissionPolicySet = permissionsPolicySet`
`119`	`119`	`)`
`120`	`120`	`)`
`121`		`- return Group(client, group)`
	`121`	`+ return Group(client.inboxId, group)`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`// Sync from the network the latest list of conversations`
`@@ -152,7 +152,7 @@ data class Conversations(`
`152`	`152`	`var dm = client.findDmByAddress(peerAddress)`
`153`	`153`	`if (dm == null) {`
`154`	`154`	`val dmConversation = ffiConversations.createDm(peerAddress.lowercase())`
`155`		`- dm = Dm(client, dmConversation)`
	`155`	`+ dm = Dm(client.inboxId, dmConversation)`
`156`	`156`	`}`
`157`	`157`	`return dm`
`158`	`158`	`}`
`@@ -174,7 +174,7 @@ data class Conversations(`
`174`	`174`	`)`
`175`	`175`
`176`	`176`	`return ffiGroups.map {`
`177`		`- Group(client, it.conversation(), it.lastMessage())`
	`177`	`+ Group(client.inboxId, it.conversation(), it.lastMessage())`
`178`	`178`	`}`
`179`	`179`	`}`
`180`	`180`
`@@ -195,7 +195,7 @@ data class Conversations(`
`195`	`195`	`)`
`196`	`196`
`197`	`197`	`return ffiDms.map {`
`198`		`- Dm(client, it.conversation(), it.lastMessage())`
	`198`	`+ Dm(client.inboxId, it.conversation(), it.lastMessage())`
`199`	`199`	`}`
`200`	`200`	`}`
`201`	`201`
`@@ -220,8 +220,8 @@ data class Conversations(`
`220`	`220`
`221`	`221`	`private suspend fun FfiConversationListItem.toConversation(): Conversation {`
`222`	`222`	`return when (conversation().conversationType()) {`
`223`		`- FfiConversationType.DM -> Conversation.Dm(Dm(client, conversation(), lastMessage()))`
`224`		`- else -> Conversation.Group(Group(client, conversation(), lastMessage()))`
	`223`	`+ FfiConversationType.DM -> Conversation.Dm(Dm(client.inboxId, conversation(), lastMessage()))`
	`224`	`+ else -> Conversation.Group(Group(client.inboxId, conversation(), lastMessage()))`
`225`	`225`	`}`
`226`	`226`	`}`
`227`	`227`
`@@ -234,13 +234,13 @@ data class Conversations(`
`234`	`234`	`FfiConversationType.DM -> trySend(`
`235`	`235`	`Conversation.Dm(`
`236`	`236`	`Dm(`
`237`		`- client,`
	`237`	`+ client.inboxId,`
`238`	`238`	`conversation`
`239`	`239`	`)`
`240`	`240`	`)`
`241`	`241`	`)`
`242`	`242`
`243`		`- else -> trySend(Conversation.Group(Group(client, conversation)))`
	`243`	`+ else -> trySend(Conversation.Group(Group(client.inboxId, conversation)))`
`244`	`244`	`}`
`245`	`245`	`}`
`246`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ import uniffi.xmtpv3.FfiMessageCallback`
`22`	`22`	`import uniffi.xmtpv3.FfiSubscribeException`
`23`	`23`	`import java.util.Date`
`24`	`24`
`25`		`-class Dm(val client: Client, private val libXMTPGroup: FfiConversation, private val ffiLastMessage: FfiMessage? = null) {`
	`25`	`+class Dm(private val clientInboxId: String, private val libXMTPGroup: FfiConversation, private val ffiLastMessage: FfiMessage? = null) {`
`26`	`26`	`val id: String`
`27`	`27`	`get() = libXMTPGroup.id().toHex()`
`28`	`28`
`@@ -150,7 +150,7 @@ class Dm(val client: Client, private val libXMTPGroup: FfiConversation, private`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`suspend fun isCreator(): Boolean {`
`153`		`- return metadata().creatorInboxId() == client.inboxId`
	`153`	`+ return metadata().creatorInboxId() == clientInboxId`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`suspend fun members(): List<Member> {`