fix(gradle): admit module metadata from its root version marker (#12488)

This commit is contained in:
morluto authored and GitHub committed 2026-11-19 19:28:12 +00:00
1 parent 3d0fa7dae2
commit cd331e7b04
4 files changed
+99 -30

No files matched your search

+5 -3
View File
@@ -21,9 +21,11 @@ requires an absolute filesystem path and preserves that exact selection:
}
```
Classification is from content, not the suffix: a well-formed Maven `<project>`
document is `maven-pom`; a JSON object with `formatVersion` and a `component`
or `variants` array is `gradle-module`.
REA classifies files by their content. A well-formed Maven `<project>` document
is `maven-pom`. A Gradle metadata object starts with `formatVersion`.
Version `1.1` can omit `component` and `variants`. For other revisions, REA
also requires a `component` object or `variants` array as format evidence.
[Gradle Module Metadata 1.1 specification](https://github.com/gradle/gradle/blob/v9.2.1/platforms/documentation/docs/src/docs/design/gradle-module-metadata-latest-specification.md#contents)
## Observations
+18 -10
View File
@@ -15,6 +15,8 @@ export type ParsedJsonWithPolicy =
| {
readonly ok: true;
readonly value: unknown;
/** First source member of a root object scanned under the reject policy. */
readonly firstObjectMember?: string;
}
| {
readonly ok: false;
@@ -48,9 +50,8 @@ export const parseJsonStringLiteral = (raw: string): unknown =>
* Parse JSON text under an explicit duplicate-member policy, with an optional
* `JSON.parse` reviver.
*
* When `policy` is `"reject"`, `findDuplicateJsonMember` scans the validated
* JSON text and attaches the first repeated member name as `duplicate` on the
* returned result so the caller can raise its format-specific error.
* The `"reject"` policy scans the validated JSON text for repeated names and
* preserves the first root object member in its original source order.
*/
export const parseJsonWithDuplicatePolicy = (
text: string,
@@ -67,11 +68,13 @@ export const parseJsonWithDuplicatePolicy = (
} catch (cause: unknown) {
return { ok: false, cause };
}
const duplicate =
policy === "reject" ? findDuplicateJsonMember(text) : undefined;
return duplicate === undefined
if (policy === "last-wins") return { ok: true, value };
const members = observeJsonMembers(text);
if (members.duplicate !== undefined)
return { ok: false, duplicate: members.duplicate };
return members.firstObjectMember === undefined
? { ok: true, value }
: { ok: false, duplicate };
: { ok: true, value, firstObjectMember: members.firstObjectMember };
};
/**
@@ -97,11 +100,14 @@ export const parseLastWinsJson = (
*/
export const findDuplicateJsonMember = (
text: string,
): JsonDuplicateMember | undefined => {
): JsonDuplicateMember | undefined => observeJsonMembers(text).duplicate;
const observeJsonMembers = (text: string) => {
// One entry per open container: the names seen so far for an object, or
// null for an array. `expectName` marks the next string as a member name.
const open: (Set<string> | null)[] = [];
let expectName = false;
let firstObjectMember: string | undefined;
for (let index = 0; index < text.length; index++) {
const code = text.charCodeAt(index);
if (code === QUOTE) {
@@ -138,7 +144,9 @@ export const findDuplicateJsonMember = (
const name = raw.includes("\\")
? (JSON.parse(raw) as string)
: raw.slice(1, -1);
if (names.has(name)) return { name, offset: start };
if (open.length === 1) firstObjectMember ??= name;
if (names.has(name))
return { firstObjectMember, duplicate: { name, offset: start } };
names.add(name);
continue;
}
@@ -162,5 +170,5 @@ export const findDuplicateJsonMember = (
break;
}
}
return undefined;
return { firstObjectMember, duplicate: undefined };
};
+33 -17
View File
@@ -138,6 +138,18 @@ const gradleArray = (value: unknown, field: string): readonly unknown[] => {
);
};
const gradleObject = (
value: unknown,
field: string,
): Record<string, unknown> | null => {
if (value === undefined) return null;
if (isRecord(value)) return value;
throw malformedInput(
MAVEN_GRADLE_METADATA_FORMAT,
`Gradle module metadata ${field} is present but is not a JSON object.`,
);
};
const gradleObjects = (
value: unknown,
field: string,
@@ -474,15 +486,26 @@ const parseGradle = (
"Gradle module metadata root must be a JSON object.",
);
const format_version = textOf(parsed.formatVersion);
const component = isRecord(parsed.component) ? parsed.component : null;
if (format_version === null)
throw unsupportedInput(
MAVEN_GRADLE_METADATA_FORMAT,
"Selected JSON document is not Gradle module metadata (missing a string formatVersion).",
);
if (json.firstObjectMember !== "formatVersion")
throw malformedInput(
MAVEN_GRADLE_METADATA_FORMAT,
"Gradle module metadata formatVersion must be the first object member.",
);
const component = gradleObject(parsed.component, "component");
const variantsValue = parsed.variants;
if (
format_version === null ||
(component === null && !Array.isArray(variantsValue))
parsed.formatVersion !== "1.1" &&
component === null &&
!Array.isArray(variantsValue)
)
throw unsupportedInput(
MAVEN_GRADLE_METADATA_FORMAT,
"Selected JSON document is not Gradle module metadata (missing formatVersion and component or variants).",
"Unrecognized Gradle module metadata formatVersion without component or variants.",
);
const limitations: string[] = [
...BASE_LIMITATIONS,
@@ -497,9 +520,8 @@ const parseGradle = (
packaging: null,
};
unresolved.coordinates(coordinates, "project", null, false);
const createdBy = isRecord(parsed.createdBy) ? parsed.createdBy : null;
const createdGradle =
createdBy !== null && isRecord(createdBy.gradle) ? createdBy.gradle : null;
const createdBy = gradleObject(parsed.createdBy, "createdBy");
const createdGradle = gradleObject(createdBy?.gradle, "createdBy.gradle");
// Count each expanded collection before any report record is built.
admit(
"variants",
@@ -532,18 +554,12 @@ const parseGradle = (
);
for (const variant of variants) {
const name = textOf(variant.name);
const attributes = isRecord(variant.attributes) ? variant.attributes : {};
const category = textOf(attributes["org.gradle.category"]);
const usage = textOf(attributes["org.gradle.usage"]);
const attributes = gradleObject(variant.attributes, "variant.attributes");
const category = textOf(attributes?.["org.gradle.category"]);
const usage = textOf(attributes?.["org.gradle.usage"]);
const platform =
category === "platform" || category === "enforced-platform";
const availableAt: unknown = variant["available-at"];
if (availableAt !== undefined && !isRecord(availableAt))
throw malformedInput(
MAVEN_GRADLE_METADATA_FORMAT,
"Gradle module metadata available-at is present but is not a JSON object.",
);
const available = availableAt === undefined ? null : availableAt;
const available = gradleObject(variant["available-at"], "available-at");
const variantDependencies = gradleArray(
variant.dependencies,
"dependencies",
@@ -6,6 +6,49 @@ import { mavenPomFixture } from "../../../src/java/MavenGradleMetadata.fixture.j
import { createTestTempDirectory } from "../../fixtures/temporaryDirectory.js";
describe("Maven POM and Gradle module metadata stable filesystem boundary", () => {
it("admits a minimal Gradle document by its first decoded member", async () => {
const root = await createTestTempDirectory("rea-gradle-format-order-");
const path = join(root, "module.json");
const service = createMavenGradleMetadataService();
const inspect = async (source: string) => {
await writeFile(path, source);
return service.inspect({ path });
};
try {
// JSON object enumeration promotes numeric keys ahead of string keys.
const minimal = await inspect(
String.raw`{"f\u006frmatVersion":"1.1","0":null}`,
);
if (!minimal.ok) throw minimal.error;
expect(minimal.value.normalized_result).toMatchObject({
format: "gradle-module",
gradle: { format_version: "1.1", variants: [] },
dependencies: [],
coverage: { status: "complete" },
});
for (const invalid of [
'{"variants":[],"formatVersion":"1.1"}',
'{"formatVersion":"1.1","component":null,"variants":[]}',
'{"formatVersion":"1.1","createdBy":[]}',
'{"formatVersion":"1.1","createdBy":{"gradle":false}}',
'{"formatVersion":"1.1","variants":[{"name":"runtime","attributes":[]}]}',
]) {
const result = await inspect(invalid);
expect(result).toMatchObject({
ok: false,
error: { issues: [{ reason: "invalid_format" }] },
});
}
const unfamiliar = await inspect('{"formatVersion":"2.0","variants":[]}');
if (!unfamiliar.ok) throw unfamiliar.error;
expect(unfamiliar.value.normalized_result).toMatchObject({
gradle: { format_version: "2.0", variants: [] },
});
} finally {
await service.close();
}
});
it("returns typed resource and cancellation failures", async () => {
const root = await createTestTempDirectory("rea-maven-gradle-budget-");
const path = join(root, "pom.xml");