Skip to content

Jandex: reindex if the index is too new #47283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gsmet merged 1 commit into from
Apr 10, 2025
Merged

Jandex: reindex if the index is too new #47283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 28 additions & 23 deletions core/deployment/src/main/java/io/quarkus/deployment/index/IndexingUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ public class IndexingUtil {

private static final int JAVA_VERSION;

// At least Jandex 2.1 is needed
private static final int REQUIRED_INDEX_VERSION = 8;
// At least Jandex 3.0 is needed
private static final int REQUIRED_INDEX_VERSION = 11;

static {
int version = 8;
Expand All @@ -71,7 +71,7 @@ public static Index indexJar(Path path, Set<String> removed) throws IOException

public static Index indexTree(OpenPathTree tree, Set<String> removed) throws IOException {
if (removed == null) {
final Index i = tree.apply(JANDEX_INDEX, MetaInfJandexReader.getInstance());
final Index i = tree.apply(JANDEX_INDEX, new MetaInfJandexReader(tree.toString()));
if (i != null) {
return i;
}
Expand All @@ -88,17 +88,19 @@ public static Index indexJar(File file, Set<String> removed) throws IOException
if (existing != null && removed == null) {
try (InputStream in = jarFile.getInputStream(existing)) {
IndexReader reader = new IndexReader(in);
if (reader.getIndexVersion() < REQUIRED_INDEX_VERSION) {
log.warnf(
"Re-indexing %s - at least Jandex 2.1 must be used to index an application dependency",
file);
return indexJar(jarFile, removed);
} else {
try {
return reader.read();
} catch (UnsupportedVersion e) {
throw new UnsupportedVersion("Can't read Jandex index from " + file + ": " + e.getMessage());
try {
int indexVersion = reader.getIndexVersion();
if (indexVersion < REQUIRED_INDEX_VERSION) {
log.warnf("Reindexing %s, at least Jandex 3.0 must be used"
+ " to index an application dependency (index version is %s)", file, indexVersion);
return indexJar(jarFile, removed);
}
return reader.read();
} catch (UnsupportedVersion e) {
log.warnf("Reindexing %s, the index format is too new for the Jandex version"
+ " used by your application. Please report it to the author of this JAR (%s)",
file, e.getMessage());
return indexJar(jarFile, removed);
}
}
}
Expand Down Expand Up @@ -273,10 +275,10 @@ public void visitPath(PathVisit visit) {
}

private static class MetaInfJandexReader implements Function<PathVisit, Index> {
private static MetaInfJandexReader instance;
private final String treeDescription;
Copy link
Copy Markdown
Member Author

@Ladicek Ladicek Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this because visit.getRoot() often returns just / (e.g. in case of a JAR from local Maven repo), so that's quite useless. PathTree.toString() is much more descriptive (e.g. in case of a JAR from local Maven repo, it returns the full path).


private static MetaInfJandexReader getInstance() {
return instance == null ? instance = new MetaInfJandexReader() : instance;
MetaInfJandexReader(String treeDescription) {
this.treeDescription = treeDescription;
}

@Override
Expand All @@ -287,19 +289,22 @@ public Index apply(PathVisit visit) {
try (InputStream in = Files.newInputStream(visit.getPath())) {
IndexReader reader = new IndexReader(in);
try {
if (reader.getIndexVersion() < REQUIRED_INDEX_VERSION) {
log.warnf(
"Re-indexing %s:%s - at least Jandex 2.1 must be used to index an application dependency",
visit.getRoot(), visit.getPath());
int indexVersion = reader.getIndexVersion();
if (indexVersion < REQUIRED_INDEX_VERSION) {
log.warnf("Reindexing %s, at least Jandex 3.0 must be used"
+ " to index an application dependency (index version is %s)",
treeDescription, indexVersion);
return null;
}
return reader.read();
} catch (UnsupportedVersion e) {
throw new UnsupportedVersion(
"Can't read Jandex index from " + visit.getRoot() + ":" + visit.getPath() + ": " + e.getMessage());
log.warnf("Reindexing %s, the index format is too new for the Jandex version"
+ " used by your application. Please report it to the author of this JAR (%s)",
treeDescription, e.getMessage());
return null;
}
} catch (IOException e) {
throw new UncheckedIOException("Can't read Jandex index from " + visit.getRoot() + ":" + visit.getPath(), e);
throw new UncheckedIOException("Can't read Jandex index from " + treeDescription, e);
}
}
}
Expand Down
4 changes: 3 additions & 1 deletion ...ate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/boot/StaticInitFailureTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ public class StaticInitFailureTest {
.addClass(EntityWithIncorrectMapping.class))
.withConfigurationResource("application.properties")
// Expect only one error: the one we triggered
.setLogRecordPredicate(record -> record.getLevel().intValue() >= Level.WARNING.intValue())
.setLogRecordPredicate(record -> record.getLevel().intValue() >= Level.WARNING.intValue()
// Ignore these particular warnings: they are not relevant to this test.
&& !record.getMessage().contains("must be used to index an application dependency")) // too old Jandex
// In particular we don't want a log telling us JPAConfig could not be created
// because HibernateOrmRuntimeConfig is not initialized yet.
// JPAConfig should not be created in the first place!
Expand Down
3 changes: 2 additions & 1 deletion ...oyment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionExtraSpaceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ public class DbVersionExtraSpaceTest {
// Ignore these particular warnings: they are not relevant to this test.
&& !record.getMessage().contains("has been blocked for") //sometimes CI has a super slow moment and this triggers the blocked thread detector
&& !record.getMessage().contains("Agroal")
&& !record.getMessage().contains("Netty DefaultChannelId initialization"))
&& !record.getMessage().contains("Netty DefaultChannelId initialization")
&& !record.getMessage().contains("must be used to index an application dependency")) // too old Jandex
.assertLogRecords(records -> assertThat(records)
.extracting(LogRecord::getMessage) // This is just to get meaningful error messages, as LogRecord doesn't have a toString()
.isEmpty());
Expand Down
3 changes: 2 additions & 1 deletion .../src/test/java/io/quarkus/hibernate/orm/transaction/AbstractTransactionLifecycleTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ public abstract class AbstractTransactionLifecycleTest {
&& !record.getMessage().contains("has been blocked for") //sometimes CI has a super slow moment and this triggers the blocked thread detector
&& !record.getMessage().contains("Using Java versions older than 11 to build Quarkus applications")
&& !record.getMessage().contains("Agroal does not support detecting if a connection is still usable")
&& !record.getMessage().contains("Netty DefaultChannelId initialization"))
&& !record.getMessage().contains("Netty DefaultChannelId initialization")
&& !record.getMessage().contains("must be used to index an application dependency")) // too old Jandex
.assertLogRecords(records -> assertThat(records)
.extracting(LogRecord::getMessage) // This is just to get meaningful error messages, as LogRecord doesn't have a toString()
.isEmpty());
Expand Down
Loading