Skip to content

Commit 3041ee1

Browse files
utkrishtsahuutkrishtsahu
committed
Enable overriding logoutUrl and authorizeUrl
1 parent f78ef0e commit 3041ee1

File tree

8 files changed

+104
-60
lines changed

8 files changed

+104
-60
lines changed

‎auth0/src/main/java/com/auth0/android/Auth0.kt‎

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -72,48 +72,22 @@ public open class Auth0 private constructor(
7272
* @return Url to call to perform the web flow of OAuth
7373
*/
7474
public open val authorizeUrl: String
75-
get() = buildAuthorizeUrl()
76-
77-
/**
78-
* Builds the authorize URL for the current domain.
79-
*
80-
* This function constructs the URL used for the OAuth 2.0 authorization flow. Subclasses
81-
* can override this function to modify the URL generation logic, for example, to use a
82-
* different endpoint or add custom query parameters.
83-
*
84-
* @return The URL to call to perform the web flow of OAuth.
85-
*/
86-
public open fun buildAuthorizeUrl(): String { // Function instead of property
87-
return domainUrl.newBuilder()
75+
get() = domainUrl.newBuilder()
8876
.addEncodedPathSegment("authorize")
8977
.build()
9078
.toString()
91-
}
9279

9380
/**
9481
* Obtain the logout URL for the current domain
9582
*
9683
* @return Url to call to perform the web logout
9784
*/
9885
public open val logoutUrl: String
99-
get() = buildLogoutUrl()
100-
101-
/**
102-
* Builds the logout URL for the current domain.
103-
*
104-
* This function constructs the URL used for the logout process. Subclasses can override
105-
* this function to modify the URL generation logic, for example, to use a different
106-
* endpoint or add custom query parameters.
107-
*
108-
* @return The URL to call to perform the web logout.
109-
*/
110-
public open fun buildLogoutUrl(): String { // Function instead of property
111-
return domainUrl.newBuilder()
86+
get() = domainUrl.newBuilder()
11287
.addEncodedPathSegment("v2")
11388
.addEncodedPathSegment("logout")
11489
.build()
11590
.toString()
116-
}
11791

11892

11993
public companion object {
@@ -188,4 +162,4 @@ public open class Auth0 private constructor(
188162
return safeUrl.toHttpUrlOrNull()
189163
}
190164
}
191-
}
165+
}

