feat!: enable productionMode with Gradle's bootJar (#22704)

Flow Gradle plugin enable productionMode automatically when run with bootJar or bootBuildImage task. -Pvaadin.productionMode=false overrides automation.

RelatedTo: vaadin/base-starter-spring-gradle#293

Author: tltv

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

@@ -59,7 +59,7 @@ class MiscSingleModuleTest : AbstractGradleTest() {
         build.expectTaskNotRan("vaadinBuildFrontend")
 
         val war: File = testProject.builtWar
-        expectArchiveDoesntContainVaadinWebpackBundle(war, false)
+        expectArchiveDoesntContainVaadinBundle(war, false)
     }
 
     /**
@@ -160,7 +160,7 @@ class MiscSingleModuleTest : AbstractGradleTest() {
         expect(null) { build.task(":vaadinBuildFrontend") }
 
         val jar: File = testProject.builtJar
-        expectArchiveDoesntContainVaadinWebpackBundle(jar, false)
+        expectArchiveDoesntContainVaadinBundle(jar, false)
     }
 
     /**
@@ -230,6 +230,19 @@ class MiscSingleModuleTest : AbstractGradleTest() {
         doTestSpringProjectProductionMode();
     }
 
+    @Test
+    fun testSpringProjectAutoProductionMode() {
+        doTestSpringProjectAutoProductionMode();
+    }
+
+    /**
+     * Test Spring boot project build with 'bootJar' task (production), but forced in dev mode.
+     */
+    @Test
+    fun testSpringProjectForcedDevelopmentMode() {
+        doTestSpringProjectForcedDevelopmentMode();
+    }
+
     @Ignore("Webpack uses gzip compression")
     @Test
     fun testSpringProjectProductionModeWebpack() {
@@ -238,6 +251,44 @@ class MiscSingleModuleTest : AbstractGradleTest() {
 
     private fun doTestSpringProjectProductionMode(compressedExtension: String = "*.br") {
 
+        doTestSpringProject()
+
+        val build: BuildResult =
+                testProject.build("-Pvaadin.productionMode", "build")
+        build.expectTaskSucceded("vaadinPrepareFrontend")
+        build.expectTaskSucceded("vaadinBuildFrontend")
+
+        val jar: File = testProject.builtJar
+        expectArchiveContainsVaadinBundle(jar, true, compressedExtension)
+    }
+
+    private fun doTestSpringProjectAutoProductionMode(compressedExtension: String = "*.br") {
+
+        doTestSpringProject()
+
+        val build: BuildResult =
+            testProject.build("bootJar")
+        build.expectTaskSucceded("vaadinPrepareFrontend")
+        build.expectTaskSucceded("vaadinBuildFrontend")
+
+        val jar: File = testProject.builtJar
+        expectArchiveContainsVaadinBundle(jar, true, compressedExtension)
+    }
+
+    private fun doTestSpringProjectForcedDevelopmentMode(compressedExtension: String = "*.br") {
+
+        doTestSpringProject()
+
+        val build: BuildResult =
+            testProject.build("-Pvaadin.productionMode=false", "bootJar")
+        build.expectTaskSucceded("vaadinPrepareFrontend")
+        build.expectTaskNotRan("vaadinBuildFrontend")
+
+        val jar: File = testProject.builtJar
+        expectArchiveDoesntContainVaadinBundle(jar, false)
+    }
+
+    private fun doTestSpringProject() {
         val springBootVersion = "3.3.4"
 
         testProject.settingsFile.writeText(
@@ -251,7 +302,7 @@ class MiscSingleModuleTest : AbstractGradleTest() {
             """
         )
         testProject.buildFile.writeText(
-                """
+            """
             plugins {
                 id 'org.springframework.boot' version '$springBootVersion'
                 id 'io.spring.dependency-management' version '1.0.11.RELEASE'
@@ -298,7 +349,7 @@ class MiscSingleModuleTest : AbstractGradleTest() {
 
         // need to create the Application.java file otherwise bootJar will fail
         testProject.newFile(
-                "src/main/java/com/example/demo/DemoApplication.java", """
+            "src/main/java/com/example/demo/DemoApplication.java", """
             package com.example.demo;
             
             import org.springframework.boot.SpringApplication;
@@ -317,7 +368,7 @@ class MiscSingleModuleTest : AbstractGradleTest() {
 
         // AppShell.java file creation
         testProject.newFile(
-                "src/main/java/com/example/demo/AppShell.java", """
+            "src/main/java/com/example/demo/AppShell.java", """
             package com.example.demo;
             
             import com.vaadin.flow.component.page.AppShellConfigurator;
@@ -328,14 +379,6 @@ class MiscSingleModuleTest : AbstractGradleTest() {
             }
         """.trimIndent()
         )
-
-        val build: BuildResult =
-                testProject.build("-Pvaadin.productionMode", "build")
-        build.expectTaskSucceded("vaadinPrepareFrontend")
-        build.expectTaskSucceded("vaadinBuildFrontend")
-
-        val jar: File = testProject.builtJar
-        expectArchiveContainsVaadinBundle(jar, true, compressedExtension)
     }
 
     /**

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

@@ -15,16 +15,13 @@
  */
 package com.vaadin.flow.gradle
 
-import org.gradle.api.JavaVersion
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.BuildTask
 import org.gradle.testkit.runner.GradleRunner
 import org.gradle.testkit.runner.TaskOutcome
 import java.io.File
-import java.io.IOException
 import java.nio.file.FileSystems
 import java.nio.file.Files
-import java.nio.file.Path
 import java.nio.file.PathMatcher
 import java.util.zip.ZipInputStream
 import kotlin.test.expect
@@ -165,11 +162,11 @@ fun expectArchiveContainsVaadinBundle(
 }
 
 /**
- * Asserts that given archive (jar/war) doesn't contain the Vaadin webpack bundle:
+ * Asserts that given archive (jar/war) doesn't contain the Vaadin bundle:
  * the `META-INF/VAADIN/build/` directory.
  */
-fun expectArchiveDoesntContainVaadinWebpackBundle(archive: File,
-                                                  isSpringBootJar: Boolean) {
+fun expectArchiveDoesntContainVaadinBundle(archive: File,
+                                           isSpringBootJar: Boolean) {
     val isWar: Boolean = archive.name.endsWith(".war", true)
     val isStandaloneJar: Boolean = !isWar && !isSpringBootJar
     val resourcePackaging: String = when {

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

@@ -38,8 +38,9 @@ import org.gradle.internal.component.external.model.ModuleComponentArtifactIdent
 
 public abstract class VaadinFlowPluginExtension @Inject constructor(private val project: Project) {
     /**
-     * Whether we are running in productionMode or not. Defaults to false.
-     * Responds to the `-Pvaadin.productionMode` property.
+     * Whether we are running in productionMode or not. Defaults to true when
+     * run with `bootJar` or `bootBuildImage` task, otherwise false. Responds to
+     * the `-Pvaadin.productionMode` property.
      */
     public abstract val productionMode: Property<Boolean>
 
@@ -352,9 +353,12 @@ public class PluginEffectiveConfiguration(
     internal val projectName = project.name
 
     public val productionMode: Provider<Boolean> = extension.productionMode
-        .convention(false)
+        .convention(project.tasks.names.any { task ->
+            task.contains("bootJar") || task.contains("bootBuildImage")
+        })
         .overrideWithSystemPropertyFlag(project, "vaadin.productionMode")
 
+
     public val sourceSetName: Property<String> = extension.sourceSetName
         .convention("main")