Skip to content

Document optional browser debugger version#4503

Closed
watson wants to merge 1 commit intographite-base/4503from
watson/DEBUG-5465/use-version-to-resolve-git-metadata
Closed

Document optional browser debugger version#4503
watson wants to merge 1 commit intographite-base/4503from
watson/DEBUG-5465/use-version-to-resolve-git-metadata

Conversation

@watson
Copy link
Copy Markdown
Collaborator

@watson watson commented Apr 19, 2026

Motivation

Browser Live Debugger can use version to resolve browser builds back to uploaded sourcemap metadata, but version should remain optional so the product still works when applications do not provide it. The SDK docs and API examples should make that graceful-degradation behavior explicit.

Changes

  • document version as optional in the Browser Debugger package
  • clarify that, when provided, version should be the immutable deployed browser build identifier
  • clarify that omitting version still allows debugger delivery and snapshots to work, but browser build lookup and source-aware resolution may be unavailable
  • update the datadogDebugger.init() example in the public API docs to reflect the optional version field

Test instructions

  • Review the updated Browser Debugger README and API docs in:
    • packages/debugger/README.md
    • packages/debugger/src/entries/main.ts
  • Confirm the docs now describe:
    • version as optional
    • the recommended meaning of version when present
    • graceful degradation when version is absent

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.
  • Updated documentation and/or relevant AGENTS.md file

@watson watson mentioned this pull request Apr 19, 2026
4 tasks
Copy link
Copy Markdown
Collaborator Author

watson commented Apr 19, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@cit-pr-commenter-54b7da
Copy link
Copy Markdown

cit-pr-commenter-54b7da Bot commented Apr 19, 2026

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 179.32 KiB 179.32 KiB 0 B 0.00%
Rum Profiler 6.16 KiB 6.16 KiB 0 B 0.00%
Rum Recorder 27.03 KiB 27.03 KiB 0 B 0.00%
Logs 56.80 KiB 56.80 KiB 0 B 0.00%
Rum Slim 135.16 KiB 135.16 KiB 0 B 0.00%
Worker 23.63 KiB 23.63 KiB 0 B 0.00%
🚀 CPU Performance
Action Name Base CPU Time (ms) Local CPU Time (ms) 𝚫%
RUM - add global context 0.0058 0.004 -31.03%
RUM - add action 0.0155 0.013 -16.13%
RUM - add error 0.0154 0.0157 +1.95%
RUM - add timing 0.0031 0.0031 0.00%
RUM - start view 0.0148 0.0132 -10.81%
RUM - start/stop session replay recording 0.0008 0.0008 0.00%
Logs - log message 0.0177 0.0152 -14.12%
🧠 Memory Performance
Action Name Base Memory Consumption Local Memory Consumption 𝚫
RUM - add global context 30.40 KiB 32.52 KiB +2.13 KiB
RUM - add action 107.69 KiB 102.60 KiB -5.09 KiB
RUM - add timing 33.68 KiB 33.11 KiB -586 B
RUM - add error 95.06 KiB 95.34 KiB +290 B
RUM - start/stop session replay recording 31.42 KiB 31.00 KiB -428 B
RUM - start view 499.35 KiB 490.74 KiB -8.61 KiB
Logs - log message 100.94 KiB 95.83 KiB -5.12 KiB

🔗 RealWorld

@datadog-datadog-prod-us1
Copy link
Copy Markdown

datadog-datadog-prod-us1 Bot commented Apr 19, 2026

Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 76.69% (-0.03%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: ea9361d | Docs | Datadog PR Page | Give us feedback!

@watson watson force-pushed the watson/DEBUG-5296/use-public-api branch from 4d848e6 to 91efb95 Compare April 19, 2026 19:25
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from c459811 to 9993e55 Compare April 19, 2026 19:25
@watson watson changed the base branch from watson/DEBUG-5296/use-public-api to graphite-base/4503 April 20, 2026 06:38
@watson watson force-pushed the graphite-base/4503 branch from 91efb95 to bf9a162 Compare April 20, 2026 06:38
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from 9993e55 to c442ca9 Compare April 20, 2026 06:38
@watson watson changed the base branch from graphite-base/4503 to watson/DEBUG-5296/add-live-debugger April 20, 2026 06:38
@watson watson changed the base branch from watson/DEBUG-5296/add-live-debugger to graphite-base/4503 April 21, 2026 07:35
@watson watson force-pushed the graphite-base/4503 branch from bf9a162 to b9da4f3 Compare April 21, 2026 07:38
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from c442ca9 to c82f98e Compare April 21, 2026 07:38
@watson watson changed the base branch from graphite-base/4503 to watson/DEBUG-5296/add-live-debugger April 21, 2026 07:38
@watson watson changed the base branch from watson/DEBUG-5296/add-live-debugger to graphite-base/4503 April 21, 2026 08:17
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from c82f98e to 7937903 Compare April 21, 2026 08:19
@watson watson force-pushed the graphite-base/4503 branch from b9da4f3 to 0040ee8 Compare April 21, 2026 08:19
@watson watson changed the base branch from graphite-base/4503 to watson/DEBUG-5296/add-live-debugger April 21, 2026 08:19
Clarify that browser debugger version is optional, but when provided it
should match the immutable deployed build identifier used for browser
build lookup and sourcemap resolution. This keeps the SDK contract
aligned with graceful degradation when no version is configured.
@watson watson changed the base branch from watson/DEBUG-5296/add-live-debugger to graphite-base/4503 April 21, 2026 09:12
@watson watson force-pushed the graphite-base/4503 branch from 0040ee8 to 653aee9 Compare April 21, 2026 09:14
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from 7937903 to ea9361d Compare April 21, 2026 09:14
@watson watson changed the base branch from graphite-base/4503 to watson/DEBUG-5296/add-live-debugger April 21, 2026 09:14
@watson watson changed the base branch from watson/DEBUG-5296/add-live-debugger to graphite-base/4503 April 22, 2026 12:24
@watson watson closed this Apr 22, 2026
@watson watson deleted the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch April 22, 2026 13:46
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant