Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: use hierarchical route as key for collecting client menus #2462

Merged
merged 5 commits into from
May 24, 2024
Merged

fix: use hierarchical route as key for collecting client menus #2462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c5179b
fix: use hierarchical route as key for collecting client menus
taefi May 23, 2024
35b2509
add tests
taefi May 24, 2024
1dff209
add tests
taefi May 24, 2024
6d300f4
Merge branch '24.4' into taefi/fix-2460
taefi May 24, 2024
93c1a5e
Merge branch '24.4' into taefi/fix-2460
taefi May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions .../endpoint/src/main/java/com/vaadin/hilla/route/RouteUnifyingIndexHtmlRequestListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.stream.Collectors;
import java.util.stream.Stream;

import com.vaadin.hilla.route.records.ClientViewConfig;
import org.jsoup.nodes.DataNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -138,21 +139,28 @@ protected Map<String, AvailableViewInfo> collectClientViews(
deploymentConfiguration);
}

return clientRouteRegistry.getAllRoutes().values().stream()
.filter(config -> config.getRouteParameters() == null
|| config.getRouteParameters().isEmpty()
|| config.getRouteParameters().values().stream()
.noneMatch(
param -> param == RouteParamType.REQUIRED))
.filter(config -> routeUtil.isRouteAllowed(isUserInRole,
isUserAuthenticated, config))
.map(config -> new AvailableViewInfo(config.getTitle(),
config.getRolesAllowed(), config.isLoginRequired(),
config.getRoute(), config.isLazy(),
config.isAutoRegistered(), config.menu(),
config.getRouteParameters()))
.collect(Collectors.toMap(AvailableViewInfo::route,
Function.identity()));
return clientRouteRegistry.getAllRoutes().entrySet().stream()
.filter(viewMapping -> !hasRequiredParameter(
viewMapping.getValue().getRouteParameters()))
.filter(viewMapping -> routeUtil.isRouteAllowed(isUserInRole,
isUserAuthenticated, viewMapping.getValue()))
.collect(Collectors.toMap(Map.Entry::getKey,
viewMapping -> toAvailableViewInfo(
viewMapping.getValue())));
}

private boolean hasRequiredParameter(
Map<String, RouteParamType> routeParameters) {
return routeParameters != null && !routeParameters.isEmpty()
&& routeParameters.values().stream().anyMatch(
paramType -> paramType == RouteParamType.REQUIRED);
}

private AvailableViewInfo toAvailableViewInfo(ClientViewConfig config) {
return new AvailableViewInfo(config.getTitle(),
config.getRolesAllowed(), config.isLoginRequired(),
config.getRoute(), config.isLazy(), config.isAutoRegistered(),
config.menu(), config.getRouteParameters());
}

protected Map<String, AvailableViewInfo> collectServerViews(
Expand Down
28 changes: 26 additions & 2 deletions ...point/src/test/java/com/vaadin/hilla/route/RouteUnifyingIndexHtmlRequestListenerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,30 @@ private Map<String, ClientViewConfig> prepareClientRoutes() {
.setRouteParameters(Map.of(":userId", RouteParamType.REQUIRED));
routes.put("/user/:userId", userProfileConfig);

ClientViewConfig rootIndexConfig = new ClientViewConfig();
rootIndexConfig.setTitle("Index");
rootIndexConfig.setRolesAllowed(null);
rootIndexConfig.setLoginRequired(false);
rootIndexConfig.setRoute("");
rootIndexConfig.setLazy(false);
rootIndexConfig.setAutoRegistered(false);
rootIndexConfig.setMenu(null);
rootIndexConfig.setChildren(Collections.emptyList());
rootIndexConfig.setRouteParameters(Collections.emptyMap());
routes.put("/", rootIndexConfig);

ClientViewConfig ordersIndexConfig = new ClientViewConfig();
ordersIndexConfig.setTitle("Orders");
ordersIndexConfig.setRolesAllowed(null);
ordersIndexConfig.setLoginRequired(false);
ordersIndexConfig.setRoute("");
ordersIndexConfig.setLazy(false);
ordersIndexConfig.setAutoRegistered(false);
ordersIndexConfig.setMenu(null);
ordersIndexConfig.setChildren(Collections.emptyList());
ordersIndexConfig.setRouteParameters(Collections.emptyMap());
routes.put("/orders", ordersIndexConfig);

return routes;
}

Expand Down Expand Up @@ -360,7 +384,7 @@ public void when_productionMode_should_collectClientViews() {
boolean isAuthenticated = true;
var views = requestListener.collectClientViews(isUserInRole,
isAuthenticated);
MatcherAssert.assertThat(views, Matchers.aMapWithSize(2));
MatcherAssert.assertThat(views, Matchers.aMapWithSize(4));
}

@Test
Expand All @@ -371,7 +395,7 @@ public void when_developmentMode_should_collectClientViews()
Predicate<? super String> isUserInRole = role -> true;
var views = requestListener.collectClientViews(isUserInRole,
isUserAuthenticated);
MatcherAssert.assertThat(views, Matchers.aMapWithSize(2));
MatcherAssert.assertThat(views, Matchers.aMapWithSize(4));
}

@Test
Expand Down
20 changes: 20 additions & 0 deletions packages/java/endpoint/src/test/resources/META-INF/VAADIN/available-views-admin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,25 @@
"params": {
":___commentId?": "opt"
}
},
"/": {
"title": "Index",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
},
"/orders": {
"title": "Orders",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
}
}
20 changes: 20 additions & 0 deletions packages/java/endpoint/src/test/resources/META-INF/VAADIN/available-views-anonymous.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,25 @@
"params": {
":___commentId?": "opt"
}
},
"/": {
"title": "Index",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
},
"/orders": {
"title": "Orders",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
}
}
20 changes: 20 additions & 0 deletions packages/java/endpoint/src/test/resources/META-INF/VAADIN/available-views-user.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,25 @@
"params": {
":___commentId?": "opt"
}
},
"/": {
"title": "Index",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
},
"/orders": {
"title": "Orders",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
}
}
20 changes: 20 additions & 0 deletions packages/java/endpoint/src/test/resources/META-INF/VAADIN/only-client-views.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,25 @@
"register": false,
"menu": null,
"params": {}
},
"/": {
"title": "Index",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
},
"/orders": {
"title": "Orders",
"rolesAllowed": null,
"requiresLogin": false,
"route": "",
"lazy": false,
"register": false,
"menu": null,
"params": {}
}
}
Loading