POC for workflow abstraction

Author: bidetofevil

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
 }

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
+}

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)
 }

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
+    }
+}

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)

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.
      *