Skip to content

Commit 63a8dd5

Browse files
nplasterernplasterer
authored
Add group chat features (#82)
* add api client with grpc kotlin * add group chat content type work * add group chat tests * fix up linter issues * more linter issues
1 parent 8cbec35 commit 63a8dd5

File tree

12 files changed

+215
-14
lines changed

12 files changed

+215
-14
lines changed

‎library/src/androidTest/java/org/xmtp/android/library/ConversationTest.kt

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import org.junit.Assert
88
import org.junit.Assert.assertEquals
99
import org.junit.Assert.assertThrows
1010
import org.junit.Before
11+
import org.junit.Ignore
1112
import org.junit.Test
1213
import org.junit.runner.RunWith
1314
import org.web3j.crypto.Hash
@@ -371,6 +372,7 @@ class ConversationTest {
371372
}
372373

373374
@Test
375+
@Ignore("Rust seems to be Flaky with V1")
374376
fun testCanPaginateV1Messages() {
375377
// Overwrite contact as legacy so we can get v1
376378
fixtures.publishLegacyContact(client = bobClient)

‎library/src/androidTest/java/org/xmtp/android/library/GroupChatTest.kt

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
package org.xmtp.android.library
2+
3+
import androidx.test.ext.junit.runners.AndroidJUnit4
4+
import org.junit.Assert.assertEquals
5+
import org.junit.Test
6+
import org.junit.runner.RunWith
7+
import org.xmtp.android.library.messages.walletAddress
8+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.ContentTypeGroupChatMemberAdded
9+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.ContentTypeGroupTitleChangedAdded
10+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.GroupChatMemberAdded
11+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.GroupChatTitleChanged
12+
13+
@RunWith(AndroidJUnit4::class)
14+
class GroupChatTest {
15+
@Test
16+
fun testCanAddMemberToGroupChatCodec() {
17+
val fixtures = fixtures()
18+
val aliceClient = fixtures.aliceClient
19+
aliceClient.enableGroupChat()
20+
val aliceConversation =
21+
aliceClient.conversations.newConversation(fixtures.bob.walletAddress)
22+
23+
val personAdded = GroupChatMemberAdded(
24+
member = fixtures.steve.walletAddress,
25+
)
26+
27+
aliceConversation.send(
28+
content = personAdded,
29+
options = SendOptions(contentType = ContentTypeGroupChatMemberAdded),
30+
)
31+
val messages = aliceConversation.messages()
32+
assertEquals(messages.size, 1)
33+
val content: GroupChatMemberAdded? = messages[0].content()
34+
assertEquals(fixtures.steve.walletAddress, content?.member)
35+
}
36+
37+
@Test
38+
fun testCanChangeGroupChatNameCodec() {
39+
val fixtures = fixtures()
40+
val aliceClient = fixtures.aliceClient
41+
aliceClient.enableGroupChat()
42+
val aliceConversation =
43+
aliceClient.conversations.newConversation(fixtures.bob.walletAddress)
44+
45+
val titleChange = GroupChatTitleChanged(
46+
newTitle = "New Title",
47+
)
48+
49+
aliceConversation.send(
50+
content = titleChange,
51+
options = SendOptions(contentType = ContentTypeGroupTitleChangedAdded),
52+
)
53+
val messages = aliceConversation.messages()
54+
assertEquals(messages.size, 1)
55+
val content: GroupChatTitleChanged? = messages[0].content()
56+
assertEquals("New Title", content?.newTitle)
57+
}
58+
}

‎library/src/androidTest/java/org/xmtp/android/library/LocalInstrumentedTest.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
package org.xmtp.android.library
22

33
import androidx.test.ext.junit.runners.AndroidJUnit4
4-
import androidx.test.filters.FlakyTest
54
import kotlinx.coroutines.ExperimentalCoroutinesApi
65
import kotlinx.coroutines.flow.mapLatest
76
import kotlinx.coroutines.runBlocking
87
import org.junit.Assert.assertEquals
8+
import org.junit.Ignore
99
import org.junit.Test
1010
import org.junit.runner.RunWith
1111
import org.xmtp.android.library.messages.Envelope
@@ -72,7 +72,7 @@ class LocalInstrumentedTest {
7272
}
7373

7474
@Test
75-
@FlakyTest
75+
@Ignore("Flaky test")
7676
fun testPublishingAndFetchingContactBundlesWithSavedKeys() {
7777
val aliceWallet = PrivateKeyBuilder()
7878
val alice = PrivateKeyOuterClass.PrivateKeyBundleV1.newBuilder().build()

‎library/src/androidTest/java/org/xmtp/android/library/TestHelpers.kt

+4-2
Original file line numberDiff line numberDiff line change
@@ -187,14 +187,16 @@ class FakeApiClient : ApiClient {
187187
}
188188
}
189189

190-
data class Fixtures(val aliceAccount: PrivateKeyBuilder, val bobAccount: PrivateKeyBuilder) {
190+
data class Fixtures(val aliceAccount: PrivateKeyBuilder, val bobAccount: PrivateKeyBuilder, val steveAccount: PrivateKeyBuilder) {
191191
var fakeApiClient: FakeApiClient = FakeApiClient()
192192
var alice: PrivateKey = aliceAccount.getPrivateKey()
193193
var aliceClient: Client = Client().create(account = aliceAccount, apiClient = fakeApiClient)
194194
var bob: PrivateKey = bobAccount.getPrivateKey()
195195
var bobClient: Client = Client().create(account = bobAccount, apiClient = fakeApiClient)
196+
var steve: PrivateKey = steveAccount.getPrivateKey()
197+
var steveClient: Client = Client().create(account = steveAccount, apiClient = fakeApiClient)
196198

197-
constructor() : this(aliceAccount = PrivateKeyBuilder(), bobAccount = PrivateKeyBuilder())
199+
constructor() : this(aliceAccount = PrivateKeyBuilder(), bobAccount = PrivateKeyBuilder(), steveAccount = PrivateKeyBuilder())
198200

199201
fun publishLegacyContact(client: Client) {
200202
val contactBundle = ContactBundle.newBuilder().also { builder ->

‎library/src/main/java/org/xmtp/android/library/Client.kt

+15-2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import org.xmtp.android.library.messages.walletAddress
3434
import org.xmtp.proto.message.api.v1.MessageApiOuterClass
3535
import org.xmtp.proto.message.api.v1.MessageApiOuterClass.BatchQueryResponse
3636
import org.xmtp.proto.message.api.v1.MessageApiOuterClass.QueryRequest
37+
import uniffi.xmtp_dh.org.xmtp.android.library.GroupChat
3738
import java.nio.charset.StandardCharsets
3839
import java.text.SimpleDateFormat
3940
import java.time.Instant
@@ -45,7 +46,11 @@ typealias PublishResponse = org.xmtp.proto.message.api.v1.MessageApiOuterClass.P
4546
typealias QueryResponse = org.xmtp.proto.message.api.v1.MessageApiOuterClass.QueryResponse
4647

4748
data class ClientOptions(val api: Api = Api()) {
48-
data class Api(val env: XMTPEnvironment = XMTPEnvironment.DEV, val isSecure: Boolean = true, val appVersion: String? = null)
49+
data class Api(
50+
val env: XMTPEnvironment = XMTPEnvironment.DEV,
51+
val isSecure: Boolean = true,
52+
val appVersion: String? = null,
53+
)
4954
}
5055

5156
class Client() {
@@ -54,6 +59,8 @@ class Client() {
5459
lateinit var apiClient: ApiClient
5560
lateinit var contacts: Contacts
5661
lateinit var conversations: Conversations
62+
var isGroupChatEnabled: Boolean = false
63+
private set
5764

5865
companion object {
5966
private const val TAG = "Client"
@@ -220,7 +227,8 @@ class Client() {
220227
it.v2 = it.v2.toBuilder().also { v2Builder ->
221228
v2Builder.keyBundle = v2Builder.keyBundle.toBuilder().also { keyBuilder ->
222229
keyBuilder.identityKey = keyBuilder.identityKey.toBuilder().also { idBuilder ->
223-
idBuilder.signature = it.v2.keyBundle.identityKey.signature.ensureWalletSignature()
230+
idBuilder.signature =
231+
it.v2.keyBundle.identityKey.signature.ensureWalletSignature()
224232
}.build()
225233
}.build()
226234
}.build()
@@ -347,4 +355,9 @@ class Client() {
347355

348356
val keys: PrivateKeyBundleV2
349357
get() = privateKeyBundleV1.toV2()
358+
359+
fun enableGroupChat() {
360+
this.isGroupChatEnabled = true
361+
GroupChat.registerCodecs()
362+
}
350363
}

‎library/src/main/java/org/xmtp/android/library/Conversation.kt

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ sealed class Conversation {
1414
V2
1515
}
1616

17+
val isGroup: Boolean
18+
get() {
19+
return when (this) {
20+
is V1 -> false
21+
is V2 -> conversationV2.isGroup
22+
}
23+
}
24+
1725
val version: Version
1826
get() {
1927
return when (this) {
@@ -75,6 +83,7 @@ sealed class Conversation {
7583
is V1 -> {
7684
conversationV1.prepareMessage(content = content, options = options)
7785
}
86+
7887
is V2 -> {
7988
conversationV2.prepareMessage(content = content, options = options)
8089
}
@@ -114,6 +123,7 @@ sealed class Conversation {
114123
before = before,
115124
after = after
116125
)
126+
117127
is V2 ->
118128
conversationV2.messages(
119129
limit = limit,

‎library/src/main/java/org/xmtp/android/library/ConversationV2.kt

+4-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ data class ConversationV2(
2828
val context: Invitation.InvitationV1.Context,
2929
val peerAddress: String,
3030
val client: Client,
31+
val isGroup: Boolean = false,
3132
private val header: SealedInvitationHeaderV1,
3233
) {
3334

@@ -36,6 +37,7 @@ data class ConversationV2(
3637
client: Client,
3738
invitation: Invitation.InvitationV1,
3839
header: SealedInvitationHeaderV1,
40+
isGroup: Boolean = false
3941
): ConversationV2 {
4042
val myKeys = client.keys.getPublicKeyBundle()
4143
val peer =
@@ -48,7 +50,8 @@ data class ConversationV2(
4850
context = invitation.context,
4951
peerAddress = peerAddress,
5052
client = client,
51-
header = header
53+
header = header,
54+
isGroup = isGroup
5255
)
5356
}
5457
}

‎library/src/main/java/org/xmtp/android/library/Conversations.kt

+34-7
Original file line numberDiff line numberDiff line change
@@ -163,17 +163,19 @@ data class Conversations(
163163
val invitations = listInvitations(pagination = pagination)
164164
for (sealedInvitation in invitations) {
165165
try {
166-
val unsealed = sealedInvitation.v1.getInvitation(viewer = client.keys)
167-
val conversation = ConversationV2.create(
168-
client = client,
169-
invitation = unsealed,
170-
header = sealedInvitation.v1.header
171-
)
172-
newConversations.add(Conversation.V2(conversation))
166+
newConversations.add(Conversation.V2(conversation(sealedInvitation)))
173167
} catch (e: Exception) {
174168
Log.d(TAG, e.message.toString())
175169
}
176170
}
171+
for (sealedInvitation in listGroupInvitations()) {
172+
try {
173+
newConversations.add(Conversation.V2(conversation(sealedInvitation, true)))
174+
} catch (e: Exception) {
175+
Log.d(TAG, e.message.toString())
176+
}
177+
}
178+
177179
conversationsByTopic += newConversations.filter { it.peerAddress != client.address }
178180
.map { Pair(it.topic, it) }
179181

@@ -228,6 +230,31 @@ data class Conversations(
228230
}
229231
}
230232

233+
private fun listGroupInvitations(): List<SealedInvitation> {
234+
if (!client.isGroupChatEnabled) {
235+
return listOf()
236+
}
237+
val envelopes = runBlocking {
238+
client.apiClient.envelopes(
239+
topic = Topic.groupInvite(client.address).description,
240+
pagination = null
241+
)
242+
}
243+
return envelopes.map { envelope ->
244+
SealedInvitation.parseFrom(envelope.message)
245+
}
246+
}
247+
248+
fun conversation(sealedInvitation: SealedInvitation, isGroup: Boolean = false): ConversationV2 {
249+
val unsealed = sealedInvitation.v1.getInvitation(viewer = client.keys)
250+
return ConversationV2.create(
251+
client = client,
252+
invitation = unsealed,
253+
header = sealedInvitation.v1.header,
254+
isGroup = isGroup
255+
)
256+
}
257+
231258
fun listBatchMessages(
232259
topics: List<String>,
233260
limit: Int? = null,

‎library/src/main/java/org/xmtp/android/library/GroupChat.kt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package uniffi.xmtp_dh.org.xmtp.android.library
2+
3+
import org.xmtp.android.library.Client
4+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.GroupChatMemberAddedCodec
5+
import uniffi.xmtp_dh.org.xmtp.android.library.codecs.GroupChatTitleChangedCodec
6+
7+
class GroupChat {
8+
companion object {
9+
fun registerCodecs() {
10+
Client.register(codec = GroupChatMemberAddedCodec())
11+
Client.register(codec = GroupChatTitleChangedCodec())
12+
}
13+
}
14+
}

‎library/src/main/java/org/xmtp/android/library/codecs/GroupChatMemberAddedCodec.kt

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package uniffi.xmtp_dh.org.xmtp.android.library.codecs
2+
3+
import com.google.gson.GsonBuilder
4+
import com.google.protobuf.kotlin.toByteStringUtf8
5+
import org.xmtp.android.library.codecs.ContentCodec
6+
import org.xmtp.android.library.codecs.ContentTypeId
7+
import org.xmtp.android.library.codecs.ContentTypeIdBuilder
8+
import org.xmtp.android.library.codecs.EncodedContent
9+
10+
val ContentTypeGroupChatMemberAdded = ContentTypeIdBuilder.builderFromAuthorityId(
11+
"xmtp.org",
12+
"groupChatMemberAdded",
13+
versionMajor = 1,
14+
versionMinor = 0
15+
)
16+
17+
// The address of the member being added
18+
data class GroupChatMemberAdded(var member: String)
19+
20+
data class GroupChatMemberAddedCodec(override var contentType: ContentTypeId = ContentTypeGroupChatMemberAdded) :
21+
ContentCodec<GroupChatMemberAdded> {
22+
23+
override fun encode(content: GroupChatMemberAdded): EncodedContent {
24+
val gson = GsonBuilder().create()
25+
return EncodedContent.newBuilder().also {
26+
it.type = ContentTypeGroupChatMemberAdded
27+
it.content = gson.toJson(content).toByteStringUtf8()
28+
}.build()
29+
}
30+
31+
override fun decode(content: EncodedContent): GroupChatMemberAdded {
32+
val gson = GsonBuilder().create()
33+
return gson.fromJson(content.content.toStringUtf8(), GroupChatMemberAdded::class.java)
34+
}
35+
}

‎library/src/main/java/org/xmtp/android/library/codecs/GroupChatTitleChangedCodec.kt

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package uniffi.xmtp_dh.org.xmtp.android.library.codecs
2+
3+
import com.google.gson.GsonBuilder
4+
import com.google.protobuf.kotlin.toByteStringUtf8
5+
import org.xmtp.android.library.codecs.ContentCodec
6+
import org.xmtp.android.library.codecs.ContentTypeId
7+
import org.xmtp.android.library.codecs.ContentTypeIdBuilder
8+
import org.xmtp.android.library.codecs.EncodedContent
9+
10+
val ContentTypeGroupTitleChangedAdded = ContentTypeIdBuilder.builderFromAuthorityId(
11+
"xmtp.org",
12+
"groupChatTitleChanged",
13+
versionMajor = 1,
14+
versionMinor = 0
15+
)
16+
17+
// The new title
18+
data class GroupChatTitleChanged(var newTitle: String)
19+
20+
data class GroupChatTitleChangedCodec(override var contentType: ContentTypeId = ContentTypeGroupTitleChangedAdded) :
21+
ContentCodec<GroupChatTitleChanged> {
22+
23+
override fun encode(content: GroupChatTitleChanged): EncodedContent {
24+
val gson = GsonBuilder().create()
25+
return EncodedContent.newBuilder().also {
26+
it.type = ContentTypeGroupTitleChangedAdded
27+
it.content = gson.toJson(content).toByteStringUtf8()
28+
}.build()
29+
}
30+
31+
override fun decode(content: EncodedContent): GroupChatTitleChanged {
32+
val gson = GsonBuilder().create()
33+
return gson.fromJson(content.content.toStringUtf8(), GroupChatTitleChanged::class.java)
34+
}
35+
}

‎library/src/main/java/org/xmtp/android/library/messages/Topic.kt

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sealed class Topic {
77
data class userInvite(val address: String?) : Topic()
88
data class directMessageV1(val address1: String?, val address2: String?) : Topic()
99
data class directMessageV2(val addresses: String?) : Topic()
10+
data class groupInvite(val address: String?) : Topic()
1011

1112
val description: String
1213
get() {
@@ -21,6 +22,7 @@ sealed class Topic {
2122
wrap("dm-${addresses.joinToString(separator = "-")}")
2223
}
2324
is directMessageV2 -> wrap("m-$addresses")
25+
is groupInvite -> wrap("groupInvite-$address")
2426
}
2527
}
2628

0 commit comments

Comments
 (0)