Fixing serialization error to provide a nicer error

dlcs · Jan 14, 2025 · 485c303 · 485c303
1 parent 85a4153
commit 485c303
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 13 deletions.
diff --git a/src/IIIFPresentation/API/Features/Manifest/ManifestController.cs b/src/IIIFPresentation/API/Features/Manifest/ManifestController.cs
@@ -3,6 +3,7 @@
 using API.Auth;
 using API.Features.Manifest.Requests;
 using API.Features.Manifest.Validators;
+using API.Features.Storage.Helpers;
 using API.Infrastructure;
 using API.Infrastructure.Helpers;
 using API.Infrastructure.Requests;
@@ -12,6 +13,7 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
+using Models.API.Collection;
 using Models.API.Manifest;
 
 namespace API.Features.Manifest;
@@ -100,21 +102,21 @@ private async Task<IActionResult> ManifestUpsert<T, TEnum>(
         if (!Request.HasShowExtraHeader()) return this.Forbidden();
 
         var rawRequestBody = await Request.GetRawRequestBodyAsync(cancellationToken);
-        var presentationManifest = await rawRequestBody.ToPresentation<PresentationManifest>();
-
-        if (presentationManifest == null)
+        var presentationManifest = await rawRequestBody.TryDeserializePresentation<PresentationManifest>();
+        
+        if (presentationManifest.Error)
         {
             return this.PresentationProblem("Could not deserialize manifest", null, (int) HttpStatusCode.BadRequest,
                 "Deserialization Error");
         }
 
-        var validation = await validator.ValidateAsync(presentationManifest, cancellationToken);
+        var validation = await validator.ValidateAsync(presentationManifest.ConvertedIIIF!, cancellationToken);
         if (!validation.IsValid)
         {
             return this.ValidationFailed(validation);
         }
 
-        return await HandleUpsert(requestFactory(presentationManifest, rawRequestBody), instance, errorTitle,
+        return await HandleUpsert(requestFactory(presentationManifest.ConvertedIIIF!, rawRequestBody), instance, errorTitle,
             cancellationToken);
     }
-}
+}
diff --git a/src/IIIFPresentation/API/Features/Storage/CollectionController.cs b/src/IIIFPresentation/API/Features/Storage/CollectionController.cs
@@ -97,7 +97,8 @@ private async Task<DeserializeValidationResult<PresentationCollection>> Deserial
 
         var rawRequestBody = await Request.GetRawRequestBodyAsync();
 
-        var deserializedCollection = await rawRequestBody.TryDeserializePresentationCollection();
+        var deserializedCollection =
+            await rawRequestBody.TryDeserializePresentation<PresentationCollection>();
         if (deserializedCollection.Error)
         {
             return DeserializeValidationResult<PresentationCollection>.Failure(PresentationUnableToSerialize());

diff --git a/src/IIIFPresentation/API/Features/Storage/Helpers/RequestBodyX.cs b/src/IIIFPresentation/API/Features/Storage/Helpers/RequestBodyX.cs
@@ -2,6 +2,7 @@
 using Core.IIIF;
 using IIIF;
 using IIIF.Serialisation;
+using Models.API;
 using Models.API.Collection;
 
 namespace API.Features.Storage.Helpers;
@@ -35,19 +36,20 @@ public static TryConvertIIIFResult<T> ConvertCollectionToIIIF<T>(this string req
     /// </summary>
     /// <param name="requestBody">The raw request body to convert</param>
     /// <returns>A result containing the deserialized collection, or a failure</returns>
-    public static async Task<TryConvertIIIFResult<PresentationCollection>> TryDeserializePresentationCollection(this string requestBody) 
+    public static async Task<TryConvertIIIFResult<T>> TryDeserializePresentation<T>(this string requestBody) 
+        where T : JsonLdBase, new()
     {
         try
         {
-            var collection = await requestBody.ToPresentation<PresentationCollection>();
+            var collection = await requestBody.ToPresentation<T>();
 
             return collection == null
-                ? TryConvertIIIFResult<PresentationCollection>.Failure()
-                : TryConvertIIIFResult<PresentationCollection>.Success(collection);
+                ? TryConvertIIIFResult<T>.Failure()
+                : TryConvertIIIFResult<T>.Success(collection);
         }
         catch (Exception)
         {
-            return TryConvertIIIFResult<PresentationCollection>.Failure();
+            return TryConvertIIIFResult<T>.Failure();
         }
     }
-}
+}