Merge pull request #214 from dlcs/feature/jobRunnerBatchCompletion

Adding ability to update a manifest with details from the DLCS

src/IIIFPresentation/API.Tests/Converters/ManifestConverterTests.cs

@@ -3,6 +3,7 @@
 using API.Tests.Helpers;
 using Models.API.Manifest;
 using Models.Database.General;
+using Models.DLCS;
 using CanvasPainting = Models.Database.CanvasPainting;
 using DBManifest = Models.Database.Collections.Manifest;
 
@@ -168,7 +169,7 @@ public void SetGeneratedFields_SetsCanvasPainting_IfPresent()
                     Id = "the-canvas",
                     ChoiceOrder = 10,
                     CanvasOrder = 100,
-                    AssetId = "1/2/assetId"
+                    AssetId = new AssetId(1, 2, "assetId")
                 }
             ]
         };
@@ -177,12 +178,52 @@ public void SetGeneratedFields_SetsCanvasPainting_IfPresent()
         var result = iiifManifest.SetGeneratedFields(dbManifest, pathGenerator);
 
         // Assert
-        var cp = result.PaintedResources.Single().CanvasPainting;
-        cp.CanvasId.Should().Be("http://base/123/canvases/the-canvas");
-        cp.ChoiceOrder.Should().Be(10);
-        cp.CanvasOrder.Should().Be(100);
-        cp.CanvasOriginalId.Should().Be("http://example.test/canvas1");
-        cp.AssetId.Should().Be("https://dlcs.test/customers/1/spaces/2/images/assetId");
+        var paintedResource = result.PaintedResources.Single();
+        paintedResource.CanvasPainting.CanvasId.Should().Be("http://base/123/canvases/the-canvas");
+        paintedResource.CanvasPainting.ChoiceOrder.Should().Be(10);
+        paintedResource.CanvasPainting.CanvasOrder.Should().Be(100);
+        paintedResource.CanvasPainting.CanvasOriginalId.Should().Be("http://example.test/canvas1");
+
+        paintedResource.Asset.GetValue("@id").ToString().Should().Be("https://dlcs.test/customers/1/spaces/2/images/assetId");
+    }
+
+    [Fact]
+    public void SetGeneratedFields_SetsCanvasPainting_WithoutAssetId()
+    {
+        // Arrange
+        var iiifManifest = new PresentationManifest();
+        var dbManifest = new DBManifest
+        {
+            CustomerId = 123,
+            Created = DateTime.UtcNow,
+            Modified = DateTime.UtcNow.AddDays(1),
+            CreatedBy = "creator",
+            ModifiedBy = "modifier",
+            Id = "id",
+            Hierarchy = [new Hierarchy { Slug = "slug" }],
+            CanvasPaintings =
+            [
+                new CanvasPainting
+                {
+                    CanvasOriginalId = new Uri("http://example.test/canvas1"),
+                    CustomerId = 123,
+                    Id = "the-canvas",
+                    ChoiceOrder = 10,
+                    CanvasOrder = 100
+                }
+            ]
+        };
+
+        // Act
+        var result = iiifManifest.SetGeneratedFields(dbManifest, pathGenerator);
+
+        // Assert
+        var paintedResource = result.PaintedResources.Single();
+        paintedResource.CanvasPainting.CanvasId.Should().Be("http://base/123/canvases/the-canvas");
+        paintedResource.CanvasPainting.ChoiceOrder.Should().Be(10);
+        paintedResource.CanvasPainting.CanvasOrder.Should().Be(100);
+        paintedResource.CanvasPainting.CanvasOriginalId.Should().Be("http://example.test/canvas1");
+        paintedResource.Asset.Should().BeNull();
     }
 
     [Fact]

src/IIIFPresentation/API.Tests/Helpers/PathGeneratorTests.cs

@@ -1,7 +1,9 @@
 using API.Helpers;
+using AWS.Helpers;
 using Models.Database;
 using Models.Database.Collections;
 using Models.Database.General;
+using Models.DLCS;
 
 namespace API.Tests.Helpers;
 
@@ -384,31 +386,18 @@ public void GenerateAssetUri_Correct_IfCanvasPaintingHasAssetWithThreeSlashes()
         {
             Id = "hello",
             CustomerId = 123,
-            AssetId = "5/4/12"
+            AssetId = new AssetId(5, 4, "12")
         };
 
         var expected = "https://dlcs.test/customers/5/spaces/4/images/12";
 
         pathGenerator.GenerateAssetUri(manifest).Should().Be(expected);
     }
 
-    [Fact]
-    public void GenerateAssetUri_Null_IfCanvasPaintingHasAssetWithNotThreeSlashes()
-    {
-        var manifest = new CanvasPainting()
-        {
-            Id = "hello",
-            CustomerId = 123,
-            AssetId = "5/4"
-        };
-
-        pathGenerator.GenerateAssetUri(manifest).Should().BeNull();
-    }
-
     [Fact]
     public void GenerateAssetUri_Null_IfCanvasPaintingDoesNotHaveAsset()
     {
-        var manifest = new CanvasPainting()
+        var manifest = new CanvasPainting
         {
             Id = "hello",
             CustomerId = 123,

src/IIIFPresentation/API.Tests/Helpers/TestPathGenerator.cs

@@ -7,16 +7,18 @@ namespace API.Tests.Helpers;
 
 public static class TestPathGenerator
 {
-    public static PathGenerator CreatePathGenerator(string baseUrl, string scheme) 
+    public static PathGenerator CreatePathGenerator(string baseUrl, string scheme)
         => new(new HttpContextAccessor
-        {
-            HttpContext = new DefaultHttpContext
             {
-                Request =
+                HttpContext = new DefaultHttpContext
                 {
-                    Scheme = scheme,
-                    Host = new HostString(baseUrl)
+                    Request =
+                    {
+                        Scheme = scheme,
+                        Host = new HostString(baseUrl)
+                    }
                 }
-            }
-        }, Options.Create(new DlcsSettings { ApiUri = new Uri("https://dlcs.test") }));
-}
+            },
+            Options.Create(new DlcsSettings
+                { ApiUri = new Uri("https://dlcs.test") }));
+}

src/IIIFPresentation/API.Tests/Integration/ModifyManifestAssetCreationTests.cs

@@ -187,7 +187,7 @@ public async Task CreateManifest_CorrectlyCreatesAssetRequests_WithSpace()
         dbManifest.CanvasPaintings.Should().HaveCount(1);
         dbManifest.CanvasPaintings!.First().Label!.First().Value[0].Should().Be("canvas testing");
         // space comes from the asset
-        dbManifest.CanvasPaintings!.First().AssetId.Should().Be($"{Customer}/{space}/{assetId}");
+        dbManifest.CanvasPaintings!.First().AssetId.ToString().Should().Be($"{Customer}/{space}/{assetId}");
         dbManifest.Batches.Should().HaveCount(1);
         dbManifest.Batches!.First().Status.Should().Be(BatchStatus.Ingesting);
         dbManifest.Batches!.First().Id.Should().Be(batchId);
@@ -288,7 +288,7 @@ public async Task CreateManifest_CorrectlyCreatesAssetRequests_WithoutSpace()
         dbManifest.CanvasPaintings.Should().HaveCount(1);
         dbManifest.CanvasPaintings!.First().Label!.First().Value[0].Should().Be("canvas testing");
         // space added using the manifest space
-        dbManifest.CanvasPaintings!.First().AssetId.Should()
+        dbManifest.CanvasPaintings!.First().AssetId.ToString().Should()
             .Be($"{Customer}/{NewlyCreatedSpace}/{assetId}");
         dbManifest.Batches.Should().HaveCount(1);
         dbManifest.Batches!.First().Status.Should().Be(BatchStatus.Ingesting);
