asset metadata form added

This commit is contained in:
2026-03-24 13:42:48 +00:00
parent f34c5a7691
commit 4050fcbcaa
17 changed files with 313 additions and 60 deletions
@@ -14,6 +14,7 @@ public record PackerAssetDetailsDTO(
OutputCodecCatalog outputCodec,
List<OutputCodecCatalog> availableOutputCodecs,
Map<OutputCodecCatalog, List<PackerCodecConfigurationFieldDTO>> codecConfigurationFieldsByCodec,
List<PackerCodecConfigurationFieldDTO> metadataFields,
Map<String, List<Path>> inputsByRole,
List<PackerDiagnosticDTO> diagnostics) {
@@ -23,6 +24,7 @@ public record PackerAssetDetailsDTO(
outputCodec = Objects.requireNonNullElse(outputCodec, OutputCodecCatalog.UNKNOWN);
availableOutputCodecs = List.copyOf(Objects.requireNonNull(availableOutputCodecs, "availableOutputCodecs"));
codecConfigurationFieldsByCodec = Map.copyOf(Objects.requireNonNull(codecConfigurationFieldsByCodec, "codecConfigurationFieldsByCodec"));
metadataFields = List.copyOf(Objects.requireNonNull(metadataFields, "metadataFields"));
inputsByRole = Map.copyOf(Objects.requireNonNull(inputsByRole, "inputsByRole"));
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
}
@@ -10,12 +10,14 @@ public record UpdateAssetContractRequest(
AssetReference assetReference,
boolean preloadEnabled,
OutputCodecCatalog outputCodec,
Map<String, String> codecFieldValues) {
Map<String, String> codecFieldValues,
Map<String, String> metadataFieldValues) {
public UpdateAssetContractRequest {
Objects.requireNonNull(project, "project");
Objects.requireNonNull(assetReference, "assetReference");
outputCodec = Objects.requireNonNullElse(outputCodec, OutputCodecCatalog.UNKNOWN);
codecFieldValues = Map.copyOf(Objects.requireNonNullElse(codecFieldValues, Map.of()));
metadataFieldValues = Map.copyOf(Objects.requireNonNullElse(metadataFieldValues, Map.of()));
}
}
@@ -17,6 +17,7 @@ public record PackerAssetDeclaration(
Map<String, List<String>> inputsByRole,
OutputFormatCatalog outputFormat,
OutputCodecCatalog outputCodec,
Map<String, String> outputMetadata,
boolean preloadEnabled) {
public PackerAssetDeclaration {
@@ -29,6 +30,7 @@ public record PackerAssetDeclaration(
inputsByRole = Map.copyOf(Objects.requireNonNull(inputsByRole, "inputsByRole"));
outputFormat = Objects.requireNonNull(outputFormat, "outputFormat");
outputCodec = Objects.requireNonNull(outputCodec, "outputCodec");
outputMetadata = Map.copyOf(Objects.requireNonNull(outputMetadata, "outputMetadata"));
if (StringUtils.isBlank(assetUuid) || StringUtils.isBlank(name)) {
throw new IllegalArgumentException("declaration fields must not be blank");
}
@@ -14,6 +14,7 @@ public record PackerAssetDetails(
OutputCodecCatalog outputCodec,
List<OutputCodecCatalog> availableOutputCodecs,
Map<OutputCodecCatalog, List<PackerCodecConfigurationField>> codecConfigurationFieldsByCodec,
List<PackerCodecConfigurationField> metadataFields,
Map<String, List<Path>> inputsByRole,
List<PackerDiagnostic> diagnostics) {
@@ -23,6 +24,7 @@ public record PackerAssetDetails(
outputCodec = Objects.requireNonNullElse(outputCodec, OutputCodecCatalog.UNKNOWN);
availableOutputCodecs = List.copyOf(Objects.requireNonNull(availableOutputCodecs, "availableOutputCodecs"));
codecConfigurationFieldsByCodec = Map.copyOf(Objects.requireNonNull(codecConfigurationFieldsByCodec, "codecConfigurationFieldsByCodec"));
metadataFields = List.copyOf(Objects.requireNonNull(metadataFields, "metadataFields"));
inputsByRole = Map.copyOf(Objects.requireNonNull(inputsByRole, "inputsByRole"));
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
}
@@ -672,6 +672,17 @@ public final class FileSystemPackerWorkspaceService implements PackerWorkspaceSe
}
codecConfigurationNode.put(normalizedFieldKey, Objects.requireNonNullElse(fieldValue, ""));
});
final ObjectNode metadataNode = mutableObject(outputNode, "metadata");
metadataNode.removeAll();
request.metadataFieldValues().entrySet().stream()
.sorted(Map.Entry.comparingByKey())
.forEach(entry -> {
if (entry.getKey() == null || entry.getKey().isBlank()) {
return;
}
metadataNode.put(entry.getKey().trim(), Objects.requireNonNullElse(entry.getValue(), ""));
});
}
private ObjectNode mutableObject(ObjectNode parent, String fieldName) {
@@ -47,6 +47,7 @@ public final class PackerAssetDeclarationParser {
final Map<String, List<String>> inputsByRole = requiredInputs(root.path("inputs"), diagnostics, manifestPath);
final OutputFormatCatalog outputFormat = requiredOutputFormat(root.path("output"), diagnostics, manifestPath);
final OutputCodecCatalog outputCodec = requiredOutputCodec(root.path("output"), diagnostics, manifestPath);
final Map<String, String> outputMetadata = optionalOutputMetadata(root.path("output"), diagnostics, manifestPath);
final Boolean preloadEnabled = requiredBoolean(root.path("preload"), "enabled", diagnostics, manifestPath);
if (schemaVersion != null && schemaVersion != SUPPORTED_SCHEMA_VERSION) {
@@ -71,6 +72,7 @@ public final class PackerAssetDeclarationParser {
inputsByRole,
outputFormat,
outputCodec,
outputMetadata,
preloadEnabled),
diagnostics);
}
@@ -156,6 +158,53 @@ public final class PackerAssetDeclarationParser {
return outputCodec;
}
private Map<String, String> optionalOutputMetadata(
JsonNode outputNode,
List<PackerDiagnostic> diagnostics,
Path manifestPath) {
final JsonNode metadataNode = outputNode.path("metadata");
if (metadataNode.isMissingNode() || metadataNode.isNull()) {
return Map.of();
}
if (!metadataNode.isObject()) {
diagnostics.add(new PackerDiagnostic(
PackerDiagnosticSeverity.ERROR,
PackerDiagnosticCategory.STRUCTURAL,
"Field 'output.metadata' must be a JSON object.",
manifestPath,
true));
return Map.of();
}
final Map<String, String> metadata = new LinkedHashMap<>();
metadataNode.fields().forEachRemaining(entry -> {
final String key = Objects.requireNonNullElse(entry.getKey(), "").trim();
if (key.isBlank()) {
diagnostics.add(new PackerDiagnostic(
PackerDiagnosticSeverity.ERROR,
PackerDiagnosticCategory.STRUCTURAL,
"Field 'output.metadata' has an invalid empty key.",
manifestPath,
true));
return;
}
final JsonNode valueNode = entry.getValue();
if (valueNode == null || valueNode.isContainerNode()) {
diagnostics.add(new PackerDiagnostic(
PackerDiagnosticSeverity.ERROR,
PackerDiagnosticCategory.STRUCTURAL,
"Field 'output.metadata' values must be scalar (text/number/boolean).",
manifestPath,
true));
return;
}
metadata.put(key, valueNode.asText());
});
return Map.copyOf(metadata);
}
private Map<String, List<String>> requiredInputs(JsonNode inputsNode, List<PackerDiagnostic> diagnostics, Path manifestPath) {
if (!inputsNode.isObject()) {
diagnostics.add(missingOrInvalid("inputs", "object of input roles", manifestPath));
@@ -73,6 +73,7 @@ public final class PackerAssetDetailsService {
declaration.outputCodec(),
outputContract.availableCodecs(),
outputContract.codecConfigurationFieldsByCodec(),
metadataFields(declaration.outputMetadata()),
resolveInputs(resolved.assetRoot(), declaration.inputsByRole()),
diagnostics);
return new GetAssetDetailsResult(
@@ -111,6 +112,7 @@ public final class PackerAssetDetailsService {
OutputCodecCatalog.UNKNOWN,
List.of(OutputCodecCatalog.NONE),
Map.of(OutputCodecCatalog.NONE, List.of()),
List.of(),
Map.of(),
diagnostics);
return new GetAssetDetailsResult(
@@ -130,6 +132,18 @@ public final class PackerAssetDetailsService {
return Map.copyOf(resolved);
}
private List<PackerCodecConfigurationField> metadataFields(Map<String, String> outputMetadata) {
return outputMetadata.entrySet().stream()
.map(entry -> new PackerCodecConfigurationField(
entry.getKey(),
entry.getKey(),
PackerCodecConfigurationFieldType.TEXT,
entry.getValue(),
false,
List.of()))
.toList();
}
private List<PackerDiagnostic> identityMismatchDiagnostics(
final Optional<PackerRegistryEntry> registryEntry,
final PackerAssetDeclaration declaration,
@@ -30,6 +30,7 @@ public final class PackerReadMessageMapper {
details.outputCodec(),
details.availableOutputCodecs(),
toCodecConfigurationFieldsByCodecDTO(details.codecConfigurationFieldsByCodec()),
toCodecConfigurationFieldDTOs(details.metadataFields()),
details.inputsByRole(),
toDiagnosticDTOs(details.diagnostics()));
}
@@ -74,6 +75,11 @@ public final class PackerReadMessageMapper {
field.options());
}
private static List<PackerCodecConfigurationFieldDTO> toCodecConfigurationFieldDTOs(
List<PackerCodecConfigurationField> fields) {
return fields.stream().map(PackerReadMessageMapper::toCodecConfigurationFieldDTO).toList();
}
private static PackerDiagnosticDTO toDiagnosticDTO(PackerDiagnostic diagnostic) {
return new PackerDiagnosticDTO(
diagnostic.severity(),
@@ -191,7 +191,10 @@ final class FileSystemPackerWorkspaceServiceTest {
OutputCodecCatalog.NONE,
Map.of(
"NONE:packMode", "tight",
"NONE:palette", "mono")));
"NONE:palette", "mono"),
Map.of(
"tile_size", "16",
"channels", "1")));
assertTrue(result.success());
assertNull(result.errorMessage());
@@ -202,6 +205,8 @@ final class FileSystemPackerWorkspaceServiceTest {
assertEquals("NONE", manifest.path("output").path("codec").asText());
assertEquals("tight", manifest.path("output").path("codec_configuration").path("packMode").asText());
assertEquals("mono", manifest.path("output").path("codec_configuration").path("palette").asText());
assertEquals("16", manifest.path("output").path("metadata").path("tile_size").asText());
assertEquals("1", manifest.path("output").path("metadata").path("channels").asText());
}
@Test
@@ -218,7 +223,8 @@ final class FileSystemPackerWorkspaceServiceTest {
AssetReference.forAssetId(1),
false,
OutputCodecCatalog.NONE,
Map.of("NONE:packMode", "tight")));
Map.of("NONE:packMode", "tight"),
Map.of()));
assertTrue(updateResult.success());
assertEquals(1, loader.loadCount());
@@ -243,6 +249,7 @@ final class FileSystemPackerWorkspaceServiceTest {
AssetReference.forAssetId(1),
true,
OutputCodecCatalog.NONE,
Map.of(),
Map.of()));
assertFalse(result.success());
@@ -1,6 +1,7 @@
package p.packer.services;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import p.packer.messages.AssetReference;
@@ -16,6 +17,7 @@ import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import static org.junit.jupiter.api.Assertions.*;
@@ -57,6 +59,30 @@ final class PackerAssetDetailsServiceTest {
assertEquals(List.of(), result.details().codecConfigurationFieldsByCodec().get(OutputCodecCatalog.NONE));
}
@Test
void exposesMetadataFieldsFromOutputMetadataContract() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("managed-with-metadata"));
final Path manifestPath = projectRoot.resolve("assets/ui/atlas/asset.json");
final ObjectMapper mapper = new ObjectMapper();
final var manifest = mapper.readTree(manifestPath.toFile());
final ObjectNode output = (ObjectNode) manifest.path("output");
final ObjectNode metadata = output.putObject("metadata");
metadata.put("tile_size", "16");
metadata.put("channels", "1");
mapper.writerWithDefaultPrettyPrinter().writeValue(manifestPath.toFile(), manifest);
final PackerAssetDetailsService service = service();
final var result = service.getAssetDetails(new GetAssetDetailsRequest(project(projectRoot), AssetReference.forAssetId(1)));
assertEquals(PackerOperationStatus.SUCCESS, result.status());
assertEquals(
Map.of("tile_size", "16", "channels", "1"),
result.details().metadataFields().stream().collect(java.util.stream.Collectors.toMap(
field -> field.key(),
field -> field.value())));
}
@Test
void returnsInvalidDetailsForInvalidDeclaration() throws Exception {
final Path projectRoot = copyFixture("workspaces/invalid-missing-fields", tempDir.resolve("invalid"));