Skip to content

Commit 938cd0c

Browse files
vaadin-botArtur-
andauthored
feat: Allow rerouting to an external URL (#14571) (#14642)
Fixes #11029 Co-authored-by: Artur <artur@vaadin.com>
1 parent 28358e3 commit 938cd0c

3 files changed

Lines changed: 93 additions & 8 deletions

File tree

‎flow-server/src/main/java/com/vaadin/flow/router/BeforeEvent.java‎

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,10 @@ public abstract class BeforeEvent extends EventObject {
5353
private NavigationState rerouteTargetState;
5454
private ErrorParameter<?> errorParameter;
5555

56-
private String forwardToUrl = null;
57-
private String rerouteToUrl = null;
56+
private String unknownForward = null;
57+
private String unknownReroute = null;
58+
59+
private String externalForwardUrl = null;
5860

5961
/**
6062
* Constructs event from a NavigationEvent.
@@ -165,7 +167,7 @@ public BeforeEvent(Router router, NavigationTrigger trigger,
165167
* @return forward route is not found in the route registry.
166168
*/
167169
public boolean hasUnknownForward() {
168-
return forwardToUrl != null;
170+
return unknownForward != null;
169171
}
170172

171173
/**
@@ -175,7 +177,7 @@ public boolean hasUnknownForward() {
175177
* @return reroute is not found in the route registry.
176178
*/
177179
public boolean hasUnknownReroute() {
178-
return rerouteToUrl != null;
180+
return unknownReroute != null;
179181
}
180182

181183
/**
@@ -184,7 +186,7 @@ public boolean hasUnknownReroute() {
184186
* @return the unknown forward.
185187
*/
186188
public String getUnknownForward() {
187-
return forwardToUrl;
189+
return unknownForward;
188190
}
189191

190192
/**
@@ -193,7 +195,16 @@ public String getUnknownForward() {
193195
* @return the unknown reroute.
194196
*/
195197
public String getUnknownReroute() {
196-
return rerouteToUrl;
198+
return unknownReroute;
199+
}
200+
201+
/**
202+
* Gets the external forward url.
203+
*
204+
* @return the external forward url or {@code null} if none has been set
205+
*/
206+
public String getExternalForwardUrl() {
207+
return externalForwardUrl;
197208
}
198209

199210
/**
@@ -229,6 +240,15 @@ public boolean hasForwardTarget() {
229240
return forwardTarget != null;
230241
}
231242

243+
/**
244+
* Check if we have a forward for an external URL.
245+
*
246+
* @return forward target exists
247+
*/
248+
public boolean hasExternalForwardUrl() {
249+
return externalForwardUrl != null;
250+
}
251+
232252
/**
233253
* Check if we have a reroute target.
234254
*
@@ -361,10 +381,22 @@ public void forwardTo(String location) {
361381
location));
362382
} else {
363383
// Inform that forward target location is not known.
364-
forwardToUrl = PathUtil.trimPath(location);
384+
unknownForward = PathUtil.trimPath(location);
365385
}
366386
}
367387

388+
/**
389+
* Forward to the given URL instead of the component about to be displayed.
390+
* <p>
391+
* This function performs a page reload in the browser with the new URL.
392+
*
393+
* @param externalForwardUrl
394+
* forward target location string
395+
*/
396+
public void forwardToUrl(String externalForwardUrl) {
397+
this.externalForwardUrl = externalForwardUrl;
398+
}
399+
368400
/**
369401
* Forward to navigation component registered for given location string with
370402
* given location parameter instead of the component about to be displayed.
@@ -505,7 +537,7 @@ public void rerouteTo(String route) {
505537
route));
506538
} else {
507539
// Inform that reroute target location is not known.
508-
rerouteToUrl = PathUtil.trimPath(route);
540+
unknownReroute = PathUtil.trimPath(route);
509541
}
510542
}
511543

‎flow-server/src/main/java/com/vaadin/flow/router/internal/AbstractNavigationStateRenderer.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,9 @@ private static boolean isComponentElementEqualsOrChild(
658658
protected Optional<Integer> handleTriggeredBeforeEvent(
659659
NavigationEvent event, BeforeEvent beforeEvent) {
660660

661+
if (beforeEvent.hasExternalForwardUrl()) {
662+
return Optional.of(forwardToExternalUrl(event, beforeEvent));
663+
}
661664
if (beforeEvent.hasForwardTarget()
662665
&& !isSameNavigationState(beforeEvent.getForwardTargetType(),
663666
beforeEvent.getForwardTargetRouteParameters())) {
@@ -684,6 +687,14 @@ private boolean isSameNavigationState(Class<? extends Component> targetType,
684687
return sameTarget && sameParameters;
685688
}
686689

690+
private int forwardToExternalUrl(NavigationEvent event,
691+
BeforeEvent beforeNavigation) {
692+
event.getUI().getPage()
693+
.setLocation(beforeNavigation.getExternalForwardUrl());
694+
695+
return HttpStatusCode.OK.getCode();
696+
}
697+
687698
private int forward(NavigationEvent event, BeforeEvent beforeNavigation) {
688699
NavigationHandler handler = beforeNavigation.getForwardTarget();
689700

‎flow-server/src/test/java/com/vaadin/flow/router/RouterTest.java‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1616,6 +1616,17 @@ public void afterNavigation(AfterNavigationEvent event) {
16161616
}
16171617
}
16181618

1619+
@Route("forwardtourl")
1620+
@Tag(Tag.DIV)
1621+
public static class RedirectToExternalUrl extends Component {
1622+
static AtomicInteger instancesCreated = new AtomicInteger(0);
1623+
1624+
public RedirectToExternalUrl() {
1625+
instancesCreated.incrementAndGet();
1626+
}
1627+
1628+
}
1629+
16191630
@Override
16201631
@Before
16211632
public void init() throws NoSuchFieldException, SecurityException,
@@ -3922,6 +3933,37 @@ public void forward_fromSetParameters_withoutBeforeEnterObserver() {
39223933
ForwardSetParameterView.backBeforeEnterInvoked);
39233934
}
39243935

3936+
@Test
3937+
public void forwardToExternalUrl_preventsViewFromBeingCreated() {
3938+
setNavigationTargets(RedirectToExternalUrl.class);
3939+
ui.addBeforeEnterListener(
3940+
e -> e.forwardToUrl("https://external/enter"));
3941+
3942+
navigate("forwardtourl");
3943+
3944+
Assert.assertEquals(0, RedirectToExternalUrl.instancesCreated.get());
3945+
}
3946+
3947+
@Test
3948+
public void forwardToExternalUrl_forwardsToUrl() {
3949+
String externalForwardUrl = "https://external/enter";
3950+
setNavigationTargets(RedirectToExternalUrl.class);
3951+
ui.addBeforeEnterListener(e -> {
3952+
e.forwardToUrl(externalForwardUrl);
3953+
});
3954+
3955+
navigate("forwardtourl");
3956+
long historyInvocations = ui.getInternals()
3957+
.dumpPendingJavaScriptInvocations().stream()
3958+
.filter(js -> js.getInvocation().getExpression()
3959+
.contains("window.open")
3960+
&& ((String) js.getInvocation().getParameters().get(0))
3961+
.contains(externalForwardUrl))
3962+
.count();
3963+
assertEquals(1, historyInvocations);
3964+
3965+
}
3966+
39253967
private void assertWrongRouteParametersRedirect() {
39263968
assertRouteParameters("show/wrong", null, null);
39273969
}

0 commit comments

Comments
 (0)