Improve AEI capture code quality #1694
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,35 +4,30 @@ import android.app.ActivityManager | |
| import android.app.ApplicationExitInfo | ||
| import android.os.Build.VERSION_CODES | ||
| import androidx.annotation.RequiresApi | ||
| import io.embrace.android.embracesdk.Severity.INFO | ||
| import io.embrace.android.embracesdk.internal.arch.datasource.LogDataSourceImpl | ||
| import io.embrace.android.embracesdk.internal.arch.datasource.NoInputValidation | ||
| import io.embrace.android.embracesdk.internal.arch.destination.LogWriter | ||
| import io.embrace.android.embracesdk.internal.arch.limits.UpToLimitStrategy | ||
| import io.embrace.android.embracesdk.internal.arch.schema.SchemaType.AeiLog | ||
| import io.embrace.android.embracesdk.internal.config.behavior.AppExitInfoBehavior | ||
| import io.embrace.android.embracesdk.internal.logging.EmbLogger | ||
| import io.embrace.android.embracesdk.internal.logging.InternalErrorType | ||
| import io.embrace.android.embracesdk.internal.prefs.PreferencesService | ||
| import io.embrace.android.embracesdk.internal.spans.toOtelSeverity | ||
| import io.embrace.android.embracesdk.internal.utils.BuildVersionChecker | ||
| import io.embrace.android.embracesdk.internal.utils.VersionChecker | ||
| import io.embrace.android.embracesdk.internal.worker.BackgroundWorker | ||
|
|
||
| @RequiresApi(VERSION_CODES.R) | ||
| internal class AeiDataSourceImpl( | ||
| private val backgroundWorker: BackgroundWorker, | ||
| private val appExitInfoBehavior: AppExitInfoBehavior, | ||
| private val activityManager: ActivityManager, | ||
| private val preferencesService: PreferencesService, | ||
| logWriter: LogWriter, | ||
| private val logger: EmbLogger, | ||
| private val versionChecker: VersionChecker = BuildVersionChecker, | ||
| ) : AeiDataSource, LogDataSourceImpl( | ||
| logWriter, | ||
| logger, | ||
|
|
@@ -43,193 +38,42 @@ internal class AeiDataSourceImpl( | |
| private const val SDK_AEI_SEND_LIMIT = 32 | ||
| } | ||
|
|
||
| override fun enableDataCapture() { | ||
| backgroundWorker.submit { | ||
| try { | ||
| processAeiRecords() | ||
| } catch (exc: Throwable) { | ||
| logger.trackInternalError(InternalErrorType.ENABLE_DATA_CAPTURE, exc) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun processAeiRecords() { | ||
| val maxNum = appExitInfoBehavior.appExitInfoMaxNum() | ||
| val records = activityManager.getHistoricalProcessExitReasons(null, 0, maxNum).take(SDK_AEI_SEND_LIMIT) | ||
| val unsentRecords = getUnsentRecords(records) | ||
|
|
||
| unsentRecords.forEach { | ||
| val obj = it.constructAeiObject(versionChecker, appExitInfoBehavior.getTraceMaxLimit()) ?: return@forEach | ||
| captureData( | ||
| inputValidation = NoInputValidation, | ||
| captureAction = { | ||
| val schemaType = AeiLog(obj) | ||
| addLog(schemaType, INFO.toOtelSeverity(), obj.trace ?: "") | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Calculates what AEI records have been sent by subtracting a collection of IDs that have been previously | ||
| * sent from the return value of getHistoricalProcessExitReasons. | ||
| */ | ||
| private fun getUnsentRecords(records: List<ApplicationExitInfo>): List<ApplicationExitInfo> { | ||
| val deliveredIds = preferencesService.deliveredAeiIds | ||
| preferencesService.deliveredAeiIds = records.map { it.getAeiId() }.toSet() | ||
|
There was a problem hiding this comment. Is there a mechanism to cap the growth of this list? There was a problem hiding this comment. Yes - we rely on the android framework's in-built limit: https://cs.android.com/android/platform/superproject/main/+/main:frameworks/base/core/res/res/values/config.xml;l=5853?q=config_app_exit_info_history_list_size |
||
| return records.filter { !deliveredIds.contains(it.getAeiId()) } | ||
| } | ||
|
|
||
| private fun ApplicationExitInfo.getAeiId(): String = "${timestamp}_$pid" | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package io.embrace.android.embracesdk.internal.capture.aei | ||
|
|
||
| import android.app.ApplicationExitInfo | ||
| import android.os.Build.VERSION_CODES | ||
| import androidx.annotation.RequiresApi | ||
| import io.embrace.android.embracesdk.internal.capture.aei.TraceResult.Failure | ||
| import io.embrace.android.embracesdk.internal.capture.aei.TraceResult.Success | ||
| import io.embrace.android.embracesdk.internal.payload.AppExitInfoData | ||
| import io.embrace.android.embracesdk.internal.utils.VersionChecker | ||
| import io.embrace.android.embracesdk.internal.utils.toUTF8String | ||
| import java.io.IOException | ||
| import java.util.regex.Pattern | ||
|
|
||
| private val SESSION_ID_PATTERN by lazy { Pattern.compile("^[0-9a-fA-F]{32}\$").toRegex() } | ||
|
|
||
| /** | ||
| * Constructs an [AppExitInfoData] object from an [ApplicationExitInfo] object. The trace | ||
| * will be truncated if it is above a certain character limit. If no trace is present, this function | ||
| * will return null as we don't wish to capture this data right now. | ||
| */ | ||
| @RequiresApi(VERSION_CODES.R) | ||
| internal fun ApplicationExitInfo.constructAeiObject( | ||
| versionChecker: VersionChecker, | ||
| charLimit: Int, | ||
| ): AppExitInfoData? { | ||
| val result = readAeiTrace(versionChecker, charLimit) ?: return null | ||
| val sessionId = String(processStateSummary ?: ByteArray(0)) | ||
|
|
||
| return AppExitInfoData( | ||
| sessionId = sessionId, | ||
| sessionIdError = getSessionIdValidationError(sessionId), | ||
| importance = importance, | ||
| pss = pss, | ||
| reason = reason, | ||
| rss = rss, | ||
| status = status, | ||
| timestamp = timestamp, | ||
| trace = result.trace, | ||
| description = description, | ||
| traceStatus = result.errMsg, | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Reads an AEI trace as a string and attempts to sanitize/handle exceptions + edge cases. | ||
| */ | ||
| @RequiresApi(VERSION_CODES.R) | ||
| private fun ApplicationExitInfo.readAeiTrace( | ||
| versionChecker: VersionChecker, | ||
| charLimit: Int, | ||
| ): TraceResult? { | ||
| return try { | ||
| val trace = readTraceAsString(versionChecker) ?: return null | ||
|
|
||
| when { | ||
| trace.length > charLimit -> Success(trace.take(charLimit), "Trace was too large, sending truncated trace") | ||
| else -> Success(trace) | ||
| } | ||
| } catch (e: IOException) { | ||
| Failure("ioexception: ${e.message}") | ||
| } catch (e: OutOfMemoryError) { | ||
| Failure("oom: ${e.message}") | ||
| } catch (tr: Throwable) { | ||
| Failure("error: ${tr.message}") | ||
| } | ||
| } | ||
|
|
||
| @RequiresApi(VERSION_CODES.R) | ||
| private fun ApplicationExitInfo.readTraceAsString(versionChecker: VersionChecker): String? { | ||
| return if (isNdkProtobufFile(versionChecker)) { | ||
| val bytes = traceInputStream?.buffered()?.readBytes() ?: return null | ||
| bytes.toUTF8String() | ||
| } else { | ||
| traceInputStream?.bufferedReader()?.readText() | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * NDK protobuf files are only available on Android 12 and above for AEI with | ||
| * the REASON_CRASH_NATIVE reason. | ||
| */ | ||
| private fun ApplicationExitInfo.isNdkProtobufFile(versionChecker: VersionChecker): Boolean { | ||
| return versionChecker.isAtLeast(VERSION_CODES.S) && reason == ApplicationExitInfo.REASON_CRASH_NATIVE | ||
| } | ||
|
|
||
| private fun getSessionIdValidationError(sid: String): String = when { | ||
| sid.isEmpty() || sid.matches(SESSION_ID_PATTERN) -> "" | ||
| else -> "invalid session ID: $sid" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| package io.embrace.android.embracesdk.internal.capture.aei | ||
|
|
||
| internal sealed class TraceResult(val trace: String?, val errMsg: String?) { | ||
| class Success(result: String?, errMsg: String? = null) : TraceResult(result, errMsg) | ||
| class Failure(message: String?) : TraceResult(null, message) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that we will be dealing with all exists now rather than just those with blobs, is the limit we are setting still reasonable? Or will you tackle that when we actually implement that feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That will be tackled when we implement the feature. I haven't made any functional changes as part of this refactor.