RUMM-1955 Multiple calls to trackDatadogEvents handled #739
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
This method removes already-added components before adding them
ncreated
requested changes
Jan 28, 2022
Comment on lines
53
to
61
| controller.addDatadogMessageHandler(allowedWebViewHosts: ["datadoghq.com"], hostsSanitizer: mockSanitizer) | ||
| (0..<5).forEach { _ in | ||
| controller.addDatadogMessageHandler(allowedWebViewHosts: ["datadoghq.com"], hostsSanitizer: mockSanitizer) | ||
| } |
There was a problem hiding this comment.
It's very unclear why we add this handler 5 times. If we want to test that "given handler already registered, when registering new handler, it removes the previous one", this should be a separate test case.
Comment on lines
85
to
91
| let userScriptsWithoutDatadog = userScripts.filter { script in | ||
| return !script.source.starts(with: jsPrefix) | ||
| } | ||
| if userScriptsWithoutDatadog.count != userScripts.count { | ||
| removeAllUserScripts() | ||
| userScriptsWithoutDatadog.forEach { addUserScript($0) } | ||
| } |
There was a problem hiding this comment.
The problem we're solving is that calling trackDatadogEvents(in:) more than once results with a crash:
controller.trackDatadogEvents(in hosts: ["foo.com"])
controller.trackDatadogEvents(in hosts: ["foo.com"]) // 🔥 crashBut this solution looks very odd and unobvious: each time the API is called we're removing all user scripts and then re-adding all but Datadog one.
Can't we just early return in this API if it was already called?
func trackDatadogEvents(in hosts: Set<String>) {
guard !isAlreadyTracked(self) else {
userLogger.warn("`trackDatadogEvents(in:)` was called more than once for the same WebView. Second call will be ignored. Make sure you call it only once.")
return
}
// ...
}
buranmert
force-pushed
the
buranmert/RUMM-1955-multiple-calls-to-trackDatadogEvents
branch
from
f5ba8bf to
c0359a9
Compare
ncreated
approved these changes
Feb 1, 2022
Tests/DatadogTests/Datadog/RUM/WebView/WKUserContentController+DatadogTests.swift
Outdated
Show resolved
Hide resolved
Co-authored-by: Maciek Grzybowski <maciek.grzybowski@datadoghq.com>
maxep
approved these changes
Feb 1, 2022
buranmert
deleted the
buranmert/RUMM-1955-multiple-calls-to-trackDatadogEvents
branch
This was referenced Feb 1, 2022
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?
If
trackDatadogEventsmethod is called multiple times, it crashes the app.The reason is that calling
WKUserContentController.add(messageHandler:, name:)multiple times with the samenamecrashes the app.How?
trackDatadogEventsmethod removes already-added components before adding them.Review checklist