POC for workflow abstraction

bidetofevil · bidetofevil · commit 299ed1388f20 · 2025-03-19T16:13:01.000-07:00
diff --git a/embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/spans/TracingApi.kt b/embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/spans/TracingApi.kt
@@ -264,4 +264,6 @@ public interface TracingApi {
      * if was completed in a prior session.
      */
     public fun getSpan(spanId: String): EmbraceSpan?
+
+    public fun createOperation(name: String): Workflow
 }
diff --git a/embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/spans/Workflow.kt b/embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/spans/Workflow.kt
@@ -0,0 +1,7 @@
+package io.embrace.android.embracesdk.spans
+
+public interface Workflow {
+    public fun start(segmentName: String? = null): Boolean
+    public fun startSegment(segmentName: String): Boolean
+    public fun end(errorCode: ErrorCode? = null): Boolean
+}
diff --git a/embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/EmbraceTracer.kt b/embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/EmbraceTracer.kt
@@ -6,6 +6,7 @@ import io.embrace.android.embracesdk.spans.EmbraceSpan
 import io.embrace.android.embracesdk.spans.EmbraceSpanEvent
 import io.embrace.android.embracesdk.spans.ErrorCode
 import io.embrace.android.embracesdk.spans.TracingApi
+import io.embrace.android.embracesdk.spans.Workflow
 
 class EmbraceTracer(
     private val spanService: SpanService,
@@ -78,4 +79,6 @@ class EmbraceTracer(
     )
 
     override fun getSpan(spanId: String): EmbraceSpan? = spanService.getSpan(spanId = spanId)
+
+    override fun createOperation(name: String): Workflow = Operation(name = name, spanService = spanService)
 }
diff --git a/embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/Operation.kt b/embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/spans/Operation.kt
@@ -0,0 +1,41 @@
+package io.embrace.android.embracesdk.internal.spans
+
+import io.embrace.android.embracesdk.spans.EmbraceSpan
+import io.embrace.android.embracesdk.spans.ErrorCode
+import io.embrace.android.embracesdk.spans.Workflow
+
+class Operation(
+    private val name: String,
+    private val spanService: SpanService,
+) : Workflow {
+    @Volatile
+    private var root: EmbraceSpan? = null
+
+    @Volatile
+    private var currentSegment: EmbraceSpan? = null
+
+    override fun start(segmentName: String?): Boolean {
+        spanService.startSpan(name)?.apply {
+            root = this
+            segmentName?.let {
+                startSegment(it)
+            }
+        }
+
+        return root != null && (segmentName == null || currentSegment != null)
+    }
+
+    override fun startSegment(segmentName: String): Boolean {
+        root?.run {
+            currentSegment?.stop()
+            currentSegment = spanService.startSpan(parent = root, name = "$name-$segmentName")
+        }
+
+        return currentSegment != null
+    }
+
+    override fun end(errorCode: ErrorCode?): Boolean {
+        currentSegment?.stop(errorCode)
+        return root?.stop(errorCode) != null
+    }
+}
diff --git a/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/TracingApiTest.kt b/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/TracingApiTest.kt
@@ -3,6 +3,7 @@ package io.embrace.android.embracesdk.testcases
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.arch.assertIsTypePerformance
 import io.embrace.android.embracesdk.assertions.assertEmbraceSpanData
+import io.embrace.android.embracesdk.assertions.findSpansByName
 import io.embrace.android.embracesdk.concurrency.SingleThreadTestScheduledExecutor
 import io.embrace.android.embracesdk.fakes.FakeSpanExporter
 import io.embrace.android.embracesdk.fakes.config.FakeEnabledFeatureConfig
@@ -329,6 +330,35 @@ internal class TracingApiTest {
         )
     }
 