‎auth0/src/main/java/com/auth0/android/provider/LogoutManager.kt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ internal class LogoutManager(
1515
ctOptions: CustomTabsOptions,
1616
federated: Boolean = false,
1717
private val launchAsTwa: Boolean = false,
18+
private val customLogoutUrl: String? = null
1819
) : ResumableManager() {
1920
private val parameters: MutableMap<String, String>
2021
private val ctOptions: CustomTabsOptions
@@ -42,7 +43,8 @@ internal class LogoutManager(
4243
}
4344

4445
private fun buildLogoutUri(): Uri {
45-
val logoutUri = Uri.parse(account.logoutUrl)
46+
val urlToUse = customLogoutUrl ?: account.logoutUrl
47+
val logoutUri = Uri.parse(urlToUse)
4648
val builder = logoutUri.buildUpon()
4749
for ((key, value) in parameters) {
4850
builder.appendQueryParameter(key, value)

‎auth0/src/main/java/com/auth0/android/provider/OAuthManager.kt‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ internal class OAuthManager(
2525
parameters: Map<String, String>,
2626
ctOptions: CustomTabsOptions,
2727
private val launchAsTwa: Boolean = false,
28+
private val customAuthorizeUrl: String? = null
2829
) : ResumableManager() {
2930
private val parameters: MutableMap<String, String>
3031
private val headers: MutableMap<String, String>
@@ -235,7 +236,8 @@ internal class OAuthManager(
235236
}
236237

237238
private fun buildAuthorizeUri(): Uri {
238-
val authorizeUri = Uri.parse(account.authorizeUrl)
239+
val urlToUse = customAuthorizeUrl ?: account.authorizeUrl
240+
val authorizeUri = Uri.parse(urlToUse)
239241
val builder = authorizeUri.buildUpon()
240242
for ((key, value) in parameters) {
241243
builder.appendQueryParameter(key, value)
@@ -357,7 +359,8 @@ internal fun OAuthManager.Companion.fromState(
357359
account = state.auth0,
358360
ctOptions = state.ctOptions,
359361
parameters = state.parameters,
360-
callback = callback
362+
callback = callback,
363+
customAuthorizeUrl = null
361364
).apply {
362365
setHeaders(
363366
state.headers

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

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ public object WebAuthProvider {
148148
private var ctOptions: CustomTabsOptions = CustomTabsOptions.newBuilder().build()
149149
private var federated: Boolean = false
150150
private var launchAsTwa: Boolean = false
151+
private var customLogoutUrl: String? = null
151152

152153
/**
153154
* When using a Custom Tabs compatible Browser, apply these customization options.
@@ -215,6 +216,18 @@ public object WebAuthProvider {
215216
return this
216217
}
217218

219+
/**
220+
* Specifies a custom Logout URL to use for this logout request, overriding the default
221+
* generated from the Auth0 domain (account.logoutUrl).
222+
*
223+
* @param logoutUrl the custom logout URL.
224+
* @return the current builder instance
225+
*/
226+
public fun withLogoutUrl(logoutUrl: String): LogoutBuilder {
227+
this.customLogoutUrl = logoutUrl
228+
return this
229+
}
230+
218231
/**
219232
* Request the user session to be cleared. When successful, the callback will get invoked.
220233
* An error is raised if there are no browser applications installed in the device or if
@@ -248,7 +261,8 @@ public object WebAuthProvider {
248261
returnToUrl!!,
249262
ctOptions,
250263
federated,
251-
launchAsTwa
264+
launchAsTwa,
265+
customLogoutUrl
252266
)
253267
managerInstance = logoutManager
254268
logoutManager.startLogout(context)
@@ -294,6 +308,7 @@ public object WebAuthProvider {
294308
private var ctOptions: CustomTabsOptions = CustomTabsOptions.newBuilder().build()
295309
private var leeway: Int? = null
296310
private var launchAsTwa: Boolean = false
311+
private var customAuthorizeUrl: String? = null
297312

298313
/**
299314
* Use a custom state in the requests
@@ -507,6 +522,18 @@ public object WebAuthProvider {
507522
return this
508523
}
509524

525+
/**
526+
* Specifies a custom Authorize URL to use for this login request, overriding the default
527+
* generated from the Auth0 domain (account.authorizeUrl).
528+
*
529+
* @param authorizeUrl the custom authorize URL.
530+
* @return the current builder instance
531+
*/
532+
public fun withAuthorizeUrl(authorizeUrl: String): Builder {
533+
this.customAuthorizeUrl = authorizeUrl
534+
return this
535+
}
536+
510537
@VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
511538
internal fun withPKCE(pkce: PKCE): Builder {
512539
this.pkce = pkce
@@ -553,7 +580,8 @@ public object WebAuthProvider {
553580
values[OAuthManager.KEY_ORGANIZATION] = organizationId
554581
values[OAuthManager.KEY_INVITATION] = invitationId
555582
}
556-
val manager = OAuthManager(account, callback, values, ctOptions, launchAsTwa)
583+
val manager = OAuthManager(account, callback, values, ctOptions, launchAsTwa,
584+
customAuthorizeUrl)
557585
manager.setHeaders(headers)
558586
manager.setPKCE(pkce)
559587
manager.setIdTokenVerificationLeeway(leeway)

‎auth0/src/test/java/com/auth0/android/Auth0Test.java‎

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import static org.hamcrest.Matchers.is;
2525
import static org.hamcrest.Matchers.notNullValue;
2626
import static org.mockito.Matchers.eq;
27-
import static org.mockito.Mockito.spy;
2827
import static org.mockito.Mockito.when;
2928

3029
import java.lang.reflect.Method;
@@ -157,17 +156,6 @@ public void shouldReturnAuthorizeUrl() {
157156
assertThat(url, hasPath("authorize"));
158157
}
159158

160-
@Test
161-
public void shouldAllowOverridingBuildAuthorizeUrl() {
162-
final String customAuthorizeUrl = "https://custom.example.com/auth";
163-
164-
165-
Auth0 auth0 = Auth0.getInstance(CLIENT_ID, DOMAIN);
166-
Auth0 spyAuth0 = spy(auth0);
167-
when(spyAuth0.buildAuthorizeUrl()).thenReturn(customAuthorizeUrl);
168-
assertThat(spyAuth0.getAuthorizeUrl(), equalTo(customAuthorizeUrl));
169-
}
170-
171159
@Test
172160
public void shouldReturnLogoutUrl() {
173161
Auth0 auth0 = Auth0.getInstance(CLIENT_ID, DOMAIN);
@@ -178,17 +166,6 @@ public void shouldReturnLogoutUrl() {
178166
assertThat(url, hasPath("v2", "logout"));
179167
}
180168

181-
@Test
182-
public void shouldAllowOverridingBuildLogoutUrl() {
183-
final String customLogoutUrl = "https://custom.example.com/logout";
184-
185-
186-
Auth0 auth0 = Auth0.getInstance(CLIENT_ID, DOMAIN);
187-
Auth0 spyAuth0 = spy(auth0);
188-
when(spyAuth0.buildLogoutUrl()).thenReturn(customLogoutUrl);
189-
assertThat(spyAuth0.getLogoutUrl(), equalTo(customLogoutUrl));
190-
}
191-
192169
@Test
193170
public void shouldSetCustomTelemetry() {
194171
Auth0UserAgent customAuth0UserAgent = new Auth0UserAgent("custom", "9.9.9", "1.1.1");
@@ -245,4 +222,4 @@ public void differentConfigShouldReturnDifferentInstances() {
245222
Auth0 auth0_2 = Auth0.getInstance(CLIENT_ID + "2", DOMAIN + "2");
246223
Assert.assertNotSame(auth0, auth0_2);
247224
}
248-
}
225+
}

‎auth0/src/test/java/com/auth0/android/provider/LogoutManagerTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public void setUp() {
3838

3939
@Test
4040
public void shouldCallOnFailureWhenResumedWithCanceledResult() {
41-
LogoutManager manager = new LogoutManager(account, callback, "https://auth0.com/android/my.app.name/callback", customTabsOptions, false, false);
41+
LogoutManager manager = new LogoutManager(account, callback, "https://auth0.com/android/my.app.name/callback", customTabsOptions, false, false,null);
4242
AuthorizeResult result = mock(AuthorizeResult.class);
4343
when(result.isCanceled()).thenReturn(true);
4444
manager.resume(result);
@@ -51,7 +51,7 @@ public void shouldCallOnFailureWhenResumedWithCanceledResult() {
5151

5252
@Test
5353
public void shouldCallOnSuccessWhenResumedWithValidResult() {
54-
LogoutManager manager = new LogoutManager(account, callback, "https://auth0.com/android/my.app.name/callback", customTabsOptions, false, false);
54+
LogoutManager manager = new LogoutManager(account, callback, "https://auth0.com/android/my.app.name/callback", customTabsOptions, false, false,null);
5555
AuthorizeResult result = mock(AuthorizeResult.class);
5656
when(result.isCanceled()).thenReturn(false);
5757
manager.resume(result);

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

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ public class WebAuthProviderTest {
7272
private val callbackCaptor: KArgumentCaptor<Callback<Credentials, AuthenticationException>> =
7373
argumentCaptor()
7474

75+
private val customAuthorizeUrl = "https://custom.domain.com/custom_auth"
76+
private val customLogoutUrl = "https://custom.domain.com/custom_logout"
77+
7578
@Before
7679
public fun setUp() {
7780
MockitoAnnotations.openMocks(this)
@@ -106,6 +109,24 @@ public class WebAuthProviderTest {
106109
Assert.assertNotNull(WebAuthProvider.managerInstance)
107110
}
108111

112+
@Test
113+
public fun shouldSetCustomAuthorizeUrlOnLogin() {
114+
login(account)
115+
.withAuthorizeUrl(customAuthorizeUrl)
116+
.start(activity, callback)
117+
verify(activity).startActivity(intentCaptor.capture())
118+
val uri =
119+
intentCaptor.firstValue.getParcelableExtra<Uri>(AuthenticationActivity.EXTRA_AUTHORIZE_URI)
120+
assertThat(uri, `is`(notNullValue()))
121+
assertThat(uri?.scheme, `is`("https"))
122+
assertThat(uri?.host, `is`("custom.domain.com"))
123+
assertThat(uri?.path, `is`("/custom_auth"))
124+
assertThat(uri, UriMatchers.hasParamWithName("client_id"))
125+
assertThat(uri, UriMatchers.hasParamWithName("redirect_uri"))
126+
assertThat(uri, UriMatchers.hasParamWithName("response_type"))
127+
assertThat(uri, UriMatchers.hasParamWithName("state"))
128+
}
129+
109130
//scheme
110131
@Test
111132
public fun shouldHaveDefaultSchemeOnLogin() {
@@ -2326,6 +2347,22 @@ public class WebAuthProviderTest {
23262347
Assert.assertNotNull(WebAuthProvider.managerInstance)
23272348
}
23282349

2350+
@Test
2351+
public fun shouldSetCustomLogoutUrlOnLogout() {
2352+
logout(account)
2353+
.withLogoutUrl(customLogoutUrl)
2354+
.start(activity, voidCallback)
2355+
verify(activity).startActivity(intentCaptor.capture())
2356+
val uri =
2357+
intentCaptor.firstValue.getParcelableExtra<Uri>(AuthenticationActivity.EXTRA_AUTHORIZE_URI)
2358+
assertThat(uri, `is`(notNullValue()))
2359+
assertThat(uri?.scheme, `is`("https"))
2360+
assertThat(uri?.host, `is`("custom.domain.com"))
2361+
assertThat(uri?.path, `is`("/custom_logout"))
2362+
assertThat(uri, UriMatchers.hasParamWithName("client_id"))
2363+
assertThat(uri, UriMatchers.hasParamWithName("returnTo"))
2364+
}
2365+
23292366
//scheme
23302367
@Test
23312368
public fun shouldHaveDefaultSchemeOnLogout() {
@@ -2612,6 +2649,22 @@ public class WebAuthProviderTest {
26122649
job.join()
26132650
}
26142651

2652+
@Test
2653+
public fun shouldBuildDefaultLogoutURIWithCorrectSchemeHostAndPathOnLogout() {
2654+
logout(account)
2655+
.start(activity, voidCallback)
2656+
val baseUriString = Uri.parse(account.logoutUrl)
2657+
verify(activity).startActivity(intentCaptor.capture())
2658+
val uri =
2659+
intentCaptor.firstValue.getParcelableExtra<Uri>(AuthenticationActivity.EXTRA_AUTHORIZE_URI)
2660+
assertThat(uri, `is`(notNullValue()))
2661+
assertThat(uri, UriMatchers.hasScheme(baseUriString.scheme))
2662+
assertThat(uri, UriMatchers.hasHost(baseUriString.host))
2663+
assertThat(uri, UriMatchers.hasPath(baseUriString.path))
2664+
assertThat(uri, UriMatchers.hasParamWithName("client_id"))
2665+
assertThat(uri, UriMatchers.hasParamWithName("returnTo"))
2666+
}
2667+
26152668
//** ** ** ** ** ** **//
26162669
//** ** ** ** ** ** **//
26172670
//** Helpers Functions**//

‎sample/src/main/java/com/auth0/sample/DatabaseLoginFragment.kt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ import java.util.concurrent.Executors
5050
*/
5151
class DatabaseLoginFragment : Fragment() {
5252

53+
private val customAuthorizeUrl = "<YOUR_CUSTOM_AUTHORIZE_URL>"
54+
private val customLogoutUrl = "<YOUR_CUSTOM_LOGOUT_URL>"
55+
5356
private val scope = "openid profile email read:current_user update:current_user_metadata"
5457

5558
private val account: Auth0 by lazy {
@@ -262,6 +265,7 @@ class DatabaseLoginFragment : Fragment() {
262265
.withScheme(getString(R.string.com_auth0_scheme))
263266
.withAudience(audience)
264267
.withScope(scope)
268+
.withAuthorizeUrl(customAuthorizeUrl)
265269
.start(requireContext(), object : Callback<Credentials, AuthenticationException> {
266270
override fun onSuccess(result: Credentials) {
267271
credentialsManager.saveCredentials(result)
@@ -292,6 +296,7 @@ class DatabaseLoginFragment : Fragment() {
292296
.withScheme(getString(R.string.com_auth0_scheme))
293297
.withAudience(audience)
294298
.withScope(scope)
299+
.withAuthorizeUrl(customAuthorizeUrl)
295300
.await(requireContext())
296301
credentialsManager.saveCredentials(credentials)
297302
Snackbar.make(
@@ -309,6 +314,7 @@ class DatabaseLoginFragment : Fragment() {
309314
private fun webLogout() {
310315
WebAuthProvider.logout(account)
311316
.withScheme(getString(R.string.com_auth0_scheme))
317+
.withLogoutUrl(customLogoutUrl)
312318
.start(requireContext(), object : Callback<Void?, AuthenticationException> {
313319
override fun onSuccess(result: Void?) {
314320
Snackbar.make(
@@ -329,6 +335,7 @@ class DatabaseLoginFragment : Fragment() {
329335
try {
330336
WebAuthProvider.logout(account)
331337
.withScheme(getString(R.string.com_auth0_scheme))
338+
.withLogoutUrl(customLogoutUrl)
332339
.await(requireContext())
333340
Snackbar.make(
334341
requireView(), "Logged out", Snackbar.LENGTH_LONG

0 commit comments

Comments
 (0)