Allow to customize the redirect URI / return to URL

auth0/src/main/java/com/auth0/android/provider/CallbackHelper.java

@@ -43,7 +43,7 @@ abstract class CallbackHelper {
      *
      * @return the callback Uri.
      */
-    public static String getCallbackUri(@NonNull String scheme, @NonNull String packageName, @NonNull String domain) {
+    static String getCallbackUri(@NonNull String scheme, @NonNull String packageName, @NonNull String domain) {
         if (!URLUtil.isValidUrl(domain)) {
             Log.e(TAG, "The Domain is invalid and the Callback URI will not be set. You used: " + domain);
             return null;
@@ -62,7 +62,7 @@ public static String getCallbackUri(@NonNull String scheme, @NonNull String pack
     }
 
     @NonNull
-    public static Map<String, String> getValuesFromUri(@Nullable Uri uri) {
+    static Map<String, String> getValuesFromUri(@Nullable Uri uri) {
         if (uri == null) {
             return Collections.emptyMap();
         }

auth0/src/main/java/com/auth0/android/provider/WebAuthProvider.java

@@ -67,6 +67,7 @@ public static class LogoutBuilder {
 
         private final Auth0 account;
         private String scheme;
+        private String returnToUrl;
         private CustomTabsOptions ctOptions;
 
         LogoutBuilder(Auth0 account) {
@@ -90,7 +91,7 @@ public LogoutBuilder withCustomTabsOptions(@NonNull CustomTabsOptions options) {
         /**
          * Specify a custom Scheme to use on the Return To Uri. Default scheme is 'https'.
          *
-         * @param scheme to use in the Callback Uri.
+         * @param scheme to use in the Return To URL.
          * @return the current builder instance
          */
         public LogoutBuilder withScheme(@NonNull String scheme) {
@@ -102,6 +103,19 @@ public LogoutBuilder withScheme(@NonNull String scheme) {
             return this;
         }
 
+        /**
+         * Specify a custom Redirect To URL to use to invoke the app on redirection.
+         * Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.
+         * The {@link LogoutBuilder#withScheme(String)} configuration is ignored when this method is called. It is your responsibility to pass a well-formed URL.
+         *
+         * @param returnToUrl to use to invoke the app on redirection.
+         * @return the current builder instance
+         */
+        public LogoutBuilder withReturnToUrl(@NonNull String returnToUrl) {
+            this.returnToUrl = returnToUrl;
+            return this;
+        }
+
         /**
          * Request the user session to be cleared. When successful, the callback will get invoked
          *
@@ -118,7 +132,9 @@ public void start(Context context, VoidCallback callback) {
                 return;
             }
 
-            String returnToUrl = CallbackHelper.getCallbackUri(scheme, context.getApplicationContext().getPackageName(), account.getDomainUrl());
+            if (returnToUrl == null) {
+                returnToUrl = CallbackHelper.getCallbackUri(scheme, context.getApplicationContext().getPackageName(), account.getDomainUrl());
+            }
             LogoutManager logoutManager = new LogoutManager(this.account, callback, returnToUrl);
             logoutManager.setCustomTabsOptions(ctOptions);
 
@@ -141,6 +157,7 @@ public static class Builder {
         private boolean useFullscreen;
         private PKCE pkce;
         private String scheme;
+        private String redirectUri;
         private CustomTabsOptions ctOptions;
         private Integer leeway;
 
@@ -241,9 +258,9 @@ public Builder withAudience(@NonNull String audience) {
         }
 
         /**
-         * Specify a custom Scheme to use on the Callback Uri. Default scheme is 'https'.
+         * Specify a custom Scheme to use on the Redirect URI. Default scheme is 'https'.
          *
-         * @param scheme to use in the Callback Uri.
+         * @param scheme to use in the Redirect URI.
          * @return the current builder instance
          */
         public Builder withScheme(@NonNull String scheme) {
@@ -255,6 +272,19 @@ public Builder withScheme(@NonNull String scheme) {
             return this;
         }
 
+        /**
+         * Specify a custom Redirect URI to use to invoke the app on redirection.
+         * Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.
+         * The {@link Builder#withScheme(String)} configuration is ignored when this method is called. It is your responsibility to pass a well-formed Uri.
+         *
+         * @param redirectUri to use to invoke the app on redirection.
+         * @return the current builder instance
+         */
+        public Builder withRedirectUri(@NonNull String redirectUri) {
+            this.redirectUri = redirectUri;
+            return this;
+        }
+
         /**
          * Give a scope for this request.
          *
@@ -389,7 +419,9 @@ public void start(@NonNull Activity activity, @NonNull AuthCallback callback, in
 
             managerInstance = manager;
 
-            String redirectUri = CallbackHelper.getCallbackUri(scheme, activity.getApplicationContext().getPackageName(), account.getDomainUrl());
+            if (redirectUri == null) {
+                redirectUri = CallbackHelper.getCallbackUri(scheme, activity.getApplicationContext().getPackageName(), account.getDomainUrl());
+            }
             manager.startAuthentication(activity, redirectUri, requestCode);
         }
 

auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.java

@@ -832,6 +832,20 @@ public void shouldHaveRedirectUriOnLogin() {
         assertThat(uri.getQueryParameter("redirect_uri"), is("https://test.domain.com/android/com.auth0.android.auth0.test/callback"));
     }
 
+    @Test
+    public void shouldSetRedirectUriIgnoringSchemeOnLogin() {
+        WebAuthProvider.init(account)
+                .withScheme("https")
+                .withRedirectUri("myapp:https://app.company.com/mobile/callback")
+                .start(activity, callback);
+
+        verify(activity).startActivity(intentCaptor.capture());
+        Uri uri = intentCaptor.getValue().getParcelableExtra(AuthenticationActivity.EXTRA_AUTHORIZE_URI);
+        assertThat(uri, is(notNullValue()));
+
+        assertThat(uri.getQueryParameter("redirect_uri"), is("myapp:https://app.company.com/mobile/callback"));
+    }
+
     //response type
 
     @Test
@@ -2437,6 +2451,20 @@ public void shouldHaveReturnToUriOnLogout() {
         assertThat(uri.getQueryParameter("returnTo"), is("https://test.domain.com/android/com.auth0.android.auth0.test/callback"));
     }
 
+    @Test
+    public void shouldSetReturnToUrlIgnoringSchemeOnLogout() {
+        WebAuthProvider.logout(account)
+                .withScheme("https")
+                .withReturnToUrl("myapp:https://app.company.com/mobile/callback")
+                .start(activity, voidCallback);
+
+        verify(activity).startActivity(intentCaptor.capture());
+        Uri uri = intentCaptor.getValue().getParcelableExtra(AuthenticationActivity.EXTRA_AUTHORIZE_URI);
+        assertThat(uri, is(notNullValue()));
+
+        assertThat(uri.getQueryParameter("returnTo"), is("myapp:https://app.company.com/mobile/callback"));
+    }
+
 
     // Launch log out