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

BREAKING CHANGE: incorporated changes planned for v3 #751

Merged
merged 5 commits into from
Jul 31, 2024

Conversation

desusai7
Copy link
Contributor

@desusai7 desusai7 commented Jul 19, 2024

Incorporated changes planned for v3 including breaking changes

List of breaking changes that were taken care as part of this major release are:

  1. Converted Credentials class into a data class as shown here, as a result of which this class can no longer be extended and also property currentTimeInMillis is removed from it . Fixed unit tests using CredentialsMock.kt with this change as it can no longer extend Credentials class.
  2. Updated the BaseCredentialsManager interface with all the overloads of getCredentials & awaitCredentials methods, and now all the implementing classes should override them instead of defining them directly.
  3. Convert await() in the Request.kt here to an abstract function, now all the implementations of it should define the function.

List of other changes that were taken care as part of this major release are:

  1. Accepting GsonProvider directly via the internal constructor of DefaultClient as shown here.
  2. Disabling logging within DefaultClient by default as shown here.
  3. Returning NetworkErrorException directly from the ErrorAdapter's in AuthenticationAPIClient and UsersAPIClient, so now AuthenticationException and ManagementException should just check if the cause is NetworkErrorException to understand if an error is due to Network Error. Created a Util function to check if a throwable is a network error and added unit tests for it.

Testing

This has been tested with all the existing unit tests and with the sample app as well.

  • This change adds unit test coverage
  • This change adds integration test coverage
  • This change has been tested on the latest version of the platform/language

Checklist

@desusai7 desusai7 changed the title BREAKING CHANGE: incorporated breaking changes planned for v3 BREAKING CHANGE: incorporated changes planned for v3 Jul 24, 2024
@desusai7 desusai7 merged commit e5c2bd1 into feat/biometric Jul 31, 2024
7 of 8 checks passed
@desusai7 desusai7 deleted the BREAKING_CHANGE_v3 branch July 31, 2024 12:22
desusai7 added a commit that referenced this pull request Aug 1, 2024
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.

2 participants