refactor: move init module to core

embrace-io · Jul 29, 2024 · 2f37751 · 2f37751
1 parent d0d514c
commit 2f37751
Show file tree

Hide file tree

Showing 60 changed files with 229 additions and 276 deletions.
diff --git a/...ndroid/embracesdk/internal/IdGenerator.kt → ...ndroid/embracesdk/internal/IdGenerator.kt b/...ndroid/embracesdk/internal/IdGenerator.kt → ...ndroid/embracesdk/internal/IdGenerator.kt
@@ -4,18 +4,18 @@ import io.opentelemetry.api.trace.SpanId
 import io.opentelemetry.api.trace.TraceId
 import kotlin.random.Random
 
-internal class IdGenerator(
+public class IdGenerator(
     private val random: Random = Random.Default
 ) {
     /**
      * Generate a valid W3C-compliant traceparent. See the format here: https://www.w3.org/TR/trace-context/#traceparent-header-field-values
      *
      * Note: because Embrace may be recording a span on our side for the given traceparent, we have set the "sampled" flag to indicate that.
      */
-    fun generateTraceparent(): String =
+    public fun generateTraceparent(): String =
         "00-" + TraceId.fromLongs(validRandomLong(), validRandomLong()) + "-" + SpanId.fromLong(validRandomLong()) + "-01"
 
-    fun generateUUID(): String = SpanId.fromLong(validRandomLong())
+    public fun generateUUID(): String = SpanId.fromLong(validRandomLong())
 
     private fun validRandomLong(): Long {
         var value: Long
@@ -25,12 +25,12 @@ internal class IdGenerator(
         return value
     }
 
-    companion object {
+    public companion object {
         private val INSTANCE = IdGenerator()
 
         @JvmStatic
-        fun generateW3CTraceparent() = INSTANCE.generateTraceparent()
+        public fun generateW3CTraceparent(): String = INSTANCE.generateTraceparent()
 
-        fun generateLaunchInstanceId() = INSTANCE.generateUUID()
+        public fun generateLaunchInstanceId(): String = INSTANCE.generateUUID()
     }
 }
diff --git a/...android/embracesdk/internal/SystemInfo.kt → ...android/embracesdk/internal/SystemInfo.kt b/...android/embracesdk/internal/SystemInfo.kt → ...android/embracesdk/internal/SystemInfo.kt
@@ -5,7 +5,7 @@ import android.os.Build
 /**
  * Information about the the device or OS that can be retrieved without disk or platform API access
  */
-internal data class SystemInfo(
+public data class SystemInfo(
     /**
      * Name of the operating system of the device. To use the Android SDK, this has to be Android, so this is always "android"
      */
@@ -81,3 +81,21 @@ internal fun getDeviceModel(): String {
         ""
     }
 }
+
+/**
+ * Tries to determine whether the device is an emulator by looking for known models and
+ * manufacturers which correspond to emulators.
+ *
+ * @return true if the device is detected to be an emulator, false otherwise
+ */
+public fun SystemInfo.isEmulator(): Boolean =
+    Build.FINGERPRINT.startsWith("generic") ||
+        Build.FINGERPRINT.startsWith("unknown") ||
+        Build.FINGERPRINT.contains("emulator") ||
+        deviceModel.contains("google_sdk") ||
+        deviceModel.contains("sdk_gphone64") ||
+        deviceModel.contains("Emulator") ||
+        deviceModel.contains("Android SDK built for") ||
+        deviceManufacturer.contains("Genymotion") ||
+        Build.BRAND.startsWith("generic") && Build.DEVICE.startsWith("generic") ||
+        Build.PRODUCT.equals("google_sdk")
diff --git a/...internal/clock/NormalizedIntervalClock.kt → ...internal/clock/NormalizedIntervalClock.kt b/...internal/clock/NormalizedIntervalClock.kt → ...internal/clock/NormalizedIntervalClock.kt
@@ -7,7 +7,7 @@ package io.embrace.android.embracesdk.internal.clock
  * This is useful when it is necessary to perform interval timing but the results must be
  * sent to the API in a way that matches the device time.
  */
-internal class NormalizedIntervalClock(systemClock: SystemClock) : Clock {
+public class NormalizedIntervalClock(systemClock: SystemClock) : Clock {
     private val baseline: Long
 
     init {

diff --git a/.../embracesdk/internal/clock/SystemClock.kt → .../embracesdk/internal/clock/SystemClock.kt b/.../embracesdk/internal/clock/SystemClock.kt → .../embracesdk/internal/clock/SystemClock.kt
@@ -1,6 +1,6 @@
 package io.embrace.android.embracesdk.internal.clock
 
-internal class SystemClock : Clock {
+public class SystemClock : Clock {
     override fun now(): Long {
         return System.currentTimeMillis()
     }

diff --git a/...bracesdk/internal/injection/InitModule.kt → ...bracesdk/internal/injection/InitModule.kt b/...bracesdk/internal/injection/InitModule.kt → ...bracesdk/internal/injection/InitModule.kt
@@ -2,53 +2,48 @@ package io.embrace.android.embracesdk.internal.injection
 
 import io.embrace.android.embracesdk.internal.SystemInfo
 import io.embrace.android.embracesdk.internal.logging.EmbLogger
-import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
+import io.embrace.android.embracesdk.internal.serialization.PlatformSerializer
 import io.embrace.android.embracesdk.internal.telemetry.TelemetryService
 import io.embrace.android.embracesdk.internal.telemetry.errors.InternalErrorService
 
 /**
  * A module of components and services required at [EmbraceImpl] instantiation time, i.e. before the SDK evens starts
  */
-internal interface InitModule {
+public interface InitModule {
     /**
      * Clock instance locked to the time of creation used by the SDK throughout its lifetime
      */
-    val clock: io.embrace.android.embracesdk.internal.clock.Clock
-
-    /**
-     * OpenTelemetry SDK compatible clock based on [clock]
-     */
-    val openTelemetryClock: io.opentelemetry.sdk.common.Clock
+    public val clock: io.embrace.android.embracesdk.internal.clock.Clock
 
     /**
      * Service to track usage of public APIs and other internal metrics
      */
-    val telemetryService: TelemetryService
+    public val telemetryService: TelemetryService
 
     /**
      * Logger used by the SDK
      */
-    val logger: EmbLogger
+    public val logger: EmbLogger
 
     /**
      * Info about the system available at startup time without expensive disk or API calls
      */
-    val systemInfo: SystemInfo
+    public val systemInfo: SystemInfo
 
     /**
      * Unique ID generated for an instance of the app process and not related to the actual process ID assigned by the OS.
      * This allows us to explicitly relate all the sessions associated with a particular app launch rather than having the backend figure
      * this out by proximity for stitched sessions.
      */
-    val processIdentifier: String
+    public val processIdentifier: String
 
     /**
      * Tracks internal errors
      */
-    val internalErrorService: InternalErrorService
+    public val internalErrorService: InternalErrorService
 
     /**
      * Returns the serializer used to serialize data to JSON
      */
-    val jsonSerializer: EmbraceSerializer
+    public val jsonSerializer: PlatformSerializer
 }
diff --git a/...esdk/internal/injection/InitModuleImpl.kt → ...esdk/internal/injection/InitModuleImpl.kt b/...esdk/internal/injection/InitModuleImpl.kt → ...esdk/internal/injection/InitModuleImpl.kt
@@ -1,24 +1,21 @@
 package io.embrace.android.embracesdk.internal.injection
 
 import io.embrace.android.embracesdk.internal.IdGenerator
-import io.embrace.android.embracesdk.internal.OpenTelemetryClock
 import io.embrace.android.embracesdk.internal.SystemInfo
 import io.embrace.android.embracesdk.internal.clock.NormalizedIntervalClock
 import io.embrace.android.embracesdk.internal.clock.SystemClock
 import io.embrace.android.embracesdk.internal.logging.EmbLogger
 import io.embrace.android.embracesdk.internal.logging.EmbLoggerImpl
 import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
+import io.embrace.android.embracesdk.internal.serialization.PlatformSerializer
 import io.embrace.android.embracesdk.internal.telemetry.EmbraceTelemetryService
 import io.embrace.android.embracesdk.internal.telemetry.TelemetryService
 import io.embrace.android.embracesdk.internal.telemetry.errors.EmbraceInternalErrorService
 import io.embrace.android.embracesdk.internal.telemetry.errors.InternalErrorService
 
-internal class InitModuleImpl(
+public class InitModuleImpl(
     override val clock: io.embrace.android.embracesdk.internal.clock.Clock =
         NormalizedIntervalClock(systemClock = SystemClock()),
-    override val openTelemetryClock: io.opentelemetry.sdk.common.Clock = OpenTelemetryClock(
-        embraceClock = clock
-    ),
     override val logger: EmbLogger = EmbLoggerImpl(),
     override val systemInfo: SystemInfo = SystemInfo()
 ) : InitModule {
@@ -37,7 +34,7 @@ internal class InitModuleImpl(
 
     override val processIdentifier: String = IdGenerator.generateLaunchInstanceId()
 
-    override val jsonSerializer: EmbraceSerializer by singleton {
+    override val jsonSerializer: PlatformSerializer by singleton {
         EmbraceSerializer()
     }
 }
diff --git a/...racesdk/internal/logging/EmbLoggerImpl.kt → ...racesdk/internal/logging/EmbLoggerImpl.kt b/...racesdk/internal/logging/EmbLoggerImpl.kt → ...racesdk/internal/logging/EmbLoggerImpl.kt
@@ -8,7 +8,7 @@ internal const val EMBRACE_TAG = "[Embrace]"
  * Implementation of [EmbLogger] that logs to Android logcat & also allows tracking of internal
  * errors for our telemetry.
  */
-internal class EmbLoggerImpl : EmbLogger {
+public class EmbLoggerImpl : EmbLogger {
 
     override var internalErrorService: InternalErrorHandler? = null
 

diff --git a/...e-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/EmbraceExt.kt b/...e-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/EmbraceExt.kt
@@ -1,11 +1,29 @@
 package io.embrace.android.embracesdk.internal.spans
 
+import io.opentelemetry.api.logs.Severity
+
 /**
  * Prefix added to OTel signal object names recorded by the SDK
  */
 private const val EMBRACE_OBJECT_NAME_PREFIX = "emb-"
 
+/**
+ * Prefix added to all attribute keys for all usage attributes added by the SDK
+ */
+private const val EMBRACE_USAGE_ATTRIBUTE_NAME_PREFIX = "emb.usage."
+
 /**
  * Return the appropriate name used for telemetry created by Embrace given the current value
  */
 public fun String.toEmbraceObjectName(): String = EMBRACE_OBJECT_NAME_PREFIX + this
+
+public fun io.embrace.android.embracesdk.Severity.toOtelSeverity(): Severity = when (this) {
+    io.embrace.android.embracesdk.Severity.INFO -> Severity.INFO
+    io.embrace.android.embracesdk.Severity.WARNING -> Severity.WARN
+    io.embrace.android.embracesdk.Severity.ERROR -> Severity.ERROR
+}
+
+/**
+ * Return the appropriate internal Embrace attribute usage name given the current string
+ */
+internal fun String.toEmbraceUsageAttributeName(): String = EMBRACE_USAGE_ATTRIBUTE_NAME_PREFIX + this
diff --git a/...rnal/telemetry/EmbraceTelemetryService.kt → ...rnal/telemetry/EmbraceTelemetryService.kt b/...rnal/telemetry/EmbraceTelemetryService.kt → ...rnal/telemetry/EmbraceTelemetryService.kt
@@ -2,14 +2,14 @@ package io.embrace.android.embracesdk.internal.telemetry
 
 import io.embrace.android.embracesdk.internal.SystemInfo
 import io.embrace.android.embracesdk.internal.arch.schema.toEmbraceAttributeName
-import io.embrace.android.embracesdk.internal.capture.envelope.resource.isEmulator
+import io.embrace.android.embracesdk.internal.isEmulator
 import io.embrace.android.embracesdk.internal.spans.toEmbraceUsageAttributeName
 import java.util.concurrent.ConcurrentHashMap
 
 /**
  * Service for tracking usage of public APIs, and different internal metrics about the app.
  */
-internal class EmbraceTelemetryService(
+public class EmbraceTelemetryService(
     private val systemInfo: SystemInfo
 ) : TelemetryService {
 
@@ -67,7 +67,7 @@ internal class EmbraceTelemetryService(
             runCatching { KotlinVersion.CURRENT.toString() }.getOrDefault("unknown")
 
         appAttributesMap["is_emulator".toEmbraceAttributeName()] =
-            runCatching { isEmulator(systemInfo).toString() }.getOrDefault("unknown")
+            runCatching { systemInfo.isEmulator().toString() }.getOrDefault("unknown")
 
         return appAttributesMap
     }

diff --git a/...ernal/telemetry/OkHttpReflectionFacade.kt → ...ernal/telemetry/OkHttpReflectionFacade.kt b/...ernal/telemetry/OkHttpReflectionFacade.kt → ...ernal/telemetry/OkHttpReflectionFacade.kt
diff --git a/...dk/internal/telemetry/TelemetryService.kt → ...dk/internal/telemetry/TelemetryService.kt b/...dk/internal/telemetry/TelemetryService.kt → ...dk/internal/telemetry/TelemetryService.kt
@@ -1,22 +1,22 @@
 package io.embrace.android.embracesdk.internal.telemetry
 
-internal interface TelemetryService {
+public interface TelemetryService {
 
     /**
      * Tracks the usage of a public API by name. We only track public APIs that are called when the SDK is initialized.
      * Name should be snake_case, e.g. "start_session".
      */
-    fun onPublicApiCalled(name: String)
+    public fun onPublicApiCalled(name: String)
 
     /**
      * Tracks the storage being used, in bytes. storageTelemetry is a map of storage telemetry names and their values in bytes,
      * such as: emb.storage.usage -> "1234"
      */
-    fun logStorageTelemetry(storageTelemetry: Map<String, String>)
+    public fun logStorageTelemetry(storageTelemetry: Map<String, String>)
 
     /**
      * Returns a map with every telemetry value. This is called when the session ends.
      * We clear the usage count map so we don't count the same usages in the next session.
      */
-    fun getAndClearTelemetryAttributes(): Map<String, String>
+    public fun getAndClearTelemetryAttributes(): Map<String, String>
 }
diff --git a/...try/errors/EmbraceInternalErrorService.kt → ...try/errors/EmbraceInternalErrorService.kt b/...try/errors/EmbraceInternalErrorService.kt → ...try/errors/EmbraceInternalErrorService.kt
diff --git a/...lemetry/errors/InternalErrorDataSource.kt → ...lemetry/errors/InternalErrorDataSource.kt b/...lemetry/errors/InternalErrorDataSource.kt → ...lemetry/errors/InternalErrorDataSource.kt
@@ -3,4 +3,4 @@ package io.embrace.android.embracesdk.internal.telemetry.errors
 import io.embrace.android.embracesdk.internal.arch.datasource.LogDataSource
 import io.embrace.android.embracesdk.internal.logging.InternalErrorHandler
 
-internal interface InternalErrorDataSource : LogDataSource, InternalErrorHandler
+public interface InternalErrorDataSource : LogDataSource, InternalErrorHandler
diff --git a/...try/errors/InternalErrorDataSourceImpl.kt → ...try/errors/InternalErrorDataSourceImpl.kt b/...try/errors/InternalErrorDataSourceImpl.kt → ...try/errors/InternalErrorDataSourceImpl.kt
@@ -12,7 +12,7 @@ import io.embrace.android.embracesdk.internal.spans.toOtelSeverity
 /**
  * Tracks internal errors & sends them as OTel logs.
  */
-internal class InternalErrorDataSourceImpl(
+public class InternalErrorDataSourceImpl(
     logWriter: LogWriter,
     logger: EmbLogger,
 ) : InternalErrorDataSource,

diff --git a/.../telemetry/errors/InternalErrorService.kt → .../telemetry/errors/InternalErrorService.kt b/.../telemetry/errors/InternalErrorService.kt → .../telemetry/errors/InternalErrorService.kt
@@ -7,6 +7,6 @@ import io.embrace.android.embracesdk.internal.utils.Provider
  * Reports an internal error to Embrace. An internal error is defined as an exception that was
  * caught within Embrace code & logged to [EmbLogger].
  */
-internal interface InternalErrorService : InternalErrorHandler {
-    var internalErrorDataSource: Provider<InternalErrorDataSource?>
+public interface InternalErrorService : InternalErrorHandler {
+    public var internalErrorDataSource: Provider<InternalErrorDataSource?>
 }
diff --git a/...rnal/serialization/AppFrameworkAdapter.kt → ...rnal/serialization/AppFrameworkAdapter.kt b/...rnal/serialization/AppFrameworkAdapter.kt → ...rnal/serialization/AppFrameworkAdapter.kt
@@ -4,10 +4,10 @@ import com.squareup.moshi.FromJson
 import com.squareup.moshi.ToJson
 import io.embrace.android.embracesdk.internal.payload.AppFramework
 
-internal class AppFrameworkAdapter {
+public class AppFrameworkAdapter {
     @ToJson
-    fun toJson(appFramework: AppFramework) = appFramework.value
+    public fun toJson(appFramework: AppFramework): Int = appFramework.value
 
     @FromJson
-    fun fromJson(value: Int) = AppFramework.fromInt(value)
+    public fun fromJson(value: Int): AppFramework? = AppFramework.fromInt(value)
 }
diff --git a/...ternal/serialization/EmbraceSerializer.kt → ...ternal/serialization/EmbraceSerializer.kt b/...ternal/serialization/EmbraceSerializer.kt → ...ternal/serialization/EmbraceSerializer.kt
@@ -1,7 +1,6 @@
 package io.embrace.android.embracesdk.internal.serialization
 
 import com.squareup.moshi.Moshi
-import io.embrace.android.embracesdk.internal.utils.threadLocal
 import okio.buffer
 import okio.sink
 import okio.source
@@ -12,15 +11,16 @@ import java.lang.reflect.Type
 /**
  * A wrapper around the JSON library to allow for thread-safe serialization.
  */
-internal class EmbraceSerializer : PlatformSerializer {
+public class EmbraceSerializer : PlatformSerializer {
 
-    private val impl by threadLocal {
-        Moshi.Builder()
-            .add(EmbraceUrlAdapter())
+    private val ref = object : ThreadLocal<Moshi>() {
+        override fun initialValue(): Moshi = Moshi.Builder()
             .add(AppFrameworkAdapter())
             .build()
     }
 
+    private val impl by lazy { checkNotNull(ref.get()) }
+
     override fun <T> toJson(src: T): String {
         val clz = checkNotNull(src)::class.java
         val adapter = impl.adapter<T>(clz)
@@ -74,9 +74,4 @@ internal class EmbraceSerializer : PlatformSerializer {
             adapter.fromJson(it) ?: error("JSON conversion failed.")
         }
     }
-
-    inline fun <reified T> fromJsonWithTypeToken(json: String): T {
-        val adapter = impl.adapter(T::class.java)
-        return adapter.fromJson(json) ?: error("JSON conversion failed.")
-    }
 }
diff --git a/...rc/main/kotlin/io/embrace/android/embracesdk/internal/serialization/PlatformSerializer.kt b/...rc/main/kotlin/io/embrace/android/embracesdk/internal/serialization/PlatformSerializer.kt
@@ -0,0 +1,27 @@
+package io.embrace.android.embracesdk.internal.serialization
+
+import java.io.InputStream
+import java.io.OutputStream
+import java.lang.reflect.Type
+
+/**
+ * Interface for JSON serializer wrapper than can then be wrapped for testing purposes
+ */
+public interface PlatformSerializer {
+    public fun <T> toJson(src: T): String
+    public fun <T> toJson(src: T, clz: Class<T>): String
+    public fun <T> toJson(src: T, type: Type): String
+    public fun <T> toJson(any: T, clazz: Class<T>, outputStream: OutputStream)
+    public fun <T> toJson(any: T, type: Type, outputStream: OutputStream)
+    public fun <T> fromJson(json: String, clz: Class<T>): T
+    public fun <T> fromJson(json: String, type: Type): T
+    public fun <T> fromJson(inputStream: InputStream, clz: Class<T>): T
+    public fun <T> fromJson(inputStream: InputStream, type: Type): T
+}
+
+/**
+ * Return the first 200 elements of [elements] as a JSON-encoded string
+ */
+public fun PlatformSerializer.truncatedStacktrace(
+    elements: Array<StackTraceElement>
+): String = toJson(elements.take(200).map(StackTraceElement::toString).toList(), List::class.java)
diff --git a/...d-sdk/src/main/java/io/embrace/android/embracesdk/internal/anr/ndk/NativeAnrOtelMapper.kt b/...d-sdk/src/main/java/io/embrace/android/embracesdk/internal/anr/ndk/NativeAnrOtelMapper.kt
@@ -11,7 +11,7 @@ import io.embrace.android.embracesdk.internal.payload.NativeThreadAnrInterval
 import io.embrace.android.embracesdk.internal.payload.NativeThreadAnrSample
 import io.embrace.android.embracesdk.internal.payload.Span
 import io.embrace.android.embracesdk.internal.payload.SpanEvent
-import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
+import io.embrace.android.embracesdk.internal.serialization.PlatformSerializer
 import io.opentelemetry.api.trace.SpanId
 import io.opentelemetry.sdk.trace.IdGenerator
 import io.opentelemetry.semconv.ExceptionAttributes
@@ -20,7 +20,7 @@ import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes
 
 internal class NativeAnrOtelMapper(
     private val nativeThreadSamplerService: NativeThreadSamplerService?,
-    private val serializer: EmbraceSerializer,
+    private val serializer: PlatformSerializer,
     private val clock: Clock
 ) : DataCaptureServiceOtelConverter {