RUMM-1265 Correctly handle RUM events when app in background #504
Conversation
This file contains 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
mariusc83
force-pushed
the
mconstantin/rumm-1265/support-rum-background-events
branch
2 times, most recently
from
e1367e3
to
d11bb58
Compare
ncreated
approved these changes
May 31, 2021
There was a problem hiding this comment.
Looks very good 💪! I left few convention feedbacks.
- Also, please update the PR description 🙏, especially on "how" - as we implement a very custom way of determining if the app is in background (notably, without the app's life cycle events) I think it's worth explaining it for future references.
Comment on lines
11
to
12
| static let RUM_BACKGROUND_VIEW_URL = "com/datadog/background/view" | ||
| static let RUM_BACKGROUND_VIEW_NAME = "Background" |
There was a problem hiding this comment.
✏️ We don't use capitals for defining constants in Swift. Also, in dd-sdk-ios we adopt the convention of grouping constants in Constants struct acting as a namespace:
internal class RUMViewScope: RUMScope, RUMContextProvider {
struct Constants {
static let backgroundViewURL = "com/datadog/background/view"
static let backgroundViewName = "Background"
}
// ...
}| XCTAssertEqual(scope.viewScopes[0].viewPath, RUMViewScope.RUM_BACKGROUND_VIEW_URL) | ||
| } | ||
|
|
||
| func testWhenActiveViewScope_andReceivingStartCommand_doesNotCreateNewViewScope() { |
There was a problem hiding this comment.
✏️ missing "it":
Suggested change
| func testWhenActiveViewScope_andReceivingStartCommand_doesNotCreateNewViewScope() { | |
| func testWhenActiveViewScope_andReceivingStartCommand_itDoesNotCreateNewViewScope() { |
| XCTAssertEqual(scope.viewScopes.count, 1) | ||
| } | ||
|
|
||
| func testWhenNoActiveViewScope_andReceivingNotValidStartCommand_doesNotCreateNewViewScope() { |
There was a problem hiding this comment.
✏️ missing "it":
Suggested change
| func testWhenNoActiveViewScope_andReceivingNotValidStartCommand_doesNotCreateNewViewScope() { | |
| func testWhenNoActiveViewScope_andReceivingNotValidStartCommand_itDoesNotCreateNewViewScope() { |
|
|
||
| let scope = RUMSessionScope(parent: parent, dependencies: .mockAny(), samplingRate: 100, startTime: Date()) | ||
| _ = scope.process(command: RUMStartViewCommand.mockAny()) | ||
| _ = scope.process(command: RUMAddUserActionCommand.mockWith(time: currentTime)) |
There was a problem hiding this comment.
I think we want to call generateRandomValidStartCommand() here, no?
mariusc83
force-pushed
the
mconstantin/rumm-1265/support-rum-background-events
branch
from
d11bb58
to
6459555
Compare
mariusc83
force-pushed
the
mconstantin/rumm-1265/support-rum-background-events
branch
from
6459555
to
6e9aaf8
Compare
|
💯 👌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What and why?
Currently if the application is not in foreground (there is no active View scope), any resource or action event will be ignored as there is no active
Viewon which to attach it.In this PR we are adding a change in the way we handle the received commands in the
RUMSessionScopein order to be able to record RUM events while the application is in background.How?
We are introducing the concept of
RUM background View scopewhich by definition is a normal View scope with predefinednameandurl. Once theRUMSessionScopeneeds to handle aRUMStartActionorRUMStartResourcecommand and there is no activeRUMViewScope, instead of ignoring the command as before it will automatically create a specialRUMViewScopeon which the received resource or action will be attached. For more information please check: RUM Background events RFCReview checklist