@@ -383,7 +383,7 @@ await amazonS3.GetObjectAsync(LocalStackFixture.StorageBucketName,
         dbManifest.CanvasPaintings.Should().HaveCount(1);
         dbManifest.CanvasPaintings!.First().Label?.First().Should().BeNull();
         // space added using the manifest space
-        dbManifest.CanvasPaintings!.First().AssetId.Should()
+        dbManifest.CanvasPaintings!.First().AssetId.ToString().Should()
             .Be($"{Customer}/{NewlyCreatedSpace}/{assetId}");
         dbManifest.Batches.Should().HaveCount(1);
         dbManifest.Batches!.First().Status.Should().Be(BatchStatus.Ingesting);
@@ -595,7 +595,7 @@ public async Task CreateManifest_CorrectlyCreatesAssetRequests_WhenMultipleAsset
          foreach (var canvasPainting in dbManifest.CanvasPaintings!)
          {
              canvasPainting.CanvasOrder.Should().Be(currentCanvasOrder);
-             canvasPainting.AssetId.Should()
+             canvasPainting.AssetId.ToString().Should()
                  .Be($"{Customer}/{NewlyCreatedSpace}/testAssetByPresentation-multipleAssets-{currentCanvasOrder}");
              currentCanvasOrder++;
          }

src/IIIFPresentation/API/Converters/ManifestConverter.cs

@@ -1,11 +1,13 @@
 using API.Helpers;
 using Core.Helpers;
 using Core.IIIF;
+using DLCS.Models;
 using IIIF;
 using IIIF.Presentation;
 using Models.API.Manifest;
 using Models.Database.Collections;
 using Models.Database.General;
+using Newtonsoft.Json.Linq;
 
 namespace API.Converters;
 
@@ -62,7 +64,10 @@ public static PresentationManifest SetGeneratedFields(this PresentationManifest
                 Label = cp.Label,
                 CanvasOriginalId = cp.CanvasOriginalId?.ToString(),
                 CanvasLabel = cp.CanvasLabel,
-                AssetId = pathGenerator.GenerateAssetUri(cp)?.ToString()
+            },
+            Asset = cp.AssetId == null ? null : new JObject
+            {
+                ["@id"] = pathGenerator.GenerateAssetUri(cp)?.ToString()
             }
         }).ToList();
     }

src/IIIFPresentation/API/Features/Manifest/CanvasPaintingResolver.cs

@@ -10,6 +10,7 @@
 using Models.API.General;
 using Models.API.Manifest;
 using Models.Database;
+using Models.DLCS;
 using Newtonsoft.Json.Linq;
 using Repository.Manifests;
 using CanvasPainting = Models.Database.CanvasPainting;
@@ -217,8 +218,9 @@ public class CanvasPaintingResolver(
                 Created = DateTime.UtcNow,
                 CustomerId = customerId,
                 CanvasOrder = count,
-                AssetId = $"{customerId}/{space}/{id}",
-                ChoiceOrder = -1
+                AssetId = AssetId.FromString($"{customerId}/{space}/{id}"),
+                ChoiceOrder = -1,
+                Ingesting = true
             };
 
             count++;

src/IIIFPresentation/API/Features/Manifest/ManifestService.cs

@@ -3,11 +3,11 @@
 using API.Features.Manifest.Helpers;
 using API.Features.Storage.Helpers;
 using API.Helpers;
-using API.Infrastructure.AWS;
 using API.Infrastructure.Helpers;
 using API.Infrastructure.IdGenerator;
 using API.Infrastructure.Validation;
 using API.Settings;
+using AWS.Helpers;
 using Core;
 using Core.Auth;
 using Core.Helpers;
@@ -19,6 +19,7 @@
 using Models.API.Manifest;
 using Models.Database.Collections;
 using Models.Database.General;
+using Newtonsoft.Json.Linq;
 using Repository;
 using Repository.Helpers;
 using Collection = Models.Database.Collections.Collection;
@@ -254,7 +255,7 @@ await canvasPaintingResolver.GenerateCanvasPaintings(request.CustomerId, request
         var saveErrors = await SaveAndPopulateEntity(request, dbManifest, cancellationToken);
         return (saveErrors, dbManifest);
     }
-    
+
     private async Task<int?> CreateSpaceIfRequired(int customerId, string manifestId, bool createSpace,
         CancellationToken cancellationToken)
     {

src/IIIFPresentation/API/Features/Manifest/Requests/DeleteManifest.cs

@@ -1,5 +1,5 @@
 using API.Features.Storage.Helpers;
-using API.Infrastructure.AWS;
+using AWS.Helpers;
 using Core;
 using MediatR;
 using Microsoft.EntityFrameworkCore;

src/IIIFPresentation/API/Features/Manifest/Requests/GetManifest.cs

@@ -1,8 +1,8 @@
 using API.Converters;
 using API.Features.Storage.Helpers;
 using API.Helpers;
-using API.Infrastructure.AWS;
 using API.Infrastructure.Requests;
+using AWS.Helpers;
 using MediatR;
 using Models.API.Manifest;
 using Repository;

src/IIIFPresentation/API/Features/Manifest/Requests/GetManifestHierarchical.cs

@@ -1,6 +1,6 @@
-using API.Converters;
-using API.Converters.Streaming;
+using API.Converters.Streaming;
 using API.Helpers;
+using AWS.Helpers;
 using AWS.S3;
 using AWS.Settings;
 using Core.Streams;
@@ -56,4 +56,4 @@ public class GetManifestHierarchicalHandler(
         memoryStream.Seek(0, SeekOrigin.Begin);
         return await reader.ReadToEndAsync(cancellationToken);
     }
-}
+}

