Skip to content

Commit 03bade7

Browse files
committed
refactor: rename flight from ESTS_RETURN_REDIRECT to ESTS_HOST_REDIRECT
The feature applies to any eSTS cloud host navigation, not just return-from-external redirects. Rename the flight constant, string key, and Javadoc to reflect the actual behavior.
1 parent 9ebf18d commit 03bade7

3 files changed

Lines changed: 8 additions & 9 deletions

File tree

common/src/main/java/com/microsoft/identity/common/internal/ui/webview/AzureActiveDirectoryWebViewClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ else if (isRedirectUrl(formattedURL)) {
366366
} else if (CommonFlightsManager.INSTANCE.getFlightsProvider().isFlightEnabled(CommonFlight.ENABLE_ATTACH_PRT_HEADER_WHEN_CROSS_CLOUD) && isCrossCloudRedirect(formattedURL)) {
367367
Logger.info(methodTag,"Navigation contains cross cloud redirect.");
368368
processCrossCloudRedirect(view, url);
369-
} else if (CommonFlightsManager.INSTANCE.getFlightsProvider().isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT)
369+
} else if (CommonFlightsManager.INSTANCE.getFlightsProvider().isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT)
370370
&& isEstsCloudHost(url)
371371
&& hasPrtHeaderAttached()) {
372372
Logger.info(methodTag, "Navigation redirects to eSTS cloud host, re-attaching PRT header.");

common/src/test/java/com/microsoft/identity/common/internal/ui/webview/AzureActiveDirectoryWebViewClientEstsHostRedirectTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ public void isEstsCloudHost_returnsFalse_forMalformedUrl() {
134134
@Test
135135
public void handleUrl_whenFlightEnabled_andEstsHost_returnsTrue() {
136136
final IFlightsProvider mockFlightsProvider = Mockito.mock(IFlightsProvider.class);
137-
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT))
137+
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT))
138138
.thenReturn(true);
139139
// Keep other flights at default behaviour — not enabled
140140
final MockCommonFlightsManager mockCommonFlightsManager = new MockCommonFlightsManager();
@@ -149,7 +149,7 @@ public void handleUrl_whenFlightEnabled_andEstsHost_returnsTrue() {
149149
@Test
150150
public void handleUrl_whenFlightDisabled_andEstsHost_doesNotCallProcessEstsHostRedirect() {
151151
final IFlightsProvider mockFlightsProvider = Mockito.mock(IFlightsProvider.class);
152-
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT))
152+
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT))
153153
.thenReturn(false);
154154
final MockCommonFlightsManager mockCommonFlightsManager = new MockCommonFlightsManager();
155155
mockCommonFlightsManager.setMockCommonFlightsProvider(mockFlightsProvider);
@@ -165,7 +165,7 @@ public void handleUrl_whenFlightDisabled_andEstsHost_doesNotCallProcessEstsHostR
165165
@Test
166166
public void handleUrl_whenFlightEnabled_andNonEstsHost_doesNotHandleAsEstsHostRedirect() {
167167
final IFlightsProvider mockFlightsProvider = Mockito.mock(IFlightsProvider.class);
168-
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT))
168+
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT))
169169
.thenReturn(true);
170170
final MockCommonFlightsManager mockCommonFlightsManager = new MockCommonFlightsManager();
171171
mockCommonFlightsManager.setMockCommonFlightsProvider(mockFlightsProvider);
@@ -181,7 +181,7 @@ public void handleUrl_whenFlightEnabled_andNonEstsHost_doesNotHandleAsEstsHostRe
181181
@Test
182182
public void handleUrl_whenFlightEnabled_andEstsHost_butNoPrtHeader_doesNotHandleAsEstsHostRedirect() {
183183
final IFlightsProvider mockFlightsProvider = Mockito.mock(IFlightsProvider.class);
184-
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT))
184+
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT))
185185
.thenReturn(true);
186186
final MockCommonFlightsManager mockCommonFlightsManager = new MockCommonFlightsManager();
187187
mockCommonFlightsManager.setMockCommonFlightsProvider(mockFlightsProvider);
@@ -207,7 +207,7 @@ public void setRequestUrl_extractsLoginHint_whenPresent() {
207207
// an eSTS host, the handler is called (i.e., processEstsHostRedirect
208208
// was triggered), meaning the URL was handled.
209209
final IFlightsProvider mockFlightsProvider = Mockito.mock(IFlightsProvider.class);
210-
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT))
210+
when(mockFlightsProvider.isFlightEnabled(CommonFlight.ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT))
211211
.thenReturn(true);
212212
final MockCommonFlightsManager mockCommonFlightsManager = new MockCommonFlightsManager();
213213
mockCommonFlightsManager.setMockCommonFlightsProvider(mockFlightsProvider);

common4j/src/main/com/microsoft/identity/common/java/flighting/CommonFlight.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,11 +247,10 @@ public enum CommonFlight implements IFlightConfig {
247247
USE_ENABLED_SETTING_FOR_PACKAGE_CHECK("UseEnabledSettingForPackageCheck", false),
248248

249249
/**
250-
* Flight to enable PRT header re-attachment when WebView redirects back to an eSTS cloud host
251-
* after visiting an external Entra service domain (e.g. mysignins.microsoft.com).
250+
* Flight to enable PRT header re-attachment when WebView navigates to an eSTS cloud host.
252251
* When enabled, a fresh PRT credential JWT is generated and attached to the request.
253252
*/
254-
ENABLE_PRT_HEADER_FOR_ESTS_RETURN_REDIRECT("EnablePrtHeaderForEstsReturnRedirect", false);
253+
ENABLE_PRT_HEADER_FOR_ESTS_HOST_REDIRECT("EnablePrtHeaderForEstsHostRedirect", false);
255254

256255
private String key;
257256
private Object defaultValue;

0 commit comments

Comments
 (0)