Merge pull request #285 from nachoBonafonte/make-some-concurrency-tests-clearer

Xcode 13.2 adds support to Activity framework inside Tasks, so we can use ActivityContext context management to recover active Span and Baggage, we can remove TaskLocalContextManager and all related code. We will only support task related context when using Xcode 13.2 and up

Add lots of test to ActivityContextManager so we can fully verify functionality

Author: Ignacio Bonafonte

Sources/OpenTelemetryApi/Context/ActivityContextManager.swift

@@ -16,15 +16,6 @@ private let OS_ACTIVITY_CURRENT = unsafeBitCast(dlsym(UnsafeMutableRawPointer(bi
 
 class ActivityContextManager: ContextManager {
     static let instance = ActivityContextManager()
-#if canImport(_Concurrency)
-#if swift(<5.5.2)
-    @available(macOS 12.0, iOS 15.0, tvOS 15.0, *)
-    static let taskLocalContextManager = TaskLocalContextManager.instance
-#else
-    @available(macOS 10.15, iOS 13.0, tvOS 13.0, *)
-    static let taskLocalContextManager = TaskLocalContextManager.instance
-#endif
-#endif
 
     let rlock = NSRecursiveLock()
 
@@ -33,8 +24,6 @@ class ActivityContextManager: ContextManager {
             self.scope = scope
         }
 
-        deinit {}
-
         var scope: os_activity_scope_state_s
     }
 
@@ -46,77 +35,28 @@ class ActivityContextManager: ContextManager {
         var parentIdent: os_activity_id_t = 0
         let activityIdent = os_activity_get_identifier(OS_ACTIVITY_CURRENT, &parentIdent)
         var contextValue: AnyObject?
-        if activityIdent != 0 {
-            rlock.lock()
-            guard let context = contextMap[activityIdent] ?? contextMap[parentIdent] else {
-                rlock.unlock()
-                return nil
-            }
-            contextValue = context[key.rawValue]
+        rlock.lock()
+        guard let context = contextMap[activityIdent] ?? contextMap[parentIdent] else {
             rlock.unlock()
-            return contextValue
-        } else {
-// If activityIdent == 0,  it means no active Span or we are inside an Task
-#if canImport(_Concurrency)
-#if swift(<5.5.2)
-            if #available(macOS 12.0, iOS 15.0, tvOS 15.0, *) {
-                if let contextValue = ActivityContextManager.taskLocalContextManager.getCurrentContextValue(forKey: key) {
-                    return contextValue
-                }
-            }
-#else
-            if #available(macOS 10.15, iOS 13.0, tvOS 13.0, *) {
-                if let contextValue = ActivityContextManager.taskLocalContextManager.getCurrentContextValue(forKey: key) {
-                    return contextValue
-                }
-            }
-#endif
-#endif
+            return nil
         }
-        return nil
+        contextValue = context[key.rawValue]
+        rlock.unlock()
+        return contextValue
     }
 
     func setCurrentContextValue(forKey key: OpenTelemetryContextKeys, value: AnyObject) {
         var parentIdent: os_activity_id_t = 0
         var activityIdent = os_activity_get_identifier(OS_ACTIVITY_CURRENT, &parentIdent)
-        if activityIdent != 0 {
-            // We are inside an activity, it can be an activity created by us for a span context or another independent activty
-            // We are surely not inside a Task
-            rlock.lock()
-            if contextMap[activityIdent] == nil || contextMap[activityIdent]?[key.rawValue] != nil {
-                var scope: os_activity_scope_state_s
-                (activityIdent, scope) = createActivityContext()
-                contextMap[activityIdent] = [String: AnyObject]()
-                objectScope.setObject(ScopeElement(scope: scope), forKey: value)
-            }
-            contextMap[activityIdent]?[key.rawValue] = value
-            rlock.unlock()
-        } else {
+        rlock.lock()
+        if contextMap[activityIdent] == nil || contextMap[activityIdent]?[key.rawValue] != nil {
             var scope: os_activity_scope_state_s
             (activityIdent, scope) = createActivityContext()
-            if activityIdent == 0 {
-// If activityIdent == 0, means we are inside a Task, because we cannot create an activity, set the context inside the task
-#if canImport(_Concurrency)
-#if swift(<5.5.2)
-                if #available(macOS 12.0, iOS 15.0, tvOS 15.0, *) {
-                    ActivityContextManager.taskLocalContextManager.setCurrentContextValue(forKey: key, value: value)
-                }
-#else
-                if #available(macOS 10.15, iOS 13.0, tvOS 13.0, *) {
-                    ActivityContextManager.taskLocalContextManager.setCurrentContextValue(forKey: key, value: value)
-                }
-
-#endif
-#endif
-            } else {
-                // We could create the activity so we store the context in the activity map
-                rlock.lock()
-                contextMap[activityIdent] = [String: AnyObject]()
-                objectScope.setObject(ScopeElement(scope: scope), forKey: value)
-                contextMap[activityIdent]?[key.rawValue] = value
-                rlock.unlock()
-            }
+            contextMap[activityIdent] = [String: AnyObject]()
+            objectScope.setObject(ScopeElement(scope: scope), forKey: value)
         }
+        contextMap[activityIdent]?[key.rawValue] = value
+        rlock.unlock()
     }
 
     func createActivityContext() -> (os_activity_id_t, os_activity_scope_state_s) {
@@ -133,26 +73,6 @@ class ActivityContextManager: ContextManager {
             var scope = scope.scope
             os_activity_scope_leave(&scope)
             objectScope.removeObject(forKey: value)
-        } else {
-#if canImport(_Concurrency)
-#if swift(<5.5.2)
-            if #available(macOS 12.0, iOS 15.0, tvOS 15.0, *) {
-                // If there is a parent activity, set its content as the task local
-                ActivityContextManager.taskLocalContextManager.removeContextValue(forKey: key, value: value)
-                if let currentContext = self.getCurrentContextValue(forKey: key) {
-                    ActivityContextManager.taskLocalContextManager.setCurrentContextValue(forKey: key, value: currentContext)
-                }
-            }
-#else
-            // If there is a parent activity, set its content as the task local
-            if #available(macOS 10.15, iOS 13.0, tvOS 13.0, *) {
-                ActivityContextManager.taskLocalContextManager.removeContextValue(forKey: key, value: value)
-                if let currentContext = self.getCurrentContextValue(forKey: key) {
-                    ActivityContextManager.taskLocalContextManager.setCurrentContextValue(forKey: key, value: currentContext)
-                }
-            }
-#endif
-#endif
         }
     }
 }

Sources/OpenTelemetryApi/Context/TaskLocalContextManager.swift

@@ -10,24 +10,19 @@ class PropagatedSpanBuilder: SpanBuilder {
     private var tracer: Tracer
     private var isRootSpan: Bool = false
     private var spanContext: SpanContext?
-    private var spanName: String
 
-
-    init(tracer: Tracer, spanName: String = "") {
+    init(tracer: Tracer, spanName: String) {
         self.tracer = tracer
-        self.spanName = spanName
     }
 
     @discardableResult public func startSpan() -> Span {
         if spanContext == nil, !isRootSpan {
             spanContext = OpenTelemetry.instance.contextProvider.activeSpan?.context
         }
-        let span =  PropagatedSpan(context: spanContext ?? SpanContext.create(traceId: TraceId.random(),
+        return PropagatedSpan(context: spanContext ?? SpanContext.create(traceId: TraceId.random(),
                                                                          spanId: SpanId.random(),
                                                                          traceFlags: TraceFlags(),
                                                                          traceState: TraceState()))
-        span.name = spanName
-        return span
     }
 
     @discardableResult public func setParent(_ parent: Span) -> Self {