Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consent V3 #297

Merged
merged 11 commits into from
Sep 16, 2024
Merged

Consent V3 #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d5bb86d
add group functions for setting and getting consent
nplasterer Sep 13, 2024
02022c1
update to support V3
nplasterer Sep 13, 2024
0a1b7a1
small clean up to set v2 and v3
nplasterer Sep 13, 2024
95ecc4c
add back so v2 also gets it
nplasterer Sep 13, 2024
8101609
add an involved test for members and inboxId and address consnet
nplasterer Sep 13, 2024
9326b97
get all the tests passing
nplasterer Sep 13, 2024
30a62f7
fix up linter
nplasterer Sep 13, 2024
1cc4f54
default to true
nplasterer Sep 16, 2024
3b43621
set v2 as well
nplasterer Sep 16, 2024
6f96e0b
clean up the logic
nplasterer Sep 16, 2024
49ae759
fix the lint
nplasterer Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions library/src/androidTest/java/org/xmtp/android/library/ContactsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ class ContactsTest {
val fixtures = fixtures()

val contacts = fixtures.bobClient.contacts
var result = contacts.isAllowed(fixtures.alice.walletAddress)
var result = runBlocking { contacts.isAllowed(fixtures.alice.walletAddress) }

assert(!result)

runBlocking { contacts.allow(listOf(fixtures.alice.walletAddress)) }

result = contacts.isAllowed(fixtures.alice.walletAddress)
result = runBlocking { contacts.isAllowed(fixtures.alice.walletAddress) }
assert(result)
}

Expand All @@ -47,13 +47,13 @@ class ContactsTest {
val fixtures = fixtures()

val contacts = fixtures.bobClient.contacts
var result = contacts.isAllowed(fixtures.alice.walletAddress)
var result = runBlocking { contacts.isAllowed(fixtures.alice.walletAddress) }

assert(!result)

runBlocking { contacts.deny(listOf(fixtures.alice.walletAddress)) }

result = contacts.isDenied(fixtures.alice.walletAddress)
result = runBlocking { contacts.isDenied(fixtures.alice.walletAddress) }
assert(result)
}
}
103 changes: 52 additions & 51 deletions library/src/androidTest/java/org/xmtp/android/library/ConversationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,72 +803,73 @@ class ConversationTest {
@Test
@Ignore("TODO: Fix Flaky Test")
fun testCanHaveConsentState() {
val bobConversation =
runBlocking { bobClient.conversations.newConversation(alice.walletAddress, null) }
Thread.sleep(1000)
val isAllowed = bobConversation.consentState() == ConsentState.ALLOWED
// Conversations you start should start as allowed
assertTrue("Bob convo should be allowed", isAllowed)
assertTrue(
"Bob contacts should be allowed",
bobClient.contacts.isAllowed(alice.walletAddress)
)

runBlocking {
bobClient.contacts.deny(listOf(alice.walletAddress))
bobClient.contacts.refreshConsentList()
}
val isDenied = bobConversation.consentState() == ConsentState.DENIED
assertEquals(bobClient.contacts.consentList.entries.size, 1)
assertTrue("Bob Conversation should be denied", isDenied)
val bobConversation =
runBlocking { bobClient.conversations.newConversation(alice.walletAddress, null) }
Thread.sleep(1000)
val isAllowed = bobConversation.consentState() == ConsentState.ALLOWED
// Conversations you start should start as allowed
assertTrue("Bob convo should be allowed", isAllowed)
assertTrue(
"Bob contacts should be allowed",
bobClient.contacts.isAllowed(alice.walletAddress)
)

runBlocking {
bobClient.contacts.deny(listOf(alice.walletAddress))
bobClient.contacts.refreshConsentList()
}
val isDenied = bobConversation.consentState() == ConsentState.DENIED
assertEquals(bobClient.contacts.consentList.entries.size, 1)
assertTrue("Bob Conversation should be denied", isDenied)

val aliceConversation = runBlocking { aliceClient.conversations.list()[0] }
val isUnknown = aliceConversation.consentState() == ConsentState.UNKNOWN
val aliceConversation = runBlocking { aliceClient.conversations.list()[0] }
val isUnknown = aliceConversation.consentState() == ConsentState.UNKNOWN

// Conversations started with you should start as unknown
assertTrue("Alice conversation should be unknown", isUnknown)
// Conversations started with you should start as unknown
assertTrue("Alice conversation should be unknown", isUnknown)

runBlocking { aliceClient.contacts.allow(listOf(bob.walletAddress)) }
runBlocking { aliceClient.contacts.allow(listOf(bob.walletAddress)) }

val isBobAllowed = aliceConversation.consentState() == ConsentState.ALLOWED
assertTrue("Bob should be allowed from alice conversation", isBobAllowed)
val isBobAllowed = aliceConversation.consentState() == ConsentState.ALLOWED
assertTrue("Bob should be allowed from alice conversation", isBobAllowed)

val aliceClient2 = runBlocking { Client().create(aliceWallet) }
val aliceConversation2 = runBlocking { aliceClient2.conversations.list()[0] }
val aliceClient2 = runBlocking { Client().create(aliceWallet) }
val aliceConversation2 = runBlocking { aliceClient2.conversations.list()[0] }

runBlocking { aliceClient2.contacts.refreshConsentList() }
runBlocking { aliceClient2.contacts.refreshConsentList() }

// Allow state should sync across clients
val isBobAllowed2 = aliceConversation2.consentState() == ConsentState.ALLOWED
// Allow state should sync across clients
val isBobAllowed2 = aliceConversation2.consentState() == ConsentState.ALLOWED

assertTrue("Bob should be allowed from conversation 2", isBobAllowed2)
}
assertTrue("Bob should be allowed from conversation 2", isBobAllowed2)
}

@Test
@Ignore("TODO: Fix Flaky Test")
fun testCanHaveImplicitConsentOnMessageSend() {
val bobConversation =
runBlocking { bobClient.conversations.newConversation(alice.walletAddress, null) }
Thread.sleep(1000)
val isAllowed = bobConversation.consentState() == ConsentState.ALLOWED
@Test
@Ignore("TODO: Fix Flaky Test")
fun testCanHaveImplicitConsentOnMessageSend() {
runBlocking {
val bobConversation = bobClient.conversations.newConversation(alice.walletAddress, null)
Thread.sleep(1000)
val isAllowed = bobConversation.consentState() == ConsentState.ALLOWED

// Conversations you start should start as allowed
assertTrue("Bob convo should be allowed", isAllowed)
// Conversations you start should start as allowed
assertTrue("Bob convo should be allowed", isAllowed)

val aliceConversation = runBlocking { aliceClient.conversations.list()[0] }
val isUnknown = aliceConversation.consentState() == ConsentState.UNKNOWN
val aliceConversation = aliceClient.conversations.list()[0]
val isUnknown = aliceConversation.consentState() == ConsentState.UNKNOWN

// Conversations you receive should start as unknown
assertTrue("Alice convo should be unknown", isUnknown)
// Conversations you receive should start as unknown
assertTrue("Alice convo should be unknown", isUnknown)

runBlocking {
aliceConversation.send(content = "hey bob")
aliceClient.contacts.refreshConsentList()
}
val isNowAllowed = aliceConversation.consentState() == ConsentState.ALLOWED
aliceConversation.send(content = "hey bob")
aliceClient.contacts.refreshConsentList()
val isNowAllowed = aliceConversation.consentState() == ConsentState.ALLOWED

// Conversations you send a message to get marked as allowed
assertTrue("Should now be allowed", isNowAllowed)
// Conversations you send a message to get marked as allowed
assertTrue("Should now be allowed", isNowAllowed)
}
}
}

@Test
Expand Down
106 changes: 56 additions & 50 deletions library/src/androidTest/java/org/xmtp/android/library/GroupTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,13 @@ class GroupTest {
assert(boGroup.id.isNotEmpty())
assert(alixGroup.id.isNotEmpty())

assertEquals(boClient.contacts.consentList.groupState(boGroup.id), ConsentState.ALLOWED)
assertEquals(alixClient.contacts.consentList.groupState(alixGroup.id), ConsentState.UNKNOWN)
runBlocking {
assertEquals(boClient.contacts.consentList.groupState(boGroup.id), ConsentState.ALLOWED)
assertEquals(
alixClient.contacts.consentList.groupState(alixGroup.id),
ConsentState.UNKNOWN
)
}

runBlocking {
boGroup.addMembers(listOf(caro.walletAddress))
Expand Down Expand Up @@ -424,12 +429,14 @@ class GroupTest {

@Test
fun testGroupStartsWithAllowedState() {
val group = runBlocking { boClient.conversations.newGroup(listOf(alix.walletAddress)) }
runBlocking { group.send("howdy") }
runBlocking { group.send("gm") }
runBlocking { group.sync() }
assert(boClient.contacts.isGroupAllowed(group.id))
assertEquals(boClient.contacts.consentList.groupState(group.id), ConsentState.ALLOWED)
runBlocking {
val group = boClient.conversations.newGroup(listOf(alix.walletAddress))
group.send("howdy")
group.send("gm")
group.sync()
assert(boClient.contacts.isGroupAllowed(group.id))
assertEquals(boClient.contacts.consentList.groupState(group.id), ConsentState.ALLOWED)
}
}

@Test
Expand Down Expand Up @@ -771,58 +778,57 @@ class GroupTest {
}

@Test
fun testCanAllowGroup() {
val group = runBlocking {
boClient.conversations.newGroup(
listOf(
alix.walletAddress,
caro.walletAddress
fun testGroupConsent() {
runBlocking {
val group =
boClient.conversations.newGroup(
listOf(
alix.walletAddress,
caro.walletAddress
)
)
)
}

var result = boClient.contacts.isGroupAllowed(group.id)
assert(result)
assert(boClient.contacts.isGroupAllowed(group.id))
assertEquals(group.consentState(), ConsentState.ALLOWED)

runBlocking { boClient.contacts.allowGroups(listOf(group.id)) }

result = boClient.contacts.isGroupAllowed(group.id)
assert(result)
}
boClient.contacts.denyGroups(listOf(group.id))
assert(boClient.contacts.isGroupDenied(group.id))
assertEquals(group.consentState(), ConsentState.DENIED)

@Test
fun testCanDenyGroup() {
val group = runBlocking {
boClient.conversations.newGroup(
listOf(
alix.walletAddress,
caro.walletAddress
)
)
group.updateConsentState(ConsentState.ALLOWED)
assert(boClient.contacts.isGroupAllowed(group.id))
assertEquals(group.consentState(), ConsentState.ALLOWED)
}
var result = boClient.contacts.isGroupAllowed(group.id)
assert(result)

runBlocking { boClient.contacts.denyGroups(listOf(group.id)) }

result = boClient.contacts.isGroupDenied(group.id)
assert(result)
}

@Test
fun testCanAllowAndDenyInboxId() {
assert(!boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(!boClient.contacts.isInboxDenied(alixClient.inboxId))
runBlocking {
val boGroup = boClient.conversations.newGroup(listOf(alix.walletAddress))
assert(!boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(!boClient.contacts.isInboxDenied(alixClient.inboxId))

runBlocking { boClient.contacts.allowInboxes(listOf(alixClient.inboxId)) }
boClient.contacts.allowInboxes(listOf(alixClient.inboxId))
var alixMember = boGroup.members().firstOrNull { it.inboxId == alixClient.inboxId }
assertEquals(alixMember!!.consentState, ConsentState.ALLOWED)

assert(boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(!boClient.contacts.isInboxDenied(alixClient.inboxId))
assert(boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(!boClient.contacts.isInboxDenied(alixClient.inboxId))

runBlocking { boClient.contacts.denyInboxes(listOf(alixClient.inboxId)) }
boClient.contacts.denyInboxes(listOf(alixClient.inboxId))
alixMember = boGroup.members().firstOrNull { it.inboxId == alixClient.inboxId }
assertEquals(alixMember!!.consentState, ConsentState.DENIED)

assert(!boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(boClient.contacts.isInboxDenied(alixClient.inboxId))
assert(!boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(boClient.contacts.isInboxDenied(alixClient.inboxId))

boClient.contacts.allow(listOf(alixClient.address))
alixMember = boGroup.members().firstOrNull { it.inboxId == alixClient.inboxId }
assertEquals(alixMember!!.consentState, ConsentState.ALLOWED)
assert(boClient.contacts.isInboxAllowed(alixClient.inboxId))
assert(!boClient.contacts.isInboxDenied(alixClient.inboxId))
assert(boClient.contacts.isAllowed(alixClient.address))
assert(!boClient.contacts.isDenied(alixClient.address))
}
}

@Test
Expand Down Expand Up @@ -872,9 +878,9 @@ class GroupTest {
}
runBlocking { alixClient.conversations.syncGroups() }
val alixGroup: Group = alixClient.findGroup(boGroup.id)!!
assert(!alixClient.contacts.isGroupAllowed(boGroup.id))
runBlocking { assert(!alixClient.contacts.isGroupAllowed(boGroup.id)) }
val preparedMessageId = runBlocking { alixGroup.prepareMessage("Test text") }
assert(alixClient.contacts.isGroupAllowed(boGroup.id))
runBlocking { assert(alixClient.contacts.isGroupAllowed(boGroup.id)) }
assertEquals(alixGroup.messages().size, 1)
assertEquals(alixGroup.messages(deliveryStatus = MessageDeliveryStatus.PUBLISHED).size, 0)
assertEquals(alixGroup.messages(deliveryStatus = MessageDeliveryStatus.UNPUBLISHED).size, 1)
Expand Down
3 changes: 2 additions & 1 deletion library/src/main/java/org/xmtp/android/library/Client.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,10 @@ class Client() {
var logger: XMTPLogger = XMTPLogger()
val libXMTPVersion: String = getVersionInfo()
var installationId: String = ""
private var v3Client: FfiXmtpClient? = null
var v3Client: FfiXmtpClient? = null
var dbPath: String = ""
lateinit var inboxId: String
var hasV2Client: Boolean = true

companion object {
private const val TAG = "Client"
Expand Down
Loading
Loading