RUMM-2507 Create an ApplicationLaunch view during session initialization

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+- [IMPROVEMENT] Always create an ApplicationLaunch view on session initialization. See [#1160][]
+
 # 1.15.0 / 23-01-2023
 
 - [BUGFIX] Fix 'Could not allocate memory' after corrupted TLV. See [#1089][] (Thanks [@cltnschlosser][])
@@ -430,6 +432,7 @@
 [#1071]: https://github.com/DataDog/dd-sdk-ios/pull/1071
 [#1089]: https://github.com/DataDog/dd-sdk-ios/pull/1089
 [#1145]: https://github.com/DataDog/dd-sdk-ios/pull/1145
+[#1160]: https://github.com/DataDog/dd-sdk-ios/pull/1160
 [@00fa9a]: https://github.com/00FA9A
 [@britton-earnin]: https://github.com/Britton-Earnin
 [@hengyu]: https://github.com/Hengyu

Sources/Datadog/RUM/RUMMonitor/RUMCommand.swift

@@ -15,19 +15,23 @@ internal protocol RUMCommand {
     /// Whether or not receiving this command should start the "Background" view if no view is active
     /// and ``Datadog.Configuration.Builder.trackBackgroundEvents(_:)`` is enabled.
     var canStartBackgroundView: Bool { get }
-    /// Whether or not receiving this command should start the "ApplicationLaunch" view if no view was yet started in current app process.
-    var canStartApplicationLaunchView: Bool { get }
     /// Whether or not this command is considered a user intaraction
     var isUserInteraction: Bool { get }
 }
 
+internal struct RUMApplicationStartCommand: RUMCommand {
+    var time: Date
+    var attributes: [AttributeKey: AttributeValue]
+    var canStartBackgroundView = false
+    var isUserInteraction = false
+}
+
 // MARK: - RUM View related commands
 
 internal struct RUMStartViewCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, it should start its own view, not the "Background"
-    let canStartApplicationLaunchView = false // no, it should start its own view, not the "ApplicationLaunch"
     let isUserInteraction = true // a new View means there was a navigation, it's considered a User interaction
 
     /// The value holding stable identity of the RUM View.
@@ -58,7 +62,6 @@ internal struct RUMStopViewCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view
-    let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view
     let isUserInteraction = false // a view can be stopped and in most cases should not be considered an interaction (if it's stopped because the user navigate inside the same app, the startView will happen shortly after this)
 
     /// The value holding stable identity of the RUM View.
@@ -69,7 +72,6 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track errors in "Background" view
-    let canStartApplicationLaunchView = true // yes, we want to track errors in "ApplicationLaunch" view
     let isUserInteraction = false // an error is not an interactive event
 
     /// The error message.
@@ -128,7 +130,6 @@ internal struct RUMAddViewTimingCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, it doesn't make sense to start "Background" view on receiving custom timing, as it will be `0ns` timing
-    let canStartApplicationLaunchView = false // no, it doesn't make sense to start "ApplicationLaunch" view on receiving custom timing, as it will be `0ns` timing
     let isUserInteraction = false // a custom view timing is not an interactive event
 
     /// The name of the timing. It will be used as a JSON key, whereas the value will be the timing duration,
@@ -159,7 +160,6 @@ internal struct RUMStartResourceCommand: RUMResourceCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track resources in "Background" view
-    let canStartApplicationLaunchView = true // yes, we want to track resources in "ApplicationLaunch" view
     let isUserInteraction = false // a resource is not an interactive event
 
     /// Resource url
@@ -177,7 +177,6 @@ internal struct RUMAddResourceMetricsCommand: RUMResourceCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
-    let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let isUserInteraction = false // an error is not an interactive event
 
     /// Resource metrics.
@@ -189,7 +188,6 @@ internal struct RUMStopResourceCommand: RUMResourceCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
-    let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let isUserInteraction = false // a resource is not an interactive event
 
     /// A type of the Resource
@@ -205,7 +203,6 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
-    let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartResourceCommand`)
     let isUserInteraction = false // a resource is not an interactive event
 
     /// The error message.
@@ -279,7 +276,6 @@ internal struct RUMStartUserActionCommand: RUMUserActionCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track actions in "Background" view (e.g. it makes sense for custom actions)
-    let canStartApplicationLaunchView = true // yes, we want to track actions in "ApplicationLaunch" view (e.g. it makes sense for custom actions)
     let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
@@ -291,7 +287,6 @@ internal struct RUMStopUserActionCommand: RUMUserActionCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartUserActionCommand`)
-    let canStartApplicationLaunchView = false // no, we don't expect receiving it without an active view (started earlier on `RUMStartUserActionCommand`)
     let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
@@ -303,7 +298,6 @@ internal struct RUMAddUserActionCommand: RUMUserActionCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we want to track actions in "Background" view (e.g. it makes sense for custom actions)
-    let canStartApplicationLaunchView = true // yes, we want to track actions in "ApplicationLaunch" view (e.g. it makes sense for custom actions)
     let isUserInteraction = true // a user action definitely is a User Interacgion
 
     let actionType: RUMUserActionType
@@ -315,7 +309,6 @@ internal struct RUMAddFeatureFlagEvaluationCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = true // yes, we don't want to miss evaluation of flags that may affect background tasks
-    let canStartApplicationLaunchView = true // yes, we don't want to miss evaluation of feature flags during application launch
     let isUserInteraction = false
     let name: String
     let value: Encodable
@@ -334,7 +327,6 @@ internal struct RUMAddLongTaskCommand: RUMCommand {
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
     let canStartBackgroundView = false // no, we don't expect receiving long tasks in "Background" view
-    let canStartApplicationLaunchView = true // yes, we want to track long tasks in "ApplicationLaunch" view (e.g. any hitches before presenting first UI)
     let isUserInteraction = false // a long task is not an interactive event
 
     let duration: TimeInterval
@@ -345,7 +337,6 @@ internal struct RUMAddLongTaskCommand: RUMCommand {
 /// RUM Events received from WebView should keep the active session alive, therefore they fire this command to do so. (ref: RUMM-1793)
 internal struct RUMKeepSessionAliveCommand: RUMCommand {
     let canStartBackgroundView = false
-    let canStartApplicationLaunchView = false
     let isUserInteraction = false
     var time: Date
     var attributes: [AttributeKey: AttributeValue]
@@ -355,7 +346,6 @@ internal struct RUMKeepSessionAliveCommand: RUMCommand {
 
 internal struct RUMUpdatePerformanceMetric: RUMCommand {
     let canStartBackgroundView = false
-    let canStartApplicationLaunchView = false
     let isUserInteraction = false
     let metric: PerformanceMetric
     let value: Double

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMApplicationScope.swift

@@ -37,7 +37,7 @@ internal class RUMApplicationScope: RUMScope, RUMContextProvider {
 
     func process(command: RUMCommand, context: DatadogContext, writer: Writer) -> Bool {
         if sessionScope == nil {
-            startInitialSession(context: context)
+            startInitialSession(on: command, context: context, writer: writer)
         }
 
         if let currentSession = sessionScope {
@@ -60,16 +60,28 @@ internal class RUMApplicationScope: RUMScope, RUMContextProvider {
         _ = refreshedSession.process(command: command, context: context, writer: writer)
     }
 
-    private func startInitialSession(context: DatadogContext) {
+    private func startInitialSession(on command: RUMCommand, context: DatadogContext, writer: Writer) {
         let initialSession = RUMSessionScope(
             isInitialSession: true,
             parent: self,
             startTime: context.sdkInitDate,
             dependencies: dependencies,
             isReplayBeingRecorded: context.srBaggage?.isReplayBeingRecorded
         )
+
         sessionScope = initialSession
         sessionScopeDidUpdate(initialSession)
+        if context.applicationStateHistory.currentSnapshot.state != .background {
+            // Immediately start the ApplicationLaunchView for the new session
+            _ = sessionScope?.process(
+                command: RUMApplicationStartCommand(
+                    time: command.time,
+                    attributes: command.attributes
+                ),
+                context: context,
+                writer: writer
+            )
+        }
     }
 
     private func sessionScopeDidUpdate(_ sessionScope: RUMSessionScope) {

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMSessionScope.swift

@@ -138,7 +138,9 @@ internal class RUMSessionScope: RUMScope, RUMContextProvider {
             return true // discard all events in this session
         }
 
-        if let startViewCommand = command as? RUMStartViewCommand {
+        if let startApplicationCommand = command as? RUMApplicationStartCommand {
+            startApplicationLaunchView(on: startApplicationCommand, context: context, writer: writer)
+        } else if let startViewCommand = command as? RUMStartViewCommand {
             // Start view scope explicitly on receiving "start view" command
             startView(on: startViewCommand, context: context)
         } else if !hasActiveView {
@@ -150,8 +152,6 @@ internal class RUMSessionScope: RUMScope, RUMContextProvider {
             )
 
             switch handlingRule {
-            case .handleInApplicationLaunchView where command.canStartApplicationLaunchView:
-                startApplicationLaunchView(on: command, context: context)
             case .handleInBackgroundView where command.canStartBackgroundView:
                 startBackgroundView(on: command, context: context)
             default:
@@ -207,20 +207,28 @@ internal class RUMSessionScope: RUMScope, RUMContextProvider {
         )
     }
 
-    private func startApplicationLaunchView(on command: RUMCommand, context: DatadogContext) {
+    private func startApplicationLaunchView(on command: RUMApplicationStartCommand, context: DatadogContext, writer: Writer) {
+        var startTime = sessionStartTime
+        if context.launchTime?.isActivePrewarm == false,
+           let processStartTime = context.launchTime?.launchDate {
+            startTime = processStartTime
+        }
+
+        let scope = RUMViewScope(
+            isInitialView: true,
+            parent: self,
+            dependencies: dependencies,
+            identity: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewURL,
+            path: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewURL,
+            name: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewName,
+            attributes: command.attributes,
+            customTimings: [:],
+            startTime: startTime,
+            serverTimeOffset: context.serverTimeOffset
+        )
+
         viewScopes.append(
-            RUMViewScope(
-                isInitialView: true,
-                parent: self,
-                dependencies: dependencies,
-                identity: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewURL,
-                path: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewURL,
-                name: RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewName,
-                attributes: command.attributes,
-                customTimings: [:],
-                startTime: sessionStartTime,
-                serverTimeOffset: context.serverTimeOffset
-            )
+            scope
         )
     }
 

Sources/Datadog/RUM/RUMMonitor/Scopes/RUMViewScope.swift

@@ -149,14 +149,25 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
         // Propagate to User Action scope
         userActionScope = userActionScope?.scope(byPropagating: command, context: context, writer: writer)
 
-        // Send "application start" action if this is the very first view tracked in the app
         let hasSentNoViewUpdatesYet = version == 0
         if isInitialView, hasSentNoViewUpdatesYet {
-            sendApplicationStartAction(context: context, writer: writer)
+            needsViewUpdate = true
         }
 
         // Apply side effects
         switch command {
+        // Application Launch
+        case let command as RUMApplicationStartCommand:
+            sendApplicationStartAction(on: command, context: context, writer: writer)
+            if !isInitialView || viewPath != RUMOffViewEventsHandlingRule.Constants.applicationLaunchViewURL {
+                DD.telemetry.error(
+                    "A RUMApplicationStartCommand got sent to a View other than the ApplicationLaunch view."
+                )
+            }
+            // Application Launch also serves as a StartView command for this view
+            didReceiveStartCommand = true
+            needsViewUpdate = true
+
         // View commands
         case let command as RUMStartViewCommand where identity.equals(command.identity):
             if didReceiveStartCommand {
@@ -326,7 +337,7 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
 
     // MARK: - Sending RUM Events
 
-    private func sendApplicationStartAction(context: DatadogContext, writer: Writer) {
+    private func sendApplicationStartAction(on command: RUMApplicationStartCommand, context: DatadogContext, writer: Writer) {
         actionsCount += 1
 
         var attributes = self.attributes
@@ -346,9 +357,9 @@ internal class RUMViewScope: RUMScope, RUMContextProvider {
             // a RUM view on `SwiftUI.View/onAppear`.
             //
             // In that case, we consider the time between the application
-            // launch and the first view start as the application loading
+            // launch and the sdkInitialization as the application loading
             // time.
-            loadingTime = viewStartTime.timeIntervalSince(launchDate).toInt64Nanoseconds
+            loadingTime = command.time.timeIntervalSince(launchDate).toInt64Nanoseconds
         }
 
         let actionEvent = RUMActionEvent(

Tests/DatadogIntegrationTests/Scenarios/CrashReporting/CrashReportingWithRUMScenarioTests.swift

@@ -54,7 +54,7 @@ class CrashReportingWithRUMScenarioTests: IntegrationTests, RUMCommonAsserts {
         let sessions = try RUMSessionMatcher.sessions(maxCount: 2, from: recordedRequests)
             .sorted { session1, session2 in
                 // Sort sessions by their "application_start" action date
-                return session1.viewVisits[0].actionEvents[0].date < session2.viewVisits[0].actionEvents[0].date
+                return session1.applicationLaunchView!.actionEvents[0].date < session2.applicationLaunchView!.actionEvents[0].date
             }
         let crashedSession = try XCTUnwrap(sessions.first)
 

Tests/DatadogIntegrationTests/Scenarios/RUM/RUMManualInstrumentationScenarioTests.swift

@@ -55,6 +55,9 @@ class RUMManualInstrumentationScenarioTests: IntegrationTests, RUMCommonAsserts
         let session = try XCTUnwrap(RUMSessionMatcher.singleSession(from: recordedRUMRequests))
         sendCIAppLog(session)
 
+        let launchView = try XCTUnwrap(session.applicationLaunchView)
+        XCTAssertEqual(launchView.actionEvents[0].action.type, .applicationStart)
+
         let view1 = session.viewVisits[0]
         XCTAssertEqual(view1.name, "SendRUMFixture1View")
         XCTAssertEqual(view1.path, "Example.SendRUMFixture1ViewController")
@@ -67,13 +70,12 @@ class RUMManualInstrumentationScenarioTests: IntegrationTests, RUMCommonAsserts
                 "Expected architecture to start with 'x86_64', 'i486' or 'arm'. Got \(architecture)"
             )
         }
-        XCTAssertEqual(view1.viewEvents.last?.view.action.count, 2)
+        XCTAssertEqual(view1.viewEvents.last?.view.action.count, 1)
         XCTAssertEqual(view1.viewEvents.last?.view.resource.count, 1)
         XCTAssertEqual(view1.viewEvents.last?.view.error.count, 1)
-        XCTAssertEqual(view1.actionEvents[0].action.type, .applicationStart)
-        XCTAssertEqual(view1.actionEvents[1].action.type, .tap)
-        XCTAssertEqual(view1.actionEvents[1].action.resource?.count, 1, "Action should track one successful Resource")
-        XCTAssertEqual(view1.actionEvents[1].action.error?.count, 1, "Action should track second Resource failure as Error")
+        XCTAssertEqual(view1.actionEvents[0].action.type, .tap)
+        XCTAssertEqual(view1.actionEvents[0].action.resource?.count, 1, "Action should track one successful Resource")
+        XCTAssertEqual(view1.actionEvents[0].action.error?.count, 1, "Action should track second Resource failure as Error")
         XCTAssertEqual(view1.resourceEvents[0].resource.url, "https://foo.com/resource/1")
         XCTAssertEqual(view1.resourceEvents[0].resource.statusCode, 200)
         XCTAssertEqual(view1.resourceEvents[0].resource.type, .image)