Skip to content

Commit 56ea3aa

Browse files
authored
fix: Validate Layout annotation (#19849)
Add validation that Layout annotated classes are on classes that extend RouterLayout.
1 parent b9d72b8 commit 56ea3aa

3 files changed

Lines changed: 60 additions & 2 deletions

File tree

‎flow-server/src/main/java/com/vaadin/flow/server/startup/RouteRegistryInitializer.java‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717

1818
import jakarta.servlet.annotation.HandlesTypes;
1919

20+
import java.util.List;
2021
import java.util.Set;
22+
import java.util.stream.Collectors;
2123

2224
import com.googlecode.gentyref.GenericTypeReflector;
2325

@@ -30,6 +32,7 @@
3032
import com.vaadin.flow.router.RouterLayout;
3133
import com.vaadin.flow.server.AmbiguousRouteConfigurationException;
3234
import com.vaadin.flow.server.InvalidRouteConfigurationException;
35+
import com.vaadin.flow.server.InvalidRouteLayoutConfigurationException;
3336
import com.vaadin.flow.server.VaadinContext;
3437
import com.vaadin.flow.router.Layout;
3538

@@ -63,6 +66,7 @@ public void initialize(Set<Class<?>> classSet, VaadinContext context)
6366
ApplicationRouteRegistry routeRegistry = ApplicationRouteRegistry
6467
.getInstance(context);
6568

69+
validateLayoutAnnotations(routesSet);
6670
routesSet.stream()
6771
.filter(clazz -> clazz.isAnnotationPresent(Layout.class))
6872
.filter(clazz -> RouterLayout.class.isAssignableFrom(clazz))
@@ -88,6 +92,33 @@ public void initialize(Set<Class<?>> classSet, VaadinContext context)
8892
}
8993
}
9094

95+
/**
96+
* Validate {@link Layout} annotations that they are not added on classes
97+
* that do not extend {@link RouterLayout} as they can not work without the
98+
* implementation.
99+
*
100+
* @param routesSet
101+
* Routes to check
102+
* @throws InvalidRouteLayoutConfigurationException
103+
* Thrown if any {@link Layout} annotations are found on non
104+
* {@link RouterLayout} classes
105+
*/
106+
public static void validateLayoutAnnotations(Set<Class<?>> routesSet)
107+
throws InvalidRouteLayoutConfigurationException {
108+
List<Class<?>> faultyLayouts = routesSet.stream()
109+
.filter(clazz -> clazz.isAnnotationPresent(Layout.class))
110+
.filter(clazz -> !RouterLayout.class.isAssignableFrom(clazz))
111+
.collect(Collectors.toList());
112+
if (!faultyLayouts.isEmpty()) {
113+
String message = "Found @Layout on classes not extending RouterLayout.%nCheck the following classes: %s";
114+
String faultyLayoutsString = faultyLayouts.stream()
115+
.map(clazz -> clazz.getName())
116+
.collect(Collectors.joining(","));
117+
throw new InvalidRouteLayoutConfigurationException(
118+
String.format(message, faultyLayoutsString));
119+
}
120+
}
121+
91122
private void configureStaticRoutesRegistry(VaadinContext context,
92123
Set<Class<? extends Component>> routes) {
93124
PreviouslyStoredRoutesRegistry registry = new PreviouslyStoredRoutesRegistry(

‎flow-server/src/test/java/com/vaadin/flow/server/startup/RouteRegistryInitializerTest.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
import com.vaadin.flow.router.HasDynamicTitle;
5050
import com.vaadin.flow.router.HasErrorParameter;
5151
import com.vaadin.flow.router.HasUrlParameter;
52+
import com.vaadin.flow.router.Layout;
5253
import com.vaadin.flow.router.NotFoundException;
5354
import com.vaadin.flow.router.PageTitle;
5455
import com.vaadin.flow.router.ParentLayout;
@@ -874,6 +875,24 @@ public static class InlineFailingAliasView extends Component {
874875
public static class InlineAliasView extends Component {
875876
}
876877

878+
@Layout
879+
@Tag(Tag.DIV)
880+
public static class FaultyParentLayout extends Component {
881+
}
882+
883+
@Test
884+
public void layout_annotation_on_non_routelayout_throws()
885+
throws ServletException {
886+
expectedEx.expect(InvalidRouteLayoutConfigurationException.class);
887+
expectedEx.expectMessage(String.format(
888+
"Found @Layout on classes not extending RouterLayout.%nCheck the following classes: %s",
889+
FaultyParentLayout.class.getName()));
890+
891+
routeRegistryInitializer.process(
892+
Stream.of(FaultyParentLayout.class).collect(Collectors.toSet()),
893+
servletContext);
894+
}
895+
877896
@Test
878897
public void process_wrong_position_inline_view_layout_throws()
879898
throws ServletException {

‎vaadin-spring/src/main/java/com/vaadin/flow/spring/VaadinServletContextInitializer.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
import com.vaadin.flow.router.RouterLayout;
7272
import com.vaadin.flow.server.AmbiguousRouteConfigurationException;
7373
import com.vaadin.flow.server.InvalidRouteConfigurationException;
74+
import com.vaadin.flow.server.InvalidRouteLayoutConfigurationException;
7475
import com.vaadin.flow.server.RouteRegistry;
7576
import com.vaadin.flow.server.VaadinServletContext;
7677
import com.vaadin.flow.server.communication.IndexHtmlRequestHandler;
@@ -81,6 +82,7 @@
8182
import com.vaadin.flow.server.startup.ApplicationRouteRegistry;
8283
import com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer;
8384
import com.vaadin.flow.server.startup.LookupServletContainerInitializer;
85+
import com.vaadin.flow.server.startup.RouteRegistryInitializer;
8486
import com.vaadin.flow.server.startup.VaadinAppShellInitializer;
8587
import com.vaadin.flow.server.startup.VaadinInitializerException;
8688
import com.vaadin.flow.server.startup.WebComponentConfigurationRegistryInitializer;
@@ -354,8 +356,13 @@ public void failFastContextInitialized(ServletContextEvent event) {
354356
"There are {} navigation targets after filtering route classes: {}",
355357
navigationTargets.size(), navigationTargets);
356358

359+
Set<Class<?>> layoutClasses = findByAnnotation(
360+
routePackages, Layout.class)
361+
.collect(Collectors.toSet());
362+
RouteRegistryInitializer
363+
.validateLayoutAnnotations(layoutClasses);
357364
// Collect all layouts to use with Hilla as a main layout
358-
findByAnnotation(routePackages, Layout.class).filter(
365+
layoutClasses.stream().filter(
359366
clazz -> RouterLayout.class.isAssignableFrom(clazz))
360367
.forEach(clazz -> registry.setLayout(
361368
(Class<? extends RouterLayout>) clazz));
@@ -368,7 +375,8 @@ public void failFastContextInitialized(ServletContextEvent event) {
368375
registry.setPwaConfigurationClass(validatePwaClass(
369376
vaadinServletContext, routeClasses.stream()));
370377

371-
} catch (InvalidRouteConfigurationException e) {
378+
} catch (InvalidRouteConfigurationException
379+
| InvalidRouteLayoutConfigurationException e) {
372380
throw new IllegalStateException(e);
373381
}
374382
} else {

0 commit comments

Comments
 (0)