Remove Dev UI and other Dev Mode classes from prod #44250

phillip-kruger · 2024-11-01T09:24:02Z

This PR add removing all the non-relevant dev mode classes from Prod (Dev UI Json RPC Services and HotReloadSetup etc.)

The way that you add a JSON-RPC Service in Dev UI:

@BuildStep(onlyIf = IsDevelopment.class)
JsonRPCProvidersBuildItem createJsonRPCServiceForCache() {
    return new JsonRPCProvidersBuildItem(CacheJsonRPCService.class);
}

You will do a similar thing in Prod mode only:

@BuildStep(onlyIf = IsNormal.class)
DevModeCleanupBuildItem cleanProd() {
    return new DevModeCleanupBuildItem(CacheJsonRPCService.class, true);
}

This will remove the JsonRPC service when Prod mode is build, and (due to the true) also any other classes in that package.

quarkus-bot · 2024-11-01T09:24:23Z

/cc @gsmet (hibernate-orm,hibernate-search), @marko-bekhta (hibernate-search), @yrodiere (hibernate-orm,hibernate-search)

github-actions · 2024-11-01T10:22:01Z

🙈 The PR is closed and the preview is expired.

Signed-off-by: Phillip Kruger <[email protected]>

quarkus-bot · 2024-11-01T11:10:27Z

Status for workflow `Quarkus Documentation CI`

This is the status report for running Quarkus Documentation CI on commit f37ce27.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

maxandersen

This for me seem like a natural progression :)

I never liked that devui 2 added content to product jars that is not needed in production.

Since this is using existing mechanics I think its a good move.

I would like @aloubyansky or @dmlloyd to review it.

maxandersen · 2024-11-01T12:03:05Z

docs/src/main/asciidoc/dev-ui.adoc

@@ -887,6 +887,19 @@ JsonRPCProvidersBuildItem createJsonRPCServiceForCache() {// <2>

 https://github.com/quarkusio/quarkus/blob/main/extensions/cache/deployment/src/main/java/io/quarkus/cache/deployment/devui/CacheDevUiProcessor.java[Example code]

+Also cleanup this in Prod mode, so when the app build in prod mode, we remove all dev-ui related runtime classes:


this pops up kinda in the middle in jsonrpc explanation. Maybe have a more explicit section/title like "Remove devUI from Production" ?

It only really apply to Dev UI that has jsonrpc services. Many extensions does not have any. Any screen (js) and any build time data or runtime against the deployment cp is already not included in the prod build, it's just when you do the jsonrpc service, hence its added here

maxandersen · 2024-11-01T12:03:50Z

docs/src/main/asciidoc/dev-ui.adoc

+----
+<1> Always only do this in Normal (Prod) Mode
+<2> Produce or return a `DevModeCleanupBuildItem`
+<3> Define the class or classes in your runtime module that will be removed. You can also clean the whole package of that class in case you used more than just the JSON-RPC Service


show how to clean the whole package as otherwise one is left guessing :)

aloubyansky · 2024-11-01T12:17:24Z

Oh, this doesn't look like a proper way of fixing the issue. Ideally, these classes/dependencies should be properly isolated. Was there a discussion about this?

quarkus-bot · 2024-11-01T16:17:20Z

Status for workflow `Quarkus CI`

This is the status report for running Quarkus CI on commit f37ce27.

Warning

Unable to include the stracktraces as the report was too long. See annotations below for the details.

Failing Jobs

Status	Name	Step	Failures	Logs	Raw logs	Build scan
✖	JVM Tests - JDK 17	`Build`	Failures	Logs	Raw logs	🔍
✖	JVM Tests - JDK 21	`Build`	Failures	Logs	Raw logs	🔍
✖	JVM Tests - JDK 17 Windows	`Build`	Failures	Logs	Raw logs	🔍
✖	Maven Tests - JDK 17	`Build`	Failures	Logs	Raw logs	🔍
✖	Maven Tests - JDK 17 Windows	`Build`	Failures	Logs	Raw logs	🔍
✖	Gradle Tests - JDK 17	`Build`	Failures	Logs	Raw logs	🔍
✖	Gradle Tests - JDK 17 Windows	`Build`	Failures	Logs	Raw logs	🔍

Full information is available in the Build summary check run.
You can consult the Develocity build scans.

Failures

⚙️ JVM Tests - JDK 17 #

- Failing: integration-tests/kotlin integration-tests/scala

📦 integration-tests/kotlin

✖ io.quarkus.kotlin.maven.it.KotlinRemoteDevModeIT.testThatTheApplicationIsReloadedOnKotlinChange line 23 - History - More details - Source on GitHub

📦 integration-tests/scala

✖ io.quarkus.scala.maven.it.ScalaRemoteDevModeIT.testThatTheApplicationIsReloadedOnScalaChange line 24 - History - More details - Source on GitHub

⚙️ JVM Tests - JDK 21 #

- Failing: integration-tests/kotlin

📦 integration-tests/kotlin

✖ io.quarkus.kotlin.maven.it.KotlinRemoteDevModeIT.testThatTheApplicationIsReloadedOnKotlinChange line 23 - History - More details - Source on GitHub

⚙️ JVM Tests - JDK 17 Windows #

- Failing: integration-tests/kotlin integration-tests/scala

📦 integration-tests/kotlin

✖ io.quarkus.kotlin.maven.it.KotlinRemoteDevModeIT.testThatTheApplicationIsReloadedOnKotlinChange line 23 - History - More details - Source on GitHub

📦 integration-tests/scala

✖ io.quarkus.scala.maven.it.ScalaRemoteDevModeIT.testThatTheApplicationIsReloadedOnScalaChange line 24 - History - More details - Source on GitHub

⚙️ Maven Tests - JDK 17 #

- Failing: integration-tests/maven

📦 integration-tests/maven

✖ io.quarkus.maven.it.JarRunnerIT.reaugmentationWithRemovedArtifacts line 315 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.JarRunnerIT.reaugmentationWithRemovedArtifactsUsingSystemProperties line 416 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.JarRunnerIT.testThatMutableFastJarWorks line 198 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.JarRunnerIT.testThatMutableFastJarWorksProvidersDirOutsideOutputDir line 203 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.RemoteDevMojoIT.testThatApplicationRecoversCompilationIssue line 166 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.RemoteDevMojoIT.testThatNewBeanAreDiscovered line 204 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.RemoteDevMojoIT.testThatTheApplicationIsReloadedOnConfigChange line 100 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.RemoteDevMojoIT.testThatTheApplicationIsReloadedOnJavaChange line 33 - History - More details - Source on GitHub

✖ io.quarkus.maven.it.RemoteDevMojoIT.testThatTheApplicationIsReloadedOnNewResource line 67 - History - More details - Source on GitHub

⚙️ Maven Tests - JDK 17 Windows #

- Failing: integration-tests/maven