feat: generate layout.json (#19933)

Genrate a layout.json for Hilla to automatically enable server layouts part of vaadin/hilla#2709
vaadin · Sep 13, 2024 · e4a00ab · e4a00ab
1 parent 20623f5
commit e4a00ab
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 2 deletions.
diff --git a/flow-server/src/main/java/com/vaadin/flow/server/frontend/TaskGenerateReactFiles.java b/flow-server/src/main/java/com/vaadin/flow/server/frontend/TaskGenerateReactFiles.java
@@ -20,6 +20,7 @@
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.StandardCopyOption;
+import java.util.Set;
 import java.util.regex.Pattern;
 
 import org.apache.commons.io.FileUtils;
@@ -28,10 +29,14 @@
 import org.slf4j.LoggerFactory;
 
 import com.vaadin.flow.internal.StringUtil;
+import com.vaadin.flow.router.Layout;
 import com.vaadin.flow.router.Route;
 import com.vaadin.flow.server.ExecutionFailedException;
 import com.vaadin.flow.server.Version;
 
+import elemental.json.Json;
+import elemental.json.JsonArray;
+import elemental.json.JsonObject;
 import static com.vaadin.flow.server.frontend.FileIOUtils.compareIgnoringIndentationEOLAndWhiteSpace;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -102,6 +107,7 @@ function build() {
     private static final String VAADIN_REACT_TSX = "vaadin-react.tsx";
     private static final String REACT_ADAPTER_TEMPLATE = "ReactAdapter.template";
     private static final String REACT_ADAPTER_TSX = "ReactAdapter.tsx";
+    private static final String LAYOUTS_JSON = "layouts.json";
     static final String FLOW_FLOW_TSX = "flow/" + FLOW_TSX;
     static final String FLOW_REACT_ADAPTER_TSX = "flow/" + REACT_ADAPTER_TSX;
     private static final String ROUTES_JS_IMPORT_PATH_TOKEN = "%routesJsImportPath%";
@@ -158,6 +164,8 @@ private void doExecute() throws ExecutionFailedException {
             writeFile(flowTsx, getFileContent(FLOW_TSX));
             writeFile(vaadinReactTsx,
                     getVaadinReactTsContent(routesTsx.exists()));
+            writeFile(new File(frontendGeneratedFolder, LAYOUTS_JSON),
+                    layoutsContent());
             if (fileAvailable(REACT_ADAPTER_TEMPLATE)) {
                 String reactAdapterContent = getFileContent(
                         REACT_ADAPTER_TEMPLATE);
@@ -193,6 +201,19 @@ && serverRoutesAvailable()) {
         }
     }
 
+    private String layoutsContent() {
+        JsonArray availableLayouts = Json.createArray();
+        Set<Class<?>> layoutClasses = options.getClassFinder()
+                .getAnnotatedClasses(Layout.class);
+        for (Class<?> layout : layoutClasses) {
+            JsonObject layoutObject = Json.createObject();
+            layoutObject.put("path",
+                    layout.getAnnotation(Layout.class).value());
+            availableLayouts.set(availableLayouts.length(), layoutObject);
+        }
+        return availableLayouts.toJson();
+    }
+
     private void cleanup() throws ExecutionFailedException {
         try {
             File frontendDirectory = options.getFrontendDirectory();
@@ -204,7 +225,9 @@ private void cleanup() throws ExecutionFailedException {
                     FLOW_REACT_ADAPTER_TSX);
             File frontendGeneratedFolderRoutesTsx = new File(
                     frontendGeneratedFolder, FrontendUtils.ROUTES_TSX);
+            File layoutsJson = new File(frontendGeneratedFolder, LAYOUTS_JSON);
             FileUtils.deleteQuietly(flowTsx);
+            FileUtils.deleteQuietly(layoutsJson);
             FileUtils.deleteQuietly(vaadinReactTsx);
             FileUtils.deleteQuietly(reactAdapterTsx);
             FileUtils.deleteQuietly(frontendGeneratedFolderRoutesTsx);

diff --git a/flow-server/src/test/java/com/vaadin/flow/server/frontend/TaskGenerateReactFilesTest.java b/flow-server/src/test/java/com/vaadin/flow/server/frontend/TaskGenerateReactFilesTest.java
@@ -31,7 +31,9 @@
 
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.component.Tag;
+import com.vaadin.flow.router.Layout;
 import com.vaadin.flow.router.Route;
+import com.vaadin.flow.router.RouterLayout;
 import com.vaadin.flow.server.ExecutionFailedException;
 import com.vaadin.flow.server.frontend.scanner.ClassFinder;
 import com.vaadin.tests.util.MockOptions;
@@ -82,6 +84,27 @@ public void reactFilesAreWrittenToFrontend()
                         "routes.tsx").exists());
         Assert.assertFalse("Missing ./frontend/routes.tsx",
                 new File(frontend, "routes.tsx").exists());
+        Assert.assertTrue(
+                "Missing ./frontend/" + FrontendUtils.GENERATED
+                        + "layouts.json",
+                new File(new File(frontend, FrontendUtils.GENERATED),
+                        "layouts.json").exists());
+    }
+
+    @Test
+    public void layoutsJson_containsExpectedPaths()
+            throws ExecutionFailedException, IOException {
+        Mockito.when(options.getClassFinder().getAnnotatedClasses(Layout.class))
+                .thenReturn(Collections.singleton(TestLayout.class));
+
+        TaskGenerateReactFiles task = new TaskGenerateReactFiles(options);
+        task.execute();
+
+        String layoutsContent = FileUtils.readFileToString(
+                new File(options.getFrontendGeneratedFolder(), "layouts.json"));
+
+        Assert.assertEquals("[{\"path\":\"/test\"}]", layoutsContent);
+
     }
 
     @Test
@@ -555,4 +578,9 @@ public void routesContainExport_oneSingleExport_exceptionThrown()
     @Route("test")
     private class TestRoute extends Component {
     }
+
+    @Tag("div")
+    @Layout("/test")
+    private class TestLayout extends Component implements RouterLayout {
+    }
 }
diff --git a/...in-dev-server/src/main/java/com/vaadin/base/devserver/startup/DevModeStartupListener.java b/...in-dev-server/src/main/java/com/vaadin/base/devserver/startup/DevModeStartupListener.java
@@ -39,6 +39,7 @@
 import com.vaadin.flow.internal.DevModeHandlerManager;
 import com.vaadin.flow.internal.Template;
 import com.vaadin.flow.router.HasErrorParameter;
+import com.vaadin.flow.router.Layout;
 import com.vaadin.flow.router.Route;
 import com.vaadin.flow.server.LoadDependenciesOnStartup;
 import com.vaadin.flow.server.PWA;
@@ -68,7 +69,7 @@
         JavaScript.Container.class, Theme.class, NoTheme.class,
         HasErrorParameter.class, PWA.class, AppShellConfigurator.class,
         Template.class, LoadDependenciesOnStartup.class,
-        TypeScriptBootstrapModifier.class, Component.class })
+        TypeScriptBootstrapModifier.class, Component.class, Layout.class })
 @WebListener
 public class DevModeStartupListener
         implements VaadinServletContextStartupInitializer, Serializable,

diff --git a/...in-dev-server/src/test/java/com/vaadin/base/devserver/startup/DevModeClassFinderTest.java b/...in-dev-server/src/test/java/com/vaadin/base/devserver/startup/DevModeClassFinderTest.java
@@ -37,6 +37,7 @@
 import com.vaadin.flow.component.page.AppShellConfigurator;
 import com.vaadin.flow.internal.Template;
 import com.vaadin.flow.router.HasErrorParameter;
+import com.vaadin.flow.router.Layout;
 import com.vaadin.flow.router.Route;
 import com.vaadin.flow.server.LoadDependenciesOnStartup;
 import com.vaadin.flow.server.PWA;
@@ -69,7 +70,8 @@ public void applicableClasses_knownClasses() {
                 CssImport.Container.class, Theme.class, NoTheme.class,
                 HasErrorParameter.class, PWA.class, AppShellConfigurator.class,
                 Template.class, LoadDependenciesOnStartup.class,
-                Component.class, TypeScriptBootstrapModifier.class);
+                Component.class, TypeScriptBootstrapModifier.class,
+                Layout.class);
 
         for (Class<?> clz : classes) {
             assertTrue("should be a known class " + clz.getName(),