Extend ManifestV3Builder to add adjuncts

donaldgray · donaldgray · commit 4c93801316a7 · 2026-01-21T15:16:16.000Z
Tests for outputting external adjuncts
diff --git a/src/protagonist/Orchestrator.Tests/Integration/ManifestHandlingTests.cs b/src/protagonist/Orchestrator.Tests/Integration/ManifestHandlingTests.cs
@@ -9,6 +9,7 @@
 using IIIF.ImageApi.V3;
 using IIIF.Presentation.V3.Annotation;
 using IIIF.Presentation.V3.Content;
+using IIIF.Presentation.V3.Strings;
 using IIIF.Serialisation;
 using Microsoft.Extensions.DependencyInjection;
 using Newtonsoft.Json.Linq;
@@ -794,4 +795,66 @@ await dbFixture.DbContext.Images.AddTestAsset(id, roles: "clickthrough", maxUnau
             .ContainSingle(s => s is AuthProbeService2 && s.Id.Contains(id.ToString()));
         paintable.Service.OfType<AuthProbeService2>().Single().Id.Should().Contain(id.ToString());
     }
+
+    [Fact]
+    public async Task Get_V3ManifestWithAdjuncts_OutputsAdjunctsInCorrectLocation()
+    {
+        // Arrange
+        var id = AssetIdGenerator.GetAssetId();
+        await dbFixture.DbContext.Images
+            .AddTestAsset(id, imageDeliveryChannels: imageDeliveryChannels)
+            .WithTestAdjunct("seeAlso1", type: "Dataset", mediaType: "text/xml", iiifLinkType: IIIFLinkType.SeeAlso,
+                profile: "http://www.loc.gov/standards/alto/v3/alto.xsd", label: new LanguageMap("en", "METS-ALTO XML"),
+                externalId: "https://mets.example/1", language: ["en-GB"])
+            .WithTestAdjunct("anno1", type: "Ignored", mediaType: "text/ignored",
+                iiifLinkType: IIIFLinkType.Annotations, label: new LanguageMap("en", "Line-level annos"),
+                externalId: "https://mets.example/w3c", language: ["ignored"])
+            .WithTestAdjunct("rendering1", type: "Text", mediaType: "application/pdf", iiifLinkType: IIIFLinkType.Rendering,
+                label: new LanguageMap("none", "PDF of image"), externalId: "https://pdf.example/1", language: ["fr"])
+            .WithTestAdjunct("seeAlso2", type: "Text", mediaType: "text/xml", iiifLinkType: IIIFLinkType.SeeAlso,
+                externalId: "https://other.example/2");
+        
+        await dbFixture.DbContext.SaveChangesAsync();
+
+        List<AnnotationPage> expectedAnnos =
+        [
+            new() { Id = "https://mets.example/w3c", Label = new LanguageMap("en", "Line-level annos") }
+        ];
+
+        List<ExternalResource> expectedSeeAlso =
+        [
+            new("Dataset")
+            {
+                Id = "https://mets.example/1", Label = new LanguageMap("en", "METS-ALTO XML"),
+                Profile = "http://www.loc.gov/standards/alto/v3/alto.xsd", Format = "text/xml",
+                Language = ["en-GB"]
+            },
+            new("Text")
+            {
+                Id = "https://other.example/2", Format = "text/xml"
+            },
+        ];
+
+        List<ExternalResource> expectedRendering =
+        [
+            new("Text")
+            {
+                Id = "https://pdf.example/1", Label = new LanguageMap("none", "PDF of image"),
+                Format = "application/pdf", Language = ["fr"]
+            },
+        ];
+
+        var path = $"iiif-manifest/v3/{id}";
+
+        // Act
+        var response = await httpClient.GetAsync(path);
+            
+        // Assert
+        var manifest = (await response.Content.ReadAsStreamAsync()).FromJsonStream<IIIF3.Manifest>();
+        var canvas = manifest.Items!.Single();
+        
+        canvas.SeeAlso.Should().BeEquivalentTo(expectedSeeAlso);
+        canvas.Rendering.Should().BeEquivalentTo(expectedRendering);
+        canvas.Annotations.Should().BeEquivalentTo(expectedAnnos);
+    }
 }
diff --git a/src/protagonist/Orchestrator.Tests/Integration/NamedQueryTests.cs b/src/protagonist/Orchestrator.Tests/Integration/NamedQueryTests.cs
@@ -57,7 +57,8 @@ public NamedQueryTests(ProtagonistAppFactory<Startup> factory, DlcsDatabaseFixtu
         dbFixture.DbContext.Images.AddTestAsset(AssetId.FromString("99/1/matching-nothumbs"), num1: 3, ref1: "my-ref",
             maxUnauthorised: 10, roles: "default")
             .WithTestThumbnailMetadata()
-            .WithTestDeliveryChannel(AssetDeliveryChannels.Image);
+            .WithTestDeliveryChannel(AssetDeliveryChannels.Image)
+            .WithTestAdjunct("test-adjunct", externalId: "https://example.com/see-also-1");
         dbFixture.DbContext.Images.AddTestAsset(AssetId.FromString("99/1/not-for-delivery"), num1: 4, ref1: "my-ref",
             notForDelivery: true)
             .WithTestThumbnailMetadata()
@@ -373,6 +374,41 @@ await dbFixture.DbContext.Images.AddTestAsset(AssetId.FromString("99/1/second"),
         }
     }
     
+    [Fact]
+    public async Task Get_ReturnsV3ManifestWithCorrectAdjuncts()
+    {
+        // Arrange
+        const string path = "iiif-resource/v3/99/test-named-query/my-ref/1";
+        const string iiif3 = "application/ld+json; profile=\"http://iiif.io/api/presentation/3/context.json\"";
+        
+        // Act
+        var response = await httpClient.GetAsync(path);
+        
+        // Assert
+        response.StatusCode.Should().Be(HttpStatusCode.OK);
+        response.Headers.Vary.Should().Contain("Accept");
+        response.Content.Headers.ContentType.ToString().Should().Be(iiif3);
+        
+        var manifest = (await response.Content.ReadAsStreamAsync()).FromJsonStream<IIIF3.Manifest>();
+        manifest.Items.Should().HaveCount(3);
+
+        bool checkedSeeAlso = false;
+        foreach (var canvas in manifest.Items!)
+        {
+            if (canvas.Id.Contains("matching-nothumbs"))
+            {
+                checkedSeeAlso = true;
+                canvas.SeeAlso.Should().ContainSingle(sa => sa.Id == "https://example.com/see-also-1");
+            }
+            else
+            {
+                canvas.SeeAlso.Should().BeNull();
+            }
+        }
+
+        checkedSeeAlso.Should().BeTrue("No seeAlso checked in test, verify test data");
+    }
+    
     [Fact]
     public async Task Get_AssetsRequireAuth_ReturnsV2ManifestWithoutAuthServices()
     {
diff --git a/src/protagonist/Orchestrator/Features/Manifests/IIIFNamedQueryProjector.cs b/src/protagonist/Orchestrator/Features/Manifests/IIIFNamedQueryProjector.cs
@@ -10,6 +10,7 @@
 using IIIF;
 using Microsoft.AspNetCore.Http;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Logging;
 using Orchestrator.Infrastructure;
 using Orchestrator.Infrastructure.IIIF;
 using Orchestrator.Infrastructure.IIIF.Manifests;
@@ -21,15 +22,8 @@ namespace Orchestrator.Features.Manifests;
 /// <summary>
 /// Methods for generating IIIF results from NamedQueries
 /// </summary>
-public class IIIFNamedQueryProjector
+public class IIIFNamedQueryProjector(IIIFManifestBuilder manifestBuilder, ILogger<IIIFNamedQueryProjector> logger)
 {
-    private readonly IIIFManifestBuilder manifestBuilder;
-
-    public IIIFNamedQueryProjector(IIIFManifestBuilder manifestBuilder) 
-    {
-        this.manifestBuilder = manifestBuilder;
-    }
-
     /// <summary>
     /// Project NamedQueryResult to IIIF presentation object
     /// </summary>
@@ -43,7 +37,11 @@ public IIIFNamedQueryProjector(IIIFManifestBuilder manifestBuilder)
             .IncludeRelationsForProjections()
             .AsSplitQuery()
             .ToListAsync(cancellationToken);
-        if (assets.Count == 0) return null;
+        if (assets.Count == 0)
+        {
+            logger.LogDebug("No assets found that match NQ parameters");
+            return null;
+        }
 
         var orderedImages = NamedQueryProjections.GetOrderedAssets(assets, parsedNamedQuery).ToList();
 
diff --git a/src/protagonist/Orchestrator/Infrastructure/IIIF/Manifests/ManifestV3Builder.cs b/src/protagonist/Orchestrator/Infrastructure/IIIF/Manifests/ManifestV3Builder.cs
@@ -209,6 +209,8 @@ private async Task<AssetCanvas> GetCanvasForAsset(Asset asset, CustomerPathEleme
         {
             canvas.Thumbnail = thumbnail.AsListOf<ExternalResource>();
         }
+
+        AddAdjunctsToCanvas(canvas, asset);
         
         return new AssetCanvas(canvas, additionalContexts);
     }
@@ -268,7 +270,7 @@ private async Task<AssetCanvas> GetCanvasForAsset(Asset asset, CustomerPathEleme
     {
         logger.LogTrace("{CanvasId} is timebased, processing", canvas.Id);
         var canvasId = canvas.Id;
-        var transcodes = asset.AssetApplicationMetadata.GetTranscodeMetadata(false);
+        var transcodes = asset.AssetApplicationMetadata.GetTranscodeMetadata();
         
         if (transcodes.IsNullOrEmpty())
         {
@@ -481,4 +483,46 @@ private static List<IService> GetDistinctAccessServices(Dictionary<AssetId, Auth
             .ToList();
         return accessServices;
     }
+    
+    private void AddAdjunctsToCanvas(Canvas canvas, Asset asset)
+    {
+        var adjuncts = asset.Adjuncts ?? Enumerable.Empty<Adjunct>();
+        
+        foreach (var adjunct in adjuncts)
+        {
+            logger.LogTrace("Adding adjunct {AdjunctId} to {CanvasId}", adjunct.Id, canvas.Id);
+            switch (adjunct.IIIFLink)
+            {
+                case IIIFLinkType.SeeAlso:
+                    canvas.SeeAlso ??= [];
+                    canvas.SeeAlso.Add(CreateExternalResource(adjunct));
+                    break;
+                case IIIFLinkType.Annotations:
+                    canvas.Annotations ??= [];
+                    canvas.Annotations.Add(new AnnotationPage
+                    {
+                        Id = adjunct.ExternalId.ToString(),
+                        Label = adjunct.Label,
+                    });
+                    break;
+                case IIIFLinkType.Rendering:
+                    canvas.Rendering ??= [];
+                    canvas.Rendering.Add(CreateExternalResource(adjunct));
+                    break;
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(adjunct.IIIFLink), adjunct.IIIFLink,
+                        "IIIFLink type not supported");
+            }
+        }
+
+        // "rendering" and "seeAlso" are ExternalResources
+        ExternalResource CreateExternalResource(Adjunct adjunct) => new(adjunct.Type)
+        {
+            Id = adjunct.ExternalId.ToString(),
+            Format = adjunct.MediaType,
+            Profile = adjunct.Profile,
+            Label = adjunct.Label,
+            Language = adjunct.Language?.ToList(),
+        };
+    }
 }
diff --git a/src/protagonist/Orchestrator/Infrastructure/MetadataWithFallbackThumbSizeCalculator.cs b/src/protagonist/Orchestrator/Infrastructure/MetadataWithFallbackThumbSizeCalculator.cs
@@ -52,7 +52,7 @@ public async Task<ThumbnailSizes> GetThumbSizesForImage(Asset asset, Cancellatio
         
         if (thumbnailSizes != null)
         {
-            logger.LogDebug("ThumbSizes metadata found for {AssetId}", asset.Id);
+            logger.LogTrace("ThumbSizes metadata found for {AssetId}", asset.Id);
             return thumbnailSizes;
         }
 
diff --git a/src/protagonist/Test.Helpers/Integration/DatabaseTestDataPopulation.cs b/src/protagonist/Test.Helpers/Integration/DatabaseTestDataPopulation.cs
@@ -66,7 +66,7 @@ public static ValueTask<EntityEntry<Asset>> AddTestAsset(this DbSet<Asset> asset
     
     public static ValueTask<EntityEntry<Asset>> WithTestAdjunct(
         this ValueTask<EntityEntry<Asset>> asset,
-        string id, string type = "Image", string mediaType = "image/jpg",
+        string id, string type = "Image", string mediaType = "image/jpeg",
         IIIFLinkType iiifLinkType = IIIFLinkType.SeeAlso,
         string profile = null, LanguageMap label = null,
         string[] language = null, string externalId = "https://someHost.com/someUri", DateTime? created = null,

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public async Task<ThumbnailSizes> GetThumbSizesForImage(Asset asset, Cancellatio`
`52`	`52`
`53`	`53`	`if (thumbnailSizes != null)`
`54`	`54`	`{`
`55`		`- logger.LogDebug("ThumbSizes metadata found for {AssetId}", asset.Id);`
	`55`	`+ logger.LogTrace("ThumbSizes metadata found for {AssetId}", asset.Id);`
`56`	`56`	`return thumbnailSizes;`
`57`	`57`	`}`
`58`	`58`