Move GraalVM config from current *.json config files to reachability-metadata.json starting with GraalVM / Mandrel for JDK 25

[zakkak]

Description

Starting with GraalVM / Mandrel for JDK 23 (24.1) the proxy-config.json file will be deprecated. Instead, proxy registrations should be moved to reachability-metadata.json, see oracle/graal#9048

Not doing so results in a warning:

Warning: Option 'DynamicProxyConfigurationResources' is deprecated and might be removed in a future release. Please refer to the GraalVM release notes.

Implementation ideas

Ideally we should only generate proxy-config.json when using GraalVM / Mandrel < 24.1 and reachability-metadata.json when using >= 24.1, however the configuration files are created when building the jar file, i.e. before identifying the GraalVM / Mandrel version.

In such cases we use the following pattern:

quarkus/extensions/amazon-lambda/common-deployment/src/main/java/io/quarkus/amazon/lambda/deployment/FunctionZipProcessor.java

Lines 146 to 163 in 20d3c9d

	final GraalVM.Version graalVMVersion = nativeImageRunner.getBuildRunner().getGraalVMVersion();
	if (graalVMVersion.compareTo(GraalVM.Version.VERSION_23_0_0) >= 0) {
	// See https://github.com/oracle/graal/issues/4921
	try (DirectoryStream<Path> sharedLibs = Files.newDirectoryStream(nativeImage.getPath().getParent(),
	"*.{so,dll}")) {
	sharedLibs.forEach(src -> {
	try {
	// In this use case, we can force all libs to be non-executable.
	addZipEntry(zip, src, src.getFileName().toString(), 0644);
	} catch (Exception e) {
	throw new RuntimeException(e);
	}
	});
	} catch (IOException e) {
	log.errorf("Could not list files in directory %s. Continuing. Error: %s", nativeImage.getPath().getParent(),
	e);
	}
	}

Which unfortunately is not ideal as:

1. it requires invoking native-image --version each time we need the version
2. it might run on a different step than the actual native build (see https://quarkus.io/guides/building-native-image#separating-java-and-native-image-compilation)

[quarkus-bot]

/cc @Karm (mandrel), @galderz (mandrel), @radcortez (config)

[jerboaa]

Ideally we should only generate proxy-config.json when using GraalVM / Mandrel < 24.1 and reachability-metadata.json when using >= 24.1

How do the files differ? If they don't differ we could generate proxy-config.json and in the native build step rename to reachability-metadata.json (if the version is >= 24.1) or some such before native image runs? Just a thought.

[zakkak]

The new file follows a new schema that essentially combines all previous *-config.json files in one file so a simple rename wouldn't suffice.

An adapter that would merge the multiple config files in one could be an option but feels hacky to me.

[zakkak]

It looks like there are considerations to backport reachability-metadata.json parsing to GraalVM 23.1 for JDK 21 (oracle/graal#9606) which could make the transition a bit easier.

[zakkak]

FTR backwards compatibility has been merged in Mandrel/GraalVM for JDK 21 (see graalvm/graalvm-community-jdk21u#23) however, the schema doens't seem very stable yet, so I suggest we delay the transition till it becomes more stable (probably after the GraalVM for JDK 25 release).