filippodb
/
SchildiChat-android
mirror of https://github.com/SchildiChat/SchildiChat-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve SDK API (self review)

This commit is contained in:
Benoit Marty 2022-01-24 22:37:07 +01:00
parent f6d856d828
commit cf86fe34d5
4 changed files with 60 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/statistics/StatisticEvent.kt
View File

@ -21,17 +21,17 @@ package org.matrix.android.sdk.api.session.statistics
*/
sealed interface StatisticEvent {
/**
* Initial sync request and response downloading, not including parsing and storage of response
* Initial sync request, response downloading, and treatment (parsing and storage) of response
*/
data class InitialSyncRequest(val durationMs: Int, val nbOfRooms: Int) : StatisticEvent
/**
* Initial sync treatment: parsing and storage of response
*/
data class InitialSyncTreatment(val durationMs: Int, val nbOfRooms: Int) : StatisticEvent
data class InitialSyncRequest(val requestDurationMs: Int,
val downloadDurationMs: Int,
val treatmentDurationMs: Int,
val nbOfJoinedRooms: Int) : StatisticEvent
/**
* Incremental sync event
*/
data class SyncTreatment(val durationMs: Int, val afterPause: Boolean, val nbOfRooms: Int) : StatisticEvent
data class SyncTreatment(val durationMs: Int,
val afterPause: Boolean,
val nbOfJoinedRooms: Int) : StatisticEvent
}

49
matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/sync/SyncTask.kt
View File

@ -121,8 +121,7 @@ internal class DefaultSyncTask @Inject constructor(
if (initSyncStrategy is InitialSyncStrategy.Optimized) {
roomSyncEphemeralTemporaryStore.reset()
workingDir.mkdirs()
val file = downloadInitSyncResponse(requestParams)
syncStatisticsData.intermediateTime = SystemClock.elapsedRealtime()
val file = downloadInitSyncResponse(requestParams, syncStatisticsData)
syncResponseToReturn = reportSubtask(defaultSyncStatusService, InitSyncStep.ImportingAccount, 1, 0.7F) {
handleSyncFile(file, initSyncStrategy)
}
@ -137,7 +136,9 @@ internal class DefaultSyncTask @Inject constructor(
)
}
}
syncStatisticsData.intermediateTime = SystemClock.elapsedRealtime()
// We cannot distinguish request and download in this case.
syncStatisticsData.requestInitSyncTime = SystemClock.elapsedRealtime()
syncStatisticsData.downloadInitSyncTime = syncStatisticsData.requestInitSyncTime
logDuration("INIT_SYNC Database insertion", loggerTag) {
syncResponseHandler.handleResponse(syncResponse, token, defaultSyncStatusService)
}
@ -172,6 +173,7 @@ internal class DefaultSyncTask @Inject constructor(
Timber.tag(loggerTag.value).d("Incremental sync done")
defaultSyncStatusService.setStatus(SyncStatusService.Status.IncrementalSyncDone)
}
syncStatisticsData.treatmentSyncTime = SystemClock.elapsedRealtime()
syncStatisticsData.nbOfRooms = syncResponseToReturn?.rooms?.join?.size ?: 0
sendStatistics(syncStatisticsData)
Timber.tag(loggerTag.value).d("Sync task finished on Thread: ${Thread.currentThread().name}")
@ -179,7 +181,7 @@ internal class DefaultSyncTask @Inject constructor(
return syncResponseToReturn!!
}
private suspend fun downloadInitSyncResponse(requestParams: Map<String, String>): File {
private suspend fun downloadInitSyncResponse(requestParams: Map<String, String>, syncStatisticsData: SyncStatisticsData): File {
val workingFile = File(workingDir, "initSync.json")
val status = initialSyncStatusRepository.getStep()
if (workingFile.exists() && status >= InitialSyncStatus.STEP_DOWNLOADED) {
@ -194,7 +196,7 @@ internal class DefaultSyncTask @Inject constructor(
getSyncResponse(requestParams, MAX_NUMBER_OF_RETRY_AFTER_TIMEOUT)
}
}
syncStatisticsData.requestInitSyncTime = SystemClock.elapsedRealtime()
if (syncResponse.isSuccessful) {
logDuration("INIT_SYNC Download and save to file", loggerTag) {
reportSubtask(defaultSyncStatusService, InitSyncStep.Downloading, 1, 0.1f) {
@ -205,6 +207,7 @@ internal class DefaultSyncTask @Inject constructor(
}
}
}
syncStatisticsData.downloadInitSyncTime = SystemClock.elapsedRealtime()
} else {
throw syncResponse.toFailure(globalErrorReceiver)
.also { Timber.tag(loggerTag.value).w("INIT_SYNC request failure: $this") }
@ -260,27 +263,29 @@ internal class DefaultSyncTask @Inject constructor(
val isAfterPause: Boolean
) {
val startTime = SystemClock.elapsedRealtime()
var intermediateTime: Long = 0
var requestInitSyncTime = startTime
var downloadInitSyncTime = startTime
var treatmentSyncTime = startTime
var nbOfRooms: Int = 0
}
private fun sendStatistics(data: SyncStatisticsData) {
if (data.isInitSync) {
sendStatisticEvent(StatisticEvent.InitialSyncRequest(
durationMs = (data.intermediateTime - data.startTime).toInt(),
nbOfRooms = data.nbOfRooms
))
sendStatisticEvent(StatisticEvent.InitialSyncTreatment(
durationMs = (SystemClock.elapsedRealtime() - data.intermediateTime).toInt(),
nbOfRooms = data.nbOfRooms
))
} else {
sendStatisticEvent(StatisticEvent.SyncTreatment(
durationMs = (SystemClock.elapsedRealtime() - data.startTime).toInt(),
afterPause = data.isAfterPause,
nbOfRooms = data.nbOfRooms
))
}
sendStatisticEvent(
if (data.isInitSync) {
(StatisticEvent.InitialSyncRequest(
requestDurationMs = (data.requestInitSyncTime - data.startTime).toInt(),
downloadDurationMs = (data.downloadInitSyncTime - data.requestInitSyncTime).toInt(),
treatmentDurationMs = (data.treatmentSyncTime - data.downloadInitSyncTime).toInt(),
nbOfJoinedRooms = data.nbOfRooms,
))
} else {
StatisticEvent.SyncTreatment(
durationMs = (data.treatmentSyncTime - data.startTime).toInt(),
afterPause = data.isAfterPause,
nbOfJoinedRooms = data.nbOfRooms
)
}
)
}
private fun sendStatisticEvent(statisticEvent: StatisticEvent) {

39
vector/src/main/java/im/vector/app/features/analytics/extensions/PerformanceTimerExt.kt
View File

@ -19,30 +19,33 @@ package im.vector.app.features.analytics.extensions
import im.vector.app.features.analytics.plan.PerformanceTimer
import org.matrix.android.sdk.api.session.statistics.StatisticEvent
fun StatisticEvent.toPerformanceTimer(): PerformanceTimer? {
fun StatisticEvent.toListOfPerformanceTimer(): List<PerformanceTimer> {
return when (this) {
is StatisticEvent.InitialSyncRequest ->
PerformanceTimer(
name = PerformanceTimer.Name.InitialSyncRequest,
timeMs = durationMs,
itemCount = nbOfRooms
is StatisticEvent.InitialSyncRequest ->
listOf(
PerformanceTimer(
name = PerformanceTimer.Name.InitialSyncRequest,
timeMs = requestDurationMs + downloadDurationMs,
itemCount = nbOfJoinedRooms
),
PerformanceTimer(
name = PerformanceTimer.Name.InitialSyncParsing,
timeMs = treatmentDurationMs,
itemCount = nbOfJoinedRooms
)
)
is StatisticEvent.InitialSyncTreatment ->
PerformanceTimer(
name = PerformanceTimer.Name.InitialSyncParsing,
timeMs = durationMs,
itemCount = nbOfRooms
)
is StatisticEvent.SyncTreatment ->
is StatisticEvent.SyncTreatment ->
if (afterPause) {
PerformanceTimer(
name = PerformanceTimer.Name.StartupIncrementalSync,
timeMs = durationMs,
itemCount = nbOfRooms
listOf(
PerformanceTimer(
name = PerformanceTimer.Name.StartupIncrementalSync,
timeMs = durationMs,
itemCount = nbOfJoinedRooms
)
)
} else {
// We do not report
null
emptyList()
}
}
}

6
vector/src/main/java/im/vector/app/features/session/SessionListener.kt
View File

@ -21,7 +21,7 @@ import androidx.lifecycle.MutableLiveData
import im.vector.app.core.extensions.postLiveEvent
import im.vector.app.core.utils.LiveEvent
import im.vector.app.features.analytics.AnalyticsTracker
import im.vector.app.features.analytics.extensions.toPerformanceTimer
import im.vector.app.features.analytics.extensions.toListOfPerformanceTimer
import im.vector.app.features.call.vectorCallService
import kotlinx.coroutines.cancelChildren
import kotlinx.coroutines.launch
@ -51,7 +51,9 @@ class SessionListener @Inject constructor(
}
override fun onStatisticsEvent(session: Session, statisticEvent: StatisticEvent) {
statisticEvent.toPerformanceTimer()?.let { analyticsTracker.capture(it) }
statisticEvent.toListOfPerformanceTimer().forEach {
analyticsTracker.capture(it)
}
}
override fun onSessionStopped(session: Session) {