-
Notifications
You must be signed in to change notification settings - Fork 167
RUM-8054: Fix background session precondition for refresh and new session flows #2872
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
saraSr5
wants to merge
5
commits into
develop
Choose a base branch
from
sara.susano/RUM-8054/background-session-start-reason
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e8e81ab
RUM-8054: Fix background session precondition for refresh and new ses…
saraSr5 de6bb19
RUM-8054: Fix trailing whitespace lint violation
saraSr5 2c7165c
RUM-8054: Address review feedback
saraSr5 a18d1c5
RUM-8054: Address review feedback
saraSr5 e8cfc1e
RUM-8054: Fix background session precondition and update integration …
saraSr5 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -484,4 +484,201 @@ class RUMApplicationScopeTests: XCTestCase { | |
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .explicitStop) | ||
| } | ||
|
|
||
| func testGivenInactiveSession_whenNewOneIsStartedInBackground_itSetsBackgroundLaunchPrecondition() { | ||
| // Given | ||
| var currentTime: Date = .mockDecember15th2019At10AMUTC() | ||
| let sdkContext: DatadogContext = .mockWith(sdkInitDate: currentTime) | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| // When | ||
| currentTime.addTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .backgroundLaunch, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
|
Comment on lines
+499
to
+506
|
||
| _ = scope.process( | ||
| command: RUMCommandMock(time: currentTime, isUserInteraction: true), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .backgroundLaunch) | ||
| } | ||
|
|
||
| func testGivenExpiredSession_whenNewOneIsStartedInBackground_itSetsBackgroundLaunchPrecondition() { | ||
| // Given | ||
| let initialTime: Date = .mockDecember15th2019At10AMUTC() | ||
| var currentTime: Date = initialTime | ||
| let sdkContext: DatadogContext = .mockWith(sdkInitDate: currentTime) | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| // Keep session active without exceeding maxDuration — stop one step before it would expire | ||
| while currentTime.addingTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration - 1) < initialTime.addingTimeInterval(RUMSessionScope.Constants.sessionMaxDuration) { | ||
| currentTime.addTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration - 1) | ||
| _ = scope.process( | ||
| command: RUMCommandMock(time: currentTime, isUserInteraction: true), | ||
| context: sdkContext, | ||
| writer: writer | ||
| ) | ||
| } | ||
|
|
||
| // When - advance past maxDuration without triggering inactivity timeout, then send in background | ||
| currentTime.addTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration - 1) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .backgroundLaunch, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
| _ = scope.process( | ||
| command: RUMCommandMock(time: currentTime, isUserInteraction: true), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .backgroundLaunch) | ||
| } | ||
|
|
||
| func testGivenStoppedSession_whenNewOneIsStartedInBackground_itSetsBackgroundLaunchPrecondition() { | ||
| // Given | ||
| var currentTime: Date = .mockDecember15th2019At10AMUTC() | ||
| let sdkContext: DatadogContext = .mockWith(sdkInitDate: currentTime) | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| currentTime.addTimeInterval(1) | ||
| _ = scope.process(command: RUMStopSessionCommand(time: currentTime), context: sdkContext, writer: writer) | ||
|
|
||
| // When | ||
| currentTime.addTimeInterval(1) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .backgroundLaunch, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
| _ = scope.process( | ||
| command: RUMAddUserActionCommand.mockWith(time: currentTime), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .backgroundLaunch) | ||
| } | ||
|
|
||
| func testGivenInactiveSession_whenNewOneIsStartedInBackgroundWithPrewarming_itSetsPrewarmPrecondition() { | ||
| // Given | ||
| var currentTime: Date = .mockDecember15th2019At10AMUTC() | ||
| let sdkContext: DatadogContext = .mockWith(sdkInitDate: currentTime) | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| // When | ||
| currentTime.addTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .prewarming, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
| _ = scope.process( | ||
| command: RUMCommandMock(time: currentTime, isUserInteraction: true), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .prewarm) | ||
| } | ||
|
|
||
| func testGivenStoppedSession_whenNewOneIsStartedInBackgroundWithPrewarming_itSetsPrewarmPrecondition() { | ||
| // Given | ||
| var currentTime: Date = .mockDecember15th2019At10AMUTC() | ||
| let sdkContext: DatadogContext = .mockWith(sdkInitDate: currentTime) | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| currentTime.addTimeInterval(1) | ||
| _ = scope.process(command: RUMStopSessionCommand(time: currentTime), context: sdkContext, writer: writer) | ||
|
|
||
| // When | ||
| currentTime.addTimeInterval(1) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .prewarming, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
| _ = scope.process( | ||
| command: RUMAddUserActionCommand.mockWith(time: currentTime), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .prewarm) | ||
| } | ||
|
|
||
| func testGivenUserLaunchedApp_whenSessionTimesOutInBackground_itSetsInactivityTimeoutPrecondition() { | ||
| // Given - app launched by user, session becomes inactive | ||
| var currentTime: Date = .mockDecember15th2019At10AMUTC() | ||
| let sdkContext: DatadogContext = .mockWith( | ||
| sdkInitDate: currentTime, | ||
| launchInfo: .mockWith(launchReason: .userLaunch) | ||
| ) | ||
| let featureScope = FeatureScopeMock() | ||
| let scope = createRUMApplicationScope( | ||
| dependencies: .mockWith(featureScope: featureScope, samplingRate: 100), | ||
| sdkContext: sdkContext | ||
| ) | ||
|
|
||
| // When - session times out while app is in background | ||
| currentTime.addTimeInterval(RUMSessionScope.Constants.sessionTimeoutDuration) | ||
| let backgroundContext: DatadogContext = .mockWith( | ||
| sdkInitDate: .mockDecember15th2019At10AMUTC(), | ||
| launchInfo: .mockWith( | ||
| launchReason: .userLaunch, | ||
| processLaunchDate: .mockDecember15th2019At10AMUTC() | ||
| ), | ||
| applicationStateHistory: .mockAppInBackground(since: currentTime) | ||
| ) | ||
| _ = scope.process( | ||
| command: RUMCommandMock(time: currentTime, isUserInteraction: true), | ||
| context: backgroundContext, | ||
| writer: writer | ||
| ) | ||
|
|
||
| // Then - end-reason-based precondition is used, not backgroundLaunch | ||
| XCTAssertEqual(scope.activeSession?.context.sessionPrecondition, .inactivityTimeout) | ||
| // And no error telemetry is fired for .userLaunch in background (it is a valid scenario) | ||
| XCTAssertNil(featureScope.telemetryMock.messages.firstError()) | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above: consider using
@unknown defaulthere instead ofdefaultso newLaunchReasoncases added in the future trigger a compiler warning (see e.g.DatadogInternal/Sources/Context/AppState.swift:171).