+    @Test
+    fun `record operation`() {
+        testRule.runTest(
+            testCaseAction = {
+                recordSession {
+                    clock.tick(100L)
+                    val op = embrace.createOperation("my-op")
+                    clock.tick(100L)
+                    op.start("first")
+                    clock.tick(100L)
+                    op.start("second")
+                    clock.tick(100L)
+                    op.start("third")
+                    clock.tick(100L)
+                    op.end(ErrorCode.FAILURE)
+                }
+            },
+            assertAction = {
+                with(getSingleSessionEnvelope()) {
+                    assertNotNull(findSpansByName(name = "my-op"))
+                    assertNotNull(findSpansByName(name = "my-op-first"))
+                    assertNotNull(findSpansByName(name = "my-op-second"))
+                    assertNotNull(findSpansByName(name = "my-op-third"))
+                }
+            }
+        )
+    }
+
+
     private fun EmbracePayloadAssertionInterface.getSdkInitSpanFromBackgroundActivity(): List<Span> {
         val lastSentBackgroundActivity = getSingleSessionEnvelope(ApplicationState.BACKGROUND)
         val spans = checkNotNull(lastSentBackgroundActivity.data.spans)
diff --git a/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/Embrace.kt b/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/Embrace.kt
@@ -13,6 +13,7 @@ import io.embrace.android.embracesdk.spans.AutoTerminationMode
 import io.embrace.android.embracesdk.spans.EmbraceSpan
 import io.embrace.android.embracesdk.spans.EmbraceSpanEvent
 import io.embrace.android.embracesdk.spans.ErrorCode
+import io.embrace.android.embracesdk.spans.Workflow
 import io.opentelemetry.api.OpenTelemetry
 import io.opentelemetry.sdk.logs.export.LogRecordExporter
 import io.opentelemetry.sdk.trace.export.SpanExporter
@@ -377,6 +378,10 @@ public class Embrace private constructor(
         return impl.getSpan(spanId)
     }
 
+    override fun createOperation(name: String): Workflow {
+        return impl.createOperation(name)
+    }
+
     /**
      * Adds a [SpanExporter] to the tracer.
      *
diff --git a/examples/ExampleApp/app/build.gradle.kts b/examples/ExampleApp/app/build.gradle.kts
@@ -27,6 +27,7 @@ android {
                 getDefaultProguardFile("proguard-android-optimize.txt"),
                 "proguard-rules.pro"
             )
+            signingConfig = signingConfigs.getByName("debug")
         }
     }
     compileOptions {
diff --git a/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/MainActivity.kt b/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/MainActivity.kt
@@ -7,31 +7,41 @@ import androidx.activity.enableEdgeToEdge
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import androidx.navigation.compose.rememberNavController
+import io.embrace.android.embracesdk.Embrace
+import io.embrace.android.embracesdk.spans.Workflow
 import io.embrace.android.exampleapp.ui.CodeExample
 import io.embrace.android.exampleapp.ui.CodeExampleDetailScreen
 import io.embrace.android.exampleapp.ui.CodeExampleListScreen
 import io.embrace.android.exampleapp.ui.theme.ExampleAppTheme
 
 class MainActivity : ComponentActivity() {
 
+    private val operation: Workflow = Embrace.getInstance().createOperation("app-screen")
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+        operation.start("load")
         val examples = CodeExample.entries
         enableEdgeToEdge()
         setContent {
             ExampleAppTheme {
                 val navController = rememberNavController()
                 NavHost(navController = navController, startDestination = "main") {
                     composable("main") {
-                        CodeExampleListScreen(navController, examples)
+                        CodeExampleListScreen(navController, examples, operation)
                     }
                     examples.forEach { example ->
                         composable(example.route) {
-                            CodeExampleDetailScreen(navController, example)
+                            CodeExampleDetailScreen(navController, example, operation)
                         }
                     }
                 }
             }
         }
     }
+
+    override fun onPause() {
+        super.onPause()
+        operation.end()
+    }
 }
diff --git a/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/ui/CodeExampleDetailScreen.kt b/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/ui/CodeExampleDetailScreen.kt
@@ -17,10 +17,11 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.unit.dp
 import androidx.navigation.NavController
+import io.embrace.android.embracesdk.spans.Workflow
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun CodeExampleDetailScreen(navController: NavController, example: CodeExample) {
+fun CodeExampleDetailScreen(navController: NavController, example: CodeExample, operation: Workflow? = null) {
     Scaffold(
         topBar = {
             TopAppBar(
@@ -29,7 +30,12 @@ fun CodeExampleDetailScreen(navController: NavController, example: CodeExample)
                 },
                 colors = appBarColors(),
                 navigationIcon = {
-                    IconButton(onClick = navController::popBackStack) {
+                    IconButton(
+                        onClick = {
+                            operation?.startSegment("main")
+                            navController.popBackStack()
+                        }
+                    ) {
                         Icon(
                             imageVector = Icons.AutoMirrored.Filled.ArrowBack,
                             contentDescription = "Back",
diff --git a/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/ui/CodeExampleListScreen.kt b/examples/ExampleApp/app/src/main/kotlin/io/embrace/android/exampleapp/ui/CodeExampleListScreen.kt
@@ -15,13 +15,15 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.unit.dp
 import androidx.navigation.NavController
+import io.embrace.android.embracesdk.spans.Workflow
 import io.embrace.android.exampleapp.R
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
 fun CodeExampleListScreen(
     navController: NavController,
     examples: List<CodeExample>,
+    operation: Workflow?,
 ) {
     Scaffold(modifier = Modifier.fillMaxSize(),
         topBar = {
@@ -37,6 +39,7 @@ fun CodeExampleListScreen(
                         val item = examples[index]
                         Button(
                             onClick = {
+                                operation?.startSegment(item.route)
                                 navController.navigate(item.route)
                             },
                             modifier = Modifier
diff --git a/examples/ExampleApp/gradle/libs.versions.toml b/examples/ExampleApp/gradle/libs.versions.toml
@@ -8,7 +8,7 @@ espressoCore = "3.6.1"
 lifecycleRuntimeKtx = "2.8.7"
 activityCompose = "1.10.1"
 composeBom = "2025.03.00"
-embrace = "7.3.0"
+embrace = "7.4.0-SNAPSHOT"
 navigationCompose = "2.8.9"
 okhttp = "4.12.0"
 otel = "1.48.0"

Original file line number	Diff line number	Diff line change
`@@ -264,4 +264,6 @@ public interface TracingApi {`
`264`	`264`	`* if was completed in a prior session.`
`265`	`265`	`*/`
`266`	`266`	`public fun getSpan(spanId: String): EmbraceSpan?`
	`267`	`+`
	`268`	`+ public fun createOperation(name: String): Workflow`
`267`	`269`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import io.embrace.android.embracesdk.spans.EmbraceSpan`
`6`	`6`	`import io.embrace.android.embracesdk.spans.EmbraceSpanEvent`
`7`	`7`	`import io.embrace.android.embracesdk.spans.ErrorCode`
`8`	`8`	`import io.embrace.android.embracesdk.spans.TracingApi`
	`9`	`+import io.embrace.android.embracesdk.spans.Workflow`
`9`	`10`
`10`	`11`	`class EmbraceTracer(`
`11`	`12`	`private val spanService: SpanService,`
`@@ -78,4 +79,6 @@ class EmbraceTracer(`
`78`	`79`	`)`
`79`	`80`
`80`	`81`	`override fun getSpan(spanId: String): EmbraceSpan? = spanService.getSpan(spanId = spanId)`
	`82`	`+`
	`83`	`+ override fun createOperation(name: String): Workflow = Operation(name = name, spanService = spanService)`
`81`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ android {`
`27`	`27`	`getDefaultProguardFile("proguard-android-optimize.txt"),`
`28`	`28`	`"proguard-rules.pro"`
`29`	`29`	`)`
	`30`	`+ signingConfig = signingConfigs.getByName("debug")`
`30`	`31`	`}`
`31`	`32`	`}`
`32`	`33`	`compileOptions {`
Original file line number	Diff line number	Diff line change
`@@ -7,31 +7,41 @@ import androidx.activity.enableEdgeToEdge`
`7`	`7`	`import androidx.navigation.compose.NavHost`
`8`	`8`	`import androidx.navigation.compose.composable`
`9`	`9`	`import androidx.navigation.compose.rememberNavController`
	`10`	`+import io.embrace.android.embracesdk.Embrace`
	`11`	`+import io.embrace.android.embracesdk.spans.Workflow`
`10`	`12`	`import io.embrace.android.exampleapp.ui.CodeExample`
`11`	`13`	`import io.embrace.android.exampleapp.ui.CodeExampleDetailScreen`
`12`	`14`	`import io.embrace.android.exampleapp.ui.CodeExampleListScreen`
`13`	`15`	`import io.embrace.android.exampleapp.ui.theme.ExampleAppTheme`
`14`	`16`
`15`	`17`	`class MainActivity : ComponentActivity() {`
`16`	`18`
	`19`	`+ private val operation: Workflow = Embrace.getInstance().createOperation("app-screen")`
	`20`	`+`
`17`	`21`	`override fun onCreate(savedInstanceState: Bundle?) {`
`18`	`22`	`super.onCreate(savedInstanceState)`
	`23`	`+ operation.start("load")`
`19`	`24`	`val examples = CodeExample.entries`
`20`	`25`	`enableEdgeToEdge()`
`21`	`26`	`setContent {`
`22`	`27`	`ExampleAppTheme {`
`23`	`28`	`val navController = rememberNavController()`
`24`	`29`	`NavHost(navController = navController, startDestination = "main") {`
`25`	`30`	`composable("main") {`
`26`		`- CodeExampleListScreen(navController, examples)`
	`31`	`+ CodeExampleListScreen(navController, examples, operation)`
`27`	`32`	`}`
`28`	`33`	`examples.forEach { example ->`
`29`	`34`	`composable(example.route) {`
`30`		`- CodeExampleDetailScreen(navController, example)`
	`35`	`+ CodeExampleDetailScreen(navController, example, operation)`
`31`	`36`	`}`
`32`	`37`	`}`
`33`	`38`	`}`
`34`	`39`	`}`
`35`	`40`	`}`
`36`	`41`	`}`
	`42`	`+`
	`43`	`+ override fun onPause() {`
	`44`	`+ super.onPause()`
	`45`	`+ operation.end()`
	`46`	`+ }`
`37`	`47`	`}`