feat: add hotdeploy option (#15769)

Add the possibility to enable
frontend hotdeploy using plugin
configuration.

Closes #15765

Author: caalador

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

@@ -140,7 +140,7 @@ public class BuildDevBundleMojo extends AbstractMojo
      * Whether vaadin home node executable usage is forced. If it's set to
      * {@code true} then vaadin home 'node' is checked and installed if it's
      * absent. Then it will be used instead of globally 'node' or locally
-     * installed installed 'node'.
+     * installed 'node'.
      */
     @Parameter(property = InitParameters.REQUIRE_HOME_NODE_EXECUTABLE, defaultValue = ""
             + Constants.DEFAULT_REQUIRE_HOME_NODE_EXECUTABLE)
@@ -398,4 +398,8 @@ public List<String> postinstallPackages() {
         return postinstallPackages;
     }
 
+    @Override
+    public boolean isFrontendHotdeploy() {
+        return false;
+    }
 }

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

@@ -181,4 +181,6 @@ internal class GradlePluginAdapter(val project: Project, private val isBeforePro
         return extension.projectBuildDir
     }
     override fun postinstallPackages(): List<String> = extension.postinstallPackages
+
+    override fun isFrontendHotdeploy(): Boolean = extension.frontendHotdeploy
 }

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

@@ -210,6 +210,12 @@ public open class VaadinFlowPluginExtension(project: Project) {
      */
     public var processResourcesTaskName : String? = null
 
+    /**
+     * Parameter to control if frontend development server should be used in
+     * development mode or not.
+     */
+    public var frontendHotdeploy: Boolean = false
+
     public fun filterClasspath(@DelegatesTo(value = ClasspathFilter::class, strategy = Closure.DELEGATE_FIRST) block: Closure<*>? = null): ClasspathFilter {
         if (block != null) {
             block.delegate = classpathFilter

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

@@ -214,6 +214,15 @@ public abstract class FlowModeAbstractMojo extends AbstractMojo
     @Parameter(property = "npm.postinstallPackages", defaultValue = "")
     private List<String> postinstallPackages;
 
+    /**
+     * Parameter to control if frontend development server should be used in
+     * development mode or not.
+     * <p>
+     * By default, the frontend server is not used.
+     */
+    @Parameter(property = InitParameters.FRONTEND_HOTDEPLOY, defaultValue = "false")
+    private boolean frontendHotdeploy;
+
     /**
      * Generates a List of ClasspathElements (Run and CompileTime) from a
      * MavenProject.
@@ -428,4 +437,9 @@ public String buildFolder() {
     public List<String> postinstallPackages() {
         return postinstallPackages;
     }
+
+    @Override
+    public boolean isFrontendHotdeploy() {
+        return frontendHotdeploy;
+    }
 }

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

@@ -146,27 +146,27 @@ public void setup() throws Exception {
     }
 
     @Test
-    public void tokenFileShouldExist_noDevModeTokenVisible()
+    public void tokenFileShouldExist_noHotdeployTokenVisible()
             throws IOException, MojoExecutionException, MojoFailureException {
         mojo.execute();
         Assert.assertTrue("No token file could be found", tokenFile.exists());
 
         String json = org.apache.commons.io.FileUtils
                 .readFileToString(tokenFile, "UTF-8");
         JsonObject buildInfo = JsonUtil.parse(json);
-        Assert.assertNull("No devMode token should be available",
+        Assert.assertNull("Default HotDeploy token should not be available",
                 buildInfo.get(FRONTEND_HOTDEPLOY));
         Assert.assertNotNull("productionMode token should be available",
                 buildInfo.get(SERVLET_PARAMETER_PRODUCTION_MODE));
     }
 
     @Test
-    public void existingTokenFile_frontendHotdeployShouldBeRemoved()
+    public void existingTokenFile_defaultFrontendHotdeployShouldBeRemoved()
             throws IOException, MojoExecutionException, MojoFailureException {
 
         JsonObject initialBuildInfo = Json.createObject();
         initialBuildInfo.put(SERVLET_PARAMETER_PRODUCTION_MODE, false);
-        initialBuildInfo.put(FRONTEND_HOTDEPLOY, false);
+        initialBuildInfo.put(FRONTEND_HOTDEPLOY, true);
         org.apache.commons.io.FileUtils.forceMkdir(tokenFile.getParentFile());
         org.apache.commons.io.FileUtils.write(tokenFile,
                 JsonUtil.stringify(initialBuildInfo, 2) + "\n", "UTF-8");
@@ -176,7 +176,7 @@ public void existingTokenFile_frontendHotdeployShouldBeRemoved()
         String json = org.apache.commons.io.FileUtils
                 .readFileToString(tokenFile, "UTF-8");
         JsonObject buildInfo = JsonUtil.parse(json);
-        Assert.assertNull("No devMode token should be available",
+        Assert.assertNull("Default hotdeploy should not be added",
                 buildInfo.get(FRONTEND_HOTDEPLOY));
         Assert.assertNotNull("productionMode token should be available",
                 buildInfo.get(SERVLET_PARAMETER_PRODUCTION_MODE));

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

@@ -24,6 +24,7 @@
 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.SERVLET_PARAMETER_INITIAL_UIDL;
@@ -226,6 +227,9 @@ public static File propagateBuildInfo(PluginAdapterBase adapter) {
                 adapter.eagerServerLoad());
         buildInfo.put(NPM_TOKEN, adapter.npmFolder().getAbsolutePath());
         buildInfo.put(NODE_VERSION, adapter.nodeVersion());
+        if (adapter.isFrontendHotdeploy()) {
+            buildInfo.put(FRONTEND_HOTDEPLOY, adapter.isFrontendHotdeploy());
+        }
         try {
             buildInfo.put(NODE_DOWNLOAD_ROOT,
                     adapter.nodeDownloadRoot().toString());
@@ -643,6 +647,7 @@ public static void updateBuildFile(PluginAdapterBuild adapter) {
             buildInfo.remove(NODE_DOWNLOAD_ROOT);
             buildInfo.remove(GENERATED_TOKEN);
             buildInfo.remove(FRONTEND_TOKEN);
+            buildInfo.remove(FRONTEND_HOTDEPLOY);
             buildInfo.remove(InitParameters.SERVLET_PARAMETER_ENABLE_PNPM);
             buildInfo.remove(InitParameters.REQUIRE_HOME_NODE_EXECUTABLE);
             buildInfo.remove(

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

@@ -281,4 +281,5 @@ default Lookup createLookup(ClassFinder classFinder) {
      */
     List<String> postinstallPackages();
 
+    boolean isFrontendHotdeploy();
 }