src/IIIFPresentation/API/Features/Storage/Requests/CreateCollection.cs

@@ -2,11 +2,11 @@
 using API.Features.Storage.Helpers;
 using API.Features.Storage.Models;
 using API.Helpers;
-using API.Infrastructure.AWS;
 using API.Infrastructure.IdGenerator;
 using API.Infrastructure.Requests;
 using API.Infrastructure.Validation;
 using API.Settings;
+using AWS.Helpers;
 using Core;
 using Core.Auth;
 using Core.Helpers;

src/IIIFPresentation/API/Features/Storage/Requests/DeleteCollection.cs

@@ -1,5 +1,5 @@
 using API.Features.Storage.Helpers;
-using API.Infrastructure.AWS;
+using AWS.Helpers;
 using Core;
 using MediatR;
 using Microsoft.EntityFrameworkCore;

src/IIIFPresentation/API/Features/Storage/Requests/GetHierarchicalCollection.cs

@@ -2,6 +2,7 @@
 using API.Features.Storage.Helpers;
 using API.Features.Storage.Models;
 using API.Helpers;
+using AWS.Helpers;
 using AWS.S3;
 using AWS.S3.Models;
 using AWS.Settings;

src/IIIFPresentation/API/Features/Storage/Requests/PostHierarchicalCollection.cs

@@ -1,9 +1,9 @@
 using System.Data;
 using API.Features.Storage.Helpers;
 using API.Helpers;
-using API.Infrastructure.AWS;
 using API.Infrastructure.IdGenerator;
 using API.Infrastructure.Requests;
+using AWS.Helpers;
 using Core;
 using Core.Auth;
 using Core.IIIF;

src/IIIFPresentation/API/Features/Storage/Requests/UpsertCollection.cs

@@ -1,11 +1,11 @@
 using API.Features.Storage.Helpers;
 using API.Features.Storage.Models;
 using API.Helpers;
-using API.Infrastructure.AWS;
 using API.Infrastructure.Helpers;
 using API.Infrastructure.Requests;
 using API.Infrastructure.Validation;
 using API.Settings;
+using AWS.Helpers;
 using Core;
 using Core.Auth;
 using Core.Exceptions;

src/IIIFPresentation/API/Helpers/PathGenerator.cs

@@ -1,8 +1,10 @@
 using API.Infrastructure.Requests;
 using DLCS;
+using DLCS.Models;
 using Microsoft.Extensions.Options;
 using Models.Database.Collections;
 using Models.Database.General;
+using Models.DLCS;
 using CanvasPainting = Models.Database.CanvasPainting;
 
 namespace API.Helpers;
@@ -94,13 +96,11 @@ public string GenerateCanvasId(CanvasPainting canvasPainting)
 
     public Uri? GenerateAssetUri(CanvasPainting canvasPainting)
     {
-        if (string.IsNullOrEmpty(canvasPainting.AssetId)) return null;
-        var assetId = canvasPainting.AssetId.Split('/');
-        if (assetId.Length != 3) return null;
-
+        if (canvasPainting.AssetId == null) return null;
+
         var uriBuilder = new UriBuilder(dlcsSettings.ApiUri)
         {
-            Path = $"/customers/{assetId[0]}/spaces/{assetId[1]}/images/{assetId[2]}",
+            Path = $"/customers/{canvasPainting.AssetId.Customer}/spaces/{canvasPainting.AssetId.Space}/images/{canvasPainting.AssetId.Asset}",
         };
         return uriBuilder.Uri;
     }

src/IIIFPresentation/API/Infrastructure/PresentationController.cs

@@ -1,5 +1,4 @@
 using System.Net;
-using API.Converters;
 using API.Exceptions;
 using API.Infrastructure.Requests;
 using API.Settings;
@@ -180,4 +179,4 @@ protected async Task<IActionResult> HandleRequest(Func<Task<IActionResult>> hand
             return Problem(ex.Message, null, 500, errorTitle);
         }
     }
-}
+}