From 448ef1597f18b87799a2b503dbe00591a1b47f49 Mon Sep 17 00:00:00 2001 From: David Perez Date: Mon, 24 Jun 2024 10:22:26 -0500 Subject: [PATCH] Append 'Json' suffix to network model name (#3344) --- .../data/platform/datasource/disk/EventDiskSource.kt | 6 +++--- .../data/platform/datasource/disk/EventDiskSourceImpl.kt | 8 ++++---- .../data/platform/datasource/network/api/EventApi.kt | 4 ++-- .../{OrganizationEvent.kt => OrganizationEventJson.kt} | 2 +- .../platform/datasource/network/service/EventService.kt | 4 ++-- .../datasource/network/service/EventServiceImpl.kt | 4 ++-- .../manager/event/OrganizationEventManagerImpl.kt | 4 ++-- .../data/platform/datasource/disk/EventDiskSourceTest.kt | 6 +++--- .../datasource/network/service/EventServiceTest.kt | 4 ++-- .../manager/event/OrganizationEventManagerTest.kt | 8 ++++---- 10 files changed, 25 insertions(+), 25 deletions(-) rename app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/{OrganizationEvent.kt => OrganizationEventJson.kt} (94%) diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSource.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSource.kt index 71ba16cbff..6a8a79790d 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSource.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSource.kt @@ -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 + suspend fun getOrganizationEvents(userId: String): List } diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceImpl.kt index 724caa03ca..752252e075 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceImpl.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceImpl.kt @@ -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 = + ): List = organizationEventDao .getOrganizationEvents(userId = userId) .map { - OrganizationEvent( + OrganizationEventJson( type = withContext(context = dispatcherManager.default) { json.decodeFromString( string = it.organizationEventType, diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/EventApi.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/EventApi.kt index bef32ac634..6b5072a33c 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/EventApi.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/EventApi.kt @@ -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): Result + suspend fun collectOrganizationEvents(@Body events: List): Result } diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEvent.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEventJson.kt similarity index 94% rename from app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEvent.kt rename to app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEventJson.kt index bce26c59a1..87ae767ca0 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEvent.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/model/OrganizationEventJson.kt @@ -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, diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventService.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventService.kt index f370d68d76..c771f9e5b5 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventService.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventService.kt @@ -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): Result + suspend fun sendOrganizationEvents(events: List): Result } diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceImpl.kt index fa83b1f8ef..65a459509f 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceImpl.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceImpl.kt @@ -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, + events: List, ): Result = eventApi.collectOrganizationEvents(events = events) } diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerImpl.kt index b1bf0c4cdc..6d90ee8f4c 100644 --- a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerImpl.kt +++ b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerImpl.kt @@ -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), diff --git a/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceTest.kt index 286b360857..5f0d36ee5f 100644 --- a/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceTest.kt +++ b/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/disk/EventDiskSourceTest.kt @@ -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), diff --git a/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceTest.kt index 55fe408050..a7b9d01ecb 100644 --- a/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceTest.kt +++ b/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/service/EventServiceTest.kt @@ -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), diff --git a/app/src/test/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerTest.kt index 9f094250de..13f0a9276f 100644 --- a/app/src/test/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerTest.kt +++ b/app/src/test/java/com/x8bit/bitwarden/data/platform/manager/event/OrganizationEventManagerTest.kt @@ -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),