Skip to content

AB#3752409: Add platform broker telemetry tests and documentation - #8883

Merged
Lalima Sharda (lalimasharda) merged 9 commits into
devfrom
js-wam/platform-broker-telemetry-gaps
Oct 5, 2026
Merged

Lalima Sharda (lalimasharda) merged 9 commits into
devfrom
js-wam/platform-broker-telemetry-gaps

Conversation

@lalimasharda

@lalimasharda Lalima Sharda (lalimasharda) commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Correct the platform broker performance documentation to describe the final nested extension-handshake telemetry model and its queryable outcome signals.

Add focused telemetry coverage for an unavailable extension, an extension handshake timeout, and user cancellation returned by the platform broker.

Implements

  • AB#3752409 — Platform brokering telemetry improvements
  • AB#3752410 — Improve platform brokering observability

How to validate

  • Run the focused PlatformAuthExtensionHandler and PlatformAuthInteractionClient tests.
  • Verify unavailable and timed-out extension discovery emit their expected root-event context without a standalone handshake event.
  • Verify broker user cancellation is recorded as BrowserAuthError/user_cancelled.
  • Verify the performance documentation provides query dimensions and a request-level troubleshooting workflow.

Validation

  • 94 focused tests passed.
  • MSAL Common and MSAL Browser builds passed.
  • Browser formatting, API Extractor, and Beachball checks passed.
  • Repository-wide browser source lint reports pre-existing errors in untouched files.

assistance: agentic-cli
type: telemetry
agent-tool: copilot-cli
agent-model: gpt-5.6-sol
work-item: AB#3752409

Document nested platform broker telemetry and cover extension failure and broker cancellation signals.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
@lalimasharda
Lalima Sharda (lalimasharda) requested a review from a team as a code owner October 2, 2026 20:40
Copilot AI balanced review requested due to automatic review settings October 2, 2026 20:40
@lalimasharda Lalima Sharda (lalimasharda) added agentic-cli Copilot CLI / terminal agent drove the bulk of the edits telemetry Telemetry and observability changes labels Oct 2, 2026
Add query dimensions and a correlation-based workflow for diagnosing provider selection, handshake outcomes, failures, cancellation, fallback, and latency.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
@lalimasharda Lalima Sharda (lalimasharda) changed the title AB#3752409: Platform brokering telemetry improvements AB#3752409: Add platform broker telemetry tests and documentation Oct 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

Review effort: Lite
Findings: 3 Medium severity · 1 Low severity

Open (4)
What changed in this PR

Updates platform broker performance documentation and adds focused test coverage to ensure telemetry correctly records extension discovery outcomes (unavailable/timeout) and broker user-cancellation.

Changes:

  • Add a test asserting broker user cancellation maps to BrowserAuthError/user_cancelled telemetry.
  • Expand extension handler tests to validate timeout behavior emits only the root createProvider event context (and no standalone handshake event).
  • Update performance documentation to describe nested extension-handshake telemetry fields and queryable outcome signals.
File Description
lib/​msal-browser/​test/​interaction_client/​PlatformAuthInteractionClient.spec.ts Adds test coverage for broker user-cancellation telemetry mapping.
lib/​msal-browser/​test/​broker/​PlatformAuthExtensionHandler.spec.ts Strengthens timeout test and asserts root-event context + no handshake event emission.
lib/​msal-browser/​docs/​performance.md Documents the nested platform broker telemetry model and recommended query dimensions.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread lib/msal-browser/docs/performance.md
Comment thread lib/msal-browser/test/broker/PlatformAuthExtensionHandler.spec.ts Outdated
Comment thread lib/msal-browser/test/broker/PlatformAuthExtensionHandler.spec.ts
Co-authored-by: Forge <forge-bot@entra.github.io>
Forge-Agent: Coder
Remove generated Forge status and prompt files that were committed by the failed PR comment loop.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
…tract (#8880)

## Summary

Document the verified `navigator.platformAuthentication` compatibility
contract, including capability and supported-contract checks,
configuration gates, privacy considerations, and extension/web-flow
fallback behavior.

## Implements

- AB#3757762 — Document platformAuthentication browser compatibility
contract

## How to validate

- Confirm the documented flags and contract names match
`PlatformAuthProvider.ts`, `PlatformAuthDOMHandler.ts`, and
`BrowserConstants.ts`.
- Confirm the relative link to `device-bound-tokens.md` resolves.

<!-- BEGIN pr-telemetry -->
assistance: agentic-cli
type: docs
agent-tool: copilot-cli
agent-model: gpt-5.6-sol
work-item: AB#3757762
<!-- END pr-telemetry -->

---------

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
## Summary

Clarifies that DPoP support in MSAL Browser is still in development, is
not fully rolled out or production-ready, and should only be used for
evaluation and testing.

## How to validate

- Review the DPoP warnings in the access-token, request/response,
response, and caching documentation.
- Confirm the documentation no longer presents DPoP as generally
available for production use.

## Notes

Created by Forge `create-pr` skill.

<!-- BEGIN pr-telemetry -->
assistance: agentic-cli
type: docs
agent-tool: copilot-cli
agent-model: gpt-5.6-sol
work-item: AB#n/a
<!-- END pr-telemetry -->

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 1a77a9f7-1bca-4f21-8365-3c2c132f2c69
This PR contains the changelogs and version bumps for the MSAL.js 3P
releases.

---------

Co-authored-by: MSAL.js Release Automation <msaljsbuilds@microsoft.com>
Co-authored-by: shylasummers <shylasummers@users.noreply.github.com>
Co-authored-by: Shyla Summers <shylasummers@microsoft.com>
Copilot-Session: 36ec2798-e86d-4fdd-8b64-72f3d40951d8
Clean up the timeout performance callback, fail clearly when the expected event is absent, and keep cancellation telemetry assertions resilient to additional fields.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
@lalimasharda
Lalima Sharda (lalimasharda) requested a review from a team as a code owner October 5, 2026 17:41
Update PR #8883 to the current dev head after addressing review feedback.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bced410-2a72-4ca0-ae17-b5eae8cb4d40
@lalimasharda
Lalima Sharda (lalimasharda) merged commit 0aa1dec into dev Oct 5, 2026
77 checks passed
@lalimasharda
Lalima Sharda (lalimasharda) deleted the js-wam/platform-broker-telemetry-gaps branch October 5, 2026 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agentic-cli Copilot CLI / terminal agent drove the bulk of the edits telemetry Telemetry and observability changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants