Add Tracking Consent feature

Datadog/Datadog.xcodeproj/xcshareddata/xcschemes/Example.xcscheme

@@ -101,6 +101,16 @@
             value = "RUMResourcesScenario"
             isEnabled = "NO">
          </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "DD_TEST_SCENARIO_IDENTIFIER"
+            value = "TrackingConsentStartPendingScenario"
+            isEnabled = "NO">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "DD_TEST_SCENARIO_IDENTIFIER"
+            value = "TrackingConsentStartGrantedScenario"
+            isEnabled = "NO">
+         </EnvironmentVariable>
       </EnvironmentVariables>
    </LaunchAction>
    <ProfileAction

Datadog/Example/AppConfiguration.swift

@@ -8,6 +8,9 @@ import UIKit
 import Datadog
 
 protocol AppConfiguration {
+    /// The tracking consent value applied when initializing the SDK.
+    var initialTrackingConsent: TrackingConsent { get }
+
     /// Datadog SDK configuration for given app configuration.
     func sdkConfiguration() -> Datadog.Configuration
 
@@ -23,6 +26,8 @@ struct ExampleAppConfiguration: AppConfiguration {
     let serviceName = "ios-sdk-example-app"
     let testScenario = Environment.testScenario()
 
+    let initialTrackingConsent: TrackingConsent = .granted
+
     func sdkConfiguration() -> Datadog.Configuration {
         let configuration = Datadog.Configuration
             .builderUsing(
@@ -52,9 +57,17 @@ struct ExampleAppConfiguration: AppConfiguration {
 struct UITestsAppConfiguration: AppConfiguration {
     let testScenario = Environment.testScenario()
 
-    func sdkConfiguration() -> Datadog.Configuration {
-        deletePersistedSDKData()
+    init() {
+        if Environment.shouldClearPersistentData() {
+            deletePersistedSDKData()
+        }
+    }
+
+    var initialTrackingConsent: TrackingConsent {
+        return testScenario!.initialTrackingConsent
+    }
 
+    func sdkConfiguration() -> Datadog.Configuration {
         let configuration = Datadog.Configuration
             .builderUsing(
                 rumApplicationID: "rum-application-id",

Datadog/Example/Environment.swift

@@ -40,8 +40,9 @@ internal struct Environment {
         static let serverMockConfiguration = "DD_TEST_SERVER_MOCK_CONFIGURATION"
     }
     struct Argument {
-        static let isRunningUnitTests   = "IS_RUNNING_UNIT_TESTS"
-        static let isRunningUITests     = "IS_RUNNING_UI_TESTS"
+        static let isRunningUnitTests       = "IS_RUNNING_UNIT_TESTS"
+        static let isRunningUITests         = "IS_RUNNING_UI_TESTS"
+        static let doNotClearPersistentData = "DO_NOT_CLEAR_PERSISTENT_DATA"
     }
     struct InfoPlistKey {
         static let clientToken      = "DatadogClientToken"
@@ -58,6 +59,10 @@ internal struct Environment {
         return ProcessInfo.processInfo.arguments.contains(Argument.isRunningUITests)
     }
 
+    static func shouldClearPersistentData() -> Bool {
+        return !ProcessInfo.processInfo.arguments.contains(Argument.doNotClearPersistentData)
+    }
+
     // MARK: - Launch Variables
 
     static func testScenario() -> TestScenario? {

Datadog/Example/ExampleAppDelegate.swift

@@ -29,6 +29,7 @@ class ExampleAppDelegate: UIResponder, UIApplicationDelegate {
         // Initialize Datadog SDK
         Datadog.initialize(
             appContext: .init(),
+            trackingConsent: appConfiguration.initialTrackingConsent,
             configuration: appConfiguration.sdkConfiguration()
         )
 

Datadog/Example/Scenarios/Logging/LoggingScenarios.swift

@@ -0,0 +1,16 @@
+/*
+ * 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 2019-2020 Datadog, Inc.
+ */
+
+import Datadog
+
+let allLoggingScenarios: [TestScenario.Type] = [
+    LoggingManualInstrumentationScenario.self,
+]
+
+/// Scenario which starts a view controller that sends bunch of logs to the server.
+struct LoggingManualInstrumentationScenario: TestScenario {
+    static let storyboardName = "LoggingManualInstrumentationScenario"
+}

Datadog/Example/Scenarios/Logging/LoggingScenario.storyboard → Datadog/Example/Scenarios/Logging/ManualInstrumentation/LoggingManualInstrumentationScenario.storyboard

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="16097.2" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="Jlq-WO-Qzl">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="17156" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="Jlq-WO-Qzl">
     <device id="retina6_1" orientation="portrait" appearance="light"/>
     <dependencies>
         <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="16087"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="17125"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
+        <capability name="System colors in document resources" minToolsVersion="11.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <scenes>
@@ -24,12 +25,12 @@
                                 <nil key="highlightedColor"/>
                             </label>
                         </subviews>
-                        <color key="backgroundColor" systemColor="systemBackgroundColor" cocoaTouchSystemColor="whiteColor"/>
+                        <viewLayoutGuide key="safeArea" id="gNT-5l-zGn"/>
+                        <color key="backgroundColor" systemColor="systemBackgroundColor"/>
                         <constraints>
                             <constraint firstItem="4yI-pe-L5M" firstAttribute="centerX" secondItem="cdr-c3-9K3" secondAttribute="centerX" id="Tqb-5A-Dxp"/>
                             <constraint firstItem="4yI-pe-L5M" firstAttribute="centerY" secondItem="cdr-c3-9K3" secondAttribute="centerY" id="rot-Hg-hZg"/>
                         </constraints>
-                        <viewLayoutGuide key="safeArea" id="gNT-5l-zGn"/>
                     </view>
                     <navigationItem key="navigationItem" id="gZZ-Us-17W"/>
                 </viewController>
@@ -38,4 +39,9 @@
             <point key="canvasLocation" x="-1386" y="1233"/>
         </scene>
     </scenes>
+    <resources>
+        <systemColor name="systemBackgroundColor">
+            <color white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
+        </systemColor>
+    </resources>
 </document>

Datadog/Example/Scenarios/RUM/RUMScenarios.swift

@@ -0,0 +1,145 @@
+/*
+ * 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 2019-2020 Datadog, Inc.
+ */
+
+import UIKit
+import Datadog
+
+let allRUMScenarios: [TestScenario.Type] = [
+    RUMManualInstrumentationScenario.self,
+    RUMNavigationControllerScenario.self,
+    RUMTabBarAutoInstrumentationScenario.self,
+    RUMModalViewsAutoInstrumentationScenario.self,
+    RUMTapActionScenario.self,
+    RUMResourcesScenario.self,
+]
+
+/// Scenario which starts a navigation controller. Each view controller pushed to this navigation
+/// uses the RUM manual instrumentation API to send RUM events to the server.
+struct RUMManualInstrumentationScenario: TestScenario {
+    static let storyboardName = "RUMManualInstrumentationScenario"
+}
+
+/// Scenario which starts a navigation controller and runs through 4 different view controllers by navigating
+/// back and forth. Tracks view controllers as RUM Views.
+struct RUMNavigationControllerScenario: TestScenario {
+    static let storyboardName = "RUMNavigationControllerScenario"
+
+    private class Predicate: UIKitRUMViewsPredicate {
+        func rumView(for viewController: UIViewController) -> RUMView? {
+            switch viewController.accessibilityLabel {
+            case "Screen 1":
+                return .init(path: "Screen1")
+            case "Screen 2":
+                return .init(path: "Screen2")
+            case "Screen 3":
+                return .init(path: "Screen3")
+            case "Screen 4":
+                return .init(path: "Screen4")
+            default:
+                return nil
+            }
+        }
+    }
+
+    func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .trackUIKitRUMViews(using: Predicate())
+            .enableLogging(false)
+            .enableTracing(false)
+    }
+}
+
+/// Scenario which presents `UITabBarController`-based hierarchy and navigates through
+/// its view controllers. Tracks view controllers as RUM Views.
+struct RUMTabBarAutoInstrumentationScenario: TestScenario {
+    static var storyboardName: String = "RUMTabBarAutoInstrumentationScenario"
+
+    private class Predicate: UIKitRUMViewsPredicate {
+        func rumView(for viewController: UIViewController) -> RUMView? {
+            if let viewName = viewController.accessibilityLabel {
+                return .init(path: viewName)
+            } else {
+                return nil
+            }
+        }
+    }
+
+    func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .trackUIKitRUMViews(using: Predicate())
+            .enableLogging(false)
+            .enableTracing(false)
+    }
+}
+
+/// Scenario based on `UINavigationController` hierarchy, which presents different VCs modally.
+/// Tracks view controllers as RUM Views.
+struct RUMModalViewsAutoInstrumentationScenario: TestScenario {
+    static var storyboardName: String = "RUMModalViewsAutoInstrumentationScenario"
+
+    private class Predicate: UIKitRUMViewsPredicate {
+        func rumView(for viewController: UIViewController) -> RUMView? {
+            if let viewName = viewController.accessibilityLabel {
+                return .init(path: viewName)
+            } else {
+                return nil
+            }
+        }
+    }
+
+    func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .trackUIKitRUMViews(using: Predicate())
+            .enableLogging(false)
+            .enableTracing(false)
+    }
+}
+
+/// Scenario which interacts with various interactive elements laid between different view controllers,
+/// including `UITableViewController` and `UICollectionViewController`. Tapped views
+/// and controls are tracked as RUM Actions.
+struct RUMTapActionScenario: TestScenario {
+    static var storyboardName: String = "RUMTapActionScenario"
+
+    private class Predicate: UIKitRUMViewsPredicate {
+        func rumView(for viewController: UIViewController) -> RUMView? {
+            switch NSStringFromClass(type(of: viewController)) {
+            case "Example.RUMTASScreen1ViewController":
+                return .init(path: "MenuViewController")
+            case "Example.RUMTASTableViewController":
+                return .init(path: "TableViewController")
+            case "Example.RUMTASCollectionViewController":
+                return .init(path: "CollectionViewController")
+            case "Example.RUMTASVariousUIControllsViewController":
+                return .init(path: "UIControlsViewController")
+            default:
+                return nil
+            }
+        }
+    }
+
+    func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .trackUIKitRUMViews(using: Predicate())
+            .trackUIKitActions(true)
+            .enableLogging(false)
+            .enableTracing(false)
+    }
+}
+
+/// Scenario which uses RUM and Tracing auto instrumentation features to track bunch of network requests
+/// sent with `URLSession` from two VCs. The first VC calls first party resources, the second one calls third parties.
+final class RUMResourcesScenario: URLSessionBaseScenario, TestScenario {
+    static let storyboardName = "URLSessionScenario"
+    static func envIdentifier() -> String { "RUMResourcesScenario" }
+
+    override func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .trackUIKitRUMViews(using: DefaultUIKitRUMViewsPredicate())
+
+        super.configureSDK(builder: builder) // applies the `track(firstPartyHosts:)`
+    }
+}

Datadog/Example/Scenarios/TestScenarios.swift

@@ -0,0 +1,49 @@
+/*
+ * 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 2019-2020 Datadog, Inc.
+ */
+
+import Datadog
+
+protocol TestScenario {
+    /// The name of the storyboard containing this scenario.
+    static var storyboardName: String { get }
+
+    /// An identifier for this scenario used to pass its reference in environment variable.
+    /// Defaults to `storyboardName`.
+    static func envIdentifier() -> String
+
+    /// The value of initial tracking consent for this scenario.
+    /// Defaults to `.granted`
+    var initialTrackingConsent: TrackingConsent { get }
+
+    /// Applies additional SDK configuration for running this scenario.
+    /// Defaults to no-op.
+    func configureSDK(builder: Datadog.Configuration.Builder)
+
+    init()
+}
+
+/// Defaults.
+extension TestScenario {
+    static func envIdentifier() -> String { storyboardName }
+    var initialTrackingConsent: TrackingConsent { .granted }
+    func configureSDK(builder: Datadog.Configuration.Builder) { /* no-op */ }
+}
+
+/// Returns `TestScenario` for given env identifier.
+func createTestScenario(for envIdentifier: String) -> TestScenario {
+    let allScenarios = allLoggingScenarios
+        + allTracingScenarios
+        + allRUMScenarios
+        + allTrackingConsentScenarios
+
+    let scenarioClass = allScenarios.first { $0.envIdentifier() == envIdentifier }
+
+    guard let scenario = scenarioClass?.init() else {
+        fatalError("Cannot find `TestScenario` for `envIdentifier`: \(envIdentifier)")
+    }
+
+    return scenario
+}

Datadog/Example/Scenarios/Tracing/TracingScenarios.swift

@@ -0,0 +1,48 @@
+/*
+ * 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 2019-2020 Datadog, Inc.
+ */
+
+import Datadog
+
+let allTracingScenarios: [TestScenario.Type] = [
+    TracingManualInstrumentationScenario.self,
+    TracingURLSessionScenario.self,
+    TracingNSURLSessionScenario.self,
+]
+
+/// Scenario which starts a view controller that sends bunch of spans using manual API of `Tracer`.
+/// It also uses the `span.log()` to send logs.
+struct TracingManualInstrumentationScenario: TestScenario {
+    static let storyboardName = "TracingManualInstrumentationScenario"
+}
+
+/// Scenario which uses Tracing auto instrumentation feature to track bunch of first party network requests
+/// sent with `URLSession` (Swift) from the first VC and ignores other third party requests send from second VC.
+final class TracingURLSessionScenario: URLSessionBaseScenario, TestScenario {
+    static let storyboardName = "URLSessionScenario"
+    static func envIdentifier() -> String { "TracingURLSessionScenario" }
+
+    override func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .enableRUM(false)
+
+        super.configureSDK(builder: builder)
+    }
+}
+
+/// Scenario which uses Tracing auto instrumentation feature to track bunch of first party network requests
+/// sent with `NSURLSession` (Objective-C) from the first VC and ignores other third party requests send from second VC.
+@objc
+final class TracingNSURLSessionScenario: URLSessionBaseScenario, TestScenario {
+    static let storyboardName = "NSURLSessionScenario"
+    static func envIdentifier() -> String { "TracingNSURLSessionScenario" }
+
+    override func configureSDK(builder: Datadog.Configuration.Builder) {
+        _ = builder
+            .enableRUM(false)
+
+        super.configureSDK(builder: builder)
+    }
+}