Merge pull request #1071 from dlcs/feature/thumbs_dimensions

Output dimension on v3 manifest thumbnails

Author: donaldgray

src/protagonist/Orchestrator.Tests/Infrastructure/IIIF/Manifests/ManifestV3BuilderTests.cs

@@ -139,23 +139,35 @@ public async Task BuildManifest_Thumb()
         var manifestId = $"https://dlcs.test/iiif-manifest/{asset}";
         A.CallTo(() => builderUtils.GetFullQualifiedImagePath(asset, pathElement, A<Size>._, true))
             .Returns("https://dlcs.test/thumbs-url/");
+        A.CallTo(() => builderUtils.GetFullQualifiedThumb(asset, pathElement, A<List<Size>>._))
+            .Returns(new ThumbnailPathAndSize("https://dlcs.test/thumbs-url/full/!100,200/0/default.jpg",
+                new Size(100, 200)));
         A.CallTo(() => builderUtils.ShouldAddThumbs(asset, A<ImageSizeDetails>._)).Returns(true);
 
         var manifest = await sut.BuildManifest(manifestId, "testLabel", asset.AsList(), pathElement,
             ManifestType.NamedQuery, CancellationToken.None);
-
+    
         manifest.Id.Should().Be(manifestId);
-        manifest.Thumbnail.Should().NotBeNull("Has thumbnail delivery channel");
-        
+        ValidateThumbnail(manifest.Thumbnail);
+
         var canvas = manifest.Items!.Single();
-        canvas.Thumbnail.Should().NotBeNull("Has thumbnail delivery channel");
+        ValidateThumbnail(canvas.Thumbnail);
         canvas.Rendering.Should().BeNull("No file delivery channel");
 
         var image = canvas.GetCanvasPaintingBody<Image>();
         image.Width.Should().Be(300, "Width of largest derivative");
         image.Height.Should().Be(200, "Height of largest derivative");
         image.Id.Should().Be("https://dlcs.test/thumbs-url/");
         image.Service.Should().BeNull("No image delivery channel");
+
+        void ValidateThumbnail(List<ExternalResource> thumbnails)
+        {
+            thumbnails.Should().NotBeNull("Has thumbnail delivery channel");
+            var manifestThumbnail = thumbnails.Cast<Image>().Single();
+            manifestThumbnail.Id.Should().Be("https://dlcs.test/thumbs-url/full/!100,200/0/default.jpg");
+            manifestThumbnail.Width.Should().Be(100);
+            manifestThumbnail.Height.Should().Be(200);
+        }
     }
 
     [Fact]
@@ -512,3 +524,4 @@ private static Asset GetImageAsset(string deliveryChannels) =>
             ImageDeliveryChannels = deliveryChannels.GenerateDeliveryChannels()
         };
 }
+

src/protagonist/Orchestrator/Infrastructure/IIIF/Manifests/ManifestBuilderUtils.cs

@@ -36,7 +36,7 @@ public interface IManifestBuilderUtils
     List<IService> GetImageServiceForThumbnail(Asset asset, CustomerPathElement customerPathElement,
         List<Size> thumbnailSizes);
 
-    string GetFullQualifiedThumbPath(Asset asset, CustomerPathElement customerPathElement,
+    ThumbnailPathAndSize GetFullQualifiedThumb(Asset asset, CustomerPathElement customerPathElement,
         List<Size> availableThumbs);
 
     string GetFullQualifiedImagePath(Asset asset, CustomerPathElement customerPathElement, Size size,
@@ -87,15 +87,16 @@ public List<IService> GetImageServiceForThumbnail(Asset asset, CustomerPathEleme
             image2 => image2.Sizes = thumbnailSizes,
             image3 => image3.Sizes = thumbnailSizes);
 
-    public string GetFullQualifiedThumbPath(Asset asset, CustomerPathElement customerPathElement,
+    public ThumbnailPathAndSize GetFullQualifiedThumb(Asset asset, CustomerPathElement customerPathElement,
         List<Size> availableThumbs)
     {
         var targetThumb = orchestratorSettings.TargetThumbnailSize;
 
         // Get the thumbnail size that is closest to the system-wide TargetThumbnailSize
         var closestSize = availableThumbs.SizeClosestTo(targetThumb);
 
-        return GetFullQualifiedImagePath(asset, customerPathElement, closestSize, true);
+        return new ThumbnailPathAndSize(GetFullQualifiedImagePath(asset, customerPathElement, closestSize, true),
+            closestSize);
     }
 
     public string GetFullQualifiedImagePath(Asset asset, CustomerPathElement customerPathElement, Size size,
@@ -267,3 +268,8 @@ public class ImageSizeDetails(List<Size> openThumbnails, Size maxDerivativeSize)
     /// </summary>
     public Size MaxDerivativeSize { get; } = maxDerivativeSize;
 }
+
+/// <summary>
+/// Path to a thumbnail and the size of that thumbnail
+/// </summary>
+public record ThumbnailPathAndSize(string Path, Size Size);

src/protagonist/Orchestrator/Infrastructure/IIIF/Manifests/ManifestV2Builder.cs

@@ -104,9 +104,11 @@ private async Task<List<Canvas>> CreateCanvases(List<Asset> results, CustomerPat
 
             if (BuilderUtils.ShouldAddThumbs(asset, thumbnailSizes))
             {
+                var targetThumbnail =
+                    BuilderUtils.GetFullQualifiedThumb(asset, customerPathElement, thumbnailSizes.OpenThumbnails);
                 canvas.Thumbnail = new Thumbnail
                 {
-                    Id = BuilderUtils.GetFullQualifiedThumbPath(asset, customerPathElement, thumbnailSizes.OpenThumbnails),
+                    Id = targetThumbnail.Path,
                     Service = BuilderUtils.GetImageServiceForThumbnail(asset, customerPathElement,
                         thumbnailSizes.OpenThumbnails)
                 }.AsList();

src/protagonist/Orchestrator/Infrastructure/IIIF/Manifests/ManifestV3Builder.cs

@@ -250,11 +250,15 @@ private async Task<AssetCanvas> GetCanvasForAsset(Asset asset, CustomerPathEleme
 
         if (!BuilderUtils.ShouldAddThumbs(asset, thumbnailSizes)) return (annotationPage, null);
 
+        var targetThumbnail = BuilderUtils.GetFullQualifiedThumb(asset, customerPathElement, thumbnailSizes.OpenThumbnails);
         var thumbnail = new Image
         {
-            Id = BuilderUtils.GetFullQualifiedThumbPath(asset, customerPathElement, thumbnailSizes.OpenThumbnails),
+            Id = targetThumbnail.Path,
+            Width = targetThumbnail.Size.Width,
+            Height = targetThumbnail.Size.Height,
             Format = "image/jpeg",
-            Service = BuilderUtils.GetImageServiceForThumbnail(asset, customerPathElement, thumbnailSizes.OpenThumbnails)
+            Service = BuilderUtils.GetImageServiceForThumbnail(asset, customerPathElement,
+                thumbnailSizes.OpenThumbnails)
         };
         return (annotationPage, thumbnail);
     }