💥 [RUMF-1473] Ignore untrusted event #2308

amortemousque · 2023-06-27T14:58:40Z

Motivation

Untrusted events (event.isTrusted: false) are arbitrarily crafted by the application: some properties expected by the SDK might be missing or might not reflect legitimate data. Therefore untrusted event are now ignored.

It's important to note that:

some data may not be collected anymore, some behaviour may not be taken into account
for untrusted event to be collected by the browser SDK, add event.__ddIsTrusted: true

Changes

Ignore untrusted events

Testing

Local
Staging
Unit
End to end

I have gone over the contributing documentation.

codecov-commenter · 2023-06-29T10:03:01Z

Codecov Report

Merging #2308 (6f042de) into prerelease-v5 (ec62075) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@                Coverage Diff                @@
##           prerelease-v5    #2308      +/-   ##
=================================================
+ Coverage          94.18%   94.27%   +0.08%     
=================================================
  Files                206      206              
  Lines               6038     6074      +36     
  Branches            1318     1318              
=================================================
+ Hits                5687     5726      +39     
+ Misses               351      348       -3

Impacted Files	Coverage Δ
packages/core/src/browser/addEventListener.ts	`100.00% <100.00%> (ø)`
packages/core/src/tools/getGlobalObject.ts	`20.00% <100.00%> (ø)`
packages/core/src/tools/timer.ts	`100.00% <100.00%> (ø)`
packages/core/test/emulate/createNewEvent.ts	`81.81% <100.00%> (+1.81%)`	⬆️
packages/core/test/emulate/stubReportApis.ts	`93.75% <100.00%> (ø)`
packages/core/test/requests.ts	`93.71% <100.00%> (ø)`
...s/rum-core/src/domain/contexts/pageStateHistory.ts	`100.00% <100.00%> (+6.52%)`	⬆️
packages/rum/test/mockWorker.ts	`98.59% <100.00%> (+0.02%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

packages/core/src/browser/addEventListener.spec.ts

packages/rum-core/src/domain/contexts/foregroundContexts.ts

test/e2e/lib/framework/pageSetups.ts

test/e2e/scenario/recorder/viewports.scenario.ts

packages/rum/test/mockWorker.ts

packages/core/src/browser/addEventListener.ts

bcaudan · 2023-07-03T13:16:45Z

packages/core/src/browser/addEventListener.spec.ts

+      const eventTarget = document.createElement('div')
+      addEventListener(eventTarget, DOM_EVENT.CLICK, listener)
+
+      const event = createNewEvent(DOM_EVENT.CLICK, { __ddIsTrusted: undefined })


💬 suggestion: ‏

Suggested change

const event = createNewEvent(DOM_EVENT.CLICK, { __ddIsTrusted: undefined })

const event = createNewEvent(DOM_EVENT.CLICK)

or is it needed for some reason?

Yes it is because by default createNewEvent set __ddIsTrusted to true

…nto staging-27 pm_trace_id: 17523917 feature_branch_pipeline_id: 17523917 source: to-staging * commit '11385ba83689c56a29da7f94922036d5a5a4487c': fix v5.0.0-alpha.0 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

pm_trace_id: 18017467 feature_branch_pipeline_id: 18017467 source: to-staging * commit '5bc99408ea1dffffedaf9e13facb23f14c1f0c0f': v5.0.0-alpha.0 (#2321) 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

…to staging-30 pm_trace_id: 18134140 feature_branch_pipeline_id: 18134140 source: to-staging * commit '0a071035d316ab4a89e7ce06c7e0182e51dd0ef3': v5.0.0-alpha.0 (#2321) 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

pm_trace_id: 20186620 feature_branch_pipeline_id: 20186620 source: to-staging * commit 'f69f12e544b6325b6a4977a2ffb9d66e8dd8a394': 👷 fix merge ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347) 💥 [RUMF-1597] Drop `plan` and send `sampled_for_replay` (#2293) v5.0.0-alpha.0 (#2321) 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

pm_trace_id: 20829111 feature_branch_pipeline_id: 20829111 source: to-staging * commit '4196b47176ab4153b6dd6c64661272f3f299b9fc': Update lock file 👷 fix merge ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347) 💥 [RUMF-1597] Drop `plan` and send `sampled_for_replay` (#2293) v5.0.0-alpha.0 (#2321) 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

pm_trace_id: 21159925 feature_branch_pipeline_id: 21159925 source: to-staging * commit '1a45207eb54828a9ae04a48d773416ec3d6d7e38': 🐛 bridge action e2e: wait for click chain timeout (#2460) v4.50.1 (#2459) ✨ [RUM-1210] Add W3C tracecontext to default propagator types (#2443) Update lock file 👷 fix merge ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347) 💥 [RUMF-1597] Drop `plan` and send `sampled_for_replay` (#2293) v5.0.0-alpha.0 (#2321) 💥 [RUMF-1577] Stop collecting foreground periods (#2311) 💥 [RUMF-1473] Ignore untrusted event (#2308) 💥[RUMF-1564] remove intake subdomains (#2309) 💥 beforeSend domain context: use PerformanceEntry (#2300) 💥 Typings: consistent beforeSend return type (#2303) 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) 💥[RUMF-1228] Remove console error message prefix (#2289) 💥 [RUMF-1555] Rework logger context APIs (#2285) 💥[RUMF-1152] sanitize resource method names (#2288) 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) 💥 [RUMF-1555] Remove `event` in action domain context (#2286) ♻️ Remove deprecated context manager APIs (#2284) 💥 [RUMF-1589] automatically start recording (#2275) 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) 💥 [RUMF-1588] Update default session replay behaviour (#2257) 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) 💥[RUMF-1554] Drop some deprecated config parameters (#2238) 💥 Promote track frustration as default action behaviour (#2232)

* 💥 Promote track frustration as default action behaviour (#2232) * 💥[RUMF-1554] Drop some deprecated config parameters (#2238) * 💥 drop proxyUrl * 💥 drop sampleRate * 💥 drop allowedTracingOrigins * 💥 drop tracingSampleRate * 💥 drop trackInteractions * 👌 typo Co-authored-by: Yannick Adam <[email protected]> * 👌remove outdated comment --------- Co-authored-by: Yannick Adam <[email protected]> * 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) * 💥 Drop removeUser * 💥 Drop (Rum|Logger)GlobalContext APIs * 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) * 🔥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` * 👌 wording Co-authored-by: Aymeric <[email protected]> * 👌use trackResources/LongTasks directly from configuration * 👌remove useless config copy --------- Co-authored-by: Aymeric <[email protected]> * 💥 [RUMF-1588] Update default session replay behaviour (#2257) * 💥 update default sessionReplaySampleRate * 💥 update default defaultPrivacyLevel * tweak obfuscation scenarios * 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) * 💥 [RUMF-1589] automatically start recording (#2275) * ♻️ buffer start/stop recorder API calls before init * ✨add option to opt out of automatic recording * 💥automatically start recording by default * ♻️ cleanup scenarios using replay * 👌fix test description * ♻️ Remove deprecated context manager APIs (#2284) * 💥 [RUMF-1555] Remove `event` in action domain context (#2286) * 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) * 💥[RUMF-1152] sanitize resource method names (#2288) * 💥 [RUMF-1555] Rework logger context APIs (#2285) * 💥[RUMF-1228] Remove console error message prefix (#2289) * 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) * Improve types * Remove error.origin * 👌add test for all statuses/apis * 👌remove console override * 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) * 💥 add main logger context only to main logger logs * 💥 apply main logger level only to main logger logs * ♻️ merge logger context with message context in logger collection * 💥 Typings: consistent beforeSend return type (#2303) * 💥 beforeSend domain context: use PerformanceEntry (#2300) * 💥[RUMF-1564] remove intake subdomains (#2309) * 💥 [RUMF-1473] Ignore untrusted event (#2308) * 💥 [RUMF-1577] Stop collecting foreground periods (#2311) * v5.0.0-alpha.0 (#2321) * 💥 [RUMF-1597] Drop `plan` and send `sampled_for_replay` (#2293) * 🔥remove session plan * ✨send `session.sampled_for_replay` * 👷update sandbox no need to start replay anymore * ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347) * ♻️ remove track(Resources|LongTasks) from core configuration * ✨add allowUntrustedEvents config param * ✨addEventListener: take configuration.allowUntrustedEvents into account * ♻️ propagate signature change * update rum-events-format * 👷 fix merge * Update lock file * ✨ [RUM-1210] Add W3C tracecontext to default propagator types (#2443) * Ensure both Datadog and Tracecontext headers are present by default * 🐛 bridge action e2e: wait for click chain timeout (#2460) consistent failure on this test on firefox since the action behaviour update --------- Co-authored-by: Yannick Adam <[email protected]> Co-authored-by: Aymeric <[email protected]> Co-authored-by: Aymeric <[email protected]>

* 💥 Promote track frustration as default action behaviour (#2232) * 💥[RUMF-1554] Drop some deprecated config parameters (#2238) * 💥 drop proxyUrl * 💥 drop sampleRate * 💥 drop allowedTracingOrigins * 💥 drop tracingSampleRate * 💥 drop trackInteractions * 👌 typo Co-authored-by: Yannick Adam <[email protected]> * 👌remove outdated comment --------- Co-authored-by: Yannick Adam <[email protected]> * 💥 [RUMF-1554] Drop some deprecated public APIs (#2241) * 💥 Drop removeUser * 💥 Drop (Rum|Logger)GlobalContext APIs * 💥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` (#2256) * 🔥 [RUMF-1587] Remove `premiumSampleRate` and `replaySampleRate` * 👌 wording Co-authored-by: Aymeric <[email protected]> * 👌use trackResources/LongTasks directly from configuration * 👌remove useless config copy --------- Co-authored-by: Aymeric <[email protected]> * 💥 [RUMF-1588] Update default session replay behaviour (#2257) * 💥 update default sessionReplaySampleRate * 💥 update default defaultPrivacyLevel * tweak obfuscation scenarios * 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271) * 💥 [RUMF-1589] automatically start recording (#2275) * ♻️ buffer start/stop recorder API calls before init * ✨add option to opt out of automatic recording * 💥automatically start recording by default * ♻️ cleanup scenarios using replay * 👌fix test description * ♻️ Remove deprecated context manager APIs (#2284) * 💥 [RUMF-1555] Remove `event` in action domain context (#2286) * 🔥 [RUMF-1555] Remove `startTime` in xhr start context (#2287) * 💥[RUMF-1152] sanitize resource method names (#2288) * 💥 [RUMF-1555] Rework logger context APIs (#2285) * 💥[RUMF-1228] Remove console error message prefix (#2289) * 💥[RUMF-1229] Logs: remove `error.origin` attribute (#2294) * Improve types * Remove error.origin * 👌add test for all statuses/apis * 👌remove console override * 💥[RUMF-1230] Only apply main logger configuration to its own logs (#2298) * 💥 add main logger context only to main logger logs * 💥 apply main logger level only to main logger logs * ♻️ merge logger context with message context in logger collection * 💥 Typings: consistent beforeSend return type (#2303) * 💥 beforeSend domain context: use PerformanceEntry (#2300) * 💥[RUMF-1564] remove intake subdomains (#2309) * 💥 [RUMF-1473] Ignore untrusted event (#2308) * 💥 [RUMF-1577] Stop collecting foreground periods (#2311) * v5.0.0-alpha.0 (#2321) * 💥 [RUMF-1597] Drop `plan` and send `sampled_for_replay` (#2293) * 🔥remove session plan * ✨send `session.sampled_for_replay` * 👷update sandbox no need to start replay anymore * ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347) * ♻️ remove track(Resources|LongTasks) from core configuration * ✨add allowUntrustedEvents config param * ✨addEventListener: take configuration.allowUntrustedEvents into account * ♻️ propagate signature change * update rum-events-format * 👷 fix merge * Update lock file * ✨ [RUM-1210] Add W3C tracecontext to default propagator types (#2443) * Ensure both Datadog and Tracecontext headers are present by default * Update READMEs for v5 --------- Co-authored-by: Yannick Adam <[email protected]> Co-authored-by: Aymeric <[email protected]> Co-authored-by: Aymeric <[email protected]>

amortemousque changed the title ~~Ignore untrusted event~~ 🐛 [RUMF-1473] Ignore untrusted event Jun 27, 2023

amortemousque added 5 commits June 29, 2023 11:02

Ignore untrusted event in addEventListeners

77c5b20

Remove unnecessary isTrusted checks

ae2e3ae

Add ddIsTrusted to createNewEvent test helper

cb6bb58

Update unit tests to use createNewEvent()

6ed59f6

Add ddIsTrusted to all e2e events

c1ae25d

amortemousque force-pushed the aymeric/v5-ignore-untrusted-event branch from 1b70723 to c1ae25d Compare June 29, 2023 09:15

Merge branch 'prerelease-v5' into aymeric/v5-ignore-untrusted-event

a0847f4

amortemousque force-pushed the aymeric/v5-ignore-untrusted-event branch from 8bbb267 to a0847f4 Compare June 29, 2023 09:21

amortemousque marked this pull request as ready for review June 29, 2023 09:23

amortemousque requested review from a team as code owners June 29, 2023 09:23

Fix typecheck with node

6b61943

bcaudan reviewed Jun 30, 2023

View reviewed changes

BenoitZugmeyer reviewed Jun 30, 2023

View reviewed changes

packages/rum/test/mockWorker.ts Show resolved Hide resolved

amortemousque changed the title ~~🐛 [RUMF-1473] Ignore untrusted event~~ 💥 [RUMF-1473] Ignore untrusted event Jun 30, 2023

Fix e2e test

53ed383

amortemousque force-pushed the aymeric/v5-ignore-untrusted-event branch from 6562f01 to 53ed383 Compare June 30, 2023 10:18

BenoitZugmeyer approved these changes Jun 30, 2023

View reviewed changes

bcaudan reviewed Jul 3, 2023

View reviewed changes

packages/core/src/browser/addEventListener.ts Outdated Show resolved Hide resolved

Add test if __ddIsTrusted is absent

6f042de

amortemousque force-pushed the aymeric/v5-ignore-untrusted-event branch from 5a8256a to 6f042de Compare July 3, 2023 09:00

Fix test

466ced3

bcaudan approved these changes Jul 3, 2023

View reviewed changes

amortemousque merged commit 682d40b into prerelease-v5 Jul 3, 2023

amortemousque deleted the aymeric/v5-ignore-untrusted-event branch July 3, 2023 13:40

bcaudan mentioned this pull request Jul 27, 2023

♻️ Cherry-pick some changes from v5 to limit conflicts #2357

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

💥 [RUMF-1473] Ignore untrusted event #2308

💥 [RUMF-1473] Ignore untrusted event #2308

amortemousque commented Jun 27, 2023 •

edited

Loading

codecov-commenter commented Jun 29, 2023 •

edited

Loading

bcaudan Jul 3, 2023

amortemousque Jul 3, 2023

	const event = createNewEvent(DOM_EVENT.CLICK, { __ddIsTrusted: undefined })
	const event = createNewEvent(DOM_EVENT.CLICK)

💥 [RUMF-1473] Ignore untrusted event #2308

💥 [RUMF-1473] Ignore untrusted event #2308

Conversation

amortemousque commented Jun 27, 2023 • edited Loading

Motivation

Changes

Testing

codecov-commenter commented Jun 29, 2023 • edited Loading

Codecov Report

bcaudan Jul 3, 2023

Choose a reason for hiding this comment

amortemousque Jul 3, 2023

Choose a reason for hiding this comment

amortemousque commented Jun 27, 2023 •

edited

Loading

codecov-commenter commented Jun 29, 2023 •

edited

Loading