✨ [RUM-4052] Sanitize site parameter in configuration
#2735
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
Bundles Sizes Evolution
🚀 CPU Performance
|
nulrich
reviewed
Apr 30, 2024
| @@ -148,6 +151,11 @@ export function validateAndBuildConfiguration(initConfiguration: InitConfigurati | |||
| return | |||
| } | |||
|
|
|||
| if (initConfiguration.site && !isDatadogSite(initConfiguration.site)) { | |||
| display.error('Site should be a valid Datadog site.') | |||
There was a problem hiding this comment.
💭 thought: Should we link the the valid datadog site documentation? (i.e. https://docs.datadoghq.com/getting_started/site/)
There was a problem hiding this comment.
I have included the documentation link.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2735 +/- ##
=======================================
Coverage 93.26% 93.27%
=======================================
Files 241 241
Lines 7028 7034 +6
Branches 1553 1554 +1
=======================================
+ Hits 6555 6561 +6
Misses 473 473 ☔ View full report in Codecov by Sentry. |
acorretti
approved these changes
May 2, 2024
N-Boutaib
approved these changes
May 2, 2024
nulrich
approved these changes
May 2, 2024
thomas-lebeau
approved these changes
May 2, 2024
RomanGaignault
approved these changes
May 2, 2024
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.
Motivation
site is a Datadog-wide parameter. The current non-sanitized implementation of site config parameter offers backward compatibility when a new datacenter is created. But in the context of a browser, site has a completely different meaning and could be mistaken for “my website”.
Changes
Add a non-breaking change to only accept values meeting a pattern like:
/(datadog|ddog|datad0g|dd0g)/.This would allow to retain backward compatibility and some degree of flexibility, while adding an extra protection layer.
Testing
I have gone over the contributing documentation.