Skip to content

Update docs with popup closure detection and interaction status details#8580

Merged
konstantin-msft merged 5 commits intodevfrom
update_popup_cancel_doc
May 4, 2026
Merged

Update docs with popup closure detection and interaction status details#8580
konstantin-msft merged 5 commits intodevfrom
update_popup_cancel_doc

Conversation

@konstantin-msft
Copy link
Copy Markdown
Collaborator

@konstantin-msft konstantin-msft commented May 4, 2026

This pull request updates the MSAL Browser documentation to reflect changes in how popup and iframe authentication timeouts are handled, and provides new guidance on detecting popup closure events. The most important changes are grouped below:

Configuration and Timeout Options:

  • Updated lib/msal-browser/docs/configuration.md to remove legacy timeout options (windowHashTimeout, iframeHashTimeout, loadFrameTimeout, navigateFrameWait, and pollIntervalMilliseconds) and add new options: popupBridgeTimeout (for popups, default 60s) and iframeBridgeTimeout (for hidden iframes, default 10s), both related to BroadcastChannel-based communication.

Popup Closure Handling and User Experience:

  • Added a new section in lib/msal-browser/docs/login-user.md explaining how popup closure detection now works using BroadcastChannel, the resulting user experience when a popup is closed (including delayed error handling and InteractionStatus behavior), and how to allow users to retry login immediately using the overrideInteractionInProgress flag.

Copilot AI review requested due to automatic review settings May 4, 2026 20:36
@konstantin-msft konstantin-msft requested a review from a team as a code owner May 4, 2026 20:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates MSAL Browser documentation to clarify how popup/iframe authentication responses are received (BroadcastChannel), how manual popup closure is handled, and how to configure the related timeouts.

Changes:

  • Added a new section explaining popup closure detection behavior and how it affects InteractionStatus and emitted events.
  • Documented new configuration options popupBridgeTimeout and iframeBridgeTimeout, with defaults and expected error behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
lib/msal-browser/docs/login-user.md Adds guidance on popup closure behavior, timeout-driven failure, and retry guidance via overrideInteractionInProgress.
lib/msal-browser/docs/configuration.md Documents new timeout configuration settings tied to BroadcastChannel-based response handling.

Comment thread lib/msal-browser/docs/login-user.md Outdated
Comment thread lib/msal-browser/docs/configuration.md Outdated
Comment thread lib/msal-browser/docs/configuration.md Outdated
Comment thread lib/msal-browser/docs/login-user.md Outdated
konstantin-msft and others added 4 commits May 4, 2026 16:51
Co-authored-by: Thomas Norling <thomas.norling@microsoft.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@konstantin-msft konstantin-msft requested a review from tnorling May 4, 2026 21:04
@konstantin-msft konstantin-msft enabled auto-merge (squash) May 4, 2026 21:22
@konstantin-msft konstantin-msft merged commit 1d8d2ae into dev May 4, 2026
71 checks passed
@konstantin-msft konstantin-msft deleted the update_popup_cancel_doc branch May 4, 2026 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants