[CIVIS-9813] implemented channel name fix (#101)

* [CIVIS-9813] implemented channel name fix
* missing environment key to pass to UI tests

Sources/DatadogSDKTesting/Config.swift

@@ -64,6 +64,9 @@ final class Config {
     var tracerTraceId: String? = nil
     var tracerSpanId: String? = nil
 
+    /// UUID for message channels between App and tests
+    var messageChannelUUID: String? = nil
+
     /// The framework has been launched with extra debug information
     var extraDebug: Bool = false
     var extraDebugCallStack: Bool = false
@@ -126,6 +129,8 @@ final class Config {
         tracerTraceId = env[.tracerTraceId]
         tracerSpanId = env[.tracerSpanId]
 
+        messageChannelUUID = env[.messageChannelUUID]
+
         endpoint = env[.site] ?? env[.endpoint]
         disableTracesExporting = env[.dontExport] ?? false
         reportHostname = env[.ciVisibilityReportHostname] ?? false

Sources/DatadogSDKTesting/DDTestMonitor.swift

@@ -53,6 +53,7 @@ internal class DDTestMonitor {
     var launchNotificationObserver: NSObjectProtocol?
     var didBecomeActiveNotificationObserver: NSObjectProtocol?
     var isRumActive: Bool = false
+    let messageChannelUUID: String
 
     var crashedModuleInfo: CrashedModuleInformation?
 
@@ -92,6 +93,7 @@ internal class DDTestMonitor {
     }
 
     private var isGitUploadSucceded: Bool = false
+    private var serverTestingPort: CFMessagePort? = nil
 
     static func installTestMonitor() -> Bool {
         guard DDTestMonitor.config.apiKey != nil else {
@@ -118,6 +120,8 @@ internal class DDTestMonitor {
     }
 
     init() {
+        messageChannelUUID = DDTestMonitor.config.messageChannelUUID ?? UUID().uuidString
+
         if DDTestMonitor.config.isBinaryUnderUITesting {
             launchNotificationObserver = NotificationCenter.default.addObserver(
                 forName: launchNotificationName,
@@ -143,16 +147,18 @@ internal class DDTestMonitor {
                     #if os(iOS)
                         data[DDUISettingsTags.uiSettingsOrientation] = PlatformUtils.getOrientation()
                     #endif
-                    let encoded = try? JSONSerialization.data(withJSONObject: data)
-                    let timeout: CFTimeInterval = 1.0
-                    let remotePort = CFMessagePortCreateRemote(nil, "DatadogTestingPort" as CFString)
-                    if remotePort == nil {
+                    guard let port = self.testingPort else {
                         Log.debug("DatadogTestingPort CFMessagePortCreateRemote failed")
                         return
                     }
-                    let status = CFMessagePortSendRequest(remotePort,
+                    guard let encoded = try? JSONSerialization.data(withJSONObject: data) else {
+                        Log.debug("Json encoding failed for: \(data)")
+                        return
+                    }
+                    let timeout: CFTimeInterval = 1.0
+                    let status = CFMessagePortSendRequest(port,
                                                           DDCFMessageID.setCustomTags,
-                                                          encoded as CFData?,
+                                                          encoded as CFData,
                                                           timeout,
                                                           timeout,
                                                           nil,
@@ -349,8 +355,22 @@ internal class DDTestMonitor {
     func stopStderrCapture() {
         StderrCapture.stopCapturing()
     }
+
+    var rumPort: CFMessagePort? {
+        guard isRumActive else { return nil }
+        return CFMessagePortCreateRemote(nil, "DatadogRUMTestingPort-\(messageChannelUUID)" as CFString)
+    }
+
+    private var testingPort: CFMessagePort? {
+        CFMessagePortCreateRemote(nil, "DatadogTestingPort-\(messageChannelUUID)" as CFString)
+    }
 
     func startAttributeListener() {
+        rLock.lock()
+        defer { rLock.unlock() }
+
+        guard serverTestingPort == nil else { return }
+
         func attributeCallback(port: CFMessagePort?, msgid: Int32, data: CFData?, info: UnsafeMutableRawPointer?) -> Unmanaged<CFData>? {
             switch msgid {
                 case DDCFMessageID.setCustomTags:
@@ -373,12 +393,15 @@ internal class DDTestMonitor {
             return nil
         }
 
-        let port = CFMessagePortCreateLocal(nil, "DatadogTestingPort" as CFString, attributeCallback, nil, nil)
-        if port == nil {
+        serverTestingPort = CFMessagePortCreateLocal(
+            nil, "DatadogTestingPort-\(messageChannelUUID)" as CFString,
+            attributeCallback, nil, nil
+        )
+        guard let port = serverTestingPort else {
             Log.debug("DatadogTestingPort CFMessagePortCreateLocal failed")
             return
         }
         let runLoopSource = CFMessagePortCreateRunLoopSource(nil, port, 0)
-        CFRunLoopAddSource(CFRunLoopGetCurrent(), runLoopSource, CFRunLoopMode.commonModes)
+        CFRunLoopAddSource(CFRunLoopGetMain(), runLoopSource, CFRunLoopMode.commonModes)
     }
 }

Sources/DatadogSDKTesting/DDTracer.swift

@@ -307,12 +307,10 @@ internal class DDTracer {
     }
 
     func flush() {
-        if DDTestMonitor.instance?.isRumActive ?? false,
-           let remotePort = CFMessagePortCreateRemote(nil, "DatadogRUMTestingPort" as CFString)
-        {
+        if let rumPort = DDTestMonitor.instance?.rumPort {
             let timeout: CFTimeInterval = 10.0
             let status = CFMessagePortSendRequest(
-                remotePort,
+                rumPort,
                 DDCFMessageID.forceFlush, // Message ID for asking RUM to flush all data
                 nil,
                 timeout,
@@ -326,7 +324,7 @@ internal class DDTracer {
                 Log.debug("CFMessagePortCreateRemote request to DatadogRUMTestingPort failed")
             }
         }
-
+        
         self.tracerProviderSdk.forceFlush()
         Log.debug("Tracer flush finished")
     }
@@ -385,7 +383,7 @@ internal class DDTracer {
         EnvironmentContextPropagator().inject(spanContext: propagationContext, carrier: &headers, setter: HeaderSetter())
         if !DDTestMonitor.config.disableRUMIntegration {
             headers.merge(datadogHeaders(forContext: propagationContext)) { current, _ in current }
-            headers["CI_VISIBILITY_TEST_EXECUTION_ID"] = String(propagationContext.traceId.rawLowerLong)
+            headers[EnvironmentKey.testExecutionId.rawValue] = String(propagationContext.traceId.rawLowerLong)
         }
         return headers
     }

Sources/DatadogSDKTesting/Environment/EnvironmentKeys.swift

@@ -48,6 +48,8 @@ internal enum EnvironmentKey: String, CaseIterable {
     case testOutputFile = "TEST_OUTPUT_FILE"
     case tracerTraceId = "ENVIRONMENT_TRACER_TRACEID"
     case tracerSpanId = "ENVIRONMENT_TRACER_SPANID"
+    case messageChannelUUID = "CI_VISIBILITY_MESSAGE_CHANNEL_UUID"
+    case testExecutionId = "CI_VISIBILITY_TEST_EXECUTION_ID"
 }
 
 extension EnvironmentKey {
@@ -58,8 +60,8 @@ extension EnvironmentKey {
          .instrumentationExtraHeaders, .excludedURLs, .enableRecordPayload, disableNetworkCallStack,
          .enableNetworkCallStackSymbolicated, .disableRumIntegration, .maxPayloadSize,
          .enableCiVisibilityLogs, .enableStdoutInstrumentation, .enableStderrInstrumentation,
-         .disableSdkIosIntegration, .disableCrashHandler, .site, .endpoint, .dontExport, .traceDebug,
-         .traceDebugCallStack, .disableNTPClock]
+         .disableSdkIosIntegration, .disableCrashHandler, .disableMachCrashHandler,
+         .site, .endpoint, .dontExport, .traceDebug, .traceDebugCallStack, .disableNTPClock]
     }
 }
 

Sources/DatadogSDKTesting/Utils/XCUIApplicationSwizzler.swift

@@ -29,13 +29,15 @@ extension XCUIApplication {
     func swizzled_launch() {
         DDTestMonitor.instance?.currentTest?.setIsUITest(true)
         if let testSpanContext = DDTracer.activeSpan?.context {
-            self.launchEnvironment["ENVIRONMENT_TRACER_SPANID"] = testSpanContext.spanId.hexString
-            self.launchEnvironment["ENVIRONMENT_TRACER_TRACEID"] = testSpanContext.traceId.hexString
-            addPropagationsHeadersToEnvironment(tracer: DDTestMonitor.tracer)
-            for value in EnvironmentKey.childKeys {
-                addProcessEnvironmentToLaunch(value.rawValue)
-            }
+            self.launchEnvironment[EnvironmentKey.tracerSpanId.rawValue] = testSpanContext.spanId.hexString
+            self.launchEnvironment[EnvironmentKey.tracerTraceId.rawValue] = testSpanContext.traceId.hexString
         }
+        addPropagationsHeadersToEnvironment(tracer: DDTestMonitor.tracer)
+        for value in EnvironmentKey.childKeys {
+            addProcessEnvironmentToLaunch(value.rawValue)
+        }
+        self.launchEnvironment[EnvironmentKey.messageChannelUUID.rawValue] =
+            DDTestMonitor.instance?.messageChannelUUID
         DDTestMonitor.instance?.startAttributeListener()
         swizzled_launch()
     }

Tests/DatadogSDKTesting/DDTracerTests.swift

@@ -231,8 +231,9 @@ class DDTracerTests: XCTestCase {
         XCTAssertEqual(environmentValues[DDHeaders.traceIDField.rawValue], String(spanData.traceId.rawLowerLong))
         XCTAssertNotNil(environmentValues[DDHeaders.parentSpanIDField.rawValue])
         XCTAssertEqual(environmentValues[DDHeaders.parentSpanIDField.rawValue], String(spanData.spanId.rawValue))
-        XCTAssertNotNil(environmentValues["CI_VISIBILITY_TEST_EXECUTION_ID"])
-        XCTAssertEqual(environmentValues["CI_VISIBILITY_TEST_EXECUTION_ID"], String(spanData.traceId.rawLowerLong))
+        XCTAssertNotNil(environmentValues[EnvironmentKey.testExecutionId.rawValue])
+        XCTAssertEqual(environmentValues[EnvironmentKey.testExecutionId.rawValue],
+                       String(spanData.traceId.rawLowerLong))
 
         span.end()
     }