added coverage queue priority variable (#132)

Author: ypopovych

DatadogSDKTesting.xcodeproj/project.pbxproj

@@ -34,6 +34,7 @@
 		A71E64802BAB442300F2ACA5 /* ConfigTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A71E647F2BAB442300F2ACA5 /* ConfigTests.swift */; };
 		A74246002BFF94FA00F7EC64 /* ITRSkippabble.swift in Sources */ = {isa = PBXBuildFile; fileRef = A74245FF2BFF94FA00F7EC64 /* ITRSkippabble.swift */; };
 		A78557812BFE015B0031E2D8 /* SkippedTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = A78557802BFE015B0031E2D8 /* SkippedTest.swift */; };
+		A7A98C202C8F44BC00C93E59 /* CoveragePriority.swift in Sources */ = {isa = PBXBuildFile; fileRef = A7A98C1F2C8F44BC00C93E59 /* CoveragePriority.swift */; };
 		A7B39C6C2BCFC799007F98B2 /* CDatadogSDKTesting.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = A7E232DC2BC6E68B0087D8F8 /* CDatadogSDKTesting.framework */; };
 		A7B39C702BCFCD77007F98B2 /* SubprocessWait.c in Sources */ = {isa = PBXBuildFile; fileRef = A7B39C6F2BCFCD77007F98B2 /* SubprocessWait.c */; };
 		A7B39C722BCFD234007F98B2 /* SubprocessWait.h in Headers */ = {isa = PBXBuildFile; fileRef = A7B39C712BCFD234007F98B2 /* SubprocessWait.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -324,6 +325,7 @@
 		A71E647F2BAB442300F2ACA5 /* ConfigTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConfigTests.swift; sourceTree = "<group>"; };
 		A74245FF2BFF94FA00F7EC64 /* ITRSkippabble.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ITRSkippabble.swift; sourceTree = "<group>"; };
 		A78557802BFE015B0031E2D8 /* SkippedTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SkippedTest.swift; sourceTree = "<group>"; };
+		A7A98C1F2C8F44BC00C93E59 /* CoveragePriority.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CoveragePriority.swift; sourceTree = "<group>"; };
 		A7B39C6F2BCFCD77007F98B2 /* SubprocessWait.c */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.c; path = SubprocessWait.c; sourceTree = "<group>"; };
 		A7B39C712BCFD234007F98B2 /* SubprocessWait.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SubprocessWait.h; sourceTree = "<group>"; };
 		A7B4D4C02C21DC510059F39B /* TagsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TagsTests.swift; sourceTree = "<group>"; };
@@ -580,6 +582,7 @@
 			children = (
 				81EDADB2292698A200279027 /* LLVMTotalsCoverageFormat.swift */,
 				E1C8DEF4268363EC005B5411 /* DDCoverageHelper.swift */,
+				A7A98C1F2C8F44BC00C93E59 /* CoveragePriority.swift */,
 			);
 			path = Coverage;
 			sourceTree = "<group>";
@@ -1529,6 +1532,7 @@
 				A7FC25C22BA1EAF500067E26 /* IntelligentTestRunner.swift in Sources */,
 				A7CC6D862C07D624003C13BC /* Tags.swift in Sources */,
 				A74246002BFF94FA00F7EC64 /* ITRSkippabble.swift in Sources */,
+				A7A98C202C8F44BC00C93E59 /* CoveragePriority.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Sources/DatadogSDKTesting/Config.swift

@@ -43,6 +43,7 @@ final class Config {
     var coverageEnabled: Bool = true
     var itrEnabled: Bool = true
     var excludedBranches: Set<String> = []
+    var codeCoveragePriority: CodeCoveragePriority = .utility
 
     /// Datadog Endpoint
     var endpoint: Endpoint = .us1
@@ -135,6 +136,8 @@ final class Config {
             endpoint = .other(testsBaseURL: url, logsBaseURL: url)
         }
 
+        codeCoveragePriority = env[.ciVisibilityCodeCoveragePriority] ?? .utility
+        
         disableTracesExporting = env[.dontExport] ?? false
         reportHostname = env[.ciVisibilityReportHostname] ?? false
         extraDebugCallStack = env[.traceDebugCallStack] ?? false

Sources/DatadogSDKTesting/Coverage/CoveragePriority.swift

@@ -0,0 +1,33 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+
+import Foundation
+
+enum CodeCoveragePriority: Int, EnvironmentValue {
+    case background = 0
+    case utility = 1
+    case userInitiated = 2
+    case userInteractive = 3
+    
+    var qos: QualityOfService {
+        switch self {
+        case .background: return .background
+        case .utility: return .utility
+        case .userInitiated: return .userInitiated
+        case .userInteractive: return .userInteractive
+        }
+    }
+    
+    init?(configValue: String) {
+        guard let int = Int(configValue: configValue) else {
+            return nil
+        }
+        guard let priority = Self(rawValue: int) else {
+            return nil
+        }
+        self = priority
+    }
+}

Sources/DatadogSDKTesting/Coverage/DDCoverageHelper.swift

@@ -16,7 +16,7 @@ class DDCoverageHelper {
     var initialCoverageSaved: Bool
     let coverageWorkQueue: OperationQueue
 
-    init?(storagePath: Directory) {
+    init?(storagePath: Directory, priority: CodeCoveragePriority) {
         guard let profilePath = Self.profileGetFileName(), BinaryImages.profileImages.count > 0 else {
             Log.print("Coverage not properly enabled in project, check documentation")
             Log.debug("LLVM_PROFILE_FILE: \(Self.profileGetFileName() ?? "NIL")")
@@ -35,7 +35,7 @@ class DDCoverageHelper {
         Log.debug("DDCoverageHelper location: \(path.url.path)")
         initialCoverageSaved = false
         coverageWorkQueue = OperationQueue()
-        coverageWorkQueue.qualityOfService = .utility
+        coverageWorkQueue.qualityOfService = priority.qos
         coverageWorkQueue.maxConcurrentOperationCount = max(ProcessInfo.processInfo.activeProcessorCount - 1, 1)
         setFileLimit()
     }

Sources/DatadogSDKTesting/DDTestMonitor.swift

@@ -322,7 +322,8 @@ internal class DDTestMonitor {
                         coverageHelper = nil
                         return
                     }
-                    coverageHelper = DDCoverageHelper(storagePath: temp)
+                    coverageHelper = DDCoverageHelper(storagePath: temp,
+                                                      priority: DDTestMonitor.config.codeCoveragePriority)
                 } else {
                     Log.debug("Coverage Disabled")
                     coverageHelper = nil

Sources/DatadogSDKTesting/Environment/EnvironmentKeys.swift

@@ -39,6 +39,7 @@ internal enum EnvironmentKey: String, CaseIterable {
     case enableCiVisibilityLogs = "DD_CIVISIBILITY_LOGS_ENABLED"
     case enableCiVisibilityGitUpload = "DD_CIVISIBILITY_GIT_UPLOAD_ENABLED"
     case enableCiVisibilityCodeCoverage = "DD_CIVISIBILITY_CODE_COVERAGE_ENABLED"
+    case ciVisibilityCodeCoveragePriority = "DD_CIVISIBILITY_CODE_COVERAGE_PRIORITY"
     case enableCiVisibilityITR = "DD_CIVISIBILITY_ITR_ENABLED"
     case ciVisibilityExcludedBranches = "DD_CIVISIBILITY_EXCLUDED_BRANCHES"
     case ciVisibilityReportHostname = "DD_CIVISIBILITY_REPORT_HOSTNAME"
@@ -58,7 +59,7 @@ extension EnvironmentKey {
         [.isEnabled, .apiKey, .environment, .service, .sourcesDir, .tags,
          .disableTestInstrumenting, .disableNetworkInstrumentation, .disableHeadersInjection,
          .instrumentationExtraHeaders, .excludedURLs, .enableRecordPayload, disableNetworkCallStack,
-         .enableNetworkCallStackSymbolicated, .disableRumIntegration, .maxPayloadSize,
+         .enableNetworkCallStackSymbolicated, .disableRumIntegration, .maxPayloadSize, .ciVisibilityCodeCoveragePriority,
          .enableCiVisibilityLogs, .enableStdoutInstrumentation, .enableStderrInstrumentation,
          .disableSdkIosIntegration, .disableCrashHandler, .disableMachCrashHandler, .site, .customURL,
          .dontExport, .traceDebug, .traceDebugNetwork, .traceDebugCallStack, .disableNTPClock]