Skip to content

Commit 62cae89

Browse files
authored
fix: forward with optional callback (#19959)
* fix: forwarding with optional callback
1 parent c615be5 commit 62cae89

9 files changed

Lines changed: 158 additions & 13 deletions

File tree

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ public abstract class BeforeEvent extends EventObject {
5858
private String unknownReroute = null;
5959

6060
private String externalForwardUrl = null;
61+
private boolean useForwardCallback;
6162

6263
/**
6364
* Constructs event from a NavigationEvent.
@@ -340,6 +341,30 @@ public void forwardTo(Class<? extends Component> forwardTargetComponent) {
340341
RouteParameters.empty(), null));
341342
}
342343

344+
/**
345+
* Forward the navigation to show the given component instead of the
346+
* component that is currently about to be displayed.
347+
* <p>
348+
* This function changes the browser URL as opposed to
349+
* <code>rerouteTo()</code>.
350+
* <p>
351+
* Note that query parameters of the event are preserved in the forwarded
352+
* URL.
353+
*
354+
* @param forwardTargetComponent
355+
* the component type to display, not {@code null}
356+
* @param useForwardCallback
357+
* {@literal true} to request navigation callback from client
358+
*/
359+
public void forwardTo(Class<? extends Component> forwardTargetComponent,
360+
boolean useForwardCallback) {
361+
Objects.requireNonNull(forwardTargetComponent,
362+
"forwardTargetComponent cannot be null");
363+
this.useForwardCallback = useForwardCallback;
364+
forwardTo(getNavigationState(forwardTargetComponent,
365+
RouteParameters.empty(), null));
366+
}
367+
343368
/**
344369
* Forward the navigation to show the given component with given route
345370
* parameter instead of the component that is currently about to be
@@ -1139,6 +1164,17 @@ public ErrorParameter<?> getErrorParameter() {
11391164
return errorParameter;
11401165
}
11411166

1167+
/**
1168+
* Determines is client side callback should be requested when executing
1169+
* pending forward operation.
1170+
*
1171+
* @return {@literal true} if callback should be used,
1172+
* {@literal false otherwise}
1173+
*/
1174+
public boolean isUseForwardCallback() {
1175+
return useForwardCallback;
1176+
}
1177+
11421178
/**
11431179
* Gets the UI this navigation takes place inside.
11441180
*

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

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -737,20 +737,11 @@ private int forwardToExternalUrl(NavigationEvent event,
737737
private int forward(NavigationEvent event, BeforeEvent beforeNavigation) {
738738
NavigationHandler handler = beforeNavigation.getForwardTarget();
739739

740-
Class<? extends Component> forwardTargetType = beforeNavigation
741-
.getForwardTargetType();
742-
743-
List<Class<? extends RouterLayout>> parentLayouts = RouteUtil
744-
.getParentLayouts(event.getUI().getRouter().getRegistry(),
745-
forwardTargetType, beforeNavigation.getForwardUrl());
746-
747-
boolean preserveOnRefreshTarget = isPreserveOnRefreshTarget(
748-
forwardTargetType, parentLayouts);
749-
750740
NavigationEvent newNavigationEvent = getNavigationEvent(event,
751741
beforeNavigation);
752742
newNavigationEvent.getUI().getPage().getHistory().replaceState(null,
753-
newNavigationEvent.getLocation(), !preserveOnRefreshTarget);
743+
newNavigationEvent.getLocation(),
744+
beforeNavigation.isUseForwardCallback());
754745

755746
return handler.handle(newNavigationEvent);
756747
}

‎flow-server/src/main/java/com/vaadin/flow/server/auth/NavigationAccessControl.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ public void beforeEnter(BeforeEnterEvent event) {
246246
if (context.getPrincipal() == null) {
247247
storeRedirectURL(event, request);
248248
if (loginView != null) {
249-
event.forwardTo(loginView);
249+
event.forwardTo(loginView, true);
250250
} else {
251251
if (loginUrl != null) {
252252
event.forwardToUrl(loginUrl);

‎flow-server/src/main/java/com/vaadin/flow/server/auth/ViewAccessChecker.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ public void beforeEnter(BeforeEnterEvent beforeEnterEvent) {
206206
}
207207
}
208208
if (loginView != null) {
209-
beforeEnterEvent.forwardTo(loginView);
209+
beforeEnterEvent.forwardTo(loginView, true);
210210
} else {
211211
if (loginUrl != null) {
212212
beforeEnterEvent.forwardToUrl(loginUrl);
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package com.vaadin.flow;
2+
3+
import com.vaadin.flow.component.html.Div;
4+
import com.vaadin.flow.router.Route;
5+
6+
@Route("com.vaadin.flow.ForwardTargetView")
7+
public class ForwardTargetView extends Div {
8+
9+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package com.vaadin.flow;
2+
3+
import com.vaadin.flow.component.html.Div;
4+
import com.vaadin.flow.component.html.Span;
5+
import com.vaadin.flow.router.BeforeEvent;
6+
import com.vaadin.flow.router.HasUrlParameter;
7+
import com.vaadin.flow.router.OptionalParameter;
8+
import com.vaadin.flow.router.Route;
9+
10+
@Route("com.vaadin.flow.ForwardTargetWithParametersView")
11+
public class ForwardTargetWithParametersView extends Div
12+
implements HasUrlParameter<String> {
13+
14+
@Override
15+
public void setParameter(BeforeEvent event,
16+
@OptionalParameter String parameter) {
17+
add(new Span("setParameter"));
18+
}
19+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package com.vaadin.flow;
2+
3+
import com.vaadin.flow.component.html.Div;
4+
import com.vaadin.flow.router.BeforeEnterEvent;
5+
import com.vaadin.flow.router.BeforeEnterObserver;
6+
import com.vaadin.flow.router.Route;
7+
8+
@Route("com.vaadin.flow.ForwardingToParametersView")
9+
public class ForwardingToParametersView extends Div
10+
implements BeforeEnterObserver {
11+
@Override
12+
public void beforeEnter(BeforeEnterEvent event) {
13+
event.forwardTo(ForwardTargetWithParametersView.class);
14+
}
15+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package com.vaadin.flow;
2+
3+
import com.vaadin.flow.component.html.Div;
4+
import com.vaadin.flow.router.BeforeEnterEvent;
5+
import com.vaadin.flow.router.BeforeEnterObserver;
6+
import com.vaadin.flow.router.Route;
7+
8+
@Route("com.vaadin.flow.ForwardingView")
9+
public class ForwardingView extends Div implements BeforeEnterObserver {
10+
@Override
11+
public void beforeEnter(BeforeEnterEvent event) {
12+
event.forwardTo(ForwardTargetView.class);
13+
}
14+
}
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package com.vaadin.flow;
2+
3+
import org.junit.Assert;
4+
import org.junit.Test;
5+
import org.openqa.selenium.TimeoutException;
6+
7+
import com.vaadin.flow.component.html.testbench.SpanElement;
8+
import com.vaadin.flow.testutil.ChromeBrowserTest;
9+
10+
public class ForwardTargetIT extends ChromeBrowserTest {
11+
12+
public static final String FORWARD_TARGET_VIEW = "/view/com.vaadin.flow.ForwardTargetView";
13+
14+
// Test for https://github.com/vaadin/flow/issues/19794
15+
@Test
16+
public void testUrlIsCorrectAfterForward() {
17+
getDriver().get(getTestURL(getRootURL(), FORWARD_TARGET_VIEW, null));
18+
19+
try {
20+
waitUntil(arg -> driver.getCurrentUrl()
21+
.endsWith(FORWARD_TARGET_VIEW));
22+
} catch (TimeoutException e) {
23+
Assert.fail("URL wasn't updated to expected one: "
24+
+ FORWARD_TARGET_VIEW);
25+
}
26+
27+
getDriver().get(getTestURL(getRootURL(),
28+
"/view/com.vaadin.flow.ForwardingView", null));
29+
30+
try {
31+
waitUntil(arg -> driver.getCurrentUrl()
32+
.endsWith(FORWARD_TARGET_VIEW));
33+
} catch (TimeoutException e) {
34+
Assert.fail("URL wasn't updated to expected one: "
35+
+ FORWARD_TARGET_VIEW);
36+
}
37+
38+
Assert.assertTrue("URL was not the expected one after forward call",
39+
driver.getCurrentUrl().endsWith(FORWARD_TARGET_VIEW));
40+
}
41+
42+
// Test for https://github.com/vaadin/flow/issues/19822
43+
@Test
44+
public void testSetParameterCalledOnlyOnceAfterForward() {
45+
getDriver().get(getTestURL(getRootURL(),
46+
"/view/com.vaadin.flow.ForwardingToParametersView", null));
47+
48+
try {
49+
waitUntil(arg -> driver.getCurrentUrl().endsWith(
50+
"/view/com.vaadin.flow.ForwardTargetWithParametersView"));
51+
} catch (TimeoutException e) {
52+
Assert.fail("URL wasn't updated to expected one: "
53+
+ "/view/com.vaadin.flow.ForwardTargetWithParametersView");
54+
}
55+
56+
Assert.assertEquals("setParameter was called more than once", 1,
57+
$(SpanElement.class).all().stream()
58+
.filter(span -> span.getText().equals("setParameter"))
59+
.count());
60+
}
61+
}

0 commit comments

Comments
 (0)