feat!: Move default frontend to src/main

.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(project.projectDir, FrontendUtils.DEFAULT_PROJECT_FRONTEND_GENERATED_DIR))
 
     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

@@ -74,13 +74,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;
 
     /**
@@ -304,8 +304,10 @@ public File frontendDirectory() {
 
     @Override
     public File generatedTsFolder() {
-
-        return generatedTsFolder;
+        if (generatedTsFolder != null) {
+            return generatedTsFolder;
+        }
+        return new File(frontendDirectory(), "/generated");
     }
 
     @Override

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/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;

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

@@ -376,9 +376,8 @@ private static URL findAssetInFrontendThemesOrDevBundle(
                 .getDeploymentConfiguration();
         // First, look for the theme assets in the {project.root}/frontend/
         // themes/my-theme folder
-        File frontendFolder = new File(
-                deploymentConfiguration.getProjectFolder(),
-                FrontendUtils.FRONTEND);
+        File frontendFolder = FrontendUtils
+                .getProjectFrontendDir(deploymentConfiguration);
         File assetInFrontendThemes = new File(frontendFolder, assetPath);
         if (assetInFrontendThemes.exists()) {
             return assetInFrontendThemes.toURI().toURL();

flow-server/src/main/java/com/vaadin/flow/server/frontend/FrontendUtils.java

@@ -109,10 +109,10 @@ public class FrontendUtils {
      * Path of the folder containing application frontend source files, it needs
      * to be relative to the {@link FrontendUtils#DEFAULT_NODE_DIR}
      *
-     * By default it is <code>/frontend</code> in the project folder.
+     * By default it is <code>/src/main/frontend</code> in the project folder.
      */
     public static final String DEFAULT_FRONTEND_DIR = DEFAULT_NODE_DIR
-            + FRONTEND;
+            + "src/main/" + FRONTEND;
 
     /**
      * The name of the vite configuration file.
@@ -505,8 +505,7 @@ private static Optional<DevModeHandler> activeDevModeHandler(
 
     private static InputStream getFileFromFrontendDir(
             AbstractConfiguration config, String path) {
-        File file = new File(new File(config.getProjectFolder(), "frontend"),
-                path);
+        File file = new File(getProjectFrontendDir(config), path);
         if (file.exists()) {
             try {
                 return Files.newInputStream(file.toPath());
@@ -556,7 +555,8 @@ public static InputStream getFrontendFileFromDevModeHandler(
         if (devModeHandler.isPresent()) {
             try {
                 File frontendFile = resolveFrontendPath(
-                        devModeHandler.get().getProjectRoot(), path);
+                        devModeHandler.get().getProjectRoot(),
+                        service.getDeploymentConfiguration(), path);
                 return frontendFile == null ? null
                         : new FileInputStream(frontendFile);
             } catch (IOException e) {
@@ -568,19 +568,33 @@ public static InputStream getFrontendFileFromDevModeHandler(
 
     /**
      * Looks up the frontend resource at the given path. If the path starts with
-     * {@code ./}, first look in {@code frontend}, then in
-     * {@value FrontendUtils#JAR_RESOURCES_FOLDER}. If the path does not start
-     * with {@code ./}, look in {@code node_modules} instead.
+     * {@code ./}, first look in {@value FrontendUtils#DEFAULT_FRONTEND_DIR},
+     * then in {@value FrontendUtils#JAR_RESOURCES_FOLDER}. If the path does not
+     * start with {@code ./}, look in {@code node_modules} instead.
      *
      * @param projectRoot
      *            the project root folder.
+     * @param deploymentConfiguration
+     *            the active deployment configuration
      * @param path
      *            the file path.
      * @return an existing {@link File} , or null if the file doesn't exist.
      */
-    public static File resolveFrontendPath(File projectRoot, String path) {
+    public static File resolveFrontendPath(File projectRoot,
+            DeploymentConfiguration deploymentConfiguration, String path) {
         return resolveFrontendPath(projectRoot, path,
-                new File(projectRoot, FrontendUtils.FRONTEND));
+                getFrontendFolder(projectRoot, deploymentConfiguration));
+    }
+
+    private static File getFrontendFolder(File projectRoot,
+            DeploymentConfiguration deploymentConfiguration) {
+        String frontendFolderPath = deploymentConfiguration.getStringProperty(
+                FrontendUtils.PARAM_FRONTEND_DIR,
+                FrontendUtils.DEFAULT_FRONTEND_DIR);
+        if (frontendFolderPath.startsWith("./")) {
+            return new File(projectRoot, frontendFolderPath);
+        }
+        return new File(frontendFolderPath);
     }
 
     /**

flow-server/src/main/java/com/vaadin/flow/server/frontend/NodeUpdater.java

@@ -171,6 +171,7 @@ JsonObject getPlatformPinnedDependencies() throws IOException {
     private JsonObject getFilteredVersionsFromResource(URL versionsResource,
             String versionsOrigin) throws IOException {
         JsonObject versionsJson;
+
         try (InputStream content = versionsResource.openStream()) {
             VersionsJsonConverter convert = new VersionsJsonConverter(
                     Json.parse(

flow-server/src/main/java/com/vaadin/flow/server/frontend/TaskUpdateThemeImport.java

@@ -36,7 +36,7 @@
  * Task generating the theme definition file 'theme.js' for importing
  * application theme into the generated frontend directory.
  *
- * Default directory is ' ./frontend/generated'
+ * Default directory is ' ./src/main/frontend/generated'
  *
  * <p>
  * For internal use only. May be renamed or removed in a future release.
@@ -45,14 +45,13 @@
  */
 public class TaskUpdateThemeImport implements FallibleCommand {
 
-    private static final String JAR_RESOURCES = "frontend/"
-            + FrontendUtils.GENERATED + FrontendUtils.JAR_RESOURCES_FOLDER;
     public static final String APPLICATION_META_INF_RESOURCES = "src/main/resources/META-INF/resources";
     public static final String APPLICATION_STATIC_RESOURCES = "src/main/resources/static";
     private static final String EXPORT_MODULES_DEF = "export declare const applyTheme: (target: Node) => void;";
 
     private final File themeImportFile;
     private final File themeImportFileDefinition;
+    private final String generatedFolder;
     private final ThemeDefinition theme;
     private final Options options;
 
@@ -61,6 +60,9 @@ public class TaskUpdateThemeImport implements FallibleCommand {
         this.options = options;
         File frontendGeneratedFolder = new File(options.getFrontendDirectory(),
                 GENERATED);
+        generatedFolder = options.getNpmFolder().toPath()
+                .relativize(frontendGeneratedFolder.toPath()).toString()
+                .replaceAll("\\\\", "/");
         themeImportFile = new File(frontendGeneratedFolder, THEME_IMPORTS_NAME);
         themeImportFileDefinition = new File(frontendGeneratedFolder,
                 THEME_IMPORTS_D_TS_NAME);
@@ -125,8 +127,11 @@ private void verifyThemeDirectoryExistence()
         if (existingAppThemeDirectories.size() >= 2) {
 
             boolean themeFoundInJar = existingAppThemeDirectories.stream()
-                    .map(File::getPath).anyMatch(path -> path
-                            .contains(Paths.get(JAR_RESOURCES).toString()));
+                    .map(File::getPath)
+                    .anyMatch(path -> path.contains(Paths
+                            .get(generatedFolder,
+                                    FrontendUtils.JAR_RESOURCES_FOLDER)
+                            .toString()));
 
             if (themeFoundInJar) {
                 String errorMessage = "Theme '%s' should not exist inside a "
@@ -154,16 +159,17 @@ private void verifyThemeDirectoryExistence()
     private List<String> getAppThemePossiblePaths(String themePath) {
         String frontendTheme = String.join("/", options.getNpmFolder().toPath()
                 .relativize(options.getFrontendDirectory().toPath()).toString(),
-                themePath);
+                themePath).replaceAll("\\\\", "/");
 
         String themePathInMetaInfResources = String.join("/",
                 APPLICATION_META_INF_RESOURCES, themePath);
 
         String themePathInStaticResources = String.join("/",
                 APPLICATION_STATIC_RESOURCES, themePath);
 
-        String themePathInClassPathResources = String.join("", JAR_RESOURCES,
-                "/", themePath);
+        String themePathInClassPathResources = String.join("",
+                generatedFolder + "/" + FrontendUtils.JAR_RESOURCES_FOLDER, "/",
+                themePath);
 
         return Arrays.asList(frontendTheme, themePathInMetaInfResources,
                 themePathInStaticResources, themePathInClassPathResources);