Remove global metadata/index.json file and its usage by jormundur00 · Pull Request #983 · oracle/graalvm-reachability-metadata

jormundur00 · 2026-02-02T13:26:25Z

What does this PR do?

In this PR we remove the global index.json file located at metadata/index.json to simplify new metadata addition (so we only need to create/maintain one index.json file located at metadata/groupId/artifactId/index.json per library artifact).

To do this, we move the allowed-packages and requires fields to the inner index.json, as this is data that only the global one had previously. As the module field was used to map between the global and inner index files, we remove this field as it was redundant (the information it keeps can always be resolved from the inner-index's path). All library metadata resolution is now based on file paths (so every library is strictly in metadata/<groupId>/<artifactId>). The scaffold and other tasks which generate these metadata directories have also been updated accordingly to match the new format.

As these changes include relatively major changes to the index structure, the remaining schema version was bumped from 1.0.0 to 2.0.0.

As running changes in this PR depend on the buildtools PR which adds support for the removal of the metadata/index.json file, and this PR depends on buildtools working with the new format to successfully pass CI, the merge/release process of these PRs should have the following order:

This PR should be merged first (running CI on the branch of the buildtools PR to complete successfully),
The next reachability metadata release should be dispatched so that buildtools can use it in their corresponding PR,
The buildtools PR should then include the bump to this new reachability metadata version and get merged ASAP,
This repository's CI will work on the latest SNAPSHOT of buildtools until the new NBT release is released (which should be scheduled as soon as the buildtools PR is merged),
We open a follow-up PR here to use the newest release of buildtools and no longer use snapshots in the CI.

Fixes: #847

kimeta · 2026-02-09T14:34:14Z

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/TckExtension.java

+            groupDirs.filter(Files::isDirectory).forEach(g -> {
+                String gName = g.getFileName().toString();
+                // Filter by group if provided
+                if (groupId != null && !groupId.equals(gName)) return;


When can groupId be null?

groupId and artifactId can be null when using coordinates such as -Pcoordinates=all. In those cases, nothing gets filtered, so all metadata directories are added to dirs.

kimeta · 2026-02-09T14:34:56Z

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/TckExtension.java

+                    artifactDirs.filter(Files::isDirectory).forEach(a -> {
+                        String aName = a.getFileName().toString();
+                        // Filter by artifact if provided
+                        if (artifactId != null && !artifactId.equals(aName)) return;


Same question for artifactId.

Explained in the groupId comment above.

kimeta · 2026-02-09T14:37:41Z

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/TckExtension.java

-                if (library.containsKey("directory")) {
-                    dirs.add((String) library.get("directory"));
-                }
-                if (library.containsKey("requires")) {


In the changed code you removed adding directories, which are present in the requires field. Is this intentional? We should probably still parse requires?

We discussed this offline and decided that parsing requires here is redundant. We already parse it on native build tools when building the classpath (deciding what metadata to include), and adding it here does functionally nothing.

kimeta · 2026-02-09T14:49:23Z

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/TckExtension.java

+                if (testedVersions == null) continue;
+
+                // Derive group/artifact from directory path (index is per artifact)
+                String g = fullDir.getParent().getFileName().toString();


Is there a more elegant approach?

I left it as it is for now, as I don't see a much more elegant way to do this that wouldn't break semantics.

kimeta · 2026-02-09T14:57:21Z

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/utils/MetadataGenerationUtils.java

                testedVersions,
-                null
+                null, // skipped-versions
+                null, // allowed-packages


Now that allowed-packages and requires are fields in each version entry, it's a bit tricky deciding what should be their values when entry is automatically generated. Probably best solution would be to copy that information from the previous latest version.

kimeta · 2026-02-09T14:58:28Z

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/utils/MetadataGenerationUtils.java

+                null // requires
        );
-        entries.addFirst(newEntry);
+        entries.add(0, newEntry);


You can revert this change.

kimeta · 2026-02-09T15:08:32Z

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/MetadataFilesCheckerTask.java

+            Object ap = entry.get("allowed-packages");
+            if (ap != null) {
+                if (ap instanceof List) {
+                    return (List<String>) ap;


This could be a potential problem if allowed-packages can differ between versions. Can this happen?

Good catch. Since we have the metadata-version here (which uniquely distinguishes an index.json entry), we can retrieve a specific versions allowed-packages here. Fixed.

)" This reverts commit 6090e52.

)" (#1013) This reverts commit 6090e52.

jormundur00 requested a review from kimeta February 2, 2026 13:26

jormundur00 self-assigned this Feb 2, 2026

jormundur00 requested review from a team and vjovanov as code owners February 2, 2026 13:26

jormundur00 added the enhancement New feature or request label Feb 2, 2026

jormundur00 mentioned this pull request Feb 2, 2026

Remove global metadata/index.json file and its usage #960

Closed

jormundur00 requested a review from melix February 4, 2026 09:56

jormundur00 mentioned this pull request Feb 4, 2026

Remove the usage of the global metadata/index.json from the nbt plugins graalvm/native-build-tools#829

Merged

kimeta reviewed Feb 9, 2026

View reviewed changes

jormundur00 force-pushed the jormundur00/global-index-removal branch from b69e7a2 to d106a72 Compare February 10, 2026 13:55

Remove global metadata/index.json file from the repository

2bc2db2

jormundur00 force-pushed the jormundur00/global-index-removal branch from d106a72 to 2bc2db2 Compare February 10, 2026 13:57

vjovanov approved these changes Feb 10, 2026

View reviewed changes

kimeta approved these changes Feb 11, 2026

View reviewed changes

jormundur00 merged commit 6090e52 into master Feb 11, 2026
63 checks passed

jormundur00 added a commit that referenced this pull request Feb 18, 2026

Revert "Remove global metadata/index.json file from the repository (#983

318fe1d

)" This reverts commit 6090e52.

jormundur00 added a commit that referenced this pull request Feb 18, 2026

Revert "Remove global metadata/index.json file from the repository (#983

73435df

)" This reverts commit 6090e52.

jormundur00 added a commit that referenced this pull request Feb 18, 2026

Revert "Remove global metadata/index.json file from the repository (#983

9c4acc5

)" This reverts commit 6090e52.

jormundur00 added a commit that referenced this pull request Feb 18, 2026

Revert "Remove global metadata/index.json file from the repository (#983

c4c2b19

)" (#1013) This reverts commit 6090e52.

jormundur00 added a commit that referenced this pull request Feb 19, 2026

Remove global metadata/index.json file from the repository (#983)

32d40d6

jormundur00 mentioned this pull request Feb 19, 2026

Remove global metadata/index.json file from the repository #1015

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove global metadata/index.json file and its usage#983

Remove global metadata/index.json file and its usage#983
jormundur00 merged 1 commit intomasterfrom
jormundur00/global-index-removal

jormundur00 commented Feb 2, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

jormundur00 Feb 10, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

jormundur00 Feb 10, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

jormundur00 Feb 10, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

jormundur00 Feb 10, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

kimeta Feb 9, 2026

Uh oh!

jormundur00 Feb 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jormundur00 commented Feb 2, 2026

What does this PR do?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants