Split module `session-storage` into `api` and `impl`.

app/build.gradle.kts

@@ -200,6 +200,7 @@ dependencies {
     allFeatures()
     implementation(projects.libraries.matrix.impl)
     implementation(projects.libraries.dateformatter.impl)
+    implementation(projects.libraries.sessionStorage.impl)
     implementation(projects.tests.uitests)
     implementation(projects.anvilannotations)
     anvil(projects.anvilcodegen)

libraries/matrix/api/build.gradle.kts

@@ -39,6 +39,6 @@ dependencies {
     implementation(projects.libraries.core)
     implementation("net.java.dev.jna:jna:5.13.0@aar")
     implementation(libs.serialization.json)
-    api(projects.libraries.sessionStorage)
+    api(projects.libraries.sessionStorage.api)
     implementation(libs.coroutines.core)
 }

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt

@@ -24,7 +24,7 @@ import io.element.android.libraries.matrix.impl.media.RustMediaResolver
 import io.element.android.libraries.matrix.impl.room.RustMatrixRoom
 import io.element.android.libraries.matrix.impl.room.RustRoomSummaryDataSource
 import io.element.android.libraries.matrix.impl.sync.SlidingSyncObserverProxy
-import io.element.android.libraries.sessionstorage.SessionStore
+import io.element.android.libraries.sessionstorage.api.SessionStore
 import io.element.android.libraries.matrix.api.media.MediaResolver
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.RoomSummaryDataSource

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/auth/RustMatrixAuthenticationService.kt

@@ -27,8 +27,8 @@ import io.element.android.libraries.matrix.api.core.SessionId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.impl.RustMatrixClient
 import io.element.android.libraries.matrix.impl.util.logError
-import io.element.android.libraries.matrix.session.SessionData
-import io.element.android.libraries.sessionstorage.SessionStore
+import io.element.android.libraries.sessionstorage.api.SessionData
+import io.element.android.libraries.sessionstorage.api.SessionStore
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow

libraries/session-storage/api/build.gradle.kts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.sessionstorage.api"
+}
+
+dependencies {
+    implementation(libs.coroutines.core)
+}

libraries/session-storage/api/src/main/kotlin/io/element/android/libraries/sessionstorage/api/SessionData.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.sessionstorage.api
+
+data class SessionData(
+    val userId: String,
+    val deviceId: String,
+    val accessToken: String,
+    val refreshToken: String?,
+    val homeserverUrl: String,
+    val isSoftLogout: Boolean,
+    val slidingSyncProxy: String?
+)

libraries/session-storage/api/src/main/kotlin/io/element/android/libraries/sessionstorage/api/SessionStore.kt

@@ -14,14 +14,13 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.sessionstorage
+package io.element.android.libraries.sessionstorage.api
 
-import io.element.android.libraries.matrix.session.SessionData
 import kotlinx.coroutines.flow.Flow
 
 interface SessionStore {
     fun isLoggedIn(): Flow<Boolean>
-    suspend fun storeData(session: SessionData)
+    suspend fun storeData(sessionData: SessionData)
     suspend fun getSession(sessionId: String): SessionData?
     suspend fun getLatestSession(): SessionData?
     suspend fun removeSession(sessionId: String)

libraries/session-storage/impl/build.gradle.kts

@@ -21,7 +21,7 @@ plugins {
 }
 
 android {
-    namespace = "io.element.android.libraries.sessionstorage"
+    namespace = "io.element.android.libraries.sessionstorage.impl"
 }
 
 anvil {
@@ -32,6 +32,7 @@ dependencies {
     implementation(libs.dagger)
     implementation(projects.libraries.core)
     implementation(projects.libraries.encryptedDb)
+    implementation(projects.libraries.sessionStorage.api)
     implementation(libs.sqldelight.driver.android)
     implementation(libs.sqlcipher)
     implementation(libs.sqlite)

libraries/session-storage/impl/src/main/kotlin/io/element/android/libraries/sessionstorage/impl/DatabaseSessionStore.kt

@@ -14,14 +14,15 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.sessionstorage
+package io.element.android.libraries.sessionstorage.impl
 
 import com.squareup.anvil.annotations.ContributesBinding
 import com.squareup.sqldelight.runtime.coroutines.asFlow
 import com.squareup.sqldelight.runtime.coroutines.mapToOneOrNull
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.SingleIn
-import io.element.android.libraries.matrix.session.SessionData
+import io.element.android.libraries.sessionstorage.api.SessionData
+import io.element.android.libraries.sessionstorage.api.SessionStore
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
 import javax.inject.Inject
@@ -37,17 +38,19 @@ class DatabaseSessionStore @Inject constructor(
     }
 
     override suspend fun storeData(sessionData: SessionData) {
-        database.sessionDataQueries.insertSessionData(sessionData)
+        database.sessionDataQueries.insertSessionData(sessionData.toDbModel())
     }
 
     override suspend fun getLatestSession(): SessionData? {
         return database.sessionDataQueries.selectFirst()
             .executeAsOneOrNull()
+            ?.toApiModel()
     }
 
     override suspend fun getSession(sessionId: String): SessionData? {
         return database.sessionDataQueries.selectByUserId(sessionId)
             .executeAsOneOrNull()
+            ?.toApiModel()
     }
 
     override suspend fun removeSession(sessionId: String) {

libraries/session-storage/impl/src/main/kotlin/io/element/android/libraries/sessionstorage/impl/SessionDataMapper.kt

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.sessionstorage.impl
+
+import io.element.android.libraries.sessionstorage.api.SessionData
+
+internal fun SessionData.toDbModel(): io.element.android.libraries.matrix.session.SessionData {
+    return io.element.android.libraries.matrix.session.SessionData(
+        userId = userId,
+        deviceId = deviceId,
+        accessToken = accessToken,
+        refreshToken = refreshToken,
+        homeserverUrl = homeserverUrl,
+        isSoftLogout = isSoftLogout,
+        slidingSyncProxy = slidingSyncProxy,
+    )
+}
+
+internal fun io.element.android.libraries.matrix.session.SessionData.toApiModel(): SessionData {
+    return SessionData(
+        userId = userId,
+        deviceId = deviceId,
+        accessToken = accessToken,
+        refreshToken = refreshToken,
+        homeserverUrl = homeserverUrl,
+        isSoftLogout = isSoftLogout,
+        slidingSyncProxy = slidingSyncProxy,
+    )
+}

libraries/session-storage/impl/src/main/kotlin/io/element/android/libraries/sessionstorage/impl/di/SessionStorageModule.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.sessionstorage.di
+package io.element.android.libraries.sessionstorage.impl.di
 
 import android.content.Context
 import com.squareup.anvil.annotations.ContributesTo
@@ -23,7 +23,7 @@ import dagger.Provides
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.di.SingleIn
-import io.element.android.libraries.sessionstorage.SessionDatabase
+import io.element.android.libraries.sessionstorage.impl.SessionDatabase
 import io.element.encrypteddb.SqlCipherDriverFactory
 import io.element.encrypteddb.passphrase.RandomSecretPassphraseProvider
 

libraries/session-storage/impl/src/test/kotlin/io/element/android/libraries/sessionstorage/impl/DatabaseSessionStoreTests.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.element.android.libraries.sessionstorage
+package io.element.android.libraries.sessionstorage.impl
 
 import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
@@ -55,7 +55,7 @@ class DatabaseSessionStoreTests {
     fun `storeData persists the SessionData into the DB`() = runTest {
         assertThat(database.sessionDataQueries.selectFirst().executeAsOneOrNull()).isNull()
 
-        databaseSessionStore.storeData(aSessionData)
+        databaseSessionStore.storeData(aSessionData.toApiModel())
 
         assertThat(database.sessionDataQueries.selectFirst().executeAsOneOrNull()).isEqualTo(aSessionData)
     }
@@ -76,7 +76,7 @@ class DatabaseSessionStoreTests {
         database.sessionDataQueries.insertSessionData(aSessionData)
         database.sessionDataQueries.insertSessionData(aSessionData.copy(userId = "otherUserId"))
 
-        val latestSession = databaseSessionStore.getLatestSession()
+        val latestSession = databaseSessionStore.getLatestSession()?.toDbModel()
 
         assertThat(latestSession).isEqualTo(aSessionData)
     }
@@ -86,7 +86,7 @@ class DatabaseSessionStoreTests {
         database.sessionDataQueries.insertSessionData(aSessionData)
         database.sessionDataQueries.insertSessionData(aSessionData.copy(userId = "otherUserId"))
 
-        val foundSession = databaseSessionStore.getSession(aSessionData.userId)
+        val foundSession = databaseSessionStore.getSession(aSessionData.userId)?.toDbModel()
 
         assertThat(foundSession).isEqualTo(aSessionData)
     }

samples/minimal/src/main/kotlin/io/element/android/samples/minimal/InMemorySessionStore.kt

@@ -16,35 +16,35 @@
 
 package io.element.android.samples.minimal
 
-import io.element.android.libraries.matrix.session.SessionData
-import io.element.android.libraries.sessionstorage.SessionStore
+import io.element.android.libraries.sessionstorage.api.SessionData
+import io.element.android.libraries.sessionstorage.api.SessionStore
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.map
 
 class InMemorySessionStore : SessionStore {
 
-    private var sessionData = MutableStateFlow<SessionData?>(null)
+    private var sessionDataFlow = MutableStateFlow<SessionData?>(null)
 
     override fun isLoggedIn(): Flow<Boolean> {
-        return sessionData.map { it != null }
+        return sessionDataFlow.map { it != null }
     }
 
-    override suspend fun storeData(session: SessionData) {
-        sessionData.value = session
+    override suspend fun storeData(sessionData: SessionData) {
+        sessionDataFlow.value = sessionData
     }
 
     override suspend fun getSession(sessionId: String): SessionData? {
-        return sessionData.value.takeIf { it?.userId == sessionId }
+        return sessionDataFlow.value.takeIf { it?.userId == sessionId }
     }
 
     override suspend fun getLatestSession(): SessionData? {
-        return sessionData.value
+        return sessionDataFlow.value
     }
 
     override suspend fun removeSession(sessionId: String) {
-        if (sessionData.value?.userId == sessionId) {
-            sessionData.value = null
+        if (sessionDataFlow.value?.userId == sessionId) {
+            sessionDataFlow.value = null
         }
     }
 }

settings.gradle.kts

@@ -67,4 +67,5 @@ include(":features:template")
 include(":libraries:androidutils")
 include(":samples:minimal")
 include(":libraries:encrypted-db")
-include(":libraries:session-storage")
+include(":libraries:session-storage:api")
+include(":libraries:session-storage:impl")