Renamed OperationKind to WriteOperationKind, exposed as IJsonApiRequest.WriteOperation

Author: Bart Koelman

src/Examples/JsonApiDotNetCoreExample/Definitions/TodoItemDefinition.cs

@@ -36,13 +36,13 @@ private SortExpression GetDefaultSortOrder()
             });
         }
 
-        public override Task OnWritingAsync(TodoItem resource, OperationKind operationKind, CancellationToken cancellationToken)
+        public override Task OnWritingAsync(TodoItem resource, WriteOperationKind writeOperation, CancellationToken cancellationToken)
         {
-            if (operationKind == OperationKind.CreateResource)
+            if (writeOperation == WriteOperationKind.CreateResource)
             {
                 resource.CreatedAt = _systemClock.UtcNow;
             }
-            else if (operationKind == OperationKind.UpdateResource)
+            else if (writeOperation == WriteOperationKind.UpdateResource)
             {
                 resource.LastModifiedAt = _systemClock.UtcNow;
             }

src/JsonApiDotNetCore/AtomicOperations/LocalIdValidator.cs

@@ -56,7 +56,7 @@ public void Validate(IEnumerable<OperationContainer> operations)
 
         private void ValidateOperation(OperationContainer operation)
         {
-            if (operation.Kind == OperationKind.CreateResource)
+            if (operation.Kind == WriteOperationKind.CreateResource)
             {
                 DeclareLocalId(operation.Resource);
             }
@@ -70,7 +70,7 @@ private void ValidateOperation(OperationContainer operation)
                 AssertLocalIdIsAssigned(secondaryResource);
             }
 
-            if (operation.Kind == OperationKind.CreateResource)
+            if (operation.Kind == WriteOperationKind.CreateResource)
             {
                 AssignLocalId(operation);
             }

src/JsonApiDotNetCore/AtomicOperations/OperationProcessorAccessor.cs

@@ -44,37 +44,37 @@ protected virtual IOperationProcessor ResolveProcessor(OperationContainer operat
             return (IOperationProcessor)_serviceProvider.GetRequiredService(processorType);
         }
 
-        private static Type GetProcessorInterface(OperationKind kind)
+        private static Type GetProcessorInterface(WriteOperationKind writeOperation)
         {
-            switch (kind)
+            switch (writeOperation)
             {
-                case OperationKind.CreateResource:
+                case WriteOperationKind.CreateResource:
                 {
                     return typeof(ICreateProcessor<,>);
                 }
-                case OperationKind.UpdateResource:
+                case WriteOperationKind.UpdateResource:
                 {
                     return typeof(IUpdateProcessor<,>);
                 }
-                case OperationKind.DeleteResource:
+                case WriteOperationKind.DeleteResource:
                 {
                     return typeof(IDeleteProcessor<,>);
                 }
-                case OperationKind.SetRelationship:
+                case WriteOperationKind.SetRelationship:
                 {
                     return typeof(ISetRelationshipProcessor<,>);
                 }
-                case OperationKind.AddToRelationship:
+                case WriteOperationKind.AddToRelationship:
                 {
                     return typeof(IAddToRelationshipProcessor<,>);
                 }
-                case OperationKind.RemoveFromRelationship:
+                case WriteOperationKind.RemoveFromRelationship:
                 {
                     return typeof(IRemoveFromRelationshipProcessor<,>);
                 }
                 default:
                 {
-                    throw new NotSupportedException($"Unknown operation kind '{kind}'.");
+                    throw new NotSupportedException($"Unknown write operation kind '{writeOperation}'.");
                 }
             }
         }

src/JsonApiDotNetCore/AtomicOperations/OperationsProcessor.cs

@@ -118,7 +118,7 @@ protected virtual async Task<OperationContainer> ProcessOperationAsync(Operation
 
         protected void TrackLocalIdsForOperation(OperationContainer operation)
         {
-            if (operation.Kind == OperationKind.CreateResource)
+            if (operation.Kind == WriteOperationKind.CreateResource)
             {
                 DeclareLocalId(operation.Resource);
             }

src/JsonApiDotNetCore/Configuration/JsonApiValidationFilter.cs

@@ -41,7 +41,7 @@ public bool ShouldValidateEntry(ValidationEntry entry, ValidationEntry parentEnt
 
             var httpContextAccessor = _serviceProvider.GetRequiredService<IHttpContextAccessor>();
 
-            if (httpContextAccessor.HttpContext!.Request.Method == HttpMethods.Patch || request.OperationKind == OperationKind.UpdateResource)
+            if (httpContextAccessor.HttpContext!.Request.Method == HttpMethods.Patch || request.WriteOperation == WriteOperationKind.UpdateResource)
             {
                 var targetedFields = _serviceProvider.GetRequiredService<ITargetedFields>();
                 return IsFieldTargeted(entry, targetedFields);

src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs

@@ -132,7 +132,7 @@ protected virtual void ValidateClientGeneratedIds(IEnumerable<OperationContainer
 
                 foreach (OperationContainer operation in operations)
                 {
-                    if (operation.Kind == OperationKind.CreateResource && operation.Resource.StringId != null)
+                    if (operation.Kind == WriteOperationKind.CreateResource && operation.Resource.StringId != null)
                     {
                         throw new ResourceIdInCreateResourceNotAllowedException(index);
                     }
@@ -153,7 +153,7 @@ protected virtual void ValidateModelState(IEnumerable<OperationContainer> operat
 
             foreach (OperationContainer operation in operations)
             {
-                if (operation.Kind == OperationKind.CreateResource || operation.Kind == OperationKind.UpdateResource)
+                if (operation.Kind == WriteOperationKind.CreateResource || operation.Kind == WriteOperationKind.UpdateResource)
                 {
                     _targetedFields.Attributes = operation.TargetedFields.Attributes;
                     _targetedFields.Relationships = operation.TargetedFields.Relationships;

src/JsonApiDotNetCore/Middleware/IJsonApiRequest.cs

@@ -48,7 +48,7 @@ public interface IJsonApiRequest
         /// <summary>
         /// In case of a non-readonly request, this indicates the kind of write operation currently being processed.
         /// </summary>
-        OperationKind? OperationKind { get; }
+        WriteOperationKind? WriteOperation { get; }
 
         /// <summary>
         /// In case of an atomic:operations request, identifies the overarching transaction.

src/JsonApiDotNetCore/Middleware/JsonApiMiddleware.cs

@@ -224,10 +224,10 @@ private static void SetupResourceRequest(JsonApiRequest request, ResourceContext
                 // @formatter:wrap_chained_method_calls chop_always
                 // @formatter:keep_existing_linebreaks true
 
-                request.OperationKind =
-                    httpRequest.Method == HttpMethod.Post.Method ? OperationKind.AddToRelationship :
-                    httpRequest.Method == HttpMethod.Patch.Method ? OperationKind.SetRelationship :
-                    httpRequest.Method == HttpMethod.Delete.Method ? OperationKind.RemoveFromRelationship : null;
+                request.WriteOperation =
+                    httpRequest.Method == HttpMethod.Post.Method ? WriteOperationKind.AddToRelationship :
+                    httpRequest.Method == HttpMethod.Patch.Method ? WriteOperationKind.SetRelationship :
+                    httpRequest.Method == HttpMethod.Delete.Method ? WriteOperationKind.RemoveFromRelationship : null;
 
                 // @formatter:keep_existing_linebreaks restore
                 // @formatter:wrap_chained_method_calls restore
@@ -248,10 +248,10 @@ private static void SetupResourceRequest(JsonApiRequest request, ResourceContext
                 // @formatter:wrap_chained_method_calls chop_always
                 // @formatter:keep_existing_linebreaks true
 
-                request.OperationKind =
-                    httpRequest.Method == HttpMethod.Post.Method ? OperationKind.CreateResource :
-                    httpRequest.Method == HttpMethod.Patch.Method ? OperationKind.UpdateResource :
-                    httpRequest.Method == HttpMethod.Delete.Method ? OperationKind.DeleteResource : null;
+                request.WriteOperation =
+                    httpRequest.Method == HttpMethod.Post.Method ? WriteOperationKind.CreateResource :
+                    httpRequest.Method == HttpMethod.Patch.Method ? WriteOperationKind.UpdateResource :
+                    httpRequest.Method == HttpMethod.Delete.Method ? WriteOperationKind.DeleteResource : null;
 
                 // @formatter:keep_existing_linebreaks restore
                 // @formatter:wrap_chained_method_calls restore

src/JsonApiDotNetCore/Middleware/JsonApiRequest.cs

@@ -30,7 +30,7 @@ public sealed class JsonApiRequest : IJsonApiRequest
         public bool IsReadOnly { get; set; }
 
         /// <inheritdoc />
-        public OperationKind? OperationKind { get; set; }
+        public WriteOperationKind? WriteOperation { get; set; }
 
         /// <inheritdoc />
         public string TransactionId { get; set; }
@@ -47,7 +47,7 @@ public void CopyFrom(IJsonApiRequest other)
             Relationship = other.Relationship;
             IsCollection = other.IsCollection;
             IsReadOnly = other.IsReadOnly;
-            OperationKind = other.OperationKind;
+            WriteOperation = other.WriteOperation;
             TransactionId = other.TransactionId;
         }
     }

src/JsonApiDotNetCore/Middleware/OperationKind.cs renamed to src/JsonApiDotNetCore/Middleware/WriteOperationKind.cs

@@ -1,9 +1,10 @@
 namespace JsonApiDotNetCore.Middleware
 {
     /// <summary>
-    /// Lists the functional operation kinds of a resource request or an atomic:operations request.
+    /// Lists the functional write operations, originating from a POST/PATCH/DELETE request against a single resource/relationship or a POST request against
+    /// a list of operations.
     /// </summary>
-    public enum OperationKind
+    public enum WriteOperationKind
     {
         /// <summary>
         /// Create a new resource with attributes, relationships or both.

src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs

@@ -164,7 +164,7 @@ public virtual async Task CreateAsync(TResource resourceFromRequest, TResource r
             {
                 object rightValue = relationship.GetValue(resourceFromRequest);
 
-                object rightValueEvaluated = await VisitSetRelationshipAsync(resourceForDatabase, relationship, rightValue, OperationKind.CreateResource,
+                object rightValueEvaluated = await VisitSetRelationshipAsync(resourceForDatabase, relationship, rightValue, WriteOperationKind.CreateResource,
                     cancellationToken);
 
                 await UpdateRelationshipAsync(relationship, resourceForDatabase, rightValueEvaluated, collector, cancellationToken);
@@ -175,30 +175,30 @@ public virtual async Task CreateAsync(TResource resourceFromRequest, TResource r
                 attribute.SetValue(resourceForDatabase, attribute.GetValue(resourceFromRequest));
             }
 
-            await _resourceDefinitionAccessor.OnWritingAsync(resourceForDatabase, OperationKind.CreateResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWritingAsync(resourceForDatabase, WriteOperationKind.CreateResource, cancellationToken);
 
             DbSet<TResource> dbSet = _dbContext.Set<TResource>();
             await dbSet.AddAsync(resourceForDatabase, cancellationToken);
 
             await SaveChangesAsync(cancellationToken);
 
-            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resourceForDatabase, OperationKind.CreateResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resourceForDatabase, WriteOperationKind.CreateResource, cancellationToken);
         }
 
         private async Task<object> VisitSetRelationshipAsync(TResource leftResource, RelationshipAttribute relationship, object rightValue,
-            OperationKind operationKind, CancellationToken cancellationToken)
+            WriteOperationKind writeOperation, CancellationToken cancellationToken)
         {
             if (relationship is HasOneAttribute hasOneRelationship)
             {
-                return await _resourceDefinitionAccessor.OnSetToOneRelationshipAsync(leftResource, hasOneRelationship, (IIdentifiable)rightValue, operationKind,
-                    cancellationToken);
+                return await _resourceDefinitionAccessor.OnSetToOneRelationshipAsync(leftResource, hasOneRelationship, (IIdentifiable)rightValue,
+                    writeOperation, cancellationToken);
             }
 
             if (relationship is HasManyAttribute hasManyRelationship)
             {
                 HashSet<IIdentifiable> rightResourceIdSet = _collectionConverter.ExtractResources(rightValue).ToHashSet(IdentifiableComparer.Instance);
 
-                await _resourceDefinitionAccessor.OnSetToManyRelationshipAsync(leftResource, hasManyRelationship, rightResourceIdSet, operationKind,
+                await _resourceDefinitionAccessor.OnSetToManyRelationshipAsync(leftResource, hasManyRelationship, rightResourceIdSet, writeOperation,
                     cancellationToken);
 
                 return rightResourceIdSet;
@@ -232,7 +232,7 @@ public virtual async Task UpdateAsync(TResource resourceFromRequest, TResource r
             {
                 object rightValue = relationship.GetValue(resourceFromRequest);
 
-                object rightValueEvaluated = await VisitSetRelationshipAsync(resourceFromDatabase, relationship, rightValue, OperationKind.UpdateResource,
+                object rightValueEvaluated = await VisitSetRelationshipAsync(resourceFromDatabase, relationship, rightValue, WriteOperationKind.UpdateResource,
                     cancellationToken);
 
                 AssertIsNotClearingRequiredRelationship(relationship, resourceFromDatabase, rightValueEvaluated);
@@ -245,11 +245,11 @@ public virtual async Task UpdateAsync(TResource resourceFromRequest, TResource r
                 attribute.SetValue(resourceFromDatabase, attribute.GetValue(resourceFromRequest));
             }
 
-            await _resourceDefinitionAccessor.OnWritingAsync(resourceFromDatabase, OperationKind.UpdateResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWritingAsync(resourceFromDatabase, WriteOperationKind.UpdateResource, cancellationToken);
 
             await SaveChangesAsync(cancellationToken);
 
-            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resourceFromDatabase, OperationKind.UpdateResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resourceFromDatabase, WriteOperationKind.UpdateResource, cancellationToken);
         }
 
         protected void AssertIsNotClearingRequiredRelationship(RelationshipAttribute relationship, TResource leftResource, object rightValue)
@@ -300,7 +300,7 @@ public virtual async Task DeleteAsync(TId id, CancellationToken cancellationToke
             var emptyResource = _resourceFactory.CreateInstance<TResource>();
             emptyResource.Id = id;
 
-            await _resourceDefinitionAccessor.OnWritingAsync(emptyResource, OperationKind.DeleteResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWritingAsync(emptyResource, WriteOperationKind.DeleteResource, cancellationToken);
 
             using var collector = new PlaceholderResourceCollector(_resourceFactory, _dbContext);
             TResource resource = collector.CreateForId<TResource, TId>(id);
@@ -320,7 +320,7 @@ public virtual async Task DeleteAsync(TId id, CancellationToken cancellationToke
 
             await SaveChangesAsync(cancellationToken);
 
-            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resource, OperationKind.DeleteResource, cancellationToken);
+            await _resourceDefinitionAccessor.OnWriteSucceededAsync(resource, WriteOperationKind.DeleteResource, cancellationToken);
         }
 
         private NavigationEntry GetNavigationEntry(TResource resource, RelationshipAttribute relationship)
@@ -377,18 +377,18 @@ public virtual async Task SetRelationshipAsync(TResource leftResource, object ri
             RelationshipAttribute relationship = _targetedFields.Relationships.Single();
 
             object rightValueEvaluated =
-                await VisitSetRelationshipAsync(leftResource, relationship, rightValue, OperationKind.SetRelationship, cancellationToken);
+                await VisitSetRelationshipAsync(leftResource, relationship, rightValue, WriteOperationKind.SetRelationship, cancellationToken);
 
             AssertIsNotClearingRequiredRelationship(relationship, leftResource, rightValueEvaluated);
 
             using var collector = new PlaceholderResourceCollector(_resourceFactory, _dbContext);
             await UpdateRelationshipAsync(relationship, leftResource, rightValueEvaluated, collector, cancellationToken);
 
-            await _resourceDefinitionAccessor.OnWritingAsync(leftResource, OperationKind.SetRelationship, cancellationToken);
+            await _resourceDefinitionAccessor.OnWritingAsync(leftResource, WriteOperationKind.SetRelationship, cancellationToken);
 
             await SaveChangesAsync(cancellationToken);
 
-            await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, OperationKind.SetRelationship, cancellationToken);
+            await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, WriteOperationKind.SetRelationship, cancellationToken);
         }
 
         /// <inheritdoc />
@@ -413,11 +413,11 @@ public virtual async Task AddToToManyRelationshipAsync(TId leftId, ISet<IIdentif
 
                 await UpdateRelationshipAsync(relationship, leftResource, rightResourceIds, collector, cancellationToken);
 
-                await _resourceDefinitionAccessor.OnWritingAsync(leftResource, OperationKind.AddToRelationship, cancellationToken);
+                await _resourceDefinitionAccessor.OnWritingAsync(leftResource, WriteOperationKind.AddToRelationship, cancellationToken);
 
                 await SaveChangesAsync(cancellationToken);
 
-                await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, OperationKind.AddToRelationship, cancellationToken);
+                await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, WriteOperationKind.AddToRelationship, cancellationToken);
             }
         }
 
@@ -451,11 +451,11 @@ public virtual async Task RemoveFromToManyRelationshipAsync(TResource leftResour
                 using var collector = new PlaceholderResourceCollector(_resourceFactory, _dbContext);
                 await UpdateRelationshipAsync(relationship, leftResource, rightResourceIdsToStore, collector, cancellationToken);
 
-                await _resourceDefinitionAccessor.OnWritingAsync(leftResource, OperationKind.RemoveFromRelationship, cancellationToken);
+                await _resourceDefinitionAccessor.OnWritingAsync(leftResource, WriteOperationKind.RemoveFromRelationship, cancellationToken);
 
                 await SaveChangesAsync(cancellationToken);
 
-                await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, OperationKind.RemoveFromRelationship, cancellationToken);
+                await _resourceDefinitionAccessor.OnWriteSucceededAsync(leftResource, WriteOperationKind.RemoveFromRelationship, cancellationToken);
             }
         }