Additional unification of error messages

json-api-dotnet · Sep 29, 2021 · 2c60a42 · 2c60a42
1 parent 5f618d2
commit 2c60a42
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 62 deletions.
diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/AtomicOperationObjectAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/AtomicOperationObjectAdapter.cs
@@ -63,7 +63,7 @@ private static void AssertNoHref(AtomicOperationObject atomicOperationObject, Re
             {
                 using (state.Position.PushElement("href"))
                 {
-                    throw new DeserializationException(state.Position, "Usage of the 'href' element is not supported.", null);
+                    throw new ModelConversionException(state.Position, "The 'href' element is not supported.", null);
                 }
             }
         }
@@ -78,7 +78,7 @@ private WriteOperationKind ConvertOperationCode(AtomicOperationObject atomicOper
                     {
                         using (state.Position.PushElement("ref"))
                         {
-                            throw new DeserializationException(state.Position, "The 'ref.relationship' element is required.", null);
+                            throw new ModelConversionException(state.Position, "The 'relationship' element is required.", null);
                         }
                     }
 
@@ -92,7 +92,7 @@ private WriteOperationKind ConvertOperationCode(AtomicOperationObject atomicOper
                 {
                     if (atomicOperationObject.Ref == null)
                     {
-                        throw new DeserializationException(state.Position, "The 'ref' element is required.", null);
+                        throw new ModelConversionException(state.Position, "The 'ref' element is required.", null);
                     }
 
                     return atomicOperationObject.Ref.Relationship != null ? WriteOperationKind.RemoveFromRelationship : WriteOperationKind.DeleteResource;

diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/AtomicReferenceAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/AtomicReferenceAdapter.cs
@@ -1,6 +1,5 @@
 using System;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Objects;
@@ -44,17 +43,5 @@ private RelationshipAttribute ConvertRelationship(string relationshipName, Resou
 
             return relationship;
         }
-
-        private static void AssertToManyInAddOrRemoveRelationship(RelationshipAttribute relationship, RequestAdapterState state)
-        {
-            bool requireToManyRelationship = state.Request.WriteOperation == WriteOperationKind.AddToRelationship ||
-                state.Request.WriteOperation == WriteOperationKind.RemoveFromRelationship;
-
-            if (requireToManyRelationship && relationship is not HasManyAttribute)
-            {
-                throw new DeserializationException(state.Position, "Only to-many relationships can be targeted through this operation.",
-                    $"Relationship '{relationship.PublicName}' must be a to-many relationship.");
-            }
-        }
     }
 }
diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/OperationsDocumentAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/OperationsDocumentAdapter.cs
@@ -38,16 +38,17 @@ private static void AssertHasOperations(IEnumerable<AtomicOperationObject> atomi
         {
             if (atomicOperationObjects.IsNullOrEmpty())
             {
-                throw new DeserializationException(state.Position, "No operations found.", null);
+                throw new ModelConversionException(state.Position, "No operations found.", null);
             }
         }
 
         private void AssertMaxOperationsNotExceeded(ICollection<AtomicOperationObject> atomicOperationObjects, RequestAdapterState state)
         {
             if (atomicOperationObjects.Count > _options.MaximumOperationsPerRequest)
             {
-                throw new DeserializationException(state.Position, "Request exceeds the maximum number of operations.",
-                    $"The number of operations in this request ({atomicOperationObjects.Count}) is higher than {_options.MaximumOperationsPerRequest}.");
+                throw new ModelConversionException(state.Position, "Too many operations in request.",
+                    $"The number of operations in this request ({atomicOperationObjects.Count}) is higher " +
+                    $"than the maximum of {_options.MaximumOperationsPerRequest}.");
             }
         }
 

diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/RelationshipDataAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/RelationshipDataAdapter.cs
@@ -90,14 +90,14 @@ public object Convert(SingleOrManyData<ResourceIdentifierObject> data, Relations
         private IIdentifiable ConvertToOneRelationshipData(SingleOrManyData<ResourceIdentifierObject> data, RelationshipAttribute relationship,
             ResourceIdentityRequirements requirements, RequestAdapterState state)
         {
-            AssertHasNoManyValue(data, relationship, state);
+            AssertHasSingleValue(data, relationship, state);
 
             return data.SingleValue != null ? _resourceIdentifierObjectAdapter.Convert(data.SingleValue, requirements, state) : null;
         }
 
-        private static void AssertHasNoManyValue(SingleOrManyData<ResourceIdentifierObject> data, RelationshipAttribute relationship, RequestAdapterState state)
+        private static void AssertHasSingleValue(SingleOrManyData<ResourceIdentifierObject> data, RelationshipAttribute relationship, RequestAdapterState state)
         {
-            if (data.ManyValue != null)
+            if (!data.IsAssigned || data.ManyValue != null)
             {
                 throw new DeserializationException(state.Position, "Expected single data element for to-one relationship.",
                     $"Expected single data element for '{relationship.PublicName}' relationship.");

diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/ResourceDocumentAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/ResourceDocumentAdapter.cs
@@ -1,10 +1,7 @@
 using System.Collections.Generic;
-using System.Net;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Resources;
-using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Objects;
 
 namespace JsonApiDotNetCore.Serialization.RequestAdapters
@@ -50,7 +47,7 @@ public object Convert(Document document, RequestAdapterState state)
                         return new HashSet<IIdentifiable>(IdentifiableComparer.Instance);
                     }
 
-                    AssertToManyInAddOrRemoveRelationship(state);
+                    ResourceIdentityAdapter.AssertToManyInAddOrRemoveRelationship(state.Request.Relationship, state);
 
                     state.WritableTargetedFields.Relationships.Add(state.Request.Relationship);
                     return _relationshipDataAdapter.Convert(document.Data, state.Request.Relationship, false, state);
@@ -75,20 +72,5 @@ private ResourceIdentityRequirements CreateIdentityRequirements(RequestAdapterSt
 
             return requirements;
         }
-
-        private static void AssertToManyInAddOrRemoveRelationship(RequestAdapterState state)
-        {
-            bool requireToManyRelationship = state.Request.WriteOperation == WriteOperationKind.AddToRelationship ||
-                state.Request.WriteOperation == WriteOperationKind.RemoveFromRelationship;
-
-            if (requireToManyRelationship && state.Request.Relationship is not HasManyAttribute)
-            {
-                throw new JsonApiException(new ErrorObject(HttpStatusCode.Forbidden)
-                {
-                    Title = "Only to-many relationships can be targeted through this endpoint.",
-                    Detail = $"Relationship '{state.Request.Relationship.PublicName}' must be a to-many relationship."
-                });
-            }
-        }
     }
 }
diff --git a/src/JsonApiDotNetCore/Serialization/RequestAdapters/ResourceIdentityAdapter.cs b/src/JsonApiDotNetCore/Serialization/RequestAdapters/ResourceIdentityAdapter.cs
@@ -203,5 +203,21 @@ protected static void AssertIsKnownRelationship(RelationshipAttribute relationsh
                     $"Relationship '{relationshipName}' does not exist on resource type '{resourceContext.PublicName}'.");
             }
         }
+
+        protected internal static void AssertToManyInAddOrRemoveRelationship(RelationshipAttribute relationship, RequestAdapterState state)
+        {
+            bool requireToManyRelationship = state.Request.WriteOperation == WriteOperationKind.AddToRelationship ||
+                state.Request.WriteOperation == WriteOperationKind.RemoveFromRelationship;
+
+            if (requireToManyRelationship && relationship is not HasManyAttribute)
+            {
+                string message = state.Request.Kind == EndpointKind.AtomicOperations
+                    ? "Only to-many relationships can be targeted through this operation."
+                    : "Only to-many relationships can be targeted through this endpoint.";
+
+                throw new ModelConversionException(state.Position, message, $"Relationship '{relationship.PublicName}' is not a to-many relationship.",
+                    HttpStatusCode.Forbidden);
+            }
+        }
     }
 }
diff --git a/...piDotNetCoreTests/IntegrationTests/AtomicOperations/Creating/AtomicCreateResourceTests.cs b/...piDotNetCoreTests/IntegrationTests/AtomicOperations/Creating/AtomicCreateResourceTests.cs
@@ -494,7 +494,7 @@ public async Task Cannot_create_resource_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }
@@ -530,7 +530,7 @@ public async Task Cannot_create_resource_for_ref_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: The 'ref.relationship' element is required.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'relationship' element is required.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/ref");
         }

diff --git a/...piDotNetCoreTests/IntegrationTests/AtomicOperations/Deleting/AtomicDeleteResourceTests.cs b/...piDotNetCoreTests/IntegrationTests/AtomicOperations/Deleting/AtomicDeleteResourceTests.cs
@@ -356,7 +356,7 @@ public async Task Cannot_delete_resource_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }

diff --git a/...tNetCoreTests/IntegrationTests/AtomicOperations/Mixed/MaximumOperationsPerRequestTests.cs b/...tNetCoreTests/IntegrationTests/AtomicOperations/Mixed/MaximumOperationsPerRequestTests.cs
@@ -72,8 +72,8 @@ public async Task Cannot_process_more_operations_than_maximum()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Request exceeds the maximum number of operations.");
-            error.Detail.Should().Be("The number of operations in this request (3) is higher than 2.");
+            error.Title.Should().Be("Failed to deserialize request body: Too many operations in request.");
+            error.Detail.Should().Be("The number of operations in this request (3) is higher than the maximum of 2.");
             error.Source.Pointer.Should().Be("/atomic:operations");
         }
 

diff --git a/...rationTests/AtomicOperations/Updating/Relationships/AtomicAddToToManyRelationshipTests.cs b/...rationTests/AtomicOperations/Updating/Relationships/AtomicAddToToManyRelationshipTests.cs
@@ -64,14 +64,14 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             (HttpResponseMessage httpResponse, Document responseDocument) = await _testContext.ExecutePostAtomicAsync<Document>(route, requestBody);
 
             // Assert
-            httpResponse.Should().HaveStatusCode(HttpStatusCode.UnprocessableEntity);
+            httpResponse.Should().HaveStatusCode(HttpStatusCode.Forbidden);
 
             responseDocument.Errors.Should().HaveCount(1);
 
             ErrorObject error = responseDocument.Errors[0];
