feat: Move default frontend to src/main and enable frontend fallback (#…

…18828)

Move frontend folder from root to src/main.

Enable falling back to the
original frontend folder if
the new one doesn't exist.

Closes #18436

.gitignore

@@ -98,3 +98,4 @@ vaadin-dev-server/src/main/resources/META-INF/frontend
 vaadin-dev-server/src/main/resources/META-INF/metadata
 
 /flow-tests/**/frontend/routes.tsx
+flow-tests/**/src/main/bundles/*

flow-plugins/flow-dev-bundle-plugin/src/main/java/com/vaadin/flow/plugin/maven/BuildDevBundleMojo.java

@@ -164,6 +164,12 @@ public class BuildDevBundleMojo extends AbstractMojo
     @Parameter(property = InitParameters.REACT_ENABLE, defaultValue = "true")
     private boolean reactEnable;
 
+    /**
+     * A directory with project's frontend source files.
+     */
+    @Parameter(defaultValue = "${project.basedir}/src/main/" + FRONTEND)
+    private File frontendDirectory;
+
     @Override
     public void execute() throws MojoFailureException {
         long start = System.nanoTime();
@@ -262,12 +268,12 @@ public boolean eagerServerLoad() {
 
     @Override
     public File frontendDirectory() {
-        return new File(projectBasedir, FRONTEND);
+        return frontendDirectory;
     }
 
     @Override
     public File generatedTsFolder() {
-        return new File(projectBasedir, FRONTEND + "/generated");
+        return new File(frontendDirectory(), "generated");
     }
 
     @Override

flow-plugins/flow-gradle-plugin/src/functionalTest/kotlin/com/vaadin/gradle/VaadinSmokeTest.kt

@@ -135,10 +135,10 @@ class VaadinSmokeTest : AbstractGradleTest() {
      */
     @Test
     fun vaadinPrepareFrontendDeletesFrontendGeneratedFolder() {
-        val generatedFolder = testProject.newFolder("frontend/generated")
-        val generatedFile = testProject.newFile("frontend/generated/index.ts")
-        val generatedFlowFolder = testProject.newFolder("frontend/generated/flow")
-        val generatedOldFlowFile = testProject.newFolder("frontend/generated/flow/extra.js")
+        val generatedFolder = testProject.newFolder(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR)
+        val generatedFile = testProject.newFile(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "index.ts")
+        val generatedFlowFolder = testProject.newFolder(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "flow")
+        val generatedOldFlowFile = testProject.newFolder(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "/flow/extra.js")
         testProject.build("vaadinPrepareFrontend")
         expect(true) { generatedFolder.exists() }
         expect(false) { generatedFile.exists() }
@@ -166,8 +166,8 @@ class VaadinSmokeTest : AbstractGradleTest() {
      */
     @Test
     fun vaadinCleanDeletesGeneratedFolder() {
-        val generatedFolder = testProject.newFolder("frontend/generated")
-        val generatedFile = testProject.newFile("frontend/generated/index.ts")
+        val generatedFolder = testProject.newFolder(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR)
+        val generatedFile = testProject.newFile(FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "index.ts")
         testProject.build("vaadinClean")
         expect(false) { generatedFile.exists() }
         expect(false) { generatedFolder.exists() }
@@ -317,11 +317,11 @@ class VaadinSmokeTest : AbstractGradleTest() {
         result.expectTaskSucceded("vaadinBuildFrontend")
 
         expect(false) {
-            File(testProject.dir, "frontend/generated/index.ts").exists()
+            File(testProject.dir, FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "index.ts").exists()
         }
         expect(true) {
             // Only generated for executing project or building bundle
-            File(testProject.dir, "src/main/frontend/generated/index.tsx").exists()
+            File(testProject.dir, FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "index.tsx").exists()
         }
     }
 
@@ -365,7 +365,7 @@ class VaadinSmokeTest : AbstractGradleTest() {
         result.expectTaskSucceded("vaadinPrepareFrontend")
         result.expectTaskSucceded("vaadinBuildFrontend")
 
-        val cssFile = File(testProject.dir, "frontend/generated/jar-resources/mystyle.css")
+        val cssFile = File(testProject.dir, FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR + "jar-resources/mystyle.css")
         expect(true, cssFile.toString()) { cssFile.exists() }
 
     }
@@ -403,7 +403,7 @@ class VaadinSmokeTest : AbstractGradleTest() {
     }
 
     private fun enableHilla() {
-        testProject.newFolder("frontend")
-        testProject.newFile("frontend/index.ts")
+        testProject.newFolder(FrontendUtils.DEFAULT_FRONTEND_DIR)
+        testProject.newFile(FrontendUtils.DEFAULT_FRONTEND_DIR + "index.ts")
     }
 }

flow-plugins/flow-gradle-plugin/src/main/kotlin/com/vaadin/gradle/VaadinFlowPluginExtension.kt

@@ -313,7 +313,7 @@ public class PluginEffectiveConfiguration(
         .convention(project.projectDir)
 
     public val frontendDirectory: Provider<File> = extension.frontendDirectory
-        .convention(File(project.projectDir, "frontend"))
+        .convention(File(project.projectDir, FrontendUtils.DEFAULT_FRONTEND_DIR))
 
     public val generateBundle: Provider<Boolean> = extension.generateBundle
         .convention(true)
@@ -362,7 +362,7 @@ public class PluginEffectiveConfiguration(
         .convention(File(project.projectDir, "src/main/resources"))
 
     public val generatedTsFolder: Property<File> = extension.generatedTsFolder
-        .convention(File(project.projectDir, "frontend/generated"))
+        .convention(File(frontendDirectory.get(), FrontendUtils.GENERATED))
 
     public val nodeVersion: Property<String> = extension.nodeVersion
         .convention(FrontendTools.DEFAULT_NODE_VERSION)

flow-plugins/flow-maven-plugin/src/main/java/com/vaadin/flow/plugin/maven/FlowModeAbstractMojo.java

@@ -18,6 +18,7 @@
 import static com.vaadin.flow.server.Constants.VAADIN_SERVLET_RESOURCES;
 import static com.vaadin.flow.server.Constants.VAADIN_WEBAPP_RESOURCES;
 import static com.vaadin.flow.server.frontend.FrontendUtils.FRONTEND;
+import static com.vaadin.flow.server.frontend.FrontendUtils.GENERATED;
 
 import java.io.File;
 import java.net.URI;
@@ -74,13 +75,13 @@ public abstract class FlowModeAbstractMojo extends AbstractMojo
     /**
      * A directory with project's frontend source files.
      */
-    @Parameter(defaultValue = "${project.basedir}/" + FRONTEND)
+    @Parameter(defaultValue = "${project.basedir}/src/main/" + FRONTEND)
     private File frontendDirectory;
 
     /**
      * The folder where flow will put TS API files for client projects.
      */
-    @Parameter(defaultValue = "${project.basedir}/" + FRONTEND + "/generated")
+    @Parameter(defaultValue = "${null}")
     private File generatedTsFolder;
 
     /**
@@ -298,14 +299,15 @@ public boolean eagerServerLoad() {
 
     @Override
     public File frontendDirectory() {
-
         return frontendDirectory;
     }
 
     @Override
     public File generatedTsFolder() {
-
-        return generatedTsFolder;
+        if (generatedTsFolder != null) {
+            return generatedTsFolder;
+        }
+        return new File(frontendDirectory(), GENERATED);
     }
 
     @Override

flow-plugins/flow-maven-plugin/src/main/java/com/vaadin/flow/plugin/maven/GenerateNpmBOMMojo.java

@@ -211,7 +211,8 @@ private Properties getProperties() {
     }
 
     private boolean createDirectoryIfNotExists() {
-        int lastIndex = outputFilePath.lastIndexOf('/');
+        int lastIndex = outputFilePath
+                .lastIndexOf(FrontendUtils.isWindows() ? '\\' : '/');
         File directory = new File(outputFilePath.substring(0, lastIndex));
         return directory.exists() || directory.mkdirs();
     }

flow-plugins/flow-maven-plugin/src/test/java/com/vaadin/flow/plugin/maven/BuildFrontendMojoTest.java

@@ -149,7 +149,7 @@ public void setup() throws Exception {
         defaultJavaSource = new File(".", "src/test/java");
         openApiJsonFile = new File(npmFolder,
                 "target/classes/com/vaadin/hilla/openapi.json");
-        generatedTsFolder = new File(npmFolder, "frontend/generated");
+        generatedTsFolder = new File(npmFolder, "src/main/frontend/generated");
 
         Assert.assertTrue("Failed to create a test project resources",
                 projectFrontendResourcesDirectory.mkdirs());
@@ -469,7 +469,7 @@ public void existingTokenFile_parametersShouldBeRemoved()
         JsonObject initialBuildInfo = Json.createObject();
         initialBuildInfo.put(SERVLET_PARAMETER_PRODUCTION_MODE, false);
         initialBuildInfo.put(Constants.NPM_TOKEN, "npm");
-        initialBuildInfo.put(Constants.FRONTEND_TOKEN, "frontend");
+        initialBuildInfo.put(Constants.FRONTEND_TOKEN, "src/main/frontend");
 
         initialBuildInfo.put(InitParameters.SERVLET_PARAMETER_ENABLE_PNPM,
                 true);

flow-plugins/flow-maven-plugin/src/test/java/com/vaadin/flow/plugin/maven/CleanFrontendMojoTest.java

@@ -65,7 +65,8 @@ public void setup() throws Exception {
         Mockito.when(project.getBasedir()).thenReturn(projectBase);
 
         packageJson = new File(projectBase, PACKAGE_JSON).getAbsolutePath();
-        frontendGenerated = new File(projectBase, "frontend/generated");
+        frontendGenerated = new File(projectBase,
+                "src/main/frontend/generated");
 
         ReflectionUtils.setVariableValueInObject(mojo, Constants.NPM_TOKEN,
                 projectBase);
@@ -75,7 +76,7 @@ public void setup() throws Exception {
                 "resourceOutputDirectory",
                 new File(projectBase, VAADIN_SERVLET_RESOURCES));
         ReflectionUtils.setVariableValueInObject(mojo, "frontendDirectory",
-                new File(projectBase, "frontend"));
+                new File(projectBase, "src/main/frontend"));
 
         ReflectionUtils.setVariableValueInObject(mojo, "openApiJsonFile",
                 new File(projectBase,
@@ -301,8 +302,9 @@ private void enableHilla() throws IOException {
                 .resolve("test-classes/com/vaadin/hilla"));
         Files.createFile(Paths.get(projectBase.toString(), "target").resolve(
                 "test-classes/com/vaadin/hilla/EndpointController.class"));
-        Files.createDirectories(Paths.get(projectBase.toString(), "frontend"));
-        Files.createFile(Paths.get(projectBase.toString(), "frontend")
+        Files.createDirectories(
+                Paths.get(projectBase.toString(), "src/main/frontend"));
+        Files.createFile(Paths.get(projectBase.toString(), "src/main/frontend")
                 .resolve("index.ts"));
     }
 

flow-plugins/flow-maven-plugin/src/test/java/com/vaadin/flow/plugin/maven/PrepareFrontendMojoTest.java

@@ -102,7 +102,8 @@ public void setup() throws Exception {
                 VAADIN_SERVLET_RESOURCES);
         defaultJavaSource = new File(".", "src/test/java");
         defaultJavaResource = new File(".", "src/test/resources");
-        generatedTsFolder = new File(projectBase, "frontend/generated");
+        generatedTsFolder = new File(projectBase,
+                "src/main/frontend/generated");
 
         ReflectionUtils.setVariableValueInObject(mojo, Constants.NPM_TOKEN,
                 projectBase);
@@ -111,7 +112,7 @@ public void setup() throws Exception {
         ReflectionUtils.setVariableValueInObject(mojo,
                 "resourceOutputDirectory", resourceOutputDirectory);
         ReflectionUtils.setVariableValueInObject(mojo, "frontendDirectory",
-                new File(projectBase, "frontend"));
+                new File(projectBase, "src/main/frontend"));
 
         ReflectionUtils.setVariableValueInObject(mojo, "openApiJsonFile",
                 new File(projectBase,

flow-plugins/flow-plugin-base/src/main/java/com/vaadin/flow/plugin/base/BuildFrontendUtil.java

@@ -22,14 +22,16 @@
 import static com.vaadin.flow.server.Constants.FRONTEND_TOKEN;
 import static com.vaadin.flow.server.Constants.JAVA_RESOURCE_FOLDER_TOKEN;
 import static com.vaadin.flow.server.Constants.NPM_TOKEN;
-import static com.vaadin.flow.server.Constants.PACKAGE_JSON;
 import static com.vaadin.flow.server.Constants.PROJECT_FRONTEND_GENERATED_DIR_TOKEN;
 import static com.vaadin.flow.server.InitParameters.FRONTEND_HOTDEPLOY;
 import static com.vaadin.flow.server.InitParameters.NODE_DOWNLOAD_ROOT;
 import static com.vaadin.flow.server.InitParameters.NODE_VERSION;
 import static com.vaadin.flow.server.InitParameters.REACT_ENABLE;
 import static com.vaadin.flow.server.InitParameters.SERVLET_PARAMETER_INITIAL_UIDL;
 import static com.vaadin.flow.server.InitParameters.SERVLET_PARAMETER_PRODUCTION_MODE;
+import static com.vaadin.flow.server.frontend.FrontendUtils.DEFAULT_FRONTEND_DIR;
+import static com.vaadin.flow.server.frontend.FrontendUtils.GENERATED;
+import static com.vaadin.flow.server.frontend.FrontendUtils.LEGACY_FRONTEND_DIR;
 import static com.vaadin.flow.server.frontend.FrontendUtils.NODE_MODULES;
 import static com.vaadin.flow.server.frontend.FrontendUtils.TOKEN_FILE;
 
@@ -145,13 +147,14 @@ public static void prepareFrontend(PluginAdapterBase adapter)
         Lookup lookup = adapter.createLookup(classFinder);
 
         Options options = new Options(lookup, adapter.npmFolder())
-                .withFrontendDirectory(adapter.frontendDirectory())
+                .withFrontendDirectory(getFrontendDirectory(adapter))
                 .withBuildDirectory(adapter.buildFolder())
                 .withJarFrontendResourcesFolder(
                         getJarFrontendResourcesFolder(adapter))
                 .createMissingPackageJson(true).enableImportsUpdate(false)
                 .enablePackagesUpdate(false).withRunNpmInstall(false)
-                .withFrontendGeneratedFolder(adapter.generatedTsFolder())
+                .withFrontendGeneratedFolder(
+                        getGeneratedFrontendDirectory(adapter))
                 .withNodeVersion(adapter.nodeVersion())
                 .withNodeDownloadRoot(nodeDownloadRootURI)
                 .setNodeAutoUpdate(adapter.nodeAutoUpdate())
@@ -179,7 +182,8 @@ public static void prepareFrontend(PluginAdapterBase adapter)
     private static File getJarFrontendResourcesFolder(
             PluginAdapterBase adapter) {
         return new File(
-                new File(adapter.frontendDirectory(), FrontendUtils.GENERATED),
+                new File(getFrontendDirectory(adapter),
+                        FrontendUtils.GENERATED),
                 FrontendUtils.JAR_RESOURCES_FOLDER);
     }
 
@@ -228,7 +232,7 @@ public static File propagateBuildInfo(PluginAdapterBase adapter) {
                     e);
         }
         buildInfo.put(FRONTEND_TOKEN,
-                adapter.frontendDirectory().getAbsolutePath());
+                getFrontendDirectory(adapter).getAbsolutePath());
         buildInfo.put(CONNECT_JAVA_SOURCE_FOLDER_TOKEN,
                 adapter.javaSourceFolder().getAbsolutePath());
         buildInfo.put(JAVA_RESOURCE_FOLDER_TOKEN,
@@ -238,7 +242,7 @@ public static File propagateBuildInfo(PluginAdapterBase adapter) {
         buildInfo.put(CONNECT_OPEN_API_FILE_TOKEN,
                 adapter.openApiJsonFile().getAbsolutePath());
         buildInfo.put(PROJECT_FRONTEND_GENERATED_DIR_TOKEN,
-                adapter.generatedTsFolder().getAbsolutePath());
+                getGeneratedFrontendDirectory(adapter).getAbsolutePath());
 
         buildInfo.put(InitParameters.SERVLET_PARAMETER_ENABLE_PNPM,
                 adapter.pnpmEnable());
@@ -302,7 +306,7 @@ public static void runNodeUpdater(PluginAdapterBuild adapter)
         try {
             Options options = new com.vaadin.flow.server.frontend.Options(
                     lookup, adapter.npmFolder())
-                    .withFrontendDirectory(adapter.frontendDirectory())
+                    .withFrontendDirectory(getFrontendDirectory(adapter))
                     .withBuildDirectory(adapter.buildFolder())
                     .withRunNpmInstall(adapter.runNpmInstall())
                     .withWebpack(adapter.webpackOutputDirectory(),
@@ -320,7 +324,8 @@ public static void runNodeUpdater(PluginAdapterBuild adapter)
                     .withEnablePnpm(adapter.pnpmEnable())
                     .withEnableBun(adapter.bunEnable())
                     .useGlobalPnpm(adapter.useGlobalPnpm())
-                    .withFrontendGeneratedFolder(adapter.generatedTsFolder())
+                    .withFrontendGeneratedFolder(
+                            getGeneratedFrontendDirectory(adapter))
                     .withHomeNodeExecRequired(adapter.requireHomeNodeExec())
                     .withNodeVersion(adapter.nodeVersion())
                     .withNodeDownloadRoot(nodeDownloadRootURI)
@@ -367,7 +372,7 @@ public static void runDevBuildNodeUpdater(PluginAdapterBuild adapter)
         try {
             Options options = new com.vaadin.flow.server.frontend.Options(
                     lookup, adapter.npmFolder()).withProductionMode(false)
-                    .withFrontendDirectory(adapter.frontendDirectory())
+                    .withFrontendDirectory(getFrontendDirectory(adapter))
                     .withBuildDirectory(adapter.buildFolder())
                     .withRunNpmInstall(adapter.runNpmInstall())
                     .withWebpack(adapter.webpackOutputDirectory(),
@@ -384,7 +389,8 @@ public static void runDevBuildNodeUpdater(PluginAdapterBuild adapter)
                     .withEnablePnpm(adapter.pnpmEnable())
                     .withEnableBun(adapter.bunEnable())
                     .useGlobalPnpm(adapter.useGlobalPnpm())
-                    .withFrontendGeneratedFolder(adapter.generatedTsFolder())
+                    .withFrontendGeneratedFolder(
+                            getGeneratedFrontendDirectory(adapter))
                     .withHomeNodeExecRequired(adapter.requireHomeNodeExec())
                     .withNodeVersion(adapter.nodeVersion())
                     .withNodeDownloadRoot(nodeDownloadRootURI)
@@ -407,6 +413,45 @@ public static void runDevBuildNodeUpdater(PluginAdapterBuild adapter)
         }
     }
 
+    /**
+     * Get the legacy frontend folder if available and new folder doesn't exist.
+     *
+     * @param adapter
+     *            PluginAdapterBase
+     * @return correct folder or legacy folder if not user defined
+     */
+    private static File getFrontendDirectory(PluginAdapterBase adapter) {
+        File frontendDir = adapter.frontendDirectory();
+        if (!frontendDir.exists() && frontendDir.toPath()
+                .endsWith(DEFAULT_FRONTEND_DIR.substring(2))) {
+            File legacy = new File(adapter.npmFolder(), LEGACY_FRONTEND_DIR);
+            if (legacy.exists()) {
+                return legacy;
+            }
+        }
+        return frontendDir;
+    }
+
+    /**
+     * The generated folder should be under frontend folder and will be moved to
+     * the legacy package if not changed by the user.
+     *
+     * @param adapter
+     *            PluginAdapterBase
+     * @return correct generated folder as child to frontend
+     */
+    private static File getGeneratedFrontendDirectory(
+            PluginAdapterBase adapter) {
+        if (adapter.generatedTsFolder().toPath()
+                .startsWith(adapter.frontendDirectory().toPath())) {
+            // Possibly move frontend folder.
+            File frontendDirectory = getFrontendDirectory(adapter);
+            return new File(frontendDirectory, GENERATED);
+        }
+        // Return given generated folder
+        return adapter.generatedTsFolder();
+    }
+
     /**
      * Execute the frontend build with the wanted build system.
      *

flow-plugins/flow-plugin-base/src/test/java/com/vaadin/flow/plugin/base/BuildFrontendUtilTest.java

@@ -61,7 +61,7 @@ public void setup() throws IOException {
         adapter = Mockito.mock(PluginAdapterBuild.class);
         Mockito.when(adapter.npmFolder()).thenReturn(baseDir);
         Mockito.when(adapter.generatedTsFolder())
-                .thenReturn(new File(baseDir, "frontend/generated"));
+                .thenReturn(new File(baseDir, "src/main/frontend/generated"));
         Mockito.when(adapter.projectBaseDirectory())
                 .thenReturn(tmpDir.getRoot().toPath());
         ClassFinder classFinder = Mockito.mock(ClassFinder.class);

flow-server/src/main/java/com/vaadin/flow/server/AbstractConfiguration.java

@@ -20,7 +20,6 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import com.vaadin.flow.internal.hilla.EndpointRequestUtil;
 import com.vaadin.flow.server.frontend.BundleUtils;
 import com.vaadin.flow.server.frontend.FileIOUtils;
 import com.vaadin.flow.server.frontend.FrontendUtils;