Merge pull request #871 from dlcs/feature/empty_members

Allow batch with empty 'members' in legacy mode
dlcs · Jun 26, 2024 · 5aa8eeb · 5aa8eeb
2 parents 7856018 + ee3f39d
commit 5aa8eeb
Show file tree

Hide file tree

Showing 6 changed files with 133 additions and 3 deletions.
diff --git a/src/protagonist/API.Tests/Integration/CustomerQueueTests.cs b/src/protagonist/API.Tests/Integration/CustomerQueueTests.cs
@@ -558,6 +558,30 @@ public async Task Post_CreateBatch_201_IfLegacyModeEnabled()
         response.StatusCode.Should().Be(HttpStatusCode.Created);
     }
 
+    [Fact]
+    public async Task Post_CreateBatch_201_IfLegacyModeEnabled_MembersEmpty()
+    {
+        // Arrange
+        var hydraImageBody = @"{
+    ""@context"": ""http://www.w3.org/ns/hydra/context.jsonld"",
+    ""@type"": ""Collection"",
+    ""member"": []
+}";
+
+        var content = new StringContent(hydraImageBody, Encoding.UTF8, "application/json");
+        var path = $"/customers/{LegacyModeHelpers.LegacyCustomer}/queue";
+
+        // Act
+        var response = await httpClient.AsCustomer(LegacyModeHelpers.LegacyCustomer).PostAsync(path, content);
+
+        // Assert
+        response.StatusCode.Should().Be(HttpStatusCode.Created);
+
+        var model = await response.ReadAsHydraResponseAsync<DLCS.HydraModel.CustomerQueue>();
+        var dbBatch = dbContext.Batches.Single(a => a.Id == model.Id.GetLastPathElementAsInt());
+        dbBatch.Count.Should().Be(0);
+    }
+
     [Fact]
     public async Task Post_CreateBatch_201_IfLegacyModeEnabledWithAtIdFieldSet()
     {
@@ -698,6 +722,26 @@ public async Task Post_CreateBatch_400_WithInvalidIdsSet()
         response.StatusCode.Should().Be(HttpStatusCode.BadRequest);
     }
 
+    [Fact]
+    public async Task Post_CreateBatch_400_MembersEmpty()
+    {
+        // Arrange
+        var hydraImageBody = @"{
+    ""@context"": ""http://www.w3.org/ns/hydra/context.jsonld"",
+    ""@type"": ""Collection"",
+    ""member"": []
+}";
+
+        var content = new StringContent(hydraImageBody, Encoding.UTF8, "application/json");
+        const string path = "/customers/99/queue";
+
+        // Act
+        var response = await httpClient.AsCustomer(99).PostAsync(path, content);
+
+        // Assert
+        response.StatusCode.Should().Be(HttpStatusCode.BadRequest);
+    }
+
     [Fact]
     public async Task Post_CreateBatch_400_IfSpaceNotFound()
     {

diff --git a/src/protagonist/API/Converters/LegacyModeConverter.cs b/src/protagonist/API/Converters/LegacyModeConverter.cs
@@ -4,6 +4,7 @@
 using DLCS.HydraModel;
 using DLCS.Model.Assets;
 using Hydra;
+using Microsoft.Extensions.Logging;
 using AssetFamily = DLCS.HydraModel.AssetFamily;
 
 namespace API.Converters;
@@ -14,13 +15,16 @@ namespace API.Converters;
 public static class LegacyModeConverter
 {
     private const string DefaultMediaType = "image/unknown";
+
+    internal static void LogLegacyUsage(this ILogger logger, string message, params object?[] args)
+        => logger.LogWarning("LEGACY USE:" + message, args);
 
     /// <summary>
     /// Converts from legacy format to new format
     /// </summary>
     /// <param name="image">The image to convert should be emulated and translated into delivery channels</param>
     /// <returns>A converted image</returns>
-    public static T VerifyAndConvertToModernFormat<T>(T image)
+    public static T VerifyAndConvertToModernFormat<T>(T image, ILogger? logger = null)
         where T : Image
     {
         if (image.Origin.IsNullOrEmpty())
@@ -30,6 +34,7 @@ public static T VerifyAndConvertToModernFormat<T>(T image)
 
         if (image.MediaType.IsNullOrEmpty())
         {
+            logger?.LogLegacyUsage("Null or empty media type");
             var contentType = image.Origin?.Split('.').Last() ?? string.Empty;
 
             image.MediaType = MIMEHelper.GetContentTypeForExtension(contentType) ?? DefaultMediaType;
@@ -43,6 +48,7 @@ public static T VerifyAndConvertToModernFormat<T>(T image)
 
         if (image.MaxUnauthorised is null or 0 && image.Roles.IsNullOrEmpty())
         {
+            logger?.LogLegacyUsage("MaxUnauthorised");
             image.MaxUnauthorised = -1;
         }
 

diff --git a/src/protagonist/API/Features/Queues/CustomerQueueController.cs b/src/protagonist/API/Features/Queues/CustomerQueueController.cs
@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using System.Net;
 using API.Converters;
 using API.Exceptions;
 using API.Features.Image;
@@ -8,6 +7,7 @@
 using API.Features.Queues.Validation;
 using API.Infrastructure;
 using API.Settings;
+using DLCS.Core.Collections;
 using DLCS.Core.Strings;
 using DLCS.HydraModel;
 using DLCS.Model.Assets;
@@ -16,6 +16,7 @@
 using MediatR;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Batch = DLCS.HydraModel.Batch;
 
@@ -28,8 +29,12 @@ namespace API.Features.Queues;
 [ApiController]
 public class CustomerQueueController : HydraController
 {
-    public CustomerQueueController(IOptions<ApiSettings> settings, IMediator mediator) : base(settings.Value, mediator)
+    private readonly ILogger<CustomerQueueController> logger;
+
+    public CustomerQueueController(IOptions<ApiSettings> settings, IMediator mediator,
+        ILogger<CustomerQueueController> logger) : base(settings.Value, mediator)
     {
+        this.logger = logger;
     }
 
     /// <summary>
@@ -331,6 +336,15 @@ private async Task<IActionResult> CreateBatchInternal(int customerId, HydraColle
         try
         {
             UpdateMembers(customerId, images.Members);
+
+            if (images.Members.IsEmpty() && Settings.LegacyModeEnabledForCustomer(customerId))
+            {
+                logger.LogLegacyUsage("Empty batch received for customer {CustomerId}", customerId);
+                return await HandleUpsert(new CreateEmptyBatch(customerId),
+                    batch => batch.ToHydra(GetUrlRoots().BaseUrl),
+                    errorTitle: "Create batch failed",
+                    cancellationToken: cancellationToken);
+            }
         }
         catch (APIException apiEx)
         {

diff --git a/src/protagonist/API/Features/Queues/Requests/CreateEmptyBatch.cs b/src/protagonist/API/Features/Queues/Requests/CreateEmptyBatch.cs
@@ -0,0 +1,35 @@
+using API.Infrastructure.Requests;
+using DLCS.Core;
+using DLCS.Model.Assets;
+using MediatR;
+
+namespace API.Features.Queues.Requests;
+
+/// <summary>
+/// Handler that creates an empty batch of 0 images
+/// </summary>
+public class CreateEmptyBatch : IRequest<ModifyEntityResult<Batch>>
+{
+    public int CustomerId { get; }
+
+    public CreateEmptyBatch(int customerId)
+    {
+        CustomerId = customerId;
+    }
+}
+
+public class CreateEmptyBatchHandler : IRequestHandler<CreateEmptyBatch, ModifyEntityResult<Batch>>
+{
+    private readonly IBatchRepository batchRepository;
+
+    public CreateEmptyBatchHandler(IBatchRepository batchRepository)
+    {
+        this.batchRepository = batchRepository;
+    }
+
+    public async Task<ModifyEntityResult<Batch>> Handle(CreateEmptyBatch request, CancellationToken cancellationToken)
+    {
+        var batch = await batchRepository.CreateBatch(request.CustomerId, Array.Empty<Asset>(), cancellationToken);
+        return ModifyEntityResult<Batch>.Success(batch, WriteResult.Created);
+    }
+}
diff --git a/src/protagonist/DLCS.Core.Tests/Collections/CollectionXTests.cs b/src/protagonist/DLCS.Core.Tests/Collections/CollectionXTests.cs
@@ -54,6 +54,30 @@ public void IsNullOrEmpty_List_False_IfHasValues()
 
         coll.IsNullOrEmpty().Should().BeFalse();
     }
+
+    [Fact]
+    public void IsEmpty_List_False_IfNull()
+    {
+        List<int> coll = null;
+
+        coll.IsEmpty().Should().BeFalse();
+    }
+
+    [Fact]
+    public void IsEmpty_List_True_IfEmpty()
+    {
+        var coll = new List<int>();
+
+        coll.IsEmpty().Should().BeTrue();
+    }
+
+    [Fact]
+    public void IsEmpty_List_False_IfHasValues()
+    {
+        var coll = new List<int> {2};
+
+        coll.IsEmpty().Should().BeFalse();
+    }
 
     [Fact]
     public void AsList_ReturnsExpected()

diff --git a/src/protagonist/DLCS.Core/Collections/CollectionX.cs b/src/protagonist/DLCS.Core/Collections/CollectionX.cs
@@ -20,6 +20,13 @@ public static bool IsNullOrEmpty<T>([NotNullWhen(false)] this IEnumerable<T>? co
     /// <returns>true if null or empty, else false</returns>
     public static bool IsNullOrEmpty<T>([NotNullWhen(false)] this IList<T>? collection)
         => collection == null || collection.Count == 0;
+
+    /// <summary>
+    /// Check if IList is empty - this explicitly checks for Empty only, list could still be null
+    /// </summary>
+    /// <returns>true if empty, else false</returns>
+    public static bool IsEmpty<T>(this IList<T>? collection)
+        => collection?.Count == 0;
 
     /// <summary>
     /// Check if list contains single specified item