adding stories for todos

Author: tanderson-ld

sdk/@launchdarkly/observability-android/lib/build.gradle.kts

@@ -52,7 +52,7 @@ dependencies {
     // Android crash instrumentation
     implementation("io.opentelemetry.android.instrumentation:crash:0.11.0-alpha")
 
-    // TODO: move replay instrumentation and associated compose dependencies into dedicated package
+    // TODO: O11Y-626 - move replay instrumentation and associated compose dependencies into dedicated package
     // Compose dependencies for capture functionality
     implementation("androidx.compose.ui:ui:1.7.5")
     implementation("androidx.compose.ui:ui-tooling:1.7.5")

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/client/InstrumentationManager.kt

@@ -108,7 +108,7 @@ class InstrumentationManager(
 
         val builder = OpenTelemetryRum.builder(application, otelRumConfig)
             .addLoggerProviderCustomizer { sdkLoggerProviderBuilder, _ ->
-                // TODO: need to refactor this so that the disableLogs option is specific to core logging functionality. when logs are disabled, session replay logs should not be blocked
+                // TODO: O11Y-627 - need to refactor this so that the disableLogs option is specific to core logging functionality. when logs are disabled, session replay logs should not be blocked
                 return@addLoggerProviderCustomizer if (options.disableLogs && options.disableErrorTracking) {
                     sdkLoggerProviderBuilder
                 } else {

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/CaptureSource.kt

@@ -43,7 +43,7 @@ import androidx.compose.ui.geometry.Rect as ComposeRect
 class CaptureSource(
     private val sessionManager: SessionManager,
     private val privacyProfile: PrivacyProfile,
-    // TODO: add captureQuality options
+    // TODO: O11Y-628 - add captureQuality options
 ) :
     Application.ActivityLifecycleCallbacks {
 
@@ -70,7 +70,7 @@ class CaptureSource(
      * Requests a [Capture] be taken now.
      */
     fun captureNow() {
-        // TODO: don't use global scope
+        // TODO: O11Y-621 - don't use global scope
         CoroutineScope(Dispatchers.Default).launch {
             val capture = doCapture()
             if (capture != null) {
@@ -121,16 +121,16 @@ class CaptureSource(
 
             val rect = Rect(0, 0, decorViewWidth, decorViewHeight)
 
-            // TODO: optimize memory allocations
-            // TODO: see if holding bitmap is more efficient than base64 encoding immediately after compression
-            // TODO: use captureQuality option for scaling and adjust this bitmap accordingly, may need to investigate power of 2 rounding for performance
+            // TODO: O11Y-625 - optimize memory allocations
+            // TODO: O11Y-625 - see if holding bitmap is more efficient than base64 encoding immediately after compression
+            // TODO: O11Y-628 - use captureQuality option for scaling and adjust this bitmap accordingly, may need to investigate power of 2 rounding for performance
             // Create a bitmap with the window dimensions
             val bitmap = Bitmap.createBitmap(decorViewWidth, decorViewHeight, Bitmap.Config.ARGB_8888)
 
             // Use PixelCopy to capture the window content
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
                 suspendCancellableCoroutine { continuation ->
-                    // TODO: read PixelCopy exception recommendations and adjust logic to account for such cases
+                    // TODO: O11Y-624 - read PixelCopy exception recommendations and adjust logic to account for such cases
                     PixelCopy.request(
                         window,
                         rect,
@@ -148,9 +148,9 @@ class CaptureSource(
                                     postMask = bitmap
                                 }
 
-                                // TODO: optimize memory allocations here, re-use byte arrays and such
+                                // TODO: O11Y-625 - optimize memory allocations here, re-use byte arrays and such
                                 val outputStream = ByteArrayOutputStream()
-                                // TODO: calculate quality using captureQuality options
+                                // TODO: O11Y-628 - calculate quality using captureQuality options
                                 postMask.compress(Bitmap.CompressFormat.WEBP, 30, outputStream)
                                 val byteArray = outputStream.toByteArray()
                                 val compressedImage = Base64.encodeToString(byteArray, Base64.NO_WRAP)
@@ -164,19 +164,19 @@ class CaptureSource(
                                 )
                                 continuation.resume(capture)
                             } else {
-                                // TODO: implement handling/shutdown for errors and unsupported API levels
+                                // TODO: O11Y-624 - implement handling/shutdown for errors and unsupported API levels
                                 continuation.resumeWithException(Exception("PixelCopy failed with result: $result"))
                             }
                         },
                         Handler(Looper.getMainLooper()) // Handler for main thread
                     )
                 }
             } else {
-                // TODO: implement handling/shutdown for errors and unsupported API levels
+                // TODO: O11Y-624 - implement handling/shutdown for errors and unsupported API levels
                 throw NotImplementedError("CaptureSource does not work on unsupported Android SDK version")
             }
         } catch (e: Exception) {
-            // TODO: implement handling/shutdown for errors and unsupported API levels
+            // TODO: O11Y-624 - implement handling/shutdown for errors and unsupported API levels
             throw RuntimeException(e);
         }
     }
@@ -189,7 +189,7 @@ class CaptureSource(
      * @param activity The activity that the bitmap was captured from.
      */
     private fun maskSensitiveAreas(bitmap: Bitmap, activity: Activity): Bitmap {
-        // TODO: remove this bitmap copy if possible for memory optimization purposes
+        // TODO: O11Y-625 - remove this bitmap copy if possible for memory optimization purposes
         val maskedBitmap = bitmap.copy(Bitmap.Config.ARGB_8888, true)
         val canvas = Canvas(maskedBitmap)
         val paint = Paint().apply {
@@ -274,7 +274,7 @@ class CaptureSource(
             if (composeView.childCount > 0) {
                 val androidComposeView = composeView.getChildAt(0)
 
-                // TODO: determine if there is a more robust long term way to achieve this, this reflection is fragile.
+                // TODO: O11Y-620 - determine if there is a more robust long term way to achieve this, this reflection is fragile.
                 // Use reflection to check if this is an AndroidComposeView
                 val androidComposeViewClass =
                     Class.forName("androidx.compose.ui.platform.AndroidComposeView")
@@ -342,7 +342,7 @@ class CaptureSource(
      * Check if a semantic node contains sensitive content based on test tags or content descriptions.
      */
     private fun isSensitiveNode(node: SemanticsNode): Boolean {
-        // TODO: refactor to utilize generic MaskMatchers
+        // TODO: O11Y-620 - refactor to utilize generic MaskMatchers
 
         // Check for content description containing "sensitive"
         val contentDescriptions = node.config.getOrNull(SemanticsProperties.ContentDescription)

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/PrivacyProfile.kt

@@ -1,6 +1,6 @@
 package com.launchdarkly.observability.replay
 
-// TODO: implement full PrivacyProfiles and MaskingMatchers
+// TODO: O11Y-620 - implement full PrivacyProfiles and MaskingMatchers
 enum class PrivacyProfile {
     NO_MASK, STRICT
 }

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/RRwebGraphQLReplayLogExporter.kt

@@ -31,7 +31,7 @@ class RRwebGraphQLReplayLogExporter(
     private var graphqlClient: GraphQLClient = GraphQLClient(backendUrl)
     private var replayApiService: SessionReplayApiService = SessionReplayApiService(graphqlClient)
 
-    // TODO: need to implement sid, payloadId reset when multiple sessions occur in one application process lifecycle.
+    // TODO: O11Y-624 - need to implement sid, payloadId reset when multiple sessions occur in one application process lifecycle.
     private var sidCounter = 0
     private var payloadIdCounter = 0
     private var lastSentHeight = 0
@@ -48,7 +48,7 @@ class RRwebGraphQLReplayLogExporter(
                 for (log in logs) {
                     val capture = extractCaptureFromLog(log)
                     if (capture != null) {
-                        // TODO: investigate if there is a size limit on the push that is imposed server side.
+                        // TODO: O11Y-624 - investigate if there is a size limit on the push that is imposed server side.
                         val success = if (!capture.session.equals(lastSessionId)) {
                             sendCaptureInitial(capture)
                         } else {
@@ -66,7 +66,7 @@ class RRwebGraphQLReplayLogExporter(
                     resultCode.fail()
                 }
             } catch (e: Exception) {
-                // TODO: pass in logger to implementation and use here
+                // TODO: O11Y-627 - pass in logger to implementation and use here
                 Log.e("RRwebGraphQLReplayLogExporter", "Error during export: ${e.message}", e)
                 resultCode.fail()
             }
@@ -76,10 +76,12 @@ class RRwebGraphQLReplayLogExporter(
     }
 
     override fun flush(): CompletableResultCode {
+        // TODO: O11Y-621 - Handle flush
         TODO("Not yet implemented")
     }
 
     override fun shutdown(): CompletableResultCode {
+        // TODO: O11Y-621 - Handle shutdown
         TODO("Not yet implemented")
     }
 
@@ -126,7 +128,7 @@ class RRwebGraphQLReplayLogExporter(
             val eventsBatch1 = mutableListOf<Event>()
             val timestamp = System.currentTimeMillis()
 
-            // TODO: optimize JSON usage for performance since this region of code is essentially static
+            // TODO: O11Y-625 - optimize JSON usage for performance since this region of code is essentially static
             val incrementalEvent = Event(
                 type = EventType.INCREMENTAL_SNAPSHOT,
                 timestamp = timestamp,
@@ -139,7 +141,7 @@ class RRwebGraphQLReplayLogExporter(
 
             // TODO: add ViewPort event if resolution changes
 
-            // TODO: remove this spoofed mouse interaction when proper user interaction is instrumented
+            // TODO: O11Y-629 - remove this spoofed mouse interaction when proper user interaction is instrumented
             // This spoofed mouse interaction is necessary to make the session look like it had activity
             eventsBatch1.add(
                 Event(
@@ -155,7 +157,7 @@ class RRwebGraphQLReplayLogExporter(
             replayApiService.pushPayload(capture.session, "${nextPayloadId()}", eventsBatch1)
             true
         } catch (e: Exception) {
-            // TODO: pass in logger to implementation and use here
+            // TODO: O11Y-627 - pass in logger to implementation and use here
             Log.e(REPLAY_EXPORTER_NAME, "Error sending incremental capture for session: ${e.message}", e)
             false
         }
@@ -173,7 +175,7 @@ class RRwebGraphQLReplayLogExporter(
 
             val eventBatch = mutableListOf<Event>()
 
-            // TODO: optimize JSON usage for performance since this region of code is essentially static
+            // TODO: O11Y-625 - optimize JSON usage for performance since this region of code is essentially static
 
             val timestamp = System.currentTimeMillis()
             val metaEvent = Event(
@@ -254,7 +256,7 @@ class RRwebGraphQLReplayLogExporter(
             )
             eventBatch.add(viewportEvent)
 
-            // TODO: double check error case handling, may need to add retries per api service request, should subsequent requests wait for previous requests to succeed?
+            // TODO: O11Y-624 - double check error case handling, may need to add retries per api service request, should subsequent requests wait for previous requests to succeed?
             lastSessionId = capture.session
             lastSentWidth = capture.origWidth
             lastSentHeight = capture.origHeight
@@ -263,7 +265,7 @@ class RRwebGraphQLReplayLogExporter(
 
             true
         } catch (e: Exception) {
-            // TODO: pass in logger to implementation and use here
+            // TODO: O11Y-627 - pass in logger to implementation and use here
             Log.e(REPLAY_EXPORTER_NAME, "Error sending initial capture for session: ${e.message}", e)
             false
         }

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/ReplayInstrumentation.kt

@@ -18,7 +18,7 @@ import java.util.concurrent.atomic.AtomicBoolean
 
 private const val INSTRUMENTATION_SCOPE_NAME = "com.launchdarkly.observability.replay"
 
-// TODO: determine where these should be defined ultimately and tune accordingly.  Perhaps
+// TODO: O11Y-625 - determine where these should be defined ultimately and tune accordingly.  Perhaps
 // we don't need a batching exporter in this layer.  Perhaps this layer shouldn't be the one
 // that decides the parameters of the batching exporter.  Perhaps the batching should be
 // controlled by the instrumentation manager.
@@ -82,8 +82,8 @@ class ReplayInstrumentation(
         _captureSource = CaptureSource(ctx.sessionManager, options.privacyProfile)
         _captureSource.attachToApplication(ctx.application)
 
-        // TODO: don't use global scope
-        // TODO: shutdown procedure and cleanup of dispatched jobs
+        // TODO: O11Y-621 - don't use global scope
+        // TODO: O11Y-621 - shutdown procedure and cleanup of dispatched jobs
         GlobalScope.launch(Dispatchers.Default) {
             _captureSource.captureFlow.collect { capture ->
                 _otelLogger.logRecordBuilder()
@@ -101,7 +101,7 @@ class ReplayInstrumentation(
         internalStartCapture()
     }
 
-    // TODO: implement mechanism for customer code to invoke this method
+    // TODO: O11Y-622 - implement mechanism for customer code to invoke this method
     suspend fun runCapture() {
         _captureMutex.withLock {
             // If already running (not paused), do nothing
@@ -115,7 +115,7 @@ class ReplayInstrumentation(
         }
     }
 
-    // TODO: implement mechanism for customer code to invoke this method
+    // TODO: O11Y-622 - implement mechanism for customer code to invoke this method
     suspend fun pauseCapture() {
         _captureMutex.withLock {
             // if already paused, do nothing
@@ -131,7 +131,7 @@ class ReplayInstrumentation(
     }
 
     private fun internalStartCapture() {
-        // TODO: don't use global scope
+        // TODO: O11Y-621 - don't use global scope
         _captureJob = GlobalScope.launch(Dispatchers.Default) {
             try {
                 while (true) {

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/ReplayOptions.kt

@@ -15,4 +15,5 @@ data class ReplayOptions(
     val debug: Boolean = false,
     val privacyProfile: PrivacyProfile = PrivacyProfile.STRICT,
     val capturePeriodMillis: Long = 1000, // defaults to ever 1 second
+    // TODO O11Y-623 - Add storage options
 )

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/ReplaySessionProtocol.kt

@@ -66,7 +66,7 @@ object EventTypeSerializer : KSerializer<EventType> {
     override fun deserialize(decoder: Decoder): EventType {
         val intValue = decoder.decodeInt()
 
-        // TODO: determine better error handling
+        // TODO: O11Y-624 - determine better error handling
         return EventType.values().find { it.value == intValue }
             ?: throw IllegalArgumentException("Unknown EventType value: $intValue")
     }
@@ -91,7 +91,7 @@ object NodeTypeSerializer : KSerializer<NodeType> {
 
     override fun deserialize(decoder: Decoder): NodeType {
         val intValue = decoder.decodeInt()
-        // TODO: determine better error handling
+        // TODO: O11Y-624 - determine better error handling
         return NodeType.values().find { it.value == intValue }
             ?: throw IllegalArgumentException("Unknown NodeType value: $intValue")
     }
@@ -127,7 +127,7 @@ object IncrementalSourceSerializer : KSerializer<IncrementalSource> {
 
     override fun deserialize(decoder: Decoder): IncrementalSource {
         val intValue = decoder.decodeInt()
-        // TODO: determine better error handling
+        // TODO: O11Y-624 - determine better error handling
         return IncrementalSource.values().find { it.value == intValue }
             ?: throw IllegalArgumentException("Unknown IncrementalSource value: $intValue")
     }
@@ -157,7 +157,7 @@ object MouseInteractionsSerializer : KSerializer<MouseInteractions> {
 
     override fun deserialize(decoder: Decoder): MouseInteractions {
         val intValue = decoder.decodeInt()
-        // TODO: determine better error handling
+        // TODO: O11Y-624 - determine better error handling
         return MouseInteractions.values().find { it.value == intValue }
             ?: throw IllegalArgumentException("Unknown MouseInteractions value: $intValue")
     }

sdk/@launchdarkly/observability-android/lib/src/main/kotlin/com/launchdarkly/observability/replay/SessionReplayApiService.kt

@@ -8,7 +8,7 @@ import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.JsonNull
 import kotlinx.serialization.json.JsonPrimitive
 
-// TODO: Refactor logging handling in this class
+// TODO: O11Y-627 - Refactor logging handling in this class
 class SessionReplayApiService(
     private val graphqlClient: GraphQLClient
 ) {
@@ -54,7 +54,7 @@ class SessionReplayApiService(
                 dataSerializer = InitializeReplaySessionResponse.serializer()
             )
 
-            // TODO: check graphql requests can generate errors when necessary and add error handling
+            // TODO: O11Y-624 - check graphql requests can generate errors when necessary and add error handling
             if (response.errors?.isNotEmpty() == true) {
                 printErrors(response)
             }