π Fix propagateTraceBaggage TSDoc @defaultValue (false β true) - #4933
Merged
BeltranBulbarellaDD merged 1 commit intoAug 11, 2026
Merged
Conversation
The TSDoc @DefaultValue for propagateTraceBaggage says false, but the actual default has been true since v7 (DataDog#4226 flipped the runtime default but did not update the doc comment). This is confirmed by the public v7 migration guide, which documents the default as true and its CORS implication: https://docs.datadoghq.com/real_user_monitoring/guide/browser-sdk-upgrade/ Surfaced via a customer support ticket where the stale TSDoc led to incorrect assumptions about default behavior.
|
All contributors have signed the CLA βοΈ β
|
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
BeltranBulbarellaDD
self-requested a review
August 10, 2026 08:05
BeltranBulbarellaDD
approved these changes
Aug 10, 2026
Contributor
|
@yuandesu thanks for the contribution. Please wait until all CI has passed and then you will be able to merge. |
π All green!π§ͺ All tests passed π― Code Coverage (details) π Commit SHA: ef39b47 | Docs | Datadog PR Page | Give us feedback! |
Contributor
Author
|
@BeltranBulbarellaDD Thank you for reviewing! Thanks! |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
The TSDoc
@defaultValueforpropagateTraceBaggagecurrently saysfalse, but the actual default has beentruesince v7 (#4226 flipped the runtime default but did not update the doc comment).This is confirmed by Datadog's own public v7 migration guide, which documents the default as
trueand its CORS implication:Upgrade the RUM Browser SDK
The stale TSDoc contradicts this public documentation. Integrators who rely on the generated
.d.ts/ IDE autocomplete instead of reading the migration guide have no way to know the real default. This was surfaced via a customer support ticket.Changes
One-line JSDoc fix in
packages/browser-rum-core/src/domain/configuration/configuration.ts:No behavior change. Affects only the generated type declarations (
.d.ts) shipped in future npm releases.Test instructions
N/A, documentation-only change with no runtime behavior affected. The
truedefault is already in effect via the existing default-resolution logic (propagateTraceBaggage: initConfiguration.propagateTraceBaggage !== false, unchanged since #4226).Checklist