Use Auth0.Android v2 [SDK-2429] #610

lbalmaceda · 2021-04-13T16:56:04Z

Changes

Targetting the newer Auth0 SDK imposes two new constraints/requirements:

This SDK will now target SDK 21 and above (Bump the minimum required android version [SDK-2427] #608)
This SDK will now require to be run in a JDK 8 target

Once these settings have been adjusted, the migration guide was followed to fix the compiling errors. These mostly were:

Authentication parameters type Map<String, Object> --> Map<String, String>
Callback types AuthCallback --> Callback
Removed classes: VoidCallback and Telemetry
Removed methods: OIDC conformant

Note: The Auth0Parcelable class, used to communicate the Auth0 class settings between Lock instances, is not completely migrated. As of this PR, it's lacking support for customizing the networking client; a feature that was recently made available in Auth0 Android v2. A comment was added to re-evaluate this in the short term.

References

See SDK-2429.

Testing

Compile errors in the tests have not been completely fixed yet (wip). Once they are fixed, this PR will be removed from DRAFT.

lbalmaceda · 2021-04-13T16:56:59Z

app/src/main/java/com/auth0/android/lock/app/DemoActivity.java

@@ -228,8 +228,8 @@ private void showPasswordlessLock() {

    private Auth0 getAccount() {
        Auth0 account = new Auth0(getString(R.string.com_auth0_client_id), getString(R.string.com_auth0_domain));
-        account.setOIDCConformant(true);
-        account.setLoggingEnabled(true);
+        DefaultClient netClient = new DefaultClient(10, 10, Collections.<String, String>emptyMap(), true);


Default values from Kotlin are not available for Java. I had to hardcode the timeout values. This is for the sample app that we ship with this repository, not included in the library package itself.

lbalmaceda · 2021-04-13T16:57:29Z

lib/src/main/java/com/auth0/android/lock/AuthenticationCallback.java

@@ -76,8 +79,9 @@ private void parseAuthentication(Intent data) {
        String accessToken = data.getStringExtra(Constants.ACCESS_TOKEN_EXTRA);
        String tokenType = data.getStringExtra(Constants.TOKEN_TYPE_EXTRA);
        String refreshToken = data.getStringExtra(Constants.REFRESH_TOKEN_EXTRA);
-        long expiresIn = data.getLongExtra(Constants.EXPIRES_IN_EXTRA, 0);


we no longer save the expires in (seconds) but rather the calculated expires at (date)

lbalmaceda · 2021-04-13T16:58:15Z

lib/src/main/java/com/auth0/android/lock/LockActivity.java

-                    .login(event.getUsername(), event.getPassword(), connection)
-                    .addAuthenticationParameters(options.getAuthenticationParameters());
+                    .login(event.getUsername(), event.getPassword(), connection);
+            request.addParameters(options.getAuthenticationParameters());


this method doesn't return the type "AuthenticationRequest", but "Request". So the chain had to be split.

lbalmaceda · 2021-04-13T16:58:28Z

lib/src/main/java/com/auth0/android/lock/LockActivity.java

            if (options.getScope() != null) {
                request.setScope(options.getScope());
            }
-            if (options.getAudience() != null && options.getAccount().isOIDCConformant()) {


This method no longer exists. Moving on, everything is OIDC conformant

lbalmaceda · 2021-04-13T17:00:14Z

lib/src/main/java/com/auth0/android/lock/LockActivity.java

        }
        Log.d(TAG, "Couldn't find an specific provider, using the default: " + WebAuthProvider.class.getSimpleName());
-        webProvider.start(this, connection, extraAuthParameters, authProviderCallback, WEB_AUTH_REQUEST_CODE);
+        webProvider.start(this, connection, extraAuthParameters, new WebCallbackWrapper(authProviderCallback));


Lock works with the concept of AuthProvider. These are implementations from users (or our library) that know different strategies to sign in. We provide one for the web auth flow, using our WebAuthProvider.

Because the AuthProvider interface takes an AuthCallback to return the results, and given that we've changed the callback type in the last SDK release, we have to wrap it in this new class WebCallbackWrapper (internal)

lbalmaceda · 2021-04-13T17:01:31Z

lib/src/main/java/com/auth0/android/lock/WebProvider.java

-     * @param intent      the intent received in the onActivityResult method.
-     * @return true if a result was expected and has a valid format, or false if not
-     */
-    public boolean resume(int requestCode, int resultCode, Intent intent) {


Deprecated, removed. This class is internal anyway.

lbalmaceda · 2021-04-13T17:03:09Z

lib/src/main/java/com/auth0/android/lock/internal/configuration/ApplicationFetcher.java


-        client.newCall(req).enqueue(new Callback() {


We will no longer use the OkHttp client directly, but through the interface exposed by the Auth0 class. We still have to do the error handling, as we're doing here.

The logic in this class has been moved to a "background task" AsyncTask where the network request will be safely executed.

lbalmaceda · 2021-04-13T17:26:06Z

lib/src/main/java/com/auth0/android/lock/internal/configuration/Connection.java

@@ -22,9 +21,13 @@
    private PasswordComplexity passwordComplexity;

    private Connection(@NonNull String strategy, Map<String, Object> values) {
-        checkArgument(values != null && values.size() > 0, "Must have at least one value");


This method went away. We're doing it here now instead.

lbalmaceda · 2021-04-16T17:30:16Z

build.gradle

@@ -17,6 +17,7 @@ allprojects {
    group = 'com.auth0.android'

    repositories {
+        mavenLocal()


temporary until we make a new release of the sdk

lbalmaceda · 2021-04-16T17:31:20Z

lib/src/main/java/com/auth0/android/lock/events/DatabaseSignUpEvent.java

-        } else {
-            request = apiClient.signUp(getEmail(), getPassword(), connection);
-        }
+        SignUpRequest request = apiClient.signUp(getEmail(), getPassword(), getUsername(), connection, userMetadata);


user metadata will be passed as an extra param of this method call, rather than later in the request parameters. The method accepts a nullable username, so we no longer need the if

lbalmaceda · 2021-04-16T17:31:57Z

lib/src/test/java/com/auth0/android/lock/WebProviderTest.java

-    }
-
-    @Test
-    public void shouldStartWebViewWithOptions() {


"webview" (instead of an external browser) is no longer supported

lbalmaceda · 2021-04-16T17:32:33Z

lib/src/test/java/com/auth0/android/lock/WebProviderTest.java

-        Intent intent = mock(Intent.class);
-        Options options = mock(Options.class);
-        WebProvider webProvider = new WebProvider(options);
-        assertThat(webProvider.resume(1, Activity.RESULT_CANCELED, intent), is(false));


launching with a result code is no longer valid. This was only used for the "webview" flow.

lbalmaceda · 2021-04-16T17:33:08Z

lib/src/test/java/com/auth0/android/lock/errors/SignUpErrorMessageBuilderTest.java

@@ -27,7 +27,7 @@

    @Before
    public void setUp() {
-        MockitoAnnotations.initMocks(this);
+        MockitoAnnotations.openMocks(this);


the previous one is marked as deprecated. In some classes, I had to change it to this new way for the tests to run successfully.

lbalmaceda · 2021-04-16T17:33:54Z

lib/src/test/java/com/auth0/android/lock/utils/ApplicationAPI.java

@@ -35,11 +35,8 @@

    private MockWebServer server;

-    public ApplicationAPI() throws IOException {
-        // FIXME: Remove this if migrating to Robolectric 4.4


this PR migrates to robolectric 4.4; And this code is no longer needed.

lbalmaceda · 2021-04-16T17:34:19Z

lib/src/test/java/com/auth0/android/lock/utils/SSLTestUtils.java

+/**
+ * Utility object for executing tests that use the networking client over HTTPS on localhost.
+ */
+public class SSLTestUtils {


this is a test helper class. Not included as part of the packaged library

lbalmaceda · 2021-04-16T18:11:09Z

lib/src/test/java/com/auth0/android/lock/LockActivityTest.java

@@ -106,13 +118,15 @@ public void setUp() {
        when(client.login(anyString(), anyString(), anyString())).thenReturn(authRequest);
        when(client.loginWithOTP(anyString(), anyString())).thenReturn(authRequest);
        when(client.createUser(anyString(), anyString(), anyString())).thenReturn(dbRequest);
-        when(client.createUser(anyString(), anyString(), anyString(), anyString())).thenReturn(dbRequest);
+        when(client.createUser(anyString(), anyString(), any(), anyString())).thenReturn(dbRequest);


any() required for the username parameter, as it could be null or a valid string

jimmyjames · 2021-04-16T19:47:47Z

lib/build.gradle

    implementation 'com.squareup:otto:1.3.8'
-    api 'com.auth0.android:auth0:1.29.0'
+    api 'com.auth0.android:auth0:2.1.0-SNAPSHOT'


also temporarily using a snapshot build built locally; makes sense for now

jimmyjames · 2021-04-16T19:53:06Z

lib/src/main/java/com/auth0/android/lock/Auth0Parcelable.java

-            dest.writeString(auth0.getTelemetry().getVersion());
-            dest.writeString(auth0.getTelemetry().getLibraryVersion());
-        }
+        //FIXME: Find a way to pass the NetworkingClient implementation


Mostly just for my own education, but what does this comment mean?

This relates to the "note" I added to the PR description. Customizing the networking client was made available in the latest release of the SDK. But the way we accept that client is with a setter in the Auth0 class.

This library has an implementation that makes Auth0 "Parcelable" (similar to Serializable), so we could pass it across instances/classes to set up the widget. But because the NetworkingClient implementation cannot be serialized, it's not straightforward to update the Auth0 class to support it. I added the comment to come back to this later and evaluate if this is something we need to backport today or not.

Hello there! I realize this is a very old PR, but I was wondering if this was ever floated to be fixed, as I noticed it's still in the current version...being able to pass in a custom networking client would be super useful for my team right now as we have to do weird proxy stuff but would prefer not to do a full migration to the raw SDK at the moment 😅

My understanding is lock is not really receiving any new feature requests, but wondering if this would qualify as a bugfix and if we can contribute to a PR somehow!

Thanks so much!

jimmyjames

Left a few minor comments; may be good to walk through the changes together as it gets closer to being out of draft.

lbalmaceda added 4 commits April 13, 2021 18:25

use new auth0 SDK, run the migration checklist

eb0b2fb

Use and target JDK 8

682cd00

Run CDN fetch task in the background

b6d0456

Remove OkHttp 2 dependency, and fix annotation imports

f73a2f8

lbalmaceda added the large Large review label Apr 13, 2021

lbalmaceda added this to the Major - v3 milestone Apr 13, 2021

lbalmaceda added the CH: Changed label Apr 13, 2021

lbalmaceda added 2 commits April 13, 2021 19:01

make WebCallbackWrapper internal

1b2a692

fix AsyncTask return type declaration

71172f9

lbalmaceda commented Apr 13, 2021

View reviewed changes

lbalmaceda added 4 commits April 14, 2021 11:49

make tests compile after migration

26f67eb

allow mockito to mock kotlin final classes

88d7c25

make networking tests run with SSL

841cc3e

maintain support for user_metadata

fc543e1

lbalmaceda commented Apr 16, 2021

View reviewed changes

fix createUser / signUp mockito matchers

7adc0f8

lbalmaceda commented Apr 16, 2021

View reviewed changes

jimmyjames reviewed Apr 16, 2021

View reviewed changes

lbalmaceda marked this pull request as ready for review April 19, 2021 09:47

lbalmaceda requested a review from a team as a code owner April 19, 2021 09:47

jimmyjames approved these changes Apr 19, 2021

View reviewed changes

lbalmaceda merged commit 30269a8 into v3 Apr 19, 2021

lbalmaceda deleted the use-new-sdk branch April 19, 2021 17:22

lbalmaceda linked an issue May 4, 2021 that may be closed by this pull request

Support Auth0 v2.0.0 #605

Closed

lbalmaceda added CH: Breaking Change and removed CH: Changed labels May 4, 2021

NicholasGWK mentioned this pull request Aug 30, 2023

Unable to customize SDK networking client #656

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Auth0.Android v2 [SDK-2429] #610

Use Auth0.Android v2 [SDK-2429] #610

lbalmaceda commented Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 13, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

lbalmaceda Apr 16, 2021

jimmyjames Apr 16, 2021

jimmyjames Apr 16, 2021

lbalmaceda Apr 19, 2021

NicholasGWK Aug 24, 2023

jimmyjames left a comment

Use Auth0.Android v2 [SDK-2429] #610

Use Auth0.Android v2 [SDK-2429] #610

Conversation

lbalmaceda commented Apr 13, 2021

Changes

References

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimmyjames left a comment

Choose a reason for hiding this comment