Append 'Json' suffix to network model name (#3344)

This commit is contained in:
David Perez 2024-06-24 10:22:26 -05:00 committed by GitHub
parent 5183832e35
commit 448ef1597f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 25 additions and 25 deletions

View file

@ -1,6 +1,6 @@
package com.x8bit.bitwarden.data.platform.datasource.disk
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
/**
* Primary access point for disk information related to event data.
@ -14,10 +14,10 @@ interface EventDiskSource {
/**
* Adds a new organization event associated with the given [userId].
*/
suspend fun addOrganizationEvent(userId: String, event: OrganizationEvent)
suspend fun addOrganizationEvent(userId: String, event: OrganizationEventJson)
/**
* Retrieves all organization events associated with the given [userId].
*/
suspend fun getOrganizationEvents(userId: String): List<OrganizationEvent>
suspend fun getOrganizationEvents(userId: String): List<OrganizationEventJson>
}

View file

@ -2,7 +2,7 @@ package com.x8bit.bitwarden.data.platform.datasource.disk
import com.x8bit.bitwarden.data.platform.datasource.disk.dao.OrganizationEventDao
import com.x8bit.bitwarden.data.platform.datasource.disk.entity.OrganizationEventEntity
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import com.x8bit.bitwarden.data.platform.manager.dispatcher.DispatcherManager
import com.x8bit.bitwarden.data.platform.manager.model.OrganizationEventType
import kotlinx.coroutines.withContext
@ -22,7 +22,7 @@ class EventDiskSourceImpl(
organizationEventDao.deleteOrganizationEvents(userId = userId)
}
override suspend fun addOrganizationEvent(userId: String, event: OrganizationEvent) {
override suspend fun addOrganizationEvent(userId: String, event: OrganizationEventJson) {
organizationEventDao.insertOrganizationEvent(
event = OrganizationEventEntity(
userId = userId,
@ -37,11 +37,11 @@ class EventDiskSourceImpl(
override suspend fun getOrganizationEvents(
userId: String,
): List<OrganizationEvent> =
): List<OrganizationEventJson> =
organizationEventDao
.getOrganizationEvents(userId = userId)
.map {
OrganizationEvent(
OrganizationEventJson(
type = withContext(context = dispatcherManager.default) {
json.decodeFromString<OrganizationEventType>(
string = it.organizationEventType,

View file

@ -1,6 +1,6 @@
package com.x8bit.bitwarden.data.platform.datasource.network.api
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import retrofit2.http.Body
import retrofit2.http.POST
@ -9,5 +9,5 @@ import retrofit2.http.POST
*/
interface EventApi {
@POST("/collect")
suspend fun collectOrganizationEvents(@Body events: List<OrganizationEvent>): Result<Unit>
suspend fun collectOrganizationEvents(@Body events: List<OrganizationEventJson>): Result<Unit>
}

View file

@ -10,7 +10,7 @@ import java.time.ZonedDateTime
* Represents an individual organization event including the type and time.
*/
@Serializable
data class OrganizationEvent(
data class OrganizationEventJson(
@SerialName("type") val type: OrganizationEventType,
@SerialName("cipherId") val cipherId: String?,
@SerialName("date") @Contextual val date: ZonedDateTime,

View file

@ -1,6 +1,6 @@
package com.x8bit.bitwarden.data.platform.datasource.network.service
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
/**
* Provides an API for submitting events.
@ -9,5 +9,5 @@ interface EventService {
/**
* Attempts to submit all of the given organizations events.
*/
suspend fun sendOrganizationEvents(events: List<OrganizationEvent>): Result<Unit>
suspend fun sendOrganizationEvents(events: List<OrganizationEventJson>): Result<Unit>
}

View file

@ -1,7 +1,7 @@
package com.x8bit.bitwarden.data.platform.datasource.network.service
import com.x8bit.bitwarden.data.platform.datasource.network.api.EventApi
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
/**
* The default implementation of the [EventService].
@ -10,6 +10,6 @@ class EventServiceImpl(
private val eventApi: EventApi,
) : EventService {
override suspend fun sendOrganizationEvents(
events: List<OrganizationEvent>,
events: List<OrganizationEventJson>,
): Result<Unit> = eventApi.collectOrganizationEvents(events = events)
}

View file

@ -6,7 +6,7 @@ import androidx.lifecycle.ProcessLifecycleOwner
import com.x8bit.bitwarden.data.auth.repository.AuthRepository
import com.x8bit.bitwarden.data.auth.repository.model.AuthState
import com.x8bit.bitwarden.data.platform.datasource.disk.EventDiskSource
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import com.x8bit.bitwarden.data.platform.datasource.network.service.EventService
import com.x8bit.bitwarden.data.platform.manager.dispatcher.DispatcherManager
import com.x8bit.bitwarden.data.platform.manager.model.OrganizationEventType
@ -76,7 +76,7 @@ class OrganizationEventManagerImpl(
}
eventDiskSource.addOrganizationEvent(
userId = userId,
event = OrganizationEvent(
event = OrganizationEventJson(
type = eventType,
cipherId = cipherId,
date = ZonedDateTime.now(clock),

View file

@ -4,7 +4,7 @@ import com.x8bit.bitwarden.data.platform.base.FakeDispatcherManager
import com.x8bit.bitwarden.data.platform.datasource.disk.dao.FakeOrganizationEventDao
import com.x8bit.bitwarden.data.platform.datasource.disk.entity.OrganizationEventEntity
import com.x8bit.bitwarden.data.platform.datasource.network.di.PlatformNetworkModule
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import com.x8bit.bitwarden.data.platform.manager.model.OrganizationEventType
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
@ -35,7 +35,7 @@ class EventDiskSourceTest {
@Test
fun `addOrganizationEvent should insert a new organization event`() = runTest {
val userId = "userId-1"
val organizationEvent = OrganizationEvent(
val organizationEvent = OrganizationEventJson(
type = OrganizationEventType.CIPHER_DELETED,
cipherId = "cipherId-1",
date = ZonedDateTime.now(fixedClock),
@ -128,7 +128,7 @@ class EventDiskSourceTest {
assertEquals(
listOf(
OrganizationEvent(
OrganizationEventJson(
type = OrganizationEventType.CIPHER_DELETED,
cipherId = "cipherId-1",
date = ZonedDateTime.now(fixedClock),

View file

@ -2,7 +2,7 @@ package com.x8bit.bitwarden.data.platform.datasource.network.service
import com.x8bit.bitwarden.data.platform.base.BaseServiceTest
import com.x8bit.bitwarden.data.platform.datasource.network.api.EventApi
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import com.x8bit.bitwarden.data.platform.manager.model.OrganizationEventType
import kotlinx.coroutines.test.runTest
import okhttp3.mockwebserver.MockResponse
@ -31,7 +31,7 @@ class EventServiceTest : BaseServiceTest() {
server.enqueue(MockResponse())
val result = eventService.sendOrganizationEvents(
events = listOf(
OrganizationEvent(
OrganizationEventJson(
type = OrganizationEventType.CIPHER_CREATED,
cipherId = "cipher-id",
date = ZonedDateTime.now(fixedClock),

View file

@ -5,7 +5,7 @@ import com.x8bit.bitwarden.data.auth.repository.AuthRepository
import com.x8bit.bitwarden.data.auth.repository.model.AuthState
import com.x8bit.bitwarden.data.platform.base.FakeDispatcherManager
import com.x8bit.bitwarden.data.platform.datasource.disk.EventDiskSource
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEvent
import com.x8bit.bitwarden.data.platform.datasource.network.model.OrganizationEventJson
import com.x8bit.bitwarden.data.platform.datasource.network.service.EventService
import com.x8bit.bitwarden.data.platform.manager.model.OrganizationEventType
import com.x8bit.bitwarden.data.platform.repository.model.DataState
@ -69,7 +69,7 @@ class OrganizationEventManagerTest {
@Test
fun `onLifecycleStart should upload events after 2 minutes and again after 5 more minutes`() =
runTest {
val organizationEvent = OrganizationEvent(
val organizationEvent = OrganizationEventJson(
type = OrganizationEventType.CIPHER_UPDATED,
cipherId = CIPHER_ID,
date = ZonedDateTime.now(fixedClock),
@ -100,7 +100,7 @@ class OrganizationEventManagerTest {
@Test
fun `onLifecycleStop should upload events immediately`() = runTest {
val organizationEvent = OrganizationEvent(
val organizationEvent = OrganizationEventJson(
type = OrganizationEventType.CIPHER_UPDATED,
cipherId = CIPHER_ID,
date = ZonedDateTime.now(fixedClock),
@ -202,7 +202,7 @@ class OrganizationEventManagerTest {
coVerify(exactly = 1) {
eventDiskSource.addOrganizationEvent(
userId = USER_ID,
event = OrganizationEvent(
event = OrganizationEventJson(
type = eventType,
cipherId = CIPHER_ID,
date = ZonedDateTime.now(fixedClock),