Skip to content

Validate optional live-debugger version#325

Merged
yoannmoinet merged 2 commits intomasterfrom
watson/DEBUG-5465/use-version-to-resolve-git-metadata
Apr 20, 2026
Merged

Validate optional live-debugger version#325
yoannmoinet merged 2 commits intomasterfrom
watson/DEBUG-5465/use-version-to-resolve-git-metadata

Conversation

@watson
Copy link
Copy Markdown
Contributor

@watson watson commented Apr 19, 2026

Motivation

Browser Live Debugger needs a stable build identifier when we want to resolve browser probe results back to uploaded sourcemap metadata, but that value should stay optional so instrumentation can still work when no version is configured.

Changes

This PR updates the Live Debugger build-plugin config to understand an optional liveDebugger.version field.

Before these changes:

  • the plugin had no explicit version option
  • there was no validation tying Live Debugger config to sourcemap upload config
  • the docs did not describe how browser build identity should be configured

With these changes:

  • add version?: string to LiveDebuggerOptions
  • carry version through the validated options shape
  • validate that version is a string when provided
  • validate that liveDebugger.version matches errorTracking.sourcemaps.releaseVersion when both are configured
  • keep version optional so Live Debugger still works without source-aware browser build lookup
  • document the intended version semantics in the plugin README
  • update unit tests and the live-debugger e2e fixture to cover the new config behavior

Testing

  • yarn test:unit packages/plugins/live-debugger/src/validate.test.ts packages/plugins/live-debugger/src/index.test.ts
  • ReadLints reported no linter errors on the changed files

@watson watson mentioned this pull request Apr 19, 2026
Copy link
Copy Markdown
Contributor Author

watson commented Apr 19, 2026

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

Add an optional version field to the live-debugger plugin config and use
it to validate consistency with sourcemap uploads. This documents the
browser build identity contract while still allowing instrumentation to
work when no version is configured.
@watson watson force-pushed the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch from edb4ac4 to af0764e Compare April 19, 2026 19:04
Base automatically changed from watson/DEBUG-5291/add-live-debugger-plugin to master April 20, 2026 13:42
@watson watson marked this pull request as ready for review April 20, 2026 13:45
@watson watson requested review from a team and yoannmoinet as code owners April 20, 2026 13:45
Copy link
Copy Markdown
Member

@yoannmoinet yoannmoinet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@yoannmoinet yoannmoinet merged commit 441c100 into master Apr 20, 2026
4 checks passed
@yoannmoinet yoannmoinet deleted the watson/DEBUG-5465/use-version-to-resolve-git-metadata branch April 20, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants