Use the new EncodeMapTask output in the SDK and stop using resources (#2091)

Author: priettt

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/injection/NativeCoreModuleImpl.kt

@@ -38,7 +38,6 @@ internal class NativeCoreModuleImpl(
 
     override val symbolService: SymbolService by singleton {
         symbolServiceProvider() ?: SymbolServiceImpl(
-            coreModule.context,
             payloadSourceModule.deviceArchitecture,
             initModule.jsonSerializer,
             initModule.logger

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/ndk/symbols/SymbolServiceImpl.kt

@@ -1,19 +1,19 @@
 package io.embrace.android.embracesdk.internal.ndk.symbols
 
-import android.annotation.SuppressLint
-import android.content.Context
 import android.util.Base64
 import io.embrace.android.embracesdk.internal.DeviceArchitecture
+import io.embrace.android.embracesdk.internal.config.instrumented.InstrumentedConfigImpl
+import io.embrace.android.embracesdk.internal.config.instrumented.schema.InstrumentedConfig
 import io.embrace.android.embracesdk.internal.logging.EmbLogger
 import io.embrace.android.embracesdk.internal.logging.InternalErrorType
 import io.embrace.android.embracesdk.internal.payload.NativeSymbols
 import io.embrace.android.embracesdk.internal.serialization.PlatformSerializer
 
 class SymbolServiceImpl(
-    private val context: Context,
     private val deviceArchitecture: DeviceArchitecture,
     private val serializer: PlatformSerializer,
     private val logger: EmbLogger,
+    private val instrumentedConfig: InstrumentedConfig = InstrumentedConfigImpl,
 ) : SymbolService {
 
     override val symbolsForCurrentArch: Map<String, String>? by lazy {
@@ -34,30 +34,19 @@ class SymbolServiceImpl(
         }
     }
 
-    @SuppressLint("DiscouragedApi")
     private fun getNativeSymbols(): NativeSymbols? {
-        val resources = context.resources
-        val resourceId = resources.getIdentifier(KEY_NDK_SYMBOLS, "string", context.packageName)
-        if (resourceId != 0) {
-            try {
-                val encodedSymbols: String = Base64.decode(
-                    context.resources.getString(resourceId),
-                    Base64.DEFAULT
-                ).decodeToString()
-                return serializer.fromJson(encodedSymbols, NativeSymbols::class.java)
-            } catch (ex: Exception) {
-                logger.trackInternalError(InternalErrorType.INVALID_NATIVE_SYMBOLS, ex)
-            }
+        try {
+            val encodedSymbols = instrumentedConfig.symbols.getBase64SharedObjectFilesMap() ?: return null
+            val decodedSymbols: String = Base64.decode(encodedSymbols, Base64.DEFAULT).decodeToString()
+            return serializer.fromJson(decodedSymbols, NativeSymbols::class.java)
+        } catch (ex: Exception) {
+            logger.trackInternalError(InternalErrorType.INVALID_NATIVE_SYMBOLS, ex)
         }
+
         return null
     }
 
     private companion object {
-
-        /**
-         * The NDK symbols name that matches with the resource name injected by the plugin.
-         */
-        private const val KEY_NDK_SYMBOLS = "emb_ndk_symbols"
         private const val ARM_ABI_V7_NAME = "armeabi-v7a"
         private const val ARM_64_NAME = "arm64-v8a"
         private const val ARCH_X86_NAME = "x86"

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/ndk/symbols/SymbolServiceImplTest.kt

@@ -1,41 +1,36 @@
 package io.embrace.android.embracesdk.internal.ndk.symbols
 
-import android.content.Context
-import android.content.res.Resources
 import android.util.Base64
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.fakes.FakeDeviceArchitecture
 import io.embrace.android.embracesdk.fakes.FakeEmbLogger
 import io.embrace.android.embracesdk.fakes.TestPlatformSerializer
+import io.embrace.android.embracesdk.fakes.config.FakeBase64SharedObjectFilesMap
+import io.embrace.android.embracesdk.fakes.config.FakeInstrumentedConfig
 import io.embrace.android.embracesdk.internal.payload.NativeSymbols
-import io.mockk.every
-import io.mockk.mockk
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNull
 import org.junit.Test
 import org.junit.runner.RunWith
 
+// Needed for android.util.Base64
 @RunWith(AndroidJUnit4::class)
 class SymbolServiceImplTest {
 
-    private companion object {
-        private const val PACKAGE_NAME = "com.example.app"
-        private const val SYMBOL_RES_ID = "emb_ndk_symbols"
-        private const val RES_INT_VALUE = 1602934923
-    }
-
     private val symbolMap = mapOf(
         "armeabi-v7a" to mapOf("symbol" to "armeabi-v7a-value"),
         "arm64-v8a" to mapOf("symbol" to "arm64-v8a-value"),
         "x86" to mapOf("symbol" to "x86-value"),
         "x86_64" to mapOf("symbol" to "x86_64-value")
     )
 
+    private val serializer = TestPlatformSerializer()
+
     private val limitedMap = symbolMap.filter { it.key != "arm64-v8a" }
 
     @Test
     fun `missing symbols`() {
-        val service = createService(symbolMap, resId = 0)
+        val service = createServiceWithNullSymbols()
         assertNull(service.symbolsForCurrentArch)
     }
 
@@ -66,26 +61,24 @@ class SymbolServiceImplTest {
     private fun createService(
         symbolMap: Map<String, Map<String, String>>,
         arch: String = "arm64-v8a",
-        resId: Int = RES_INT_VALUE,
     ): SymbolService {
-        val res = mockk<Resources>(relaxed = true)
-        val ctx = mockk<Context>(relaxed = true) {
-            every { packageName } returns PACKAGE_NAME
-            every { resources } returns res
-        }
-
-        val serializer = TestPlatformSerializer()
         val json = serializer.toJson(NativeSymbols(symbols = symbolMap))
         val encodedSymbols = Base64.encodeToString(json.toByteArray(), Base64.DEFAULT)
 
-        every { res.getIdentifier(SYMBOL_RES_ID, "string", PACKAGE_NAME) } returns resId
-        every { res.getString(resId) } returns encodedSymbols
-
         return SymbolServiceImpl(
-            ctx,
             FakeDeviceArchitecture(arch),
             serializer,
-            FakeEmbLogger()
+            FakeEmbLogger(),
+            FakeInstrumentedConfig(symbols = FakeBase64SharedObjectFilesMap(encodedSymbols)),
+        )
+    }
+
+    private fun createServiceWithNullSymbols(): SymbolService {
+        return SymbolServiceImpl(
+            FakeDeviceArchitecture("arm64-v8a"),
+            serializer,
+            FakeEmbLogger(),
+            FakeInstrumentedConfig(symbols = FakeBase64SharedObjectFilesMap(null)),
         )
     }
 }

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/build.gradle

@@ -0,0 +1,25 @@
+plugins {
+    id("com.android.application")
+    id("io.embrace.swazzler")
+    id("io.embrace.android.testplugin")
+}
+
+integrationTest.configureAndroidProject(project)
+
+repositories {
+    google()
+    mavenCentral()
+    mavenLocal()
+}
+
+embrace {
+    autoAddEmbraceDependencies.set(true)
+}
+
+android {
+    externalNativeBuild {
+        cmake {
+            path("src/main/cpp/CMakeLists.txt")
+        }
+    }
+}

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest />

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/cpp/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.10.2)
+
+add_library(
+        emb-crisps
+        SHARED
+        crisps.c
+)
+
+add_library(
+        emb-donuts
+        SHARED
+        donuts.c
+)

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/cpp/crisps.c

@@ -0,0 +1,5 @@
+#include <stdint.h>
+
+int foo() {
+    return 2;
+}

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/cpp/donuts.c

@@ -0,0 +1,5 @@
+#include <stdint.h>
+
+int bar() {
+    return 2;
+}

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/embrace-config.json

@@ -0,0 +1,5 @@
+{
+  "app_id": "abcde",
+  "api_token": "12345123451234512345123451234512",
+  "ndk_enabled": true
+}

embrace-gradle-plugin-integration-tests/fixtures/android-cmake-with-code/src/main/java/com/example/app/Bar.java

@@ -0,0 +1,7 @@
+package com.example.app;
+
+public class Bar {
+    public static String getBar() {
+        return "bar";
+    }
+}