Skip to content

Commit

Permalink
feat(e2ei): replace keypackages in one api
Browse files Browse the repository at this point in the history
  • Loading branch information
@mchenani
mchenani committed Dec 7, 2023
1 parent 2ddf5b8 commit ad9f836
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 87 deletions.
9 changes: 2 additions & 7 deletions ...rc/commonMain/kotlin/com/wire/kalium/logic/data/conversation/MLSConversationRepository.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -536,13 +536,8 @@ internal class MLSConversationDataSource(
}.map { rotateBundle ->
// todo: make below API calls atomic when the backend does it in one request
// todo: store keypackages to drop, later drop them again
kaliumLogger.w("drop old key packages after conversations migration")
keyPackageRepository.deleteKeyPackages(clientId, rotateBundle.keyPackageRefsToRemove).flatMapLeft {
return Either.Left(it)
}

kaliumLogger.w("upload new key packages including x509 certificate")
keyPackageRepository.uploadKeyPackages(clientId, rotateBundle.newKeyPackages).flatMapLeft {
kaliumLogger.w("upload new keypackages and drop old ones")
keyPackageRepository.replaceKeyPackages(clientId, rotateBundle.newKeyPackages).flatMapLeft {
return Either.Left(it)
}

Expand Down
6 changes: 3 additions & 3 deletions logic/src/commonMain/kotlin/com/wire/kalium/logic/data/keypackage/KeyPackageRepository.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ interface KeyPackageRepository {

suspend fun uploadKeyPackages(clientId: ClientId, keyPackages: List<ByteArray>): Either<CoreFailure, Unit>

suspend fun deleteKeyPackages(clientId: ClientId, keyPackages: List<ByteArray>): Either<CoreFailure, Unit>
suspend fun replaceKeyPackages(clientId: ClientId, keyPackages: List<ByteArray>): Either<CoreFailure, Unit>

suspend fun getAvailableKeyPackageCount(clientId: ClientId): Either<NetworkFailure, KeyPackageCountDTO>

Expand Down Expand Up @@ -99,12 +99,12 @@ class KeyPackageDataSource(
keyPackageApi.uploadKeyPackages(clientId.value, keyPackages.map { it.encodeBase64() })
}

override suspend fun deleteKeyPackages(
override suspend fun replaceKeyPackages(
clientId: ClientId,
keyPackages: List<ByteArray>
): Either<CoreFailure, Unit> =
wrapApiRequest {
keyPackageApi.deleteKeyPackages(clientId.value, keyPackages.map { it.encodeBase64() })
keyPackageApi.replaceKeyPackages(clientId.value, keyPackages.map { it.encodeBase64() })
}

override suspend fun validKeyPackageCount(clientId: ClientId): Either<CoreFailure, Int> =
Expand Down
79 changes: 9 additions & 70 deletions ...ommonTest/kotlin/com/wire/kalium/logic/data/conversation/MLSConversationRepositoryTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1117,8 +1117,7 @@ class MLSConversationRepositoryTest {
.withGetMLSClientSuccessful()
.withRotateAllSuccessful()
.withSendCommitBundleSuccessful()
.withUploadKeyPackagesReturning(Either.Right(Unit))
.withDeleteKeyPackagesReturning(Either.Right(Unit))
.withReplaceKeyPackagesReturning(Either.Right(Unit))
.arrange()

assertEquals(
Expand All @@ -1132,12 +1131,7 @@ class MLSConversationRepositoryTest {
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::deleteKeyPackages)
.with(any(), any())
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::uploadKeyPackages)
.suspendFunction(arrangement.keyPackageRepository::replaceKeyPackages)
.with(any(), any())
.wasInvoked(once)

Expand All @@ -1148,48 +1142,11 @@ class MLSConversationRepositoryTest {
}

@Test
fun givenDropKeypackagesFailed_whenRotatingKeysAndMigratingConversation_thenReturnsFailure() = runTest {
val (arrangement, mlsConversationRepository) = Arrangement()
.withGetMLSClientSuccessful()
.withRotateAllSuccessful()
.withUploadKeyPackagesReturning(Either.Right(Unit))
.withDeleteKeyPackagesReturning(TEST_FAILURE)
.withSendCommitBundleSuccessful()
.arrange()

assertEquals(
TEST_FAILURE,
mlsConversationRepository.rotateKeysAndMigrateConversations(TestClient.CLIENT_ID, arrangement.e2eiClient, "")
)

verify(arrangement.mlsClient)
.suspendFunction(arrangement.mlsClient::e2eiRotateAll)
.with(any(), any(), any())
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::deleteKeyPackages)
.with(any(), any())
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::uploadKeyPackages)
.with(any(), any())
.wasNotInvoked()

verify(arrangement.mlsMessageApi)
.suspendFunction(arrangement.mlsMessageApi::sendCommitBundle)
.with(anyInstanceOf(MLSMessageApi.CommitBundle::class))
.wasNotInvoked()
}

@Test
fun givenUploadKeypackagesFailed_whenRotatingKeysAndMigratingConversation_thenReturnsFailure() = runTest {
fun givenReplacingKeypackagesFailed_whenRotatingKeysAndMigratingConversation_thenReturnsFailure() = runTest {
val (arrangement, mlsConversationRepository) = Arrangement()
.withGetMLSClientSuccessful()
.withRotateAllSuccessful()
.withUploadKeyPackagesReturning(TEST_FAILURE)
.withDeleteKeyPackagesReturning(Either.Right(Unit))
.withReplaceKeyPackagesReturning(TEST_FAILURE)
.withSendCommitBundleSuccessful()
.arrange()

Expand All @@ -1204,12 +1161,7 @@ class MLSConversationRepositoryTest {
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::deleteKeyPackages)
.with(any(), any())
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::uploadKeyPackages)
.suspendFunction(arrangement.keyPackageRepository::replaceKeyPackages)
.with(any(), any())
.wasInvoked(once)

Expand All @@ -1224,8 +1176,7 @@ class MLSConversationRepositoryTest {
val (arrangement, mlsConversationRepository) = Arrangement()
.withGetMLSClientSuccessful()
.withRotateAllSuccessful()
.withUploadKeyPackagesReturning(Either.Right(Unit))
.withDeleteKeyPackagesReturning(Either.Right(Unit))
.withReplaceKeyPackagesReturning(Either.Right(Unit))
.withSendCommitBundleFailing(Arrangement.MLS_CLIENT_MISMATCH_ERROR, times = 1)
.arrange()

Expand All @@ -1239,12 +1190,7 @@ class MLSConversationRepositoryTest {
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::deleteKeyPackages)
.with(any(), any())
.wasInvoked(once)

verify(arrangement.keyPackageRepository)
.suspendFunction(arrangement.keyPackageRepository::uploadKeyPackages)
.suspendFunction(arrangement.keyPackageRepository::replaceKeyPackages)
.with(any(), any())
.wasInvoked(once)

Expand Down Expand Up @@ -1392,16 +1338,9 @@ class MLSConversationRepositoryTest {
.then { Either.Right(keyPackages) }
}

fun withUploadKeyPackagesReturning(result: Either<CoreFailure, Unit>) = apply {
given(keyPackageRepository)
.suspendFunction(keyPackageRepository::uploadKeyPackages)
.whenInvokedWith(anything(), anything())
.thenReturn(result)
}

fun withDeleteKeyPackagesReturning(result: Either<CoreFailure, Unit>) = apply {
fun withReplaceKeyPackagesReturning(result: Either<CoreFailure, Unit>) = apply {
given(keyPackageRepository)
.suspendFunction(keyPackageRepository::deleteKeyPackages)
.suspendFunction(keyPackageRepository::replaceKeyPackages)
.whenInvokedWith(anything(), anything())
.thenReturn(result)
}
Expand Down
4 changes: 2 additions & 2 deletions ...monMain/kotlin/com/wire/kalium/network/api/base/authenticated/keypackage/KeyPackageApi.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ interface KeyPackageApi {
suspend fun uploadKeyPackages(clientId: String, keyPackages: List<KeyPackage>): NetworkResponse<Unit>

/**
* Delete a batch key packages from the server
* Upload and replace a batch fresh key packages from the self client
*
* @param clientId client ID
* @param keyPackages list of key packages
*
*/
suspend fun deleteKeyPackages(clientId: String, keyPackages: List<KeyPackage>): NetworkResponse<Unit>
suspend fun replaceKeyPackages(clientId: String, keyPackages: List<KeyPackage>): NetworkResponse<Unit>

/**
* Get the number of available key packages for the self client
Expand Down
4 changes: 2 additions & 2 deletions ...ork/src/commonMain/kotlin/com/wire/kalium/network/api/v0/authenticated/KeyPackageApiV0.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ internal open class KeyPackageApiV0 internal constructor() : KeyPackageApi {
APINotSupported("MLS: uploadKeyPackages api is only available on API V5")
)

override suspend fun deleteKeyPackages(
override suspend fun replaceKeyPackages(
clientId: String,
keyPackages: List<KeyPackage>
): NetworkResponse<Unit> = NetworkResponse.Error(
APINotSupported("MLS: uploadKeyPackages api is only available on API V5")
APINotSupported("MLS: replaceKeyPackages api is only available on API V5")
)

override suspend fun getAvailableKeyPackageCount(clientId: String): NetworkResponse<KeyPackageCountDTO> =
Expand Down
7 changes: 4 additions & 3 deletions ...ork/src/commonMain/kotlin/com/wire/kalium/network/api/v5/authenticated/KeyPackageApiV5.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import io.ktor.client.request.delete
import io.ktor.client.request.get
import io.ktor.client.request.parameter
import io.ktor.client.request.post
import io.ktor.client.request.put
import io.ktor.client.request.setBody

internal open class KeyPackageApiV5 internal constructor(
Expand Down Expand Up @@ -60,13 +61,13 @@ internal open class KeyPackageApiV5 internal constructor(
}
}

override suspend fun deleteKeyPackages(
override suspend fun replaceKeyPackages(
clientId: String,
keyPackages: List<KeyPackage>
): NetworkResponse<Unit> =
wrapKaliumResponse {
kaliumLogger.v("Keypackages Count to delete: ${keyPackages.size}")
httpClient.delete("$PATH_KEY_PACKAGES/$PATH_SELF/$clientId") {
kaliumLogger.v("Keypackages Count to replace: ${keyPackages.size}")
httpClient.put("$PATH_KEY_PACKAGES/$PATH_SELF/$clientId") {
setBody(KeyPackageList(keyPackages))
}
}
Expand Down

0 comments on commit ad9f836

Please sign in to comment.