-            error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
+            error.StatusCode.Should().Be(HttpStatusCode.Forbidden);
             error.Title.Should().Be("Failed to deserialize request body: Only to-many relationships can be targeted through this operation.");
-            error.Detail.Should().Be("Relationship 'ownedBy' must be a to-many relationship.");
+            error.Detail.Should().Be("Relationship 'ownedBy' is not a to-many relationship.");
             error.Source.Pointer.Should().Be("/atomic:operations[0]/ref/relationship");
         }
 
@@ -263,7 +263,7 @@ public async Task Cannot_add_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }
@@ -507,7 +507,7 @@ public async Task Cannot_add_for_missing_relationship_in_ref()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: The 'ref.relationship' element is required.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'relationship' element is required.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/ref");
         }

diff --git a/...nTests/AtomicOperations/Updating/Relationships/AtomicRemoveFromToManyRelationshipTests.cs b/...nTests/AtomicOperations/Updating/Relationships/AtomicRemoveFromToManyRelationshipTests.cs
@@ -65,14 +65,14 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             (HttpResponseMessage httpResponse, Document responseDocument) = await _testContext.ExecutePostAtomicAsync<Document>(route, requestBody);
 
             // Assert
-            httpResponse.Should().HaveStatusCode(HttpStatusCode.UnprocessableEntity);
+            httpResponse.Should().HaveStatusCode(HttpStatusCode.Forbidden);
 
             responseDocument.Errors.Should().HaveCount(1);
 
             ErrorObject error = responseDocument.Errors[0];
-            error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
+            error.StatusCode.Should().Be(HttpStatusCode.Forbidden);
             error.Title.Should().Be("Failed to deserialize request body: Only to-many relationships can be targeted through this operation.");
-            error.Detail.Should().Be("Relationship 'ownedBy' must be a to-many relationship.");
+            error.Detail.Should().Be("Relationship 'ownedBy' is not a to-many relationship.");
             error.Source.Pointer.Should().Be("/atomic:operations[0]/ref/relationship");
         }
 
@@ -263,7 +263,7 @@ public async Task Cannot_remove_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }

diff --git a/...tionTests/AtomicOperations/Updating/Relationships/AtomicReplaceToManyRelationshipTests.cs b/...tionTests/AtomicOperations/Updating/Relationships/AtomicReplaceToManyRelationshipTests.cs
@@ -299,7 +299,7 @@ public async Task Cannot_replace_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }

diff --git a/...rationTests/AtomicOperations/Updating/Relationships/AtomicUpdateToOneRelationshipTests.cs b/...rationTests/AtomicOperations/Updating/Relationships/AtomicUpdateToOneRelationshipTests.cs
@@ -546,7 +546,7 @@ public async Task Cannot_create_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }

diff --git a/...reTests/IntegrationTests/AtomicOperations/Updating/Resources/AtomicUpdateResourceTests.cs b/...reTests/IntegrationTests/AtomicOperations/Updating/Resources/AtomicUpdateResourceTests.cs
@@ -631,7 +631,7 @@ public async Task Cannot_update_resource_for_href_element()
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.UnprocessableEntity);
-            error.Title.Should().Be("Failed to deserialize request body: Usage of the 'href' element is not supported.");
+            error.Title.Should().Be("Failed to deserialize request body: The 'href' element is not supported.");
             error.Detail.Should().BeNull();
             error.Source.Pointer.Should().Be("/atomic:operations[0]/href");
         }

diff --git a/...reTests/IntegrationTests/ReadWrite/Updating/Relationships/AddToToManyRelationshipTests.cs b/...reTests/IntegrationTests/ReadWrite/Updating/Relationships/AddToToManyRelationshipTests.cs
@@ -58,8 +58,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.Forbidden);
-            error.Title.Should().Be("Only to-many relationships can be targeted through this endpoint.");
-            error.Detail.Should().Be("Relationship 'assignee' must be a to-many relationship.");
+            error.Title.Should().Be("Failed to deserialize request body: Only to-many relationships can be targeted through this endpoint.");
+            error.Detail.Should().Be("Relationship 'assignee' is not a to-many relationship.");
             error.Source.Should().BeNull();
         }
 

diff --git a/...ts/IntegrationTests/ReadWrite/Updating/Relationships/RemoveFromToManyRelationshipTests.cs b/...ts/IntegrationTests/ReadWrite/Updating/Relationships/RemoveFromToManyRelationshipTests.cs
@@ -73,8 +73,8 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
 
             ErrorObject error = responseDocument.Errors[0];
             error.StatusCode.Should().Be(HttpStatusCode.Forbidden);
-            error.Title.Should().Be("Only to-many relationships can be targeted through this endpoint.");
-            error.Detail.Should().Be("Relationship 'assignee' must be a to-many relationship.");
+            error.Title.Should().Be("Failed to deserialize request body: Only to-many relationships can be targeted through this endpoint.");
+            error.Detail.Should().Be("Relationship 'assignee' is not a to-many relationship.");
             error.Source.Should().BeNull();
         }