Merge pull request #874 from embrace-io/remove-app-id-req

Remove requirement for supplying appId

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/capture/metadata/EmbraceMetadataService.kt

@@ -300,7 +300,7 @@ internal class EmbraceMetadataService private constructor(
 
  override fun getLightweightAppInfo(): AppInfo = getAppInfo(false)
 
- override fun getAppId(): String {
+ override fun getAppId(): String? {
  return configService.sdkModeBehavior.appId
  }
 

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/capture/metadata/MetadataService.kt

@@ -33,7 +33,7 @@ internal interface MetadataService {
  *
  * @return the app ID.
  */
- fun getAppId(): String
+ fun getAppId(): String?
 
  /**
  * Gets information and specifications of the current device. This is sent with the following

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/comms/delivery/NoopDeliveryService.kt

@@ -0,0 +1,41 @@
+package io.embrace.android.embracesdk.comms.delivery
+
+import io.embrace.android.embracesdk.internal.payload.Envelope
+import io.embrace.android.embracesdk.internal.payload.LogPayload
+import io.embrace.android.embracesdk.internal.utils.Provider
+import io.embrace.android.embracesdk.ndk.NativeCrashService
+import io.embrace.android.embracesdk.payload.EventMessage
+import io.embrace.android.embracesdk.payload.NetworkEvent
+import io.embrace.android.embracesdk.payload.SessionMessage
+import io.embrace.android.embracesdk.session.id.SessionIdTracker
+import io.embrace.android.embracesdk.session.orchestrator.SessionSnapshotType
+
+internal class NoopDeliveryService : DeliveryService {
+
+ override fun sendSession(sessionMessage: SessionMessage, snapshotType: SessionSnapshotType) {
+ }
+
+ override fun sendCachedSessions(
+ nativeCrashServiceProvider: Provider<NativeCrashService?>,
+ sessionIdTracker: SessionIdTracker
+ ) {
+ }
+
+ override fun sendLog(eventMessage: EventMessage) {
+ }
+
+ override fun sendLogs(logEnvelope: Envelope<LogPayload>) {
+ }
+
+ override fun saveLogs(logEnvelope: Envelope<LogPayload>) {
+ }
+
+ override fun sendNetworkCall(networkEvent: NetworkEvent) {
+ }
+
+ override fun sendCrash(crash: EventMessage, processTerminating: Boolean) {
+ }
+
+ override fun sendMoment(eventMessage: EventMessage) {
+ }
+}

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/config/EmbraceConfigService.kt

@@ -36,7 +36,7 @@ import kotlin.math.min
  */
 internal class EmbraceConfigService @JvmOverloads constructor(
  private val localConfig: LocalConfig,
- private val apiService: ApiService,
+ private val apiService: ApiService?,
  private val preferencesService: PreferencesService,
  private val clock: Clock,
  private val logger: EmbLogger,
@@ -181,8 +181,8 @@ internal class EmbraceConfigService @JvmOverloads constructor(
  */
 
  fun loadConfigFromCache() {
- val cachedConfig = apiService.getCachedConfig()
- val obj = cachedConfig.remoteConfig
+ val cachedConfig = apiService?.getCachedConfig()
+ val obj = cachedConfig?.remoteConfig
 
  if (obj != null) {
  val oldConfig = configProp
@@ -214,7 +214,7 @@ internal class EmbraceConfigService @JvmOverloads constructor(
  if (configRequiresRefresh()) {
  try {
  lastRefreshConfigAttempt = clock.now()
- val newConfig = apiService.getConfig()
+ val newConfig = apiService?.getConfig()
  if (newConfig != null) {
  updateConfig(previousConfig, newConfig)
  lastUpdated = clock.now()

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/config/LocalConfigParser.kt

@@ -1,19 +1,21 @@
 package io.embrace.android.embracesdk.config
 
+import android.content.res.Resources.NotFoundException
 import android.util.Base64
 import io.embrace.android.embracesdk.config.local.LocalConfig
 import io.embrace.android.embracesdk.config.local.SdkLocalConfig
 import io.embrace.android.embracesdk.internal.AndroidResourcesService
 import io.embrace.android.embracesdk.internal.ApkToolsConfig
 import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
 import io.embrace.android.embracesdk.logging.EmbLogger
+import io.embrace.android.embracesdk.opentelemetry.OpenTelemetryConfiguration
 
 internal object LocalConfigParser {
 
  /**
  * Build info app id name.
  */
- public const val BUILD_INFO_APP_ID = "emb_app_id"
+ const val BUILD_INFO_APP_ID = "emb_app_id"
 
  /**
  * Build info sdk config id name.
@@ -23,12 +25,12 @@ internal object LocalConfigParser {
  /**
  * Build info ndk enabled.
  */
- public const val BUILD_INFO_NDK_ENABLED = "emb_ndk_enabled"
+ const val BUILD_INFO_NDK_ENABLED = "emb_ndk_enabled"
 
  /**
  * The default value for native crash capture enabling
  */
- public const val NDK_ENABLED_DEFAULT = false
+ const val NDK_ENABLED_DEFAULT = false
 
  /**
  * Loads the build information from resources provided by the config file packaged within the application by Gradle at
@@ -42,16 +44,11 @@ internal object LocalConfigParser {
  packageName: String,
  customAppId: String?,
  serializer: EmbraceSerializer,
+ openTelemetryCfg: OpenTelemetryConfiguration,
  logger: EmbLogger
  ): LocalConfig {
  return try {
- val appId: String = customAppId ?: resources.getString(
- resources.getIdentifier(
- BUILD_INFO_APP_ID,
- "string",
- packageName
- )
- )
+ val appId = resolveAppId(customAppId, resources, packageName)
  val ndkEnabledJsonId =
  resources.getIdentifier(BUILD_INFO_NDK_ENABLED, "string", packageName)
  val ndkEnabled = when {
@@ -74,20 +71,43 @@ internal object LocalConfigParser {
 
  else -> null
  }
- buildConfig(appId, ndkEnabled, sdkConfigJson, serializer, logger)
+ buildConfig(appId, ndkEnabled, sdkConfigJson, serializer, openTelemetryCfg, logger)
  } catch (ex: Exception) {
  throw IllegalStateException("Failed to load local config from resources.", ex)
  }
  }
 
+ private fun resolveAppId(
+ customAppId: String?,
+ resources: AndroidResourcesService,
+ packageName: String
+ ): String? {
+ return try {
+ customAppId ?: resources.getString(
+ resources.getIdentifier(
+ BUILD_INFO_APP_ID,
+ "string",
+ packageName
+ )
+ )
+ } catch (exc: NotFoundException) {
+ null
+ }
+ }
+
  fun buildConfig(
  appId: String?,
  ndkEnabled: Boolean,
  sdkConfigs: String?,
  serializer: EmbraceSerializer,
+ openTelemetryCfg: OpenTelemetryConfiguration,
  logger: EmbLogger
  ): LocalConfig {
- require(!appId.isNullOrEmpty()) { "Embrace AppId cannot be null or empty." }
+ require(!appId.isNullOrEmpty() || openTelemetryCfg.hasConfiguredOtelExporters()) {
+ "No appId supplied in embrace-config.json. This is required if you want to " +
+ "send data to Embrace, unless you configure an OTel exporter and add" +
+ " embrace.disableMappingFileUpload=true to gradle.properties."
+ }
 
  val enabledStr = when {
  ndkEnabled -> "enabled"

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/config/behavior/SdkEndpointBehavior.kt

@@ -23,10 +23,20 @@ internal class SdkEndpointBehavior(
  /**
  * Data base URL.
  */
- fun getData(appId: String): String = local?.data ?: "https://a-$appId.$DATA_DEFAULT"
+ fun getData(appId: String?): String {
+ if (appId == null) {
+ return ""
+ }
+ return local?.data ?: "https://a-$appId.$DATA_DEFAULT"
+ }
 
  /**
  * Config base URL.
  */
- fun getConfig(appId: String): String = local?.config ?: "https://a-$appId.$CONFIG_DEFAULT"
+ fun getConfig(appId: String?): String {
+ if (appId == null) {
+ return ""
+ }
+ return local?.config ?: "https://a-$appId.$CONFIG_DEFAULT"
+ }
 }

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/config/behavior/SdkModeBehavior.kt

@@ -75,7 +75,7 @@ internal class SdkModeBehavior(
  /**
  * The Embrace app ID. This is used to identify the app within the database.
  */
- val appId: String by lazy { local?.appId ?: error("App ID not supplied.") }
+ val appId: String? by lazy { local?.appId }
 
  /**
  * The % of devices that should be enabled.

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/config/local/LocalConfig.kt

@@ -9,7 +9,7 @@ internal class LocalConfig(
  /**
  * The Embrace app ID. This is used to identify the app within the database.
  */
- val appId: String,
+ val appId: String?,
 
  /**
  * Control whether the Embrace SDK is able to capture native crashes.

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/injection/DeliveryModule.kt

@@ -2,6 +2,7 @@ package io.embrace.android.embracesdk.injection
 
 import io.embrace.android.embracesdk.comms.delivery.DeliveryService
 import io.embrace.android.embracesdk.comms.delivery.EmbraceDeliveryService
+import io.embrace.android.embracesdk.comms.delivery.NoopDeliveryService
 import io.embrace.android.embracesdk.worker.WorkerName
 import io.embrace.android.embracesdk.worker.WorkerThreadModule
 
@@ -18,12 +19,17 @@ internal class DeliveryModuleImpl(
 ) : DeliveryModule {
 
  override val deliveryService: DeliveryService by singleton {
- EmbraceDeliveryService(
- storageModule.deliveryCacheManager,
- essentialServiceModule.apiService,
- workerThreadModule.backgroundWorker(WorkerName.DELIVERY_CACHE),
- coreModule.jsonSerializer,
- initModule.logger
- )
+ val apiService = essentialServiceModule.apiService
+ if (apiService == null) {
+ NoopDeliveryService()
+ } else {
+ EmbraceDeliveryService(
+ storageModule.deliveryCacheManager,
+ apiService,
+ workerThreadModule.backgroundWorker(WorkerName.DELIVERY_CACHE),
+ coreModule.jsonSerializer,
+ initModule.logger
+ )
+ }
  }
 }

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/injection/EssentialServiceModule.kt

@@ -63,7 +63,7 @@ internal interface EssentialServiceModule {
  val userService: UserService
  val urlBuilder: ApiUrlBuilder
  val apiClient: ApiClient
- val apiService: ApiService
+ val apiService: ApiService?
  val sharedObjectLoader: SharedObjectLoader
  val cpuInfoDelegate: CpuInfoDelegate
  val deviceArchitecture: DeviceArchitecture
@@ -95,6 +95,7 @@ internal class EssentialServiceModuleImpl(
  coreModule.context.packageName,
  customAppId,
  coreModule.jsonSerializer,
+ openTelemetryModule.openTelemetryConfiguration,
  initModule.logger
  )
  }
@@ -226,7 +227,7 @@ internal class EssentialServiceModuleImpl(
  thresholdCheck = thresholdCheck,
  localSupplier = localConfig.sdkConfig::baseUrls,
  )
-
+ checkNotNull(appId)
  val coreBaseUrl = sdkEndpointBehavior.getData(appId)
  val configBaseUrl = sdkEndpointBehavior.getConfig(appId)
 
@@ -278,7 +279,10 @@ internal class EssentialServiceModuleImpl(
  }
  }
 
- override val apiService: ApiService by singleton {
+ override val apiService: ApiService? by singleton {
+ if (appId == null) {
+ return@singleton null
+ }
  Systrace.traceSynchronous("api-service-init") {
  EmbraceApiService(
  apiClient = apiClient,

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/internal/BuildInfo.kt

@@ -66,10 +66,7 @@ internal class BuildInfo internal constructor(
  ex
  )
  } catch (ex: Resources.NotFoundException) {
- throw IllegalArgumentException(
- "No resource found for $buildProperty property. Failed to create build info.",
- ex
- )
+ null
  }
  }
  }

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/opentelemetry/OpenTelemetryConfiguration.kt

@@ -64,4 +64,6 @@ internal class OpenTelemetryConfiguration(
  fun addLogExporter(logExporter: LogRecordExporter) {
  externalLogExporters.add(logExporter)
  }
+
+ fun hasConfiguredOtelExporters() = externalLogExporters.isNotEmpty() || externalSpanExporters.isNotEmpty()
 }

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/payload/NetworkEvent.kt

@@ -6,7 +6,7 @@ import com.squareup.moshi.JsonClass
 @JsonClass(generateAdapter = true)
 internal data class NetworkEvent(
  @Json(name = "app_id")
- val appId: String,
+ val appId: String?,
 
  @Json(name = "a")
  val appInfo: AppInfo,

embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/EmbraceGatingServiceV1PayloadTest.kt

@@ -32,10 +32,14 @@ import io.embrace.android.embracesdk.gating.SessionGatingKeys.SESSION_PROPERTIES
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.SESSION_USER_TERMINATION
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.STARTUP_MOMENT
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.USER_PERSONAS
+import io.embrace.android.embracesdk.internal.SystemInfo
+import io.embrace.android.embracesdk.internal.logs.LogSinkImpl
 import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
+import io.embrace.android.embracesdk.internal.spans.SpanSinkImpl
 import io.embrace.android.embracesdk.internal.utils.Uuid
 import io.embrace.android.embracesdk.logging.EmbLogger
 import io.embrace.android.embracesdk.logging.EmbLoggerImpl
+import io.embrace.android.embracesdk.opentelemetry.OpenTelemetryConfiguration
 import io.embrace.android.embracesdk.payload.DiskUsage
 import io.embrace.android.embracesdk.payload.Event
 import io.embrace.android.embracesdk.payload.EventMessage
@@ -81,6 +85,13 @@ internal class EmbraceGatingServiceV1PayloadTest {
  LOGS_WARN
  )
 
+ private val otelCfg = OpenTelemetryConfiguration(
+ SpanSinkImpl(),
+ LogSinkImpl(),
+ SystemInfo(),
+ "my-id"
+ )
+
  private lateinit var sessionBehavior: SessionBehavior
  private var cfg: RemoteConfig? = RemoteConfig()
 
@@ -176,6 +187,7 @@ internal class EmbraceGatingServiceV1PayloadTest {
  "]" +
  "}}",
  EmbraceSerializer(),
+ otelCfg,
  EmbLoggerImpl()
  )