Update StartLabKey and StopLabKey tasks (#235)

- Update `stopLabKey` task to work without Spring's shutdown endpoint
- Conditionally enable Java heap dumps in `StartLabKey` task

Author: labkey-tchad

README.md

@@ -13,6 +13,13 @@ on how to do that, including how to develop and test locally and the versioning
 
 ## Release Notes
 
+### 7.1.0
+*Released*: 17 October 2025
+(Earliest compatible LabKeyversion: 25.10)
+- [Issue 53244](https://www.labkey.org/home/Developer/issues/issues-details.view?issueId=53244): Update `stopLabKey` task to work without Spring's shutdown endpoint
+- [Issue 53792](https://www.labkey.org/home/Developer/issues/issues-details.view?issueId=53792): Conditionally enable Java heap dumps in `StartLabKey` task
+- Fix output destination of `application.properties` for `DeployApp` task
+
 ### 7.0.0
 *Released*: 22 September 2025
 (Earliest compatible LabKey version: 25.10)
@@ -36,6 +43,7 @@ on how to do that, including how to develop and test locally and the versioning
 - Update `PropertiesUtils` to remove code for supporting `labkey.xml`
 - Relocate the `.restartTriggerFile` to prevent creation of empty `build/deploy/modules` directory for embedded distribution deployment
 - Fix `bootstrap` task so it will update `application.properties`
+- Remove `description` property from `DistributionExtension`
 
 ### 6.3.0
 *Released*: 3 July 2025

build.gradle

@@ -43,7 +43,7 @@ dependencies {
 }
 
 group = 'org.labkey.build'
-project.version = "7.1.0-SNAPSHOT"
+project.version = "7.2.0-SNAPSHOT"
 
 gradlePlugin {
     plugins {

src/main/groovy/org/labkey/gradle/plugin/TestRunner.groovy

@@ -169,6 +169,7 @@ class TestRunner extends UiTest
                     destdir: BuildUtils.getBuildDirFile(project,"classes/java/uiTest/").getPath(),
                     source: project.sourceCompatibility,
                     target: project.targetCompatibility,
+                    encoding: "UTF-8",
                     classpath: project.configurations.uiTestRuntimeClasspath.asPath,
                     {
                         project.sourceSets.uiTest.java.srcDirs.each {

src/main/groovy/org/labkey/gradle/task/SetUpProperties.groovy

@@ -63,7 +63,8 @@ abstract class SetUpProperties extends TeamCityPropertiesTask
     final abstract Property<String> pathToServer = project.objects.property(String).convention(project.rootDir.getAbsolutePath().replaceAll("\\\\", "/"))
 
     @Input
-    final abstract Property<String> embeddedDir = project.objects.property(String).convention(BuildUtils.getEmbeddedConfigPath(project))
+    final abstract Property<String> embeddedConfigDir = project.objects.property(String).convention(BuildUtils.getEmbeddedConfigPath(project))
+
     @InputDirectory
     File configsDir = new File(BuildUtils.getConfigsProject(project).projectDir, "configs")
 
@@ -87,7 +88,7 @@ abstract class SetUpProperties extends TeamCityPropertiesTask
 
             fs.copy({ CopySpec copy ->
                 copy.from configsDir
-                copy.into embeddedDir.get()
+                copy.into embeddedConfigDir.get()
                 copy.include "application.properties"
                 copy.setDuplicatesStrategy(DuplicatesStrategy.INCLUDE)
                 copy.filter({ String line ->

src/main/groovy/org/labkey/gradle/task/StartLabKey.groovy

@@ -110,8 +110,14 @@ abstract class StartLabKey extends TeamCityPropertiesTask
             optsList.add("-DsequencePipelineEnabled=${TeamCityExtension.getTeamCityProperty(project, "sequencePipelineEnabled", false)}".toString())
         }
 
-        if (project.hasProperty("extraCatalinaOpts"))
-            optsList.addAll(((String) project.property("extraCatalinaOpts")).split("\\s+"))
+        if (TeamCityExtension.getTeamCityProperty(project, "labkey.heapDumpOnOutOfMemoryError", TeamCityExtension.isOnTeamCity(project)))
+        {
+            optsList.add("-XX:+HeapDumpOnOutOfMemoryError");
+        }
+
+        String extraCatalinaOpts = TeamCityExtension.getTeamCityProperty(project, "extraCatalinaOpts", "")
+        if (!extraCatalinaOpts.isEmpty())
+            optsList.addAll(extraCatalinaOpts.split("\\s+"))
 
         return optsList.stream()
                 .filter({String opt -> return !StringUtils.isEmpty(opt)})

src/main/groovy/org/labkey/gradle/task/StopLabKey.groovy

@@ -16,40 +16,56 @@
 package org.labkey.gradle.task
 
 import org.gradle.api.DefaultTask
-import org.gradle.api.file.RegularFileProperty
-import org.gradle.api.provider.Property
-import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.TaskAction
-import org.labkey.gradle.util.PropertiesUtils
-import org.labkey.gradle.util.BuildUtils
+import org.labkey.gradle.plugin.extension.ServerDeployExtension
+
+import java.nio.charset.StandardCharsets
+import java.nio.file.Files
+import java.util.concurrent.TimeUnit
 
 /**
  * Task for stopping a running LabKey instance
  */
 class StopLabKey extends DefaultTask
 {
-    @InputFile
-    final abstract RegularFileProperty propertiesFile = project.objects.fileProperty().fileValue(
-            BuildUtils.getApplicationPropertiesFile(project)
-    )
 
-    @Input
-    final abstract Property<Boolean> useSsl = project.objects.property(Boolean).convention(project.hasProperty("useSsl"))
+    @InputFile @Optional
+    final abstract File pidFile = ServerDeployExtension.getEmbeddedDir(project).file("labkey.pid").asFile
+            .with { it.exists() ? it : null } // "Optional" means that the property may be null, not refer to something nonexistent
 
     @TaskAction
     void action()
     {
-        def applicationProperties = PropertiesUtils.getApplicationProperties(propertiesFile.get().asFile)
-        def port = applicationProperties.getProperty("management.server.port", applicationProperties.getProperty("server.port"))
-        def endpoint = "${useSsl.get() ? "https" : "http"}://localhost:$port/actuator/shutdown"
-        def command = "curl -X POST $endpoint"
-        this.logger.info("Sending command to $endpoint")
-        def proc = command.execute()
-        proc.waitFor()
-        if (proc.exitValue() != 0)
-            this.logger.warn("Shutdown command exited with non-zero status ${proc.exitValue()}.")
-        else
-            this.logger.quiet("Shutdown successful")
+        if (pidFile != null && pidFile.exists()) {
+            String pidStr = new String(Files.readAllBytes(pidFile.toPath()), StandardCharsets.UTF_8).trim()
+            Integer pid = Integer.parseInt(pidStr)
+            stopLabKeyByPid(pid)
+        } else {
+            logger.info("LabKey doesn't appear to be running in this enlistment. PID file not found")
+        }
+
+    }
+
+    private void stopLabKeyByPid(long pid)
+    {
+        ProcessHandle.of(pid).ifPresentOrElse({ processHandle ->
+            if (processHandle.destroy()) {
+                // Wait up to 30 seconds for the process to terminate
+                boolean isTerminated = processHandle.onExit().orTimeout(30, TimeUnit.SECONDS)
+                        .thenApply({ handle -> true })
+                        .exceptionally({ throwable -> false })
+                        .get()
+
+                if (isTerminated) {
+                    logger.info("Successfully terminated LabKey process with PID: {}", pid)
+                } else {
+                    logger.warn("Process with PID {} did not terminate within timeout period", pid)
+                }
+            } else {
+                logger.warn("Failed to initiate termination of LabKey process with PID: {}", pid)
+            }
+        }, { () -> logger.warn("No process found with PID {}", pid)} )
     }
-}
+}