chore: generate a Jandex index in the Collaboration Engine jar - #155
Merged
Merged
Conversation
The collaboration-engine jar now ships a Jandex index of its own classes in META-INF/jandex.idx, which is where the Vaadin Quarkus extension reads it from, so the Vaadin platform no longer needs to add it to an aggregate index. This matches vaadin/flow#25899 and the same change in flow-components (vaadin/flow-components#10240, #10320). The index format is owned by Flow: jandex.format.version has the same value as in the Flow root POM, so that all indexes an application loads share the same format. JandexIndexTest fails when Collaboration Engine writes a different format than flow-server. The license header template now uses the $YEAR token, so that spotless accepts the header of new files with a later year than 2024 and keeps the year of existing headers.
Artur-
approved these changes
Oct 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
collaboration-enginejar now includes a Jandex index of its own classes. The Vaadin Quarkus extension reads this index to find the Collaboration Engine classes, so the Vaadin platform no longer needs to add the jar to an aggregate index. Collaboration Engine was the last artifact still handled that way:This matches vaadin/flow#25899 and vaadin/flow#26110, which do the same for the Flow runtime modules, and the same change in flow-components (vaadin/flow-components#10240, vaadin/flow-components#10320).
What changed
Behavior change: the published
collaboration-enginejar now containsMETA-INF/jandex.idx. Nothing changes for apps that don't use Jandex. No Java code or public API changes.pom.xml:jandex-maven-plugintopluginManagementwith amake-indexexecutionjandex.plugin.versionproperty (3.6.0)jandex.format.versionproperty (13), passed to the plugin asindexVersion. The index format is owned by Flow, so this value must stay equal to the one in the Flow root POM; a comment in the POM says so.collaboration-engine/pom.xml: declares the plugin with no configuration of its own. The demo and test modules don't declare it.JandexIndexTest: reads the header of the Collaboration Engine index and of theflow-serverindex, and fails when the formats differ. When an update offlow.versionbrings a new format, this test fails untiljandex.format.versionis set to the new value.scripts/apache2-license-header.txt: the template now uses the spotless$YEARtoken instead of hardcoding2000-2024. Spotless keeps the year in existing headers, so no files change, and it accepts the2000-2026header of the new test.Verification
mvn install -pl collaboration-enginepasses, includingJandexIndexTestmvn spotless:checkpassesMETA-INF/jandex.idxin format 13