You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Allow Electron applications to filter or scrub main-process RUM events before they are sent.
Changes
Adds a synchronous beforeSend callback for fully assembled main-process RUM events.
Supports allowlisted field updates and filtering while keeping view and native crash events.
Keeps renderer filtering in the Browser SDK.
Adds documentation, playground controls, and unit/E2E coverage.
Note :
I kept beforeSend separate because renderer events already go through the Browser SDK callback before crossing the bridge
Running the Electron callback afterward would add a second filtering step . Browser therefore handles renderer events, while Electron handles main-process events. Android follow the same path with webview, there is no "global" before send
Test instructions
yarn test:unit
yarn typecheck
yarn build
yarn playwright test -c e2e --project=e2e e2e/scenarios/before-send.scenario.ts
yarn --cwd playground test before-send.scenario.ts
The reason will be displayed to describe this comment to others. Learn more.
Stale comment
PR Review — Score: 4.6 / 5
This is a well-scoped addition of main-process beforeSend filtering and scrubbing. RumEventMapper is wired at the right boundary — after format hooks assemble the event and before ServerRumEvent emission — with an allowlist + clone pattern that protects identity fields, blocks view/crash drops, and fails open on callback errors. Documentation, playground controls, and unit/E2E coverage are thorough. I would approve.
Why 4.6: Correct pipeline placement, strong allowlist enforcement with sanitization, protected view/crash semantics, clear public API typing (RumBeforeSend, MainRumEvent), and meaningful tests across mapper, assembly, config, e2e, and playground.
Why not 5: Minor consistency gap when scrubbing service/version (ddtags not updated), plus small UX/perf nits around string clearing and per-event cloning.
Findings
[Minor] ddtags not synced with scrubbed service/version — Allowlisted service/version changes do not update the ddtags string set by commonContext.
[Nit] String fields cannot be cleared — Setting an allowlisted string to null/undefined silently keeps the original value.
[Nit] Per-event deepClone cost — Every main-process RUM event is deep-cloned when beforeSend is configured.
Architectural flow
sequenceDiagram
participant Coll as RUM collection
participant EM as EventManager
participant MA as MainAssembly
participant Hooks as FormatHooks
participant Map as RumEventMapper
participant VC as ViewCollection
participant T as Transport
Coll->>EM: RawRumEvent
EM->>MA: handle
MA->>Hooks: triggerRum
Hooks-->>MA: session, view, service, ddtags
MA->>MA: combine raw + hooks
MA->>Map: map assembled event
Map->>Map: deepClone and beforeSend
alt discarded
Map-->>MA: undefined
MA-->>EM: no ServerEvent
else kept or scrubbed
Map-->>MA: modified event
MA->>EM: ServerRumEvent
EM->>VC: increment counters
EM->>T: batch for intake
end
Loading
Before: Main-process RawRumEvents were enriched via format hooks and emitted directly as ServerRumEvents. Renderer events already used the Browser SDK beforeSend before crossing the bridge.
After:MainAssembly runs RumEventMapper on fully assembled main-process RUM events. Customers can scrub allowlisted fields or return false to drop non-view, non-crash events. Discarded events never become ServerRumEvents, so view counters and transport stay consistent. Telemetry, profiles, spans, and renderer RUM events are unchanged.
The reason will be displayed to describe this comment to others. Learn more.
Fail open for unknown renderer event types
When a newer Browser SDK sends a RUM event type that this Electron SDK does not yet know, this lookup returns undefined and objectEntries(modifiableFieldPaths) throws before the callback runs. Because RendererPipeline calls apply() for every renderer RUM event whenever beforeSendRum is configured, a bridge/SDK version mismatch drops all events of the new type through the monitored IPC handler; use the common modifiable paths or otherwise pass unknown types through unchanged.
The reason will be displayed to describe this comment to others. Learn more.
PR Review — Score: 4.7 / 5
This is a solid beforeSendRum implementation wired at the right assembly boundary for both main and renderer RUM events. The allowlist + clone pattern protects identity fields, blocks view/crash drops, fails open on callback errors, and exposes source for process-aware filtering. Follow-up commits addressed prior naming, test structure, README examples, crash-protection documentation, and renderer coverage. I would approve.
Why 4.7: Correct pipeline placement on MainAssembly and RendererPipeline, comprehensive allowlists for main and renderer event shapes, clear public API (beforeSendRum, BeforeSendContext), and meaningful unit/E2E/playground coverage.
Why not 5: A forward-compat gap for unrecognized event.type values can throw before the callback runs, plus small API ergonomics (callback return typing) and the inherent per-event clone cost.
Findings
[Minor] Unknown event types — Unrecognized event.type makes field-path lookup undefined and can throw before beforeSendRum runs.
[Minor] Strict callback return type — Runtime keeps events on void/undefined but RumBeforeSend requires boolean.
[Nit] Per-event deepClone — Every RUM event is deep-cloned when beforeSendRum is configured.
Architectural flow
sequenceDiagram
participant Coll as RUM collection
participant Bridge as Renderer bridge
participant EM as EventManager
participant MA as MainAssembly
participant RP as RendererPipeline
participant Hooks as FormatHooks
participant BS as BeforeSend
participant T as Transport
Coll->>EM: RawRumEvent
EM->>MA: handle
MA->>Hooks: triggerRum
Hooks-->>MA: session, view, service, ddtags
MA->>MA: combine raw + hooks
MA->>BS: apply assembled event (source main)
alt discarded
BS-->>MA: undefined
MA-->>EM: no ServerEvent
else kept or scrubbed
BS-->>MA: modified event
MA->>EM: ServerRumEvent
end
Bridge->>RP: bridge RUM message
RP->>Hooks: triggerRum (renderer)
Hooks-->>RP: session, container view, overrides
RP->>RP: combine renderer event + overrides
RP->>BS: apply (source renderer)
alt discarded
BS-->>RP: undefined
else kept or scrubbed
BS-->>RP: modified event
RP->>EM: ServerRumEvent
end
EM->>T: batch for intake
Loading
Before: Main and renderer RUM events were enriched via format hooks and emitted directly as ServerRumEvents. Renderer events could already be filtered by the Browser SDK beforeSend before crossing the bridge.
After:MainAssembly and RendererPipeline run the shared BeforeSend helper after Electron enrichment. Customers can scrub allowlisted fields or return false to drop non-view, non-crash events from either process. Discarded events never become ServerRumEvents. Telemetry, profiles, spans, and logs remain outside this callback.
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
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.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
Motivation
Allow Electron applications to filter or scrub main-process RUM events before they are sent.
Changes
beforeSendcallback for fully assembled main-process RUM events.Note :
I kept beforeSend separate because renderer events already go through the Browser SDK callback before crossing the bridge
Running the Electron callback afterward would add a second filtering step . Browser therefore handles renderer events, while Electron handles main-process events. Android follow the same path with webview, there is no "global" before send
Test instructions
yarn test:unityarn typecheckyarn buildyarn playwright test -c e2e --project=e2e e2e/scenarios/before-send.scenario.tsyarn --cwd playground test before-send.scenario.ts