Merge pull request #1962 from turkeylurkey/issue-1959

Copy config and changed file to temp dir for feature generation

Author: turkeylurkey

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/DevMojo.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corporation 2019, 2025.
+ * (C) Copyright IBM Corporation 2019, 2026
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -446,7 +446,7 @@ public void libertyCreate() throws PluginExecutionException {
         }
 
         @Override
-        public boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean useTmpDir) {
+        public boolean libertyGenerateFeatures(Collection<String> classes, boolean optimize, boolean useTmpDirOut, boolean useTmpDirIn) {
             try {
                 if (classes != null) {
                     Element[] classesElem = new Element[classes.size()];
@@ -456,10 +456,10 @@ public boolean libertyGenerateFeatures(Collection<String> classes, boolean optim
                         i++;
                     }
                     // generate features for only the classFiles passed
-                    runLibertyMojoGenerateFeatures(element(name("classFiles"), classesElem), optimize, useTmpDir);
+                    runLibertyMojoGenerateFeatures(element(name("classFiles"), classesElem), optimize, useTmpDirOut, useTmpDirIn);
                 } else {
                     // pass null for classFiles so that features are generated for ALL of the classes
-                    runLibertyMojoGenerateFeatures(null, optimize, useTmpDir);
+                    runLibertyMojoGenerateFeatures(null, optimize, useTmpDirOut, useTmpDirIn);
                 }
                 return true; // successfully generated features
             } catch (MojoExecutionException e) {
@@ -778,7 +778,7 @@ public boolean updateArtifactPaths(ProjectModule projectModule, boolean redeploy
                             getLog().debug("Detected a change in the compile dependencies for "
                                     + buildFile + " , regenerating features");
                             // If generateToSrc is false then we must copy new generated features file from temp dir to server dir after install
-                            boolean generateFeaturesSuccess = libertyGenerateFeatures(null, true, !generateToSrc);
+                            boolean generateFeaturesSuccess = libertyGenerateFeatures(null, true, !generateToSrc, false);
                             if (generateFeaturesSuccess) {
                                 util.getJavaSourceClassPaths().clear();
                             }
@@ -1107,7 +1107,7 @@ public boolean recompileBuildFile(File buildFile, Set<String> compileArtifactPat
                     getLog().debug("Detected a change in the compile dependencies, regenerating features");
                     // always optimize generate features on dependency change
                     // If generateToSrc is false then we must copy new generated features file from temp dir to server dir after install
-                    generateFeaturesSuccess = libertyGenerateFeatures(null, true, !generateToSrc);
+                    generateFeaturesSuccess = libertyGenerateFeatures(null, true, !generateToSrc, false);
                     if (generateFeaturesSuccess) {
                         util.getJavaSourceClassPaths().clear();
                     } else {
@@ -1693,8 +1693,9 @@ private void generateFeaturesOnStartup() throws MojoExecutionException {
             getLog().warn(
                     "The source configuration directory will be modified. Features will automatically be generated in a new file: "
                             + generatedFileCanonicalPath);
-            // Only generate to a tmp dir once dev mode has started.
-            runLibertyMojoGenerateFeatures(null, true, false);
+            // During dev mode start up the server is not running yet so we will generate features to the correct
+            // output directory and then install features in the next step.
+            runLibertyMojoGenerateFeatures(null, true, false, false);
         } catch (MojoExecutionException e) {
             if (e.getCause() != null && e.getCause() instanceof PluginExecutionException) {
                 // PluginExecutionException indicates that the binary scanner jar could not be found
@@ -2191,7 +2192,7 @@ protected void runLibertyMojoCreate() throws MojoExecutionException {
      * @throws MojoExecutionException
      */
     @Override
-    protected void runLibertyMojoGenerateFeatures(Element classFiles, boolean optimize, boolean useTmpDir) throws MojoExecutionException {
-        super.runLibertyMojoGenerateFeatures(classFiles, optimize, useTmpDir);
+    protected void runLibertyMojoGenerateFeatures(Element classFiles, boolean optimize, boolean useTmpDirOut, boolean useTmpDirIn) throws MojoExecutionException {
+        super.runLibertyMojoGenerateFeatures(classFiles, optimize, useTmpDirOut, useTmpDirIn);
     }
 }

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/GenerateFeaturesMojo.java

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corporation 2021, 2025
+ * (C) Copyright IBM Corporation 2021, 2026
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy of
@@ -82,13 +82,28 @@ public class GenerateFeaturesMojo extends PluginConfigSupport {
     private boolean generateToSrc;
 
     /**
-     * The useDevModeTempDir parameter is for internal use only. It is not for users.
+     * The useTempDirAsOutput parameter is for internal use only. It is not for users.
      * The parameter is only used when generateToSrc is false meaning we generate to serverDir.
-     * When the parameter is true we will write the generated features file to the temp directory.
-     * This is required because the features must all be installed before writing to serverDir in devmode.
+     * It is needed in dev mode because the server is running and we need to ensure the features
+     * that are generated are installed before we update a running server.
+     * When the parameter is true we will write the generated features file to the special generate-features
+     * temp directory.
      */
-    @Parameter(property = "useDevModeTempDir", defaultValue = "false")
-    private boolean useDevModeTempDir;
+    @Parameter(property = "useTempDirAsOutput", defaultValue = "false")
+    private boolean useTempDirAsOutput;
+
+    /**
+     * The useTempDirAsContext parameter is for internal use only. It is not for users.
+     * It is needed in dev mode when the user updates a server config file which might affect
+     * the features that will be generated. In such a case we will required the caller to copy the
+     * serverDir configuration files into the special generate-features temp directory and augment it
+     * with the file changed by the user. We do not do this all the time because of the performance
+     * cost of copying all the files.
+     * When the parameter is true we will use the generate-features temp directory as the context for
+     * feature generation.
+     */
+    @Parameter(property = "useTempDirAsContext", defaultValue = "false")
+    private boolean useTempDirAsContext;
 
     /**
      * Generating features is performed relative to a certain server. We only generate features
@@ -195,19 +210,26 @@ private void generateFeatures() throws MojoExecutionException, PluginExecutionEx
             }
         }
 
-        // The config dir is in the src directory. Otherwise generate for the target/liberty dir.
-        generationContextDir = generateToSrc ? configDirectory : serverDirectory;
+        if (useTempDirAsContext) {
+            // When this parameter is true it is required that the caller has copied the config into this dir.
+            generationContextDir = getGeneratedFeaturesTempDir();
+        } else {
+            // The config dir is the one in the src directory. Otherwise generate for the target/liberty/wlp dir.
+            generationContextDir = generateToSrc ? configDirectory : serverDirectory;
+        }
         // When using dev mode we always generate to a temporary directory so we can call install before writing to server dir.
-        generationOutputDir = useDevModeTempDir ? new File(project.getBuild().getDirectory(), GENERATED_FEATURES_TEMP_DIR) : generationContextDir;
+        generationOutputDir = useTempDirAsOutput ? getGeneratedFeaturesTempDir() : generationContextDir;
 
         binaryScanner = getBinaryScannerJarFromRepository();
         BinaryScannerHandler binaryScannerHandler = new BinaryScannerHandler(binaryScanner);
 
         getLog().debug("--- Generate Features values ---");
         getLog().debug("Binary scanner jar: " + binaryScanner.getName());
         getLog().debug("optimize generate features: " + optimize);
-        getLog().debug("called by dev mode, useDevModeTempDir: " + useDevModeTempDir);
+        getLog().debug("useTempDirAsOutput (dev mode only): " + useTempDirAsOutput);
+        getLog().debug("useTempDirAsContext (dev mode only): " + useTempDirAsContext);
         getLog().debug("generate to directory: " + generationOutputDir.getAbsolutePath());
+
         if (classFiles != null && !classFiles.isEmpty()) {
             getLog().debug("Generate features for the following class files: " + classFiles.toString());
         }
@@ -395,6 +417,11 @@ private Set<String> getGeneratedFeatures(ServerFeatureUtil servUtil, File genera
         return features;
     }
 
+    // returns the hidden directory we use for generate-features special purposes
+    private File getGeneratedFeaturesTempDir() {
+        return new File(project.getBuild().getDirectory(), GENERATED_FEATURES_TEMP_DIR);
+    }
+
     /**
      * Gets the binary scanner jar file from the local cache.
      * Downloads it first from connected repositories such as Maven Central if a newer release is available than the cached version.

liberty-maven-plugin/src/main/java/io/openliberty/tools/maven/server/StartDebugMojoSupport.java

@@ -291,13 +291,14 @@ protected void runLibertyMojoInstallFeature(Element features, File serverDir, St
         runLibertyMojo("install-feature", config);
     }
 
-    protected void runLibertyMojoGenerateFeatures(Element classFiles, boolean optimize, boolean useTmpDir) throws MojoExecutionException {
+    protected void runLibertyMojoGenerateFeatures(Element classFiles, boolean optimize, boolean useTmpDirOut, boolean useTmpDirIn) throws MojoExecutionException {
         Xpp3Dom config = ExecuteMojoUtil.getPluginGoalConfig(getLibertyPlugin(), "generate-features", getLog());
         if (classFiles != null) {
             config = Xpp3Dom.mergeXpp3Dom(configuration(classFiles), config);
         }
         config.addChild(element(name("optimize"), Boolean.toString(optimize)).toDom());
-        config.addChild(element(name("useDevModeTempDir"), Boolean.toString(useTmpDir)).toDom());
+        config.addChild(element(name("useTempDirAsOutput"), Boolean.toString(useTmpDirOut)).toDom());
+        config.addChild(element(name("useTempDirAsContext"), Boolean.toString(useTmpDirIn)).toDom());
         runLibertyMojo("generate-features", config);
     }