Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add logoutPopup API #3044

Merged
merged 30 commits into from
Mar 24, 2021
Merged

Add logoutPopup API #3044

merged 30 commits into from
Mar 24, 2021

Conversation

tnorling
Copy link
Collaborator

@tnorling tnorling commented Feb 19, 2021

Adds logoutPopup API as described in the design proposal: #3123

@tnorling tnorling added the work-in-progress Issue or PR is not finished. label Feb 19, 2021
@github-actions github-actions bot added msal-browser Related to msal-browser package samples Related to the samples apps for the library. labels Feb 19, 2021
@tnorling tnorling linked an issue Feb 19, 2021 that may be closed by this pull request
5 tasks
@github-actions github-actions bot added the documentation Related to documentation. label Mar 9, 2021
@github-actions github-actions bot added the msal-react Related to @azure/msal-react label Mar 10, 2021
@coveralls
Copy link

coveralls commented Mar 15, 2021

Coverage Status

Coverage increased (+0.2%) to 82.83% when pulling 866a4c8 on logoutPopup into 310ab2c on dev.

@tnorling tnorling linked an issue Mar 16, 2021 that may be closed by this pull request
@github-actions github-actions bot added the msal-angular Related to @azure/msal-angular package label Mar 16, 2021
@tnorling tnorling removed the work-in-progress Issue or PR is not finished. label Mar 17, 2021
@github-actions github-actions bot added the msal-common Related to msal-common package label Mar 18, 2021
Copy link
Contributor

@jasonnutter jasonnutter left a comment

Choose a reason for hiding this comment

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

One suggestion on naming, and some e2e test seem to be failing, otherwise looks good!

@tnorling
Copy link
Collaborator Author

One suggestion on naming, and some e2e test seem to be failing, otherwise looks good!

Angular E2E tests are still running on published versions of the lib afaik so it is expected that they fail on this PR. This is something we need to fix before GA cc: @jo-arroyo

@@ -11,5 +11,6 @@ The MSAL Browser library has a set of configuration options that can be used to
| `acquireTokenSilent` | [SilentRequest](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#silentrequest) | [AuthenticationResult](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#authenticationresult) |
| `loginPopup` | [PopupRequest](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#popuprequest) | [AuthenticationResult](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#authenticationresult) |
| `loginRedirect` | [RedirectRequest](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#redirectrequest) | [AuthenticationResult](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#authenticationresult) (via `handleRedirectPromise`) |
| `logout` | [EndSessionRequest](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_browser.html#endsessionrequest) | `void` |

Choose a reason for hiding this comment

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

This is technically a new major version. Assuming you're going with semver that is.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes you're right that this would be a breaking change, however, the logout API has not been removed from the library, just from the docs (to encourage people to use the new APIs going forward). This API will be removed in the next major version

pkanher617 pushed a commit to pkanher617/microsoft-authentication-library-for-js that referenced this pull request Dec 30, 2021
azure-pipelines bot pushed a commit to pkanher617/microsoft-authentication-library-for-js that referenced this pull request Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation. msal-angular Related to @azure/msal-angular package msal-browser Related to msal-browser package msal-common Related to msal-common package msal-react Related to @azure/msal-react samples Related to the samples apps for the library.
Projects
None yet
5 participants