Rename AppCDS build items now that we support JEP 483

geoand · geoand · commit 416e22b0c5a4 · 2025-02-18T18:33:43.000+02:00
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/AppCDSRequestedBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/AppCDSRequestedBuildItem.java
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/AppCDSResultBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/AppCDSResultBuildItem.java
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveContainerImageBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveContainerImageBuildItem.java
@@ -5,11 +5,11 @@
 /**
  * Indicates that a specific container image should be used to generate the AppCDS file
  */
-public final class AppCDSContainerImageBuildItem extends SimpleBuildItem {
+public final class JvmStartupOptimizerArchiveContainerImageBuildItem extends SimpleBuildItem {
 
     private final String containerImage;
 
-    public AppCDSContainerImageBuildItem(String containerImage) {
+    public JvmStartupOptimizerArchiveContainerImageBuildItem(String containerImage) {
         this.containerImage = containerImage;
     }
 
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveRequestedBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveRequestedBuildItem.java
@@ -0,0 +1,31 @@
+package io.quarkus.deployment.pkg.builditem;
+
+import java.nio.file.Path;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+
+/**
+ * Build item to indicate to the various steps that generation
+ * of a JVM startup archive has been requested
+ */
+public final class JvmStartupOptimizerArchiveRequestedBuildItem extends SimpleBuildItem {
+
+    /**
+     * Directory where various files needed for JVM startup archive generation will reside
+     */
+    private final Path dir;
+    private final JvmStartupOptimizerArchiveType type;
+
+    public JvmStartupOptimizerArchiveRequestedBuildItem(Path dir, JvmStartupOptimizerArchiveType type) {
+        this.dir = dir;
+        this.type = type;
+    }
+
+    public Path getDir() {
+        return dir;
+    }
+
+    public JvmStartupOptimizerArchiveType getType() {
+        return type;
+    }
+}
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveResultBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JvmStartupOptimizerArchiveResultBuildItem.java
@@ -0,0 +1,37 @@
+package io.quarkus.deployment.pkg.builditem;
+
+import java.nio.file.Path;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+
+/**
+ * A build item containing the result of the JVM startup archive generation process
+ */
+public final class JvmStartupOptimizerArchiveResultBuildItem extends SimpleBuildItem {
+
+    /**
+     * The file containing the generated archive
+     */
+    private final Path archive;
+    /**
+     * The type of archive generated
+     */
+    private final JvmStartupOptimizerArchiveType type;
+
+    public JvmStartupOptimizerArchiveResultBuildItem(Path archive) {
+        this(archive, JvmStartupOptimizerArchiveType.AppCDS);
+    }
+
+    public JvmStartupOptimizerArchiveResultBuildItem(Path archive, JvmStartupOptimizerArchiveType type) {
+        this.archive = archive;
+        this.type = type;
+    }
+
+    public Path getArchive() {
+        return archive;
+    }
+
+    public JvmStartupOptimizerArchiveType getType() {
+        return type;
+    }
+}
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JarResultBuildStep.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JarResultBuildStep.java
@@ -69,11 +69,11 @@
 import io.quarkus.deployment.builditem.TransformedClassesBuildItem;
 import io.quarkus.deployment.configuration.ClassLoadingConfig;
 import io.quarkus.deployment.pkg.PackageConfig;
-import io.quarkus.deployment.pkg.builditem.AppCDSRequestedBuildItem;
 import io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.BuildSystemTargetBuildItem;
 import io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem;
 import io.quarkus.deployment.pkg.builditem.JarBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveRequestedBuildItem;
 import io.quarkus.deployment.pkg.builditem.NativeImageSourceJarBuildItem;
 import io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem;
 import io.quarkus.deployment.pkg.builditem.UberJarIgnoredResourceBuildItem;
@@ -198,10 +198,12 @@ public JarBuildItem buildRunnerJar(CurateOutcomeBuildItem curateOutcomeBuildItem
             List<UberJarIgnoredResourceBuildItem> uberJarIgnoredResourceBuildItems,
             QuarkusBuildCloseablesBuildItem closeablesBuildItem,
             List<AdditionalApplicationArchiveBuildItem> additionalApplicationArchiveBuildItems,
-            MainClassBuildItem mainClassBuildItem, Optional<AppCDSRequestedBuildItem> appCDS) throws Exception {
+            MainClassBuildItem mainClassBuildItem,
+            Optional<JvmStartupOptimizerArchiveRequestedBuildItem> jvmStartupOptimizerArchiveRequested)
+            throws Exception {
 
-        if (appCDS.isPresent()) {
-            handleAppCDSSupportFileGeneration(transformedClasses, generatedClasses, appCDS.get());
+        if (jvmStartupOptimizerArchiveRequested.isPresent()) {
+            handleAppCDSSupportFileGeneration(transformedClasses, generatedClasses, jvmStartupOptimizerArchiveRequested.get());
         }
 
         return switch (packageConfig.jar().type()) {
@@ -224,9 +226,11 @@ public JarBuildItem buildRunnerJar(CurateOutcomeBuildItem curateOutcomeBuildItem
     // the idea here is to just dump the class names of the generated and transformed classes into a file
     // that is read at runtime when AppCDS generation is requested
     private void handleAppCDSSupportFileGeneration(TransformedClassesBuildItem transformedClasses,
-            List<GeneratedClassBuildItem> generatedClasses, AppCDSRequestedBuildItem appCDS) throws IOException {
-        Path appCDsDir = appCDS.getAppCDSDir();
-        Path generatedClassesFile = appCDsDir.resolve("generatedAndTransformed.lst");
+            List<GeneratedClassBuildItem> generatedClasses,
+            JvmStartupOptimizerArchiveRequestedBuildItem jvmStartupOptimizerArchiveRequested)
+            throws IOException {
+        Path dir = jvmStartupOptimizerArchiveRequested.getDir();
+        Path generatedClassesFile = dir.resolve("generatedAndTransformed.lst");
         try (BufferedWriter writer = Files.newBufferedWriter(generatedClassesFile, StandardOpenOption.CREATE)) {
             StringBuilder classes = new StringBuilder();
             for (GeneratedClassBuildItem generatedClass : generatedClasses) {
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JvmStartupOptimizerArchiveBuildStep.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JvmStartupOptimizerArchiveBuildStep.java
@@ -21,12 +21,12 @@
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.pkg.PackageConfig;
-import io.quarkus.deployment.pkg.builditem.AppCDSContainerImageBuildItem;
-import io.quarkus.deployment.pkg.builditem.AppCDSRequestedBuildItem;
-import io.quarkus.deployment.pkg.builditem.AppCDSResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.CompiledJavaVersionBuildItem;
 import io.quarkus.deployment.pkg.builditem.JarBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveContainerImageBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveRequestedBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveType;
 import io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem;
 import io.quarkus.deployment.steps.MainClassBuildStep;
@@ -44,30 +44,31 @@ public class JvmStartupOptimizerArchiveBuildStep {
 
     @BuildStep(onlyIf = AppCDSRequired.class)
     public void requested(PackageConfig packageConfig, OutputTargetBuildItem outputTarget,
-            BuildProducer<AppCDSRequestedBuildItem> producer)
+            BuildProducer<JvmStartupOptimizerArchiveRequestedBuildItem> producer)
             throws IOException {
-        Path appCDSDir = outputTarget.getOutputDirectory().resolve("appcds");
-        IoUtils.createOrEmptyDir(appCDSDir);
+        Path archiveDir = outputTarget.getOutputDirectory().resolve("jvmstartuparchive");
+        IoUtils.createOrEmptyDir(archiveDir);
 
-        producer.produce(new AppCDSRequestedBuildItem(outputTarget.getOutputDirectory().resolve("appcds"),
-                packageConfig.jar().appcds().useAot() ? JvmStartupOptimizerArchiveType.AOT
-                        : JvmStartupOptimizerArchiveType.AppCDS));
+        producer.produce(
+                new JvmStartupOptimizerArchiveRequestedBuildItem(outputTarget.getOutputDirectory().resolve("jvmstartuparchive"),
+                        packageConfig.jar().appcds().useAot() ? JvmStartupOptimizerArchiveType.AOT
+                                : JvmStartupOptimizerArchiveType.AppCDS));
     }
 
     @BuildStep(onlyIfNot = NativeOrNativeSourcesBuild.class)
-    public void build(Optional<AppCDSRequestedBuildItem> requested,
+    public void build(Optional<JvmStartupOptimizerArchiveRequestedBuildItem> requested,
             JarBuildItem jarResult, OutputTargetBuildItem outputTarget, PackageConfig packageConfig,
             CompiledJavaVersionBuildItem compiledJavaVersion,
-            Optional<AppCDSContainerImageBuildItem> appCDSContainerImage,
-            BuildProducer<AppCDSResultBuildItem> appCDS,
+            Optional<JvmStartupOptimizerArchiveContainerImageBuildItem> jvmStartupOptimizerArchiveContainerImage,
+            BuildProducer<JvmStartupOptimizerArchiveResultBuildItem> jvmStartupOptimizerArchive,
             BuildProducer<ArtifactResultBuildItem> artifactResult) throws Exception {
         if (requested.isEmpty()) {
             return;
         }
 
         // to actually execute the commands needed to generate the AppCDS file, either the JVM in the container image will be used
         // (if specified), or the JVM running the build
-        String containerImage = determineContainerImage(packageConfig, appCDSContainerImage);
+        String containerImage = determineContainerImage(packageConfig, jvmStartupOptimizerArchiveContainerImage);
         String javaBinPath = null;
         if (containerImage == null) {
             javaBinPath = System.getProperty("java.home") + File.separator + "bin" + File.separator
@@ -117,18 +118,18 @@ public void build(Optional<AppCDSRequestedBuildItem> requested,
             }
         }
 
-        appCDS.produce(new AppCDSResultBuildItem(archivePath));
+        jvmStartupOptimizerArchive.produce(new JvmStartupOptimizerArchiveResultBuildItem(archivePath));
         artifactResult.produce(new ArtifactResultBuildItem(archivePath, "appCDS", Collections.emptyMap()));
     }
 
     private String determineContainerImage(PackageConfig packageConfig,
-            Optional<AppCDSContainerImageBuildItem> appCDSContainerImage) {
+            Optional<JvmStartupOptimizerArchiveContainerImageBuildItem> jvmStartupOptimizerArchiveContainer) {
         if (!packageConfig.jar().appcds().useContainer()) {
             return null;
         } else if (packageConfig.jar().appcds().builderImage().isPresent()) {
             return packageConfig.jar().appcds().builderImage().get();
-        } else if (appCDSContainerImage.isPresent()) {
-            return appCDSContainerImage.get().getContainerImage();
+        } else if (jvmStartupOptimizerArchiveContainer.isPresent()) {
+            return jvmStartupOptimizerArchiveContainer.get().getContainerImage();
         }
         return null;
     }
diff --git a/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ArcProcessor.java b/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ArcProcessor.java
@@ -66,7 +66,7 @@
 import io.quarkus.arc.runtime.BeanContainer;
 import io.quarkus.arc.runtime.LaunchModeProducer;
 import io.quarkus.arc.runtime.LoggerProducer;
-import io.quarkus.arc.runtime.appcds.AppCDSRecorder;
+import io.quarkus.arc.runtime.appcds.JvmStartupOptimizerArchiveRecorder;
 import io.quarkus.arc.runtime.context.ArcContextProvider;
 import io.quarkus.bootstrap.BootstrapDebug;
 import io.quarkus.deployment.Capabilities;
@@ -93,7 +93,7 @@
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveFieldBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem;
-import io.quarkus.deployment.pkg.builditem.AppCDSRequestedBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveRequestedBuildItem;
 import io.quarkus.runtime.LaunchMode;
 import io.quarkus.runtime.QuarkusApplication;
 import io.quarkus.runtime.annotations.QuarkusMain;
@@ -638,10 +638,10 @@ public PreBeanContainerBuildItem notifyBeanContainerListeners(ArcContainerBuildI
 
     @Record(RUNTIME_INIT)
     @BuildStep
-    public void signalBeanContainerReady(AppCDSRecorder recorder, PreBeanContainerBuildItem bi,
-            Optional<AppCDSRequestedBuildItem> appCDSRequested,
+    public void signalBeanContainerReady(JvmStartupOptimizerArchiveRecorder recorder, PreBeanContainerBuildItem bi,
+            Optional<JvmStartupOptimizerArchiveRequestedBuildItem> jvmStartupOptimizerArchiveRequested,
             BuildProducer<BeanContainerBuildItem> beanContainerProducer) {
-        if (appCDSRequested.isPresent()) {
+        if (jvmStartupOptimizerArchiveRequested.isPresent()) {
             recorder.controlGenerationAndExit();
         }
         beanContainerProducer.produce(new BeanContainerBuildItem(bi.getValue()));
diff --git a/extensions/arc/runtime/src/main/java/io/quarkus/arc/runtime/appcds/JvmStartupOptimizerArchiveRecorder.java b/extensions/arc/runtime/src/main/java/io/quarkus/arc/runtime/appcds/JvmStartupOptimizerArchiveRecorder.java
@@ -6,12 +6,12 @@
 import io.quarkus.runtime.init.InitializationTaskRecorder;
 
 @Recorder
-public class AppCDSRecorder {
+public class JvmStartupOptimizerArchiveRecorder {
 
     public void controlGenerationAndExit() {
         if (ApplicationLifecycleManager.isAppCDSGeneration()) {
             InitializationTaskRecorder.preventFurtherRecorderSteps(5,
-                    "Unable to properly shutdown Quarkus application when creating AppCDS",
+                    "Unable to properly shutdown Quarkus application when creating JVM startup archive",
                     PreventFurtherStepsException::new);
         }
     }
diff --git a/extensions/container-image/container-image-buildpack/deployment/src/main/java/io/quarkus/container/image/buildpack/deployment/BuildpackProcessor.java b/extensions/container-image/container-image-buildpack/deployment/src/main/java/io/quarkus/container/image/buildpack/deployment/BuildpackProcessor.java
@@ -34,10 +34,10 @@
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.MainClassBuildItem;
-import io.quarkus.deployment.pkg.builditem.AppCDSResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem;
 import io.quarkus.deployment.pkg.builditem.JarBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.NativeImageBuildItem;
 import io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem;
 import io.quarkus.deployment.pkg.steps.NativeBuild;
@@ -71,7 +71,7 @@ public void buildFromJar(ContainerImageConfig containerImageConfig, BuildpackCon
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
             List<ContainerImageLabelBuildItem> containerImageLabels,
-            Optional<AppCDSResultBuildItem> appCDSResult,
+            Optional<JvmStartupOptimizerArchiveResultBuildItem> jvmStartupOptimizerArchiveResult,
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
             BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder) {
 
diff --git a/extensions/container-image/container-image-docker/deployment/src/main/java/io/quarkus/container/image/docker/deployment/DockerProcessor.java b/extensions/container-image/container-image-docker/deployment/src/main/java/io/quarkus/container/image/docker/deployment/DockerProcessor.java
@@ -18,10 +18,10 @@
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.DockerStatusBuildItem;
 import io.quarkus.deployment.pkg.PackageConfig;
-import io.quarkus.deployment.pkg.builditem.AppCDSResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.CompiledJavaVersionBuildItem;
 import io.quarkus.deployment.pkg.builditem.JarBuildItem;
+import io.quarkus.deployment.pkg.builditem.JvmStartupOptimizerArchiveResultBuildItem;
 import io.quarkus.deployment.pkg.builditem.NativeImageBuildItem;
 import io.quarkus.deployment.pkg.builditem.OutputTargetBuildItem;
 import io.quarkus.deployment.pkg.builditem.UpxCompressedBuildItem;
@@ -52,11 +52,11 @@ public void dockerBuildFromJar(DockerConfig dockerConfig,
             @SuppressWarnings("unused") CompiledJavaVersionBuildItem compiledJavaVersion,
             Optional<ContainerImageBuildRequestBuildItem> buildRequest,
             Optional<ContainerImagePushRequestBuildItem> pushRequest,
-            @SuppressWarnings("unused") Optional<AppCDSResultBuildItem> appCDSResult, // ensure docker build will be performed after AppCDS creation
+            @SuppressWarnings("unused") Optional<JvmStartupOptimizerArchiveResultBuildItem> jvmStartupOptimizerArchiveResult, // ensure docker build will be performed after AppCDS creation
             BuildProducer<ArtifactResultBuildItem> artifactResultProducer,
             BuildProducer<ContainerImageBuilderBuildItem> containerImageBuilder,
             PackageConfig packageConfig,
-            @SuppressWarnings("unused") JarBuildItem jar // used to ensure that the jar has been built
+            @SuppressWarnings("unused") JarBuildItem jar// used to ensure that the jar has been built
     ) {
 
         buildFromJar(dockerConfig, dockerStatusBuildItem, containerImageConfig, out, containerImageInfo,
diff --git a/extensions/container-image/container-image-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibProcessor.java b/extensions/container-image/container-image-jib/deployment/src/main/java/io/quarkus/container/image/jib/deployment/JibProcessor.java
diff --git a/extensions/container-image/container-image-podman/deployment/src/main/java/io/quarkus/container/image/podman/deployment/PodmanProcessor.java b/extensions/container-image/container-image-podman/deployment/src/main/java/io/quarkus/container/image/podman/deployment/PodmanProcessor.java

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,12 @@`
`6`	`6`	`import io.quarkus.runtime.init.InitializationTaskRecorder;`
`7`	`7`
`8`	`8`	`@Recorder`
`9`		`-public class AppCDSRecorder {`
	`9`	`+public class JvmStartupOptimizerArchiveRecorder {`
`10`	`10`
`11`	`11`	`public void controlGenerationAndExit() {`
`12`	`12`	`if (ApplicationLifecycleManager.isAppCDSGeneration()) {`
`13`	`13`	`InitializationTaskRecorder.preventFurtherRecorderSteps(5,`
`14`		`- "Unable to properly shutdown Quarkus application when creating AppCDS",`
	`14`	`+ "Unable to properly shutdown Quarkus application when creating JVM startup archive",`
`15`	`15`	`PreventFurtherStepsException::new);`
`16`	`16`	`}`
`17`	`17`	`}`