-
Notifications
You must be signed in to change notification settings - Fork 126
API Changes, deprecating all methods not using TokenParameters #1595
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
Conversation
Please take a look at this common PR: AzureAD/microsoft-authentication-library-common-for-android#1682 Above PR is a dependency for this one, need to add fields to PublicApiId,java |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fadi - Please build a new version of MSAL with your changes and try and upgrade the existing sample app to ensure that we haven't missed/broken anything with this fix. We may want to get Teams to try and create a build with these changes as well.... in fact I think we should plan on it.
msal/src/main/java/com/microsoft/identity/client/IPublicClientApplication.java
Show resolved
Hide resolved
Codecov Report
@@ Coverage Diff @@
## dev #1595 +/- ##
============================================
+ Coverage 49.10% 49.36% +0.26%
- Complexity 358 370 +12
============================================
Files 58 59 +1
Lines 2615 2686 +71
Branches 319 324 +5
============================================
+ Hits 1284 1326 +42
- Misses 1190 1216 +26
- Partials 141 144 +3
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added some minor comments
msal/src/main/java/com/microsoft/identity/client/PublicClientApplication.java
Show resolved
Hide resolved
msal/src/main/java/com/microsoft/identity/client/SignInParameters.java
Outdated
Show resolved
Hide resolved
msal/src/main/java/com/microsoft/identity/client/SignInParameters.java
Outdated
Show resolved
Hide resolved
msal/src/main/java/com/microsoft/identity/client/SignInParameters.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed Amit's Comments
@fadidurah Can we please clarify in the sentence that deletion will be in next 'major' version release instead of following release? |
What
Deprecating methods in
PublicClientApplication
SingleAccountPublicClientApplication
andMultipleAccountPublicClientApplication
that are not usingTokenParameter
subclasses or the newSignInParameters
class. Reference this Design PR: https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview/pullrequest/4872Why
This change stemmed from a smaller bug regarding
SCOPES
being passed in as a string array https://identitydivision.visualstudio.com/Engineering/_boards/board/t/Auth%20Client%20-%20Android/Backlog%20items/?workitem=1104317. Team decided that a better solution would be to standardize the use of theTokenParameter
Subclasses to increase consistency, avoid using different object types for the same conceptual scope, and reduce the number of methods that our API is exposing to developers.How
Deprecate methods not using
TokenParameter
subclasses or the newSignInParameters
class. This is the first in a two-step plan, where the deprecation is included in the next major release, and followed by deletion of these deprecating methods in the following major release.Testing
Since existing behavior is only deprecated, existing testing is kept as is. For new methods, new versions of the existing tests were created to test out the same behaviors while using
TokenParameter
methods.