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
…#3144)

* Commit with unresolved merge conflicts

* Update ServerConfigRepository.kt

* Update ServerConfigurationDAO.kt

---------

Co-authored-by: Mohamad Jaara <[email protected]>
  • Loading branch information
github-actions[bot] and MohamadJaara authored Dec 6, 2024
1 parent 645b7db commit 212ddce
Show file tree
Hide file tree
Showing 11 changed files with 90 additions and 37 deletions.
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
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ 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 @@ -92,7 +92,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 @@ -132,9 +136,17 @@ internal class ServerConfigDataSource(
storeConfig(links, metaData)
}

override suspend fun updateConfigApiVersion(serverConfig: ServerConfig): Either<CoreFailure, Unit> =
override suspend fun updateConfigMetaData(serverConfig: ServerConfig): Either<CoreFailure, Unit> =
fetchMetadata(serverConfig.links)
.flatMap { wrapStorageRequest { dao.updateApiVersion(serverConfig.id, it.commonApiVersion.version) } }
.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
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)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class CustomServerConfigRepositoryTest {
arrangement.serverConfigurationDAO.insert(any())
}.wasNotInvoked()
coVerify {
arrangement.serverConfigurationDAO.updateApiVersion(any(), any())
arrangement.serverConfigurationDAO.updateServerMetaData(any(), any(), any())
}.wasInvoked(exactly = once)
coVerify {
arrangement.serverConfigurationDAO.setFederationToTrue(any())
Expand Down Expand Up @@ -106,7 +106,7 @@ class CustomServerConfigRepositoryTest {
arrangement.serverConfigurationDAO.insert(any())
}.wasInvoked(exactly = once)
coVerify {
arrangement.serverConfigurationDAO.updateApiVersion(any(), any())
arrangement.serverConfigurationDAO.updateServerMetaData(any(), any(), any())
}.wasNotInvoked()
coVerify {
arrangement.serverConfigurationDAO.setFederationToTrue(any())
Expand Down Expand Up @@ -145,7 +145,7 @@ class CustomServerConfigRepositoryTest {
arrangement.serverConfigurationDAO.insert(any())
}.wasInvoked(exactly = once)
coVerify {
arrangement.serverConfigurationDAO.updateApiVersion(any(), any())
arrangement.serverConfigurationDAO.updateServerMetaData(any(), any(), any())
}.wasNotInvoked()
coVerify {
arrangement.serverConfigurationDAO.setFederationToTrue(any())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ class ServerConfigRepositoryTest {
arrangement.serverConfigDAO.insert(any())
}.wasNotInvoked()
coVerify {
arrangement.serverConfigDAO.updateApiVersion(any(), any())
arrangement.serverConfigDAO.updateServerMetaData(any(), any(), any())
}.wasInvoked(exactly = once)
coVerify {
arrangement.serverConfigDAO.setFederationToTrue(any())
Expand Down Expand Up @@ -159,7 +159,7 @@ class ServerConfigRepositoryTest {
arrangement.serverConfigDAO.insert(any())
}.wasInvoked(exactly = once)
coVerify {
arrangement.serverConfigDAO.updateApiVersion(any(), any())
arrangement.serverConfigDAO.updateServerMetaData(any(), any(), any())
}.wasNotInvoked()
coVerify {
arrangement.serverConfigDAO.setFederationToTrue(any())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
}

updateApiVersionsUseCase()
Expand All @@ -88,7 +88,7 @@ class UpdateApiVersionUseCaseTest {
}.wasNotInvoked()

coVerify {
arrangement.serverConfigRepository1.updateConfigApiVersion(eq(serverConfig1))
arrangement.serverConfigRepository1.updateConfigMetaData(eq(serverConfig1))
}.wasInvoked(exactly = once)
}

Expand All @@ -111,7 +111,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
}

updateApiVersionsUseCase()
Expand All @@ -122,7 +122,7 @@ class UpdateApiVersionUseCaseTest {
}.wasNotInvoked()

coVerify {
arrangement.serverConfigRepository1.updateConfigApiVersion(any())
arrangement.serverConfigRepository1.updateConfigMetaData(any())
}.wasInvoked(exactly = once)
}

Expand All @@ -145,7 +145,7 @@ class UpdateApiVersionUseCaseTest {
)
)
)
withUpdateConfigApiVersion(serverConfig1, Either.Right(Unit))
withUpdateConfigMetaData(serverConfig1, Either.Right(Unit))
withProxyCredForUser(userId1.toDao(), ProxyCredentialsEntity("user", "pass"))
}

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

coVerify {
arrangement.serverConfigRepository1.updateConfigApiVersion(any())
arrangement.serverConfigRepository1.updateConfigMetaData(any())
}.wasInvoked(exactly = once)
}

Expand Down Expand Up @@ -190,8 +190,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 @@ -208,11 +208,11 @@ class UpdateApiVersionUseCaseTest {
}.wasNotInvoked()

coVerify {
arrangement.serverConfigRepository1.updateConfigApiVersion(any())
arrangement.serverConfigRepository1.updateConfigMetaData(any())
}.wasInvoked(exactly = once)

coVerify {
arrangement.serverConfigRepository2.updateConfigApiVersion(any())
arrangement.serverConfigRepository2.updateConfigMetaData(any())
}.wasInvoked(exactly = once)

}
Expand Down Expand Up @@ -249,16 +249,16 @@ class UpdateApiVersionUseCaseTest {
}.returns(result)
}

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

serverConfig2.id -> coEvery { serverConfigRepository2.updateConfigApiVersion(any()) }
serverConfig2.id -> coEvery { serverConfigRepository2.updateConfigMetaData(any()) }
.returns(result)

else -> throw IllegalArgumentException("Unexpected server config: $serverConfig")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package com.wire.kalium.persistence

import com.wire.kalium.persistence.db.GlobalDatabaseBuilder
import kotlinx.coroutines.test.TestDispatcher

actual abstract class GlobalDBBaseTest {
actual fun deleteDatabase() {
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ 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 getCommonApiVersion(domain: String): 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 @@ -210,8 +210,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 getCommonApiVersion(domain: String): Int = withContext(queriesContext) {
Expand Down
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.GlobalDatabaseBuilder
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
),
)

globalDatabaseBuilder.serverConfigurationDAO.updateApiVersion(config1.id, newVersion.apiVersion)
val actual = globalDatabaseBuilder.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
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,15 @@ import com.wire.kalium.persistence.db.GlobalDatabaseBuilder
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 212ddce

Please sign in to comment.