asset details (WIP)

This commit is contained in:
2026-03-24 13:42:51 +00:00
parent 91799bccd7
commit a958052bbf
23 changed files with 599 additions and 143 deletions
@@ -1,6 +1,7 @@
package p.packer.models;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
@@ -10,7 +11,8 @@ public record PackerFileCacheEntry(
long size,
long lastModified,
String fingerprint,
Map<String, Object> metadata) {
Map<String, Object> metadata,
List<PackerDiagnostic> diagnostics) {
public PackerFileCacheEntry {
relativePath = normalizeRelativePath(relativePath);
@@ -23,6 +25,7 @@ public record PackerFileCacheEntry(
}
fingerprint = normalizeOptional(fingerprint);
metadata = Map.copyOf(new LinkedHashMap<>(Objects.requireNonNull(metadata, "metadata")));
diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics"));
}
private static String normalizeRelativePath(String relativePath) {
@@ -7,8 +7,11 @@ import p.packer.PackerWorkspacePaths;
import p.packer.exceptions.PackerRegistryException;
import p.packer.messages.PackerProjectContext;
import p.packer.models.PackerAssetCacheEntry;
import p.packer.models.PackerDiagnostic;
import p.packer.models.PackerFileCacheEntry;
import p.packer.models.PackerWorkspaceCacheState;
import p.packer.messages.diagnostics.PackerDiagnosticCategory;
import p.packer.messages.diagnostics.PackerDiagnosticSeverity;
import java.io.IOException;
import java.nio.file.Files;
@@ -54,7 +57,8 @@ public final class FileSystemPackerCacheRepository {
file.size,
file.lastModified,
file.fingerprint,
file.metadata == null ? Map.of() : file.metadata));
file.metadata == null ? Map.of() : file.metadata,
loadDiagnostics(file.diagnostics)));
}
}
validateAssetId(asset.assetId);
@@ -92,7 +96,8 @@ public final class FileSystemPackerCacheRepository {
file.size(),
file.lastModified(),
file.fingerprint(),
file.metadata()))
file.metadata(),
saveDiagnostics(file.diagnostics())))
.toList()))
.toList();
mapper.writerWithDefaultPrettyPrinter().writeValue(cachePath.toFile(), document);
@@ -101,6 +106,39 @@ public final class FileSystemPackerCacheRepository {
}
}
private List<PackerDiagnostic> loadDiagnostics(List<CacheDiagnosticDocument> diagnostics) {
if (diagnostics == null || diagnostics.isEmpty()) {
return List.of();
}
final List<PackerDiagnostic> loaded = new ArrayList<>();
for (CacheDiagnosticDocument diagnostic : diagnostics) {
if (diagnostic == null || diagnostic.severity == null || diagnostic.category == null || diagnostic.message == null) {
continue;
}
loaded.add(new PackerDiagnostic(
diagnostic.severity,
diagnostic.category,
diagnostic.message,
diagnostic.evidencePath == null || diagnostic.evidencePath.isBlank() ? null : Path.of(diagnostic.evidencePath),
diagnostic.blocking));
}
return List.copyOf(loaded);
}
private List<CacheDiagnosticDocument> saveDiagnostics(List<PackerDiagnostic> diagnostics) {
if (diagnostics == null || diagnostics.isEmpty()) {
return List.of();
}
return diagnostics.stream()
.map(diagnostic -> new CacheDiagnosticDocument(
diagnostic.severity(),
diagnostic.category(),
diagnostic.message(),
diagnostic.evidencePath() == null ? null : diagnostic.evidencePath().toString(),
diagnostic.blocking()))
.toList();
}
private void validateDuplicateAssetIds(List<PackerAssetCacheEntry> assets) {
final Set<Integer> assetIds = new HashSet<>();
for (PackerAssetCacheEntry asset : assets) {
@@ -162,6 +200,16 @@ public final class FileSystemPackerCacheRepository {
@JsonProperty("size") long size,
@JsonProperty("last_modified") long lastModified,
@JsonProperty("fingerprint") String fingerprint,
@JsonProperty("metadata") Map<String, Object> metadata) {
@JsonProperty("metadata") Map<String, Object> metadata,
@JsonProperty("diagnostics") List<CacheDiagnosticDocument> diagnostics) {
}
@JsonIgnoreProperties(ignoreUnknown = true)
private record CacheDiagnosticDocument(
@JsonProperty("severity") PackerDiagnosticSeverity severity,
@JsonProperty("category") PackerDiagnosticCategory category,
@JsonProperty("message") String message,
@JsonProperty("evidence_path") String evidencePath,
@JsonProperty("blocking") boolean blocking) {
}
}
@@ -73,7 +73,10 @@ public abstract class PackerAbstractBankWalker<R> {
final var fileProbe = fileProbeMaybe.get();
final var cachedEntry = resolvePriorFileCache(assetRoot, fileProbe.path(), priorAssetCache);
if (cachedEntry.isPresent() && canReuseMetadata(fileProbe, cachedEntry.get())) {
probeResults.add(new PackerProbeResult(fileProbe, cachedEntry.get().metadata(), List.of()));
probeResults.add(new PackerProbeResult(
fileProbe,
cachedEntry.get().metadata(),
cachedEntry.get().diagnostics()));
continue;
}
probeResults.add(processFileProbe(fileProbe, requirements));
@@ -74,7 +74,8 @@ public final class PackerRuntimeAssetMaterializer {
file.size(),
file.lastModified(),
file.fingerprint(),
file.metadata()))
file.metadata(),
file.diagnostics()))
.toList());
return new PackerRuntimeAssetMaterialization(runtimeAsset, Optional.of(assetCacheEntry));
}
@@ -14,6 +14,7 @@ import p.packer.messages.diagnostics.PackerDiagnosticCategory;
import p.packer.messages.diagnostics.PackerDiagnosticSeverity;
import p.packer.models.*;
import p.packer.repositories.FileSystemPackerCacheRepository;
import p.packer.repositories.PackerContractFingerprint;
import p.packer.repositories.PackerRuntimeRegistry;
import java.io.IOException;
@@ -646,7 +647,11 @@ public final class FileSystemPackerWorkspaceService implements PackerWorkspaceSe
}
try {
final String previousContractFingerprint = contractFingerprint(manifest);
patchManifestContract(manifest, request);
if (!Objects.equals(previousContractFingerprint, contractFingerprint(manifest))) {
clearManifestBankComposition(manifest);
}
mapper.writerWithDefaultPrettyPrinter().writeValue(manifestPath.toFile(), manifest);
final var runtime = runtimeRegistry.update(project, (currentSnapshot, generation) -> runtimePatchService.afterUpdateAssetContract(
currentSnapshot,
@@ -770,6 +775,35 @@ public final class FileSystemPackerWorkspaceService implements PackerWorkspaceSe
}
}
private String contractFingerprint(ObjectNode manifest) {
final JsonNode outputNode = manifest.path("output");
if (!(outputNode instanceof ObjectNode outputObject)) {
return PackerContractFingerprint.metadataFingerprint(Map.of());
}
final JsonNode metadataNode = outputObject.path("metadata");
if (!(metadataNode instanceof ObjectNode metadataObject)) {
return PackerContractFingerprint.metadataFingerprint(Map.of());
}
final Map<String, String> metadata = new LinkedHashMap<>();
metadataObject.fields().forEachRemaining(entry -> {
if (entry.getKey() == null || entry.getKey().isBlank()) {
return;
}
final JsonNode valueNode = entry.getValue();
if (valueNode == null || valueNode.isContainerNode()) {
return;
}
metadata.put(entry.getKey().trim(), valueNode.isNull() ? "" : valueNode.asText(""));
});
return PackerContractFingerprint.metadataFingerprint(metadata);
}
private void clearManifestBankComposition(ObjectNode manifest) {
final ObjectNode inputsNode = mutableObject(manifest, "inputs");
inputsNode.removeAll();
manifest.putArray("artifacts");
}
private boolean isTrustedRelativePath(String value) {
final Path path = Path.of(value).normalize();
return !path.isAbsolute() && !path.startsWith("..");
@@ -44,6 +44,7 @@ public final class PackerAssetDetailsService {
final var parsed = runtimeAsset.parsedDeclaration();
diagnostics.addAll(parsed.diagnostics());
diagnostics.addAll(runtimeAsset.walkDiagnostics());
appendWalkFileDiagnostics(runtimeAsset, diagnostics);
if (!parsed.valid()) {
return failureResult(project, request.assetReference(), resolved, diagnostics);
}
@@ -253,6 +254,18 @@ public final class PackerAssetDetailsService {
true));
}
private void appendWalkFileDiagnostics(
PackerRuntimeAsset runtimeAsset,
List<PackerDiagnostic> diagnostics) {
for (PackerRuntimeWalkFile file : runtimeAsset.walkProjection().buildCandidateFiles()) {
for (PackerDiagnostic diagnostic : file.diagnostics()) {
if (!diagnostics.contains(diagnostic)) {
diagnostics.add(diagnostic);
}
}
}
}
private AssetReference canonicalReference(
final PackerProjectContext project,
final Path assetRoot,
@@ -7,8 +7,11 @@ import p.packer.PackerWorkspacePaths;
import p.packer.exceptions.PackerRegistryException;
import p.packer.messages.PackerProjectContext;
import p.packer.models.PackerAssetCacheEntry;
import p.packer.models.PackerDiagnostic;
import p.packer.models.PackerFileCacheEntry;
import p.packer.models.PackerWorkspaceCacheState;
import p.packer.messages.diagnostics.PackerDiagnosticCategory;
import p.packer.messages.diagnostics.PackerDiagnosticSeverity;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -46,14 +49,21 @@ final class FileSystemPackerCacheRepositoryTest {
128L,
42L,
"abc123",
Map.of("tile_count", 4)),
Map.of("tile_count", 4),
List.of(new PackerDiagnostic(
PackerDiagnosticSeverity.WARNING,
PackerDiagnosticCategory.HYGIENE,
"cached warning",
Path.of("/tmp/ui.png"),
false))),
new PackerFileCacheEntry(
"tiles/ui-2.png",
"image/png",
256L,
84L,
"def456",
Map.of()))),
Map.of(),
List.of()))),
new PackerAssetCacheEntry(1, "contract-1", List.of(
new PackerFileCacheEntry(
"audio/click.wav",
@@ -61,7 +71,8 @@ final class FileSystemPackerCacheRepositoryTest {
512L,
21L,
null,
Map.of("sample_count", 8))))));
Map.of("sample_count", 8),
List.of())))));
repository.save(project, state);
final var loaded = repository.load(project);
@@ -70,6 +81,8 @@ final class FileSystemPackerCacheRepositoryTest {
assertEquals("contract-3", loaded.findAsset(3).orElseThrow().contractFingerprint());
assertTrue(loaded.findAsset(3).flatMap(asset -> asset.findFile("tiles/ui.png")).isPresent());
assertEquals(128L, loaded.findAsset(3).orElseThrow().findFile("tiles/ui.png").orElseThrow().size());
assertEquals(1, loaded.findAsset(3).orElseThrow().findFile("tiles/ui.png").orElseThrow().diagnostics().size());
assertEquals("cached warning", loaded.findAsset(3).orElseThrow().findFile("tiles/ui.png").orElseThrow().diagnostics().getFirst().message());
}
@Test
@@ -114,7 +127,7 @@ final class FileSystemPackerCacheRepositoryTest {
}
@Test
void doesNotSerializeDiagnostics() throws Exception {
void serializesDiagnosticsWhenPresent() throws Exception {
final var repository = new FileSystemPackerCacheRepository(MAPPER);
final var project = project(tempDir.resolve("project"));
final var state = new PackerWorkspaceCacheState(
@@ -126,13 +139,19 @@ final class FileSystemPackerCacheRepositoryTest {
128L,
42L,
"abc123",
Map.of("warning_count", 2))))));
Map.of("warning_count", 2),
List.of(new PackerDiagnostic(
PackerDiagnosticSeverity.WARNING,
PackerDiagnosticCategory.HYGIENE,
"cached diagnostic",
Path.of("/tmp/ui.png"),
false)))))));
repository.save(project, state);
final String json = Files.readString(PackerWorkspacePaths.cachePath(project));
assertFalse(json.contains("diagnostic"));
assertFalse(json.contains("diagnostics"));
assertTrue(json.contains("\"diagnostics\""));
assertTrue(json.contains("\"cached diagnostic\""));
assertTrue(json.contains("\"asset_id\""));
assertTrue(json.contains("\"contract_fingerprint\""));
assertTrue(json.contains("\"metadata\""));
@@ -29,7 +29,7 @@ final class PackerAbstractBankWalkerTest {
final var filePath = writeText(assetRoot.resolve("entry.txt"), "hello world");
final long lastModified = Files.getLastModifiedTime(filePath).toMillis();
final var priorCache = new PackerAssetCacheEntry(1, "contract", List.of(
new PackerFileCacheEntry("entry.txt", "text/plain", 1L, lastModified, "cached", Map.of("source", "cache"))));
new PackerFileCacheEntry("entry.txt", "text/plain", 1L, lastModified, "cached", Map.of("source", "cache"), List.of())));
final var result = walker.walk(assetRoot, "requirements", java.util.Optional.of(priorCache));
@@ -51,7 +51,8 @@ final class PackerAbstractBankWalkerTest {
Files.size(filePath),
currentLastModified - 1L,
"cached",
Map.of("source", "cache"))));
Map.of("source", "cache"),
List.of())));
final var result = walker.walk(assetRoot, "requirements", java.util.Optional.of(priorCache));
@@ -74,13 +75,21 @@ final class PackerAbstractBankWalkerTest {
Files.size(filePath),
lastModified,
fingerprint,
Map.of("source", "cache"))));
Map.of("source", "cache"),
List.of(new PackerDiagnostic(
p.packer.messages.diagnostics.PackerDiagnosticSeverity.WARNING,
p.packer.messages.diagnostics.PackerDiagnosticCategory.HYGIENE,
"cached file-scoped diagnostic",
filePath,
false)))));
final var result = walker.walk(assetRoot, "requirements", java.util.Optional.of(priorCache));
assertEquals(0, walker.processCount());
assertEquals(1, walker.fingerprintCount());
assertEquals("cache", result.probeResults().getFirst().metadata().get("source"));
assertEquals(1, result.probeResults().getFirst().diagnostics().size());
assertTrue(result.probeResults().getFirst().diagnostics().getFirst().message().contains("cached"));
}
@Test
@@ -96,7 +105,8 @@ final class PackerAbstractBankWalkerTest {
Files.size(filePath),
lastModified,
null,
Map.of("source", "cache"))));
Map.of("source", "cache"),
List.of())));
final var result = walker.walk(assetRoot, "requirements", java.util.Optional.of(priorCache));
@@ -15,6 +15,8 @@ import p.packer.repositories.PackerRuntimeRegistry;
import p.packer.repositories.PackerRuntimeSnapshotLoader;
import p.packer.testing.PackerFixtureLocator;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Comparator;
@@ -245,6 +247,41 @@ final class FileSystemPackerWorkspaceServiceTest {
assertEquals(1, loader.loadCount());
}
@Test
void updateAssetContractDropsPersistedBankCompositionWhenContractFingerprintChanges() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("update-contract-drops-bank"));
final Path assetRoot = projectRoot.resolve("assets/ui/atlas");
writeTilePng(assetRoot.resolve("confirm.png"), 16);
writeTilePng(assetRoot.resolve("cancel.png"), 16);
final FileSystemPackerWorkspaceService service = service();
final var applyResult = service.applyBankComposition(new ApplyBankCompositionRequest(
project(projectRoot),
AssetReference.forAssetId(1),
List.of("cancel.png", "confirm.png")));
assertTrue(applyResult.success());
final var updateResult = service.updateAssetContract(new UpdateAssetContractRequest(
project(projectRoot),
AssetReference.forAssetId(1),
true,
OutputCodecCatalog.NONE,
Map.of(),
Map.of("tile_size", "32x32")));
assertTrue(updateResult.success());
final var manifest = MAPPER.readTree(assetRoot.resolve("asset.json").toFile());
assertTrue(manifest.path("inputs").isObject());
assertTrue(manifest.path("inputs").isEmpty());
assertTrue(manifest.path("artifacts").isArray());
assertTrue(manifest.path("artifacts").isEmpty());
final var detailsResult = service.getAssetDetails(new GetAssetDetailsRequest(
project(projectRoot),
AssetReference.forAssetId(1)));
assertTrue(detailsResult.details().bankComposition().selectedFiles().isEmpty());
}
@Test
void applyBankCompositionWritesArtifactsAndRefreshesSnapshotWithoutWholeProjectReload() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("apply-bank-composition"));
@@ -284,6 +321,44 @@ final class FileSystemPackerWorkspaceServiceTest {
assertEquals(1, loader.loadCount());
}
@Test
void deepSyncPreservesContractDrivenBankInvalidationAfterPatchUpdate() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("deep-sync-bank-composition"));
final Path assetRoot = projectRoot.resolve("assets/ui/atlas");
writeTilePng(assetRoot.resolve("confirm.png"), 16);
writeTilePng(assetRoot.resolve("cancel.png"), 16);
final FileSystemPackerWorkspaceService service = service();
final var applyResult = service.applyBankComposition(new ApplyBankCompositionRequest(
project(projectRoot),
AssetReference.forAssetId(1),
List.of("cancel.png", "confirm.png")));
assertTrue(applyResult.success());
final var updateResult = service.updateAssetContract(new UpdateAssetContractRequest(
project(projectRoot),
AssetReference.forAssetId(1),
true,
OutputCodecCatalog.NONE,
Map.of(),
Map.of("tile_size", "32x32")));
assertTrue(updateResult.success());
final var patchedDetails = service.getAssetDetails(new GetAssetDetailsRequest(
project(projectRoot),
AssetReference.forAssetId(1)));
assertTrue(patchedDetails.details().bankComposition().availableFiles().isEmpty());
assertTrue(patchedDetails.details().bankComposition().selectedFiles().isEmpty());
service.listAssets(new ListAssetsRequest(project(projectRoot), true));
final var refreshedDetails = service.getAssetDetails(new GetAssetDetailsRequest(
project(projectRoot),
AssetReference.forAssetId(1)));
assertTrue(refreshedDetails.details().bankComposition().availableFiles().isEmpty());
assertTrue(refreshedDetails.details().bankComposition().selectedFiles().isEmpty());
}
@Test
void returnsFailureWhenAssetManifestIsMissingOnContractUpdate() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("update-contract-missing-manifest"));
@@ -786,4 +861,15 @@ final class FileSystemPackerWorkspaceServiceTest {
}
return targetRoot;
}
private void writeTilePng(Path path, int tileSize) throws Exception {
Files.createDirectories(path.getParent());
final BufferedImage image = new BufferedImage(tileSize, tileSize, BufferedImage.TYPE_INT_ARGB);
for (int y = 0; y < tileSize; y += 1) {
for (int x = 0; x < tileSize; x += 1) {
image.setRGB(x, y, 0xFFFF0000);
}
}
ImageIO.write(image, "png", path.toFile());
}
}
@@ -107,6 +107,22 @@ final class PackerAssetDetailsServiceTest {
result.details().bankComposition().selectedFiles().stream().map(file -> file.path()).toList());
}
@Test
void includesFileScopedDiagnosticsInAssetDetailsDiagnostics() throws Exception {
final Path projectRoot = copyFixture("workspaces/managed-basic", tempDir.resolve("managed-file-diagnostics"));
final Path assetRoot = projectRoot.resolve("assets/ui/atlas");
writeTilePng(assetRoot.resolve("wrong-palette.png"), 32);
final PackerAssetDetailsService service = service();
final var result = service.getAssetDetails(new GetAssetDetailsRequest(project(projectRoot), AssetReference.forAssetId(1)));
assertEquals(PackerOperationStatus.PARTIAL, result.status());
assertTrue(result.diagnostics().stream()
.anyMatch(diagnostic -> diagnostic.message().contains("Invalid tile dimensions for wrong-palette.png")));
assertTrue(result.details().diagnostics().stream()
.anyMatch(diagnostic -> diagnostic.message().contains("Invalid tile dimensions for wrong-palette.png")));
}
@Test
void returnsUnregisteredDetailsForValidUnregisteredRootReference() throws Exception {
final Path projectRoot = copyFixture("workspaces/orphan-valid", tempDir.resolve("orphan"));
@@ -224,4 +240,15 @@ final class PackerAssetDetailsServiceTest {
}
return targetRoot;
}
private void writeTilePng(Path path, int tileSize) throws Exception {
Files.createDirectories(path.getParent());
final BufferedImage image = new BufferedImage(tileSize, tileSize, BufferedImage.TYPE_INT_ARGB);
for (int y = 0; y < tileSize; y += 1) {
for (int x = 0; x < tileSize; x += 1) {
image.setRGB(x, y, 0xFFFF0000);
}
}
ImageIO.write(image, "png", path.toFile());
}
}