Skip to content

Commit

Permalink
fix: update federation flag when fetching server config [WPB-14728] (#…
Browse files Browse the repository at this point in the history 
…3143)

* fix: update federation flag when updating api version

* fix test

* remove not needed comment

* fix jvm tests

(cherry picked from commit 790b885)
  • Loading branch information
@MohamadJaara
MohamadJaara committed Dec 19, 2024
1 parent c5c2468 commit 281fc75
Show file tree
Hide file tree
Showing 10 changed files with 102 additions and 49 deletions.
6 changes: 5 additions & 1 deletion ...monMain/kotlin/com/wire/kalium/logic/configuration/server/CustomServerConfigRepository.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,11 @@ internal class CustomServerConfigDataSource internal constructor(
val storedConfigId = serverConfigurationDAO.configByLinks(serverConfigMapper.toEntity(links))?.id
if (storedConfigId != null) {
// if already exists then just update it
serverConfigurationDAO.updateApiVersion(storedConfigId, metadata.commonApiVersion.version)
serverConfigurationDAO.updateServerMetaData(
id = storedConfigId,
federation = metadata.federation,
commonApiVersion = metadata.commonApiVersion.version
)
if (metadata.federation) serverConfigurationDAO.setFederationToTrue(storedConfigId)
storedConfigId
} else {
Expand Down
24 changes: 18 additions & 6 deletions ...rc/commonMain/kotlin/com/wire/kalium/logic/configuration/server/ServerConfigRepository.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ internal interface ServerConfigRepository {
suspend fun fetchApiVersionAndStore(links: ServerConfig.Links): Either<CoreFailure, ServerConfig>

/**
* update the api version of a locally stored config
* update the api version and federation status of a locally stored config
*/
suspend fun updateConfigApiVersion(serverConfig: ServerConfig): Either<CoreFailure, Unit>
suspend fun updateConfigMetaData(serverConfig: ServerConfig): Either<CoreFailure, Unit>

/**
* Return the server links and metadata for the given userId
Expand Down Expand Up @@ -86,7 +86,11 @@ internal class ServerConfigDataSource(
val storedConfigId = dao.configByLinks(serverConfigMapper.toEntity(links))?.id
if (storedConfigId != null) {
// if already exists then just update it
dao.updateApiVersion(storedConfigId, metadata.commonApiVersion.version)
dao.updateServerMetaData(
id = storedConfigId,
federation = metadata.federation,
commonApiVersion = metadata.commonApiVersion.version
)
if (metadata.federation) dao.setFederationToTrue(storedConfigId)
storedConfigId
} else {
Expand Down Expand Up @@ -126,9 +130,17 @@ internal class ServerConfigDataSource(
storeConfig(links, metaData)
}

override suspend fun updateConfigApiVersion(serverConfig: ServerConfig): Either<CoreFailure, Unit> =
fetchMetadata(serverConfig.links)
.flatMap { wrapStorageRequest { dao.updateApiVersion(serverConfig.id, it.commonApiVersion.version) } }
override suspend fun updateConfigMetaData(serverConfig: ServerConfig): Either<CoreFailure, Unit> =
fetchMetadata(serverConfig.links)
.flatMap { newMetaData ->
wrapStorageRequest {
dao.updateServerMetaData(
id = serverConfig.id,
federation = newMetaData.federation,
commonApiVersion = newMetaData.commonApiVersion.version
)
}
}

override suspend fun configForUser(userId: UserId): Either<StorageFailure, ServerConfig> =
wrapStorageRequest { dao.configForUser(userId.toDao()) }
Expand Down
2 changes: 1 addition & 1 deletion logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/server/UpdateApiVersionsUseCase.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,6 @@ class UpdateApiVersionsUseCaseImpl internal constructor(
} else {
null
}
serverConfigRepoProvider(serverConfig, proxyCredentials).updateConfigApiVersion(serverConfig)
serverConfigRepoProvider(serverConfig, proxyCredentials).updateConfigMetaData(serverConfig)
}
}
25 changes: 13 additions & 12 deletions ...commonTest/kotlin/com/wire/kalium/logic/configuration/CustomServerConfigRepositoryTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import kotlinx.coroutines.test.runTest
import kotlin.properties.Delegates
import kotlin.test.Test
import kotlin.test.assertEquals

class CustomServerConfigRepositoryTest {

@Test
Expand Down Expand Up @@ -78,8 +79,8 @@ class CustomServerConfigRepositoryTest {
.with(any())
.wasNotInvoked()
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::updateApiVersion)
.with(any(), any())
.suspendFunction(arrangement.serverConfigurationDAO::updateServerMetaData)
.with(any(), any(), any())
.wasInvoked(exactly = once)
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::setFederationToTrue)
Expand Down Expand Up @@ -111,8 +112,8 @@ class CustomServerConfigRepositoryTest {
.with(any())
.wasInvoked(exactly = once)
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::updateApiVersion)
.with(any(), any())
.suspendFunction(arrangement.serverConfigurationDAO::updateServerMetaData)
.with(any(), any(), any())
.wasNotInvoked()
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::setFederationToTrue)
Expand Down Expand Up @@ -156,8 +157,8 @@ class CustomServerConfigRepositoryTest {
.with(any())
.wasInvoked(exactly = once)
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::updateApiVersion)
.with(any(), any())
.suspendFunction(arrangement.serverConfigurationDAO::updateServerMetaData)
.with(any(), any(), any())
.wasNotInvoked()
verify(arrangement.serverConfigurationDAO)
.suspendFunction(arrangement.serverConfigurationDAO::setFederationToTrue)
Expand All @@ -176,18 +177,19 @@ class CustomServerConfigRepositoryTest {

@Mock
val serverConfigApi = mock(classOf<ServerConfigApi>())

var developmentApiEnabled by Delegates.notNull<Boolean>()

@Mock
val serverConfigurationDAO = mock(classOf<ServerConfigurationDAO>())

init {
developmentApiEnabled = false
}

@Mock
val backendMetaDataUtil = mock(classOf<BackendMetaDataUtil>())

private var customServerConfigRepository: CustomServerConfigRepository =
CustomServerConfigDataSource(serverConfigApi, developmentApiEnabled, serverConfigurationDAO, backendMetaDataUtil)

Expand All @@ -199,8 +201,7 @@ class CustomServerConfigRepositoryTest {
domain = serverConfigEntity.metaData.domain
)
)




suspend fun withConfigForNewRequest(serverConfigEntity: ServerConfigEntity): Arrangement {
given(serverConfigurationDAO)
Expand Down Expand Up @@ -247,7 +248,7 @@ class CustomServerConfigRepositoryTest {
.then { flowOf(listOf(newServerConfigEntity(1), newServerConfigEntity(2), newServerConfigEntity(3))) }
return this
}

suspend fun withUpdatedServerConfig(): Arrangement {
val newServerConfigEntity = serverConfigEntity.copy(
metaData = serverConfigEntity.metaData.copy(
Expand Down
8 changes: 4 additions & 4 deletions ...c/src/commonTest/kotlin/com/wire/kalium/logic/configuration/ServerConfigRepositoryTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ class ServerConfigRepositoryTest {
.with(any())
.wasNotInvoked()
verify(arrangement.serverConfigDAO)
.suspendFunction(arrangement.serverConfigDAO::updateApiVersion)
.with(any(), any())
.suspendFunction(arrangement.serverConfigDAO::updateServerMetaData)
.with(any(), any(), any())
.wasInvoked(exactly = once)
verify(arrangement.serverConfigDAO)
.suspendFunction(arrangement.serverConfigDAO::setFederationToTrue)
Expand Down Expand Up @@ -171,8 +171,8 @@ class ServerConfigRepositoryTest {
.with(any())
.wasInvoked(exactly = once)
verify(arrangement.serverConfigDAO)
.suspendFunction(arrangement.serverConfigDAO::updateApiVersion)
.with(any(), any())
.suspendFunction(arrangement.serverConfigDAO::updateServerMetaData)
.with(any(), any(), any())
.wasNotInvoked()
verify(arrangement.serverConfigDAO)
.suspendFunction(arrangement.serverConfigDAO::setFederationToTrue)
Expand Down
26 changes: 13 additions & 13 deletions ...src/commonTest/kotlin/com/wire/kalium/logic/feature/server/UpdateApiVersionUseCaseTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
}

runTest {
Expand All @@ -93,7 +93,7 @@ class UpdateApiVersionUseCaseTest {


verify(arrangement.serverConfigRepository1)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigApiVersion)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigMetaData)
.with(eq(serverConfig1))
.wasInvoked(exactly = once)
}
Expand All @@ -117,7 +117,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
}

runTest {
Expand All @@ -132,7 +132,7 @@ class UpdateApiVersionUseCaseTest {


verify(arrangement.serverConfigRepository1)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigApiVersion)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigMetaData)
.with(any())
.wasInvoked(exactly = once)
}
Expand All @@ -156,7 +156,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
withProxyCredForUser(userId1.toDao(), ProxyCredentialsEntity("user", "pass"))
}

Expand All @@ -172,7 +172,7 @@ class UpdateApiVersionUseCaseTest {
.wasInvoked(exactly = once)

verify(arrangement.serverConfigRepository1)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigApiVersion)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigMetaData)
.with(any())
.wasInvoked(exactly = once)
}
Expand Down Expand Up @@ -205,8 +205,8 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigApiVersion(serverConfig2, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig2, Either.Right(Unit))
withProxyCredForUser(userId2.toDao(), ProxyCredentialsEntity("user", "pass"))
}

Expand All @@ -227,12 +227,12 @@ class UpdateApiVersionUseCaseTest {
.wasNotInvoked()

verify(arrangement.serverConfigRepository1)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigApiVersion)
.suspendFunction(arrangement.serverConfigRepository1::updateConfigMetaData)
.with(any())
.wasInvoked(exactly = once)

verify(arrangement.serverConfigRepository2)
.suspendFunction(arrangement.serverConfigRepository2::updateConfigApiVersion)
.suspendFunction(arrangement.serverConfigRepository2::updateConfigMetaData)
.with(any())
.wasInvoked(exactly = once)

Expand Down Expand Up @@ -270,18 +270,18 @@ class UpdateApiVersionUseCaseTest {
.then { result }
}

fun withUpdateConfigApiVersion(
suspend fun withUpdateConfigMetaData(
serverConfig: ServerConfig,
result: Either<CoreFailure, Unit>
) {
when (serverConfig.id) {
serverConfig1.id -> given(serverConfigRepository1)
.suspendFunction(serverConfigRepository1::updateConfigApiVersion)
.suspendFunction(serverConfigRepository1::updateConfigMetaData)
.whenInvokedWith(any())
.then { result }

serverConfig2.id -> given(serverConfigRepository2)
.suspendFunction(serverConfigRepository2::updateConfigApiVersion)
.suspendFunction(serverConfigRepository2::updateConfigMetaData)
.whenInvokedWith(any())
.then { result }

Expand Down
4 changes: 2 additions & 2 deletions persistence/src/commonMain/db_global/com/wire/kalium/persistence/ServerConfiguration.sq
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ insert:
INSERT OR FAIL INTO ServerConfiguration(id, apiBaseUrl, accountBaseUrl, webSocketBaseUrl, blackListUrl, teamsUrl, websiteUrl, title, isOnPremises, federation, domain, commonApiVersion, apiProxyHost, apiProxyNeedsAuthentication, apiProxyPort)
VALUES( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?,?,?,?);

updateApiVersion:
UPDATE ServerConfiguration SET commonApiVersion = ? WHERE id = ?;
updateServerMetaData:
UPDATE ServerConfiguration SET federation = ?, commonApiVersion = ? WHERE id = ?;

/** this function will be used when a config get updated from v0 where domain can be null */
updateApiVersionAndDomain:
Expand Down
8 changes: 5 additions & 3 deletions ...e/src/commonMain/kotlin/com/wire/kalium/persistence/daokaliumdb/ServerConfigurationDAO.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ interface ServerConfigurationDAO {
suspend fun allConfig(): List<ServerConfigEntity>
fun configById(id: String): ServerConfigEntity?
suspend fun configByLinks(links: ServerConfigEntity.Links): ServerConfigEntity?
suspend fun updateApiVersion(id: String, commonApiVersion: Int)
suspend fun updateServerMetaData(id: String, federation: Boolean, commonApiVersion: Int)
suspend fun updateApiVersionAndDomain(id: String, domain: String, commonApiVersion: Int)
suspend fun configForUser(userId: UserIDEntity): ServerConfigEntity?
suspend fun setFederationToTrue(id: String)
Expand Down Expand Up @@ -209,8 +209,10 @@ internal class ServerConfigurationDAOImpl internal constructor(
}.executeAsOneOrNull()
}

override suspend fun updateApiVersion(id: String, commonApiVersion: Int) = withContext(queriesContext) {
queries.updateApiVersion(commonApiVersion, id)
override suspend fun updateServerMetaData(id: String, federation: Boolean, commonApiVersion: Int) {
withContext(queriesContext) {
queries.updateServerMetaData(federation, commonApiVersion, id)
}
}

override suspend fun updateApiVersionAndDomain(id: String, domain: String, commonApiVersion: Int) =
Expand Down
41 changes: 34 additions & 7 deletions ...c/commonTest/kotlin/com/wire/kalium/persistence/daokaliumdb/ServerConfigurationDAOTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,26 @@ import com.wire.kalium.persistence.GlobalDBBaseTest
import com.wire.kalium.persistence.db.GlobalDatabaseProvider
import com.wire.kalium.persistence.model.ServerConfigEntity
import com.wire.kalium.persistence.utils.stubs.newServerConfig
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.test.StandardTestDispatcher
import kotlinx.coroutines.test.TestDispatcher
import kotlinx.coroutines.test.advanceUntilIdle
import kotlinx.coroutines.test.resetMain
import kotlinx.coroutines.test.runTest
import kotlinx.coroutines.test.setMain
import kotlinx.coroutines.withContext
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Ignore
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFails
import kotlin.test.assertNotEquals
import kotlin.test.assertNotNull

@OptIn(ExperimentalCoroutinesApi::class)
class ServerConfigurationDAOTest : GlobalDBBaseTest() {

private val config1 = newServerConfig(id = 1)
Expand Down Expand Up @@ -142,13 +151,31 @@ class ServerConfigurationDAOTest : GlobalDBBaseTest() {

@Test
fun givenNewApiVersion_thenItCanBeUpdated() = runTest {
insertConfig(config1)
val newVersion = config1.metaData.copy(apiVersion = 2)
val expected = config1.copy(metaData = newVersion)
val oldConfig = config1.copy(
metaData = config1.metaData.copy(
apiVersion = 1,
federation = false
),
)

db.serverConfigurationDAO.updateApiVersion(config1.id, newVersion.apiVersion)
val actual = db.serverConfigurationDAO.configById(config1.id)
assertEquals(expected, actual)
val newVersion = config1.metaData.copy(
apiVersion = 2,
federation = true
)

val expected = oldConfig.copy(metaData = newVersion)

insertConfig(oldConfig)
globalDatabaseBuilder.serverConfigurationDAO.updateServerMetaData(
id = oldConfig.id,
federation = true,
commonApiVersion = 2
)
globalDatabaseBuilder.serverConfigurationDAO.configById(oldConfig.id)
.also { actual ->
assertEquals(expected.metaData.federation, actual!!.metaData.federation)
assertEquals(expected.metaData.apiVersion, actual!!.metaData.apiVersion)
}
}

@Test
Expand Down
7 changes: 7 additions & 0 deletions persistence/src/commonTest/kotlin/com/wire/kalium/persistence/globalDB/AccountsDAOTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,15 @@ import com.wire.kalium.persistence.db.GlobalDatabaseProvider
import com.wire.kalium.persistence.model.LogoutReason
import com.wire.kalium.persistence.model.ServerConfigEntity
import com.wire.kalium.persistence.model.SsoIdEntity
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.test.StandardTestDispatcher
import kotlinx.coroutines.test.TestCoroutineScheduler
import kotlinx.coroutines.test.TestDispatcher
import kotlinx.coroutines.test.resetMain
import kotlinx.coroutines.test.runTest
import kotlinx.coroutines.test.setMain
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
Expand Down

0 comments on commit 281fc75

Please sign in to comment.