Cannot create a logger like that. The tag will be lost.

This commit is contained in:
Benoit Marty 2024-12-11 12:15:27 +01:00 committed by Benoit Marty
parent a55a493060
commit 7819c3fabf

View file

@ -8,12 +8,12 @@
package io.element.android.libraries.matrix.impl package io.element.android.libraries.matrix.impl
import io.element.android.libraries.core.coroutine.CoroutineDispatchers import io.element.android.libraries.core.coroutine.CoroutineDispatchers
import io.element.android.libraries.core.log.logger.LoggerTag
import io.element.android.libraries.matrix.impl.mapper.toSessionData import io.element.android.libraries.matrix.impl.mapper.toSessionData
import io.element.android.libraries.matrix.impl.paths.getSessionPaths import io.element.android.libraries.matrix.impl.paths.getSessionPaths
import io.element.android.libraries.matrix.impl.util.anonymizedTokens import io.element.android.libraries.matrix.impl.util.anonymizedTokens
import io.element.android.libraries.sessionstorage.api.SessionStore import io.element.android.libraries.sessionstorage.api.SessionStore
import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.launch import kotlinx.coroutines.launch
import org.matrix.rustcomponents.sdk.ClientDelegate import org.matrix.rustcomponents.sdk.ClientDelegate
import org.matrix.rustcomponents.sdk.ClientSessionDelegate import org.matrix.rustcomponents.sdk.ClientSessionDelegate
@ -22,6 +22,8 @@ import timber.log.Timber
import java.lang.ref.WeakReference import java.lang.ref.WeakReference
import java.util.concurrent.atomic.AtomicBoolean import java.util.concurrent.atomic.AtomicBoolean
private val loggerTag = LoggerTag("RustClientSessionDelegate")
/** /**
* This class is responsible for handling the session data for the Rust SDK. * This class is responsible for handling the session data for the Rust SDK.
* *
@ -29,14 +31,11 @@ import java.util.concurrent.atomic.AtomicBoolean
* *
* IMPORTANT: you must set the [client] property as soon as possible so [didReceiveAuthError] can work properly. * IMPORTANT: you must set the [client] property as soon as possible so [didReceiveAuthError] can work properly.
*/ */
@OptIn(ExperimentalCoroutinesApi::class)
class RustClientSessionDelegate( class RustClientSessionDelegate(
private val sessionStore: SessionStore, private val sessionStore: SessionStore,
private val appCoroutineScope: CoroutineScope, private val appCoroutineScope: CoroutineScope,
coroutineDispatchers: CoroutineDispatchers, coroutineDispatchers: CoroutineDispatchers,
) : ClientSessionDelegate, ClientDelegate { ) : ClientSessionDelegate, ClientDelegate {
private val clientLog = Timber.tag("$this")
// Used to ensure several calls to `didReceiveAuthError` don't trigger multiple logouts // Used to ensure several calls to `didReceiveAuthError` don't trigger multiple logouts
private val isLoggingOut = AtomicBoolean(false) private val isLoggingOut = AtomicBoolean(false)
@ -64,7 +63,7 @@ class RustClientSessionDelegate(
appCoroutineScope.launch(updateTokensDispatcher) { appCoroutineScope.launch(updateTokensDispatcher) {
val existingData = sessionStore.getSession(session.userId) ?: return@launch val existingData = sessionStore.getSession(session.userId) ?: return@launch
val (anonymizedAccessToken, anonymizedRefreshToken) = session.anonymizedTokens() val (anonymizedAccessToken, anonymizedRefreshToken) = session.anonymizedTokens()
clientLog.d( Timber.tag(loggerTag.value).d(
"Saving new session data with token: access token '$anonymizedAccessToken' and refresh token '$anonymizedRefreshToken'. " + "Saving new session data with token: access token '$anonymizedAccessToken' and refresh token '$anonymizedRefreshToken'. " +
"Was token valid: ${existingData.isTokenValid}" "Was token valid: ${existingData.isTokenValid}"
) )
@ -75,29 +74,29 @@ class RustClientSessionDelegate(
sessionPaths = existingData.getSessionPaths(), sessionPaths = existingData.getSessionPaths(),
) )
sessionStore.updateData(newData) sessionStore.updateData(newData)
clientLog.d("Saved new session data with access token: '$anonymizedAccessToken'.") Timber.tag(loggerTag.value).d("Saved new session data with access token: '$anonymizedAccessToken'.")
}.invokeOnCompletion { }.invokeOnCompletion {
if (it != null) { if (it != null) {
clientLog.e(it, "Failed to save new session data.") Timber.tag(loggerTag.value).e(it, "Failed to save new session data.")
} }
} }
} }
override fun didReceiveAuthError(isSoftLogout: Boolean) { override fun didReceiveAuthError(isSoftLogout: Boolean) {
clientLog.w("didReceiveAuthError(isSoftLogout=$isSoftLogout)") Timber.tag(loggerTag.value).w("didReceiveAuthError(isSoftLogout=$isSoftLogout)")
if (isLoggingOut.getAndSet(true).not()) { if (isLoggingOut.getAndSet(true).not()) {
clientLog.v("didReceiveAuthError -> do the cleanup") Timber.tag(loggerTag.value).v("didReceiveAuthError -> do the cleanup")
// TODO handle isSoftLogout parameter. // TODO handle isSoftLogout parameter.
appCoroutineScope.launch(updateTokensDispatcher) { appCoroutineScope.launch(updateTokensDispatcher) {
val currentClient = client.get() val currentClient = client.get()
if (currentClient == null) { if (currentClient == null) {
clientLog.w("didReceiveAuthError -> no client, exiting") Timber.tag(loggerTag.value).w("didReceiveAuthError -> no client, exiting")
isLoggingOut.set(false) isLoggingOut.set(false)
return@launch return@launch
} }
val existingData = sessionStore.getSession(currentClient.sessionId.value) val existingData = sessionStore.getSession(currentClient.sessionId.value)
val (anonymizedAccessToken, anonymizedRefreshToken) = existingData.anonymizedTokens() val (anonymizedAccessToken, anonymizedRefreshToken) = existingData.anonymizedTokens()
clientLog.d( Timber.tag(loggerTag.value).d(
"Removing session data with access token '$anonymizedAccessToken' " + "Removing session data with access token '$anonymizedAccessToken' " +
"and refresh token '$anonymizedRefreshToken'." "and refresh token '$anonymizedRefreshToken'."
) )
@ -105,18 +104,18 @@ class RustClientSessionDelegate(
// Set isTokenValid to false // Set isTokenValid to false
val newData = existingData.copy(isTokenValid = false) val newData = existingData.copy(isTokenValid = false)
sessionStore.updateData(newData) sessionStore.updateData(newData)
clientLog.d("Invalidated session data with access token: '$anonymizedAccessToken'.") Timber.tag(loggerTag.value).d("Invalidated session data with access token: '$anonymizedAccessToken'.")
} else { } else {
clientLog.d("No session data found.") Timber.tag(loggerTag.value).d("No session data found.")
} }
currentClient.logout(userInitiated = false, ignoreSdkError = true) currentClient.logout(userInitiated = false, ignoreSdkError = true)
}.invokeOnCompletion { }.invokeOnCompletion {
if (it != null) { if (it != null) {
clientLog.e(it, "Failed to remove session data.") Timber.tag(loggerTag.value).e(it, "Failed to remove session data.")
} }
} }
} else { } else {
clientLog.v("didReceiveAuthError -> already cleaning up") Timber.tag(loggerTag.value).v("didReceiveAuthError -> already cleaning up")
} }
} }