support get relationship requests in operations

jaredcnance · jaredcnance · commit 956f473cc6c2 · 2018-03-29T09:20:08.000-05:00
diff --git a/src/JsonApiDotNetCore/Builders/DocumentBuilderOptions.cs b/src/JsonApiDotNetCore/Builders/DocumentBuilderOptions.cs
@@ -1,10 +1,6 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
 namespace JsonApiDotNetCore.Builders
 {
-    public struct DocumentBuilderOptions 
+    public struct DocumentBuilderOptions
     {
         public DocumentBuilderOptions(bool omitNullValuedAttributes = false)
         {
diff --git a/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs b/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs
@@ -52,7 +52,7 @@ public class JsonApiOptions
         /// <code>options.AllowClientGeneratedIds = true;</code>
         /// </example>
         public bool AllowClientGeneratedIds { get; set; }
-        
+
         /// <summary>
         /// The graph of all resources exposed by this application.
         /// </summary>
@@ -107,10 +107,11 @@ public class JsonApiOptions
         /// <summary>
         /// Whether or not to allow json:api v1.1 operation requests.
         /// This is a beta feature and there may be breaking changes
-        /// in subsequent releases.
+        /// in subsequent releases. For now, it should be considered
+        /// experimental.
         /// </summary>
         /// <remarks>
-        /// This will be enabled by default in JsonApiDotNetCore v2.2.1
+        /// This will be enabled by default in a subsequent patch JsonApiDotNetCore v2.2.x
         /// </remarks>
         public bool EnableOperations { get; set; }
 
@@ -144,7 +145,7 @@ public void BuildContextGraph(Action<IContextGraphBuilder> builder)
             ContextGraph = ContextGraphBuilder.Build();
         }
 
-        public void EnableExtension(JsonApiExtension extension) 
+        public void EnableExtension(JsonApiExtension extension)
             => EnabledExtensions.Add(extension);
 
         internal IContextGraphBuilder ContextGraphBuilder { get; } = new ContextGraphBuilder();
diff --git a/src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs b/src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs
@@ -109,6 +109,9 @@ public static void AddJsonApiInternals(
             services.AddScoped(typeof(IGetByIdService<>), typeof(EntityResourceService<>));
             services.AddScoped(typeof(IGetByIdService<,>), typeof(EntityResourceService<,>));
 
+            services.AddScoped(typeof(IGetRelationshipService<,>), typeof(EntityResourceService<>));
+            services.AddScoped(typeof(IGetRelationshipService<,>), typeof(EntityResourceService<,>));
+
             services.AddScoped(typeof(IUpdateService<>), typeof(EntityResourceService<>));
             services.AddScoped(typeof(IUpdateService<,>), typeof(EntityResourceService<,>));
 
diff --git a/src/JsonApiDotNetCore/Services/EntityResourceService.cs b/src/JsonApiDotNetCore/Services/EntityResourceService.cs
@@ -96,6 +96,8 @@ public virtual async Task<object> GetRelationshipAsync(TId id, string relationsh
             _logger.LogTrace($"Looking up '{relationshipName}'...");
 
             var entity = await _entities.GetAndIncludeAsync(id, relationshipName);
+            // TODO: it would be better if we could distinguish whether or not the relationship was not found,
+            // vs the relationship not being set on the instance of T
             if (entity == null)
                 throw new JsonApiException(404, $"Relationship {relationshipName} not found.");
 
diff --git a/src/JsonApiDotNetCore/Services/Operations/Processors/GetOpProcessor.cs b/src/JsonApiDotNetCore/Services/Operations/Processors/GetOpProcessor.cs
@@ -1,4 +1,6 @@
+using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Builders;
 using JsonApiDotNetCore.Internal;
@@ -8,64 +10,84 @@
 
 namespace JsonApiDotNetCore.Services.Operations.Processors
 {
+    /// <summary>
+    /// Handles all "<see cref="OperationCode.get"/>" operations 
+    /// </summary>
+    /// <typeparam name="T">The resource type</typeparam>
     public interface IGetOpProcessor<T> : IOpProcessor
         where T : class, IIdentifiable<int>
     { }
 
+    /// <summary>
+    ///  Handles all "<see cref="OperationCode.get"/>" operations 
+    /// </summary>
+    /// <typeparam name="T">The resource type</typeparam>
+    /// <typeparam name="TId">The resource identifier type</typeparam>
     public interface IGetOpProcessor<T, TId> : IOpProcessor
         where T : class, IIdentifiable<TId>
     { }
 
+    /// <inheritdoc />
     public class GetOpProcessor<T> : GetOpProcessor<T, int>
         where T : class, IIdentifiable<int>
     {
+        /// <inheritdoc />
         public GetOpProcessor(
             IGetAllService<T, int> getAll,
             IGetByIdService<T, int> getById,
+            IGetRelationshipService<T, int> getRelationship,
             IJsonApiDeSerializer deSerializer,
             IDocumentBuilder documentBuilder,
             IContextGraph contextGraph,
             IJsonApiContext jsonApiContext
-        ) : base(getAll, getById, deSerializer, documentBuilder, contextGraph, jsonApiContext)
+        ) : base(getAll, getById, getRelationship, deSerializer, documentBuilder, contextGraph, jsonApiContext)
         { }
     }
 
+    /// <inheritdoc />
     public class GetOpProcessor<T, TId> : IGetOpProcessor<T, TId>
          where T : class, IIdentifiable<TId>
     {
         private readonly IGetAllService<T, TId> _getAll;
         private readonly IGetByIdService<T, TId> _getById;
+        private readonly IGetRelationshipService<T, TId> _getRelationship;
         private readonly IJsonApiDeSerializer _deSerializer;
         private readonly IDocumentBuilder _documentBuilder;
         private readonly IContextGraph _contextGraph;
         private readonly IJsonApiContext _jsonApiContext;
 
+        /// <inheritdoc />
         public GetOpProcessor(
             IGetAllService<T, TId> getAll,
             IGetByIdService<T, TId> getById,
+            IGetRelationshipService<T, TId> getRelationship,
             IJsonApiDeSerializer deSerializer,
             IDocumentBuilder documentBuilder,
             IContextGraph contextGraph,
             IJsonApiContext jsonApiContext)
         {
             _getAll = getAll;
             _getById = getById;
+            _getRelationship = getRelationship;
             _deSerializer = deSerializer;
             _documentBuilder = documentBuilder;
             _contextGraph = contextGraph;
             _jsonApiContext = jsonApiContext.ApplyContext<T>(this);
         }
 
+        /// <inheritdoc />
         public async Task<Operation> ProcessAsync(Operation operation)
         {
             var operationResult = new Operation
             {
                 Op = OperationCode.get
             };
 
-            operationResult.Data = string.IsNullOrWhiteSpace(operation.Ref.Id?.ToString())
+            operationResult.Data = string.IsNullOrWhiteSpace(operation.Ref.Id)
             ? await GetAllAsync(operation)
-            : await GetByIdAsync(operation);
+            : string.IsNullOrWhiteSpace(operation.Ref.Relationship)
+                ? await GetByIdAsync(operation)
+                : await GetRelationshipAsync(operation);
 
             return operationResult;
         }
@@ -88,7 +110,7 @@ private async Task<object> GetAllAsync(Operation operation)
 
         private async Task<object> GetByIdAsync(Operation operation)
         {
-            var id = TypeHelper.ConvertType<TId>(operation.Ref.Id);
+            var id = GetReferenceId(operation);
             var result = await _getById.GetAsync(id);
 
             // this is a bit ugly but we need to bomb the entire transaction if the entity cannot be found
@@ -104,5 +126,23 @@ private async Task<object> GetByIdAsync(Operation operation)
 
             return doc;
         }
+
+        private async Task<object> GetRelationshipAsync(Operation operation)
+        {
+            var id = GetReferenceId(operation);
+            var result = await _getRelationship.GetRelationshipAsync(id, operation.Ref.Relationship);
+
+            // TODO: need a better way to get the ContextEntity from a relationship name
+            // when no generic parameter is available
+            var relationshipType = _contextGraph.GetContextEntity(operation.GetResourceTypeName())
+                .Relationships.Single(r => r.Is(operation.Ref.Relationship)).Type;
+            var relatedContextEntity = _jsonApiContext.ContextGraph.GetContextEntity(relationshipType);
+
+            var doc = _documentBuilder.GetData(relatedContextEntity, result as IIdentifiable); // TODO: if this is safe, then it should be cast in the GetRelationshipAsync call
+
+            return doc;
+        }
+
+        private TId GetReferenceId(Operation operation) => TypeHelper.ConvertType<TId>(operation.Ref.Id);
     }
 }
diff --git a/src/JsonApiDotNetCore/api/.manifest b/src/JsonApiDotNetCore/api/.manifest
@@ -381,6 +381,7 @@
   "JsonApiDotNetCore.Models.AttrAttribute.#ctor(System.String,System.Boolean,System.Boolean,System.Boolean)": "JsonApiDotNetCore.Models.AttrAttribute.yml",
   "JsonApiDotNetCore.Models.AttrAttribute.GetValue(System.Object)": "JsonApiDotNetCore.Models.AttrAttribute.yml",
   "JsonApiDotNetCore.Models.AttrAttribute.InternalAttributeName": "JsonApiDotNetCore.Models.AttrAttribute.yml",
+  "JsonApiDotNetCore.Models.AttrAttribute.Is(System.String)": "JsonApiDotNetCore.Models.AttrAttribute.yml",
   "JsonApiDotNetCore.Models.AttrAttribute.IsFilterable": "JsonApiDotNetCore.Models.AttrAttribute.yml",
   "JsonApiDotNetCore.Models.AttrAttribute.IsImmutable": "JsonApiDotNetCore.Models.AttrAttribute.yml",
   "JsonApiDotNetCore.Models.AttrAttribute.IsSortable": "JsonApiDotNetCore.Models.AttrAttribute.yml",
@@ -459,6 +460,7 @@
   "JsonApiDotNetCore.Models.RelationshipAttribute.DocumentLinks": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
   "JsonApiDotNetCore.Models.RelationshipAttribute.Equals(System.Object)": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
   "JsonApiDotNetCore.Models.RelationshipAttribute.InternalRelationshipName": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
+  "JsonApiDotNetCore.Models.RelationshipAttribute.Is(System.String)": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
   "JsonApiDotNetCore.Models.RelationshipAttribute.IsHasMany": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
   "JsonApiDotNetCore.Models.RelationshipAttribute.IsHasOne": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
   "JsonApiDotNetCore.Models.RelationshipAttribute.PublicRelationshipName": "JsonApiDotNetCore.Models.RelationshipAttribute.yml",
@@ -638,9 +640,9 @@
   "JsonApiDotNetCore.Services.Operations.Processors.CreateOpProcessor`2.#ctor(JsonApiDotNetCore.Services.ICreateService{`0,`1},JsonApiDotNetCore.Serialization.IJsonApiDeSerializer,JsonApiDotNetCore.Builders.IDocumentBuilder,JsonApiDotNetCore.Internal.IContextGraph)": "JsonApiDotNetCore.Services.Operations.Processors.CreateOpProcessor-2.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.CreateOpProcessor`2.ProcessAsync(JsonApiDotNetCore.Models.Operations.Operation)": "JsonApiDotNetCore.Services.Operations.Processors.CreateOpProcessor-2.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`1": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-1.yml",
-  "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`1.#ctor(JsonApiDotNetCore.Services.IGetAllService{`0,System.Int32},JsonApiDotNetCore.Services.IGetByIdService{`0,System.Int32},JsonApiDotNetCore.Serialization.IJsonApiDeSerializer,JsonApiDotNetCore.Builders.IDocumentBuilder,JsonApiDotNetCore.Internal.IContextGraph,JsonApiDotNetCore.Services.IJsonApiContext)": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-1.yml",
+  "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`1.#ctor(JsonApiDotNetCore.Services.IGetAllService{`0,System.Int32},JsonApiDotNetCore.Services.IGetByIdService{`0,System.Int32},JsonApiDotNetCore.Services.IGetRelationshipService{`0,System.Int32},JsonApiDotNetCore.Serialization.IJsonApiDeSerializer,JsonApiDotNetCore.Builders.IDocumentBuilder,JsonApiDotNetCore.Internal.IContextGraph,JsonApiDotNetCore.Services.IJsonApiContext)": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-1.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`2": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-2.yml",
-  "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`2.#ctor(JsonApiDotNetCore.Services.IGetAllService{`0,`1},JsonApiDotNetCore.Services.IGetByIdService{`0,`1},JsonApiDotNetCore.Serialization.IJsonApiDeSerializer,JsonApiDotNetCore.Builders.IDocumentBuilder,JsonApiDotNetCore.Internal.IContextGraph,JsonApiDotNetCore.Services.IJsonApiContext)": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-2.yml",
+  "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`2.#ctor(JsonApiDotNetCore.Services.IGetAllService{`0,`1},JsonApiDotNetCore.Services.IGetByIdService{`0,`1},JsonApiDotNetCore.Services.IGetRelationshipService{`0,`1},JsonApiDotNetCore.Serialization.IJsonApiDeSerializer,JsonApiDotNetCore.Builders.IDocumentBuilder,JsonApiDotNetCore.Internal.IContextGraph,JsonApiDotNetCore.Services.IJsonApiContext)": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-2.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor`2.ProcessAsync(JsonApiDotNetCore.Models.Operations.Operation)": "JsonApiDotNetCore.Services.Operations.Processors.GetOpProcessor-2.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.ICreateOpProcessor`1": "JsonApiDotNetCore.Services.Operations.Processors.ICreateOpProcessor-1.yml",
   "JsonApiDotNetCore.Services.Operations.Processors.ICreateOpProcessor`2": "JsonApiDotNetCore.Services.Operations.Processors.ICreateOpProcessor-2.yml",
diff --git a/test/OperationsExampleTests/Get/GetRelationshipTests.cs b/test/OperationsExampleTests/Get/GetRelationshipTests.cs
@@ -0,0 +1,52 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using System.Threading.Tasks;
+using Bogus;
+using JsonApiDotNetCore.Models.Operations;
+using JsonApiDotNetCoreExample.Data;
+using OperationsExampleTests.Factories;
+using Xunit;
+
+namespace OperationsExampleTests
+{
+    public class GetRelationshipTests : Fixture, IDisposable
+    {
+        private readonly Faker _faker = new Faker();
+
+        [Fact]
+        public async Task Can_Get_Article_Author()
+        {
+            // arrange
+            var context = GetService<AppDbContext>();
+            var author = AuthorFactory.Get();
+            var article = ArticleFactory.Get();
+            article.Author = author;
+            context.Articles.Add(article);
+            context.SaveChanges();
+
+            var content = new
+            {
+                operations = new[] {
+                    new Dictionary<string, object> {
+                        { "op", "get"},
+                        { "ref",  new { type = "articles", id = article.StringId, relationship = nameof(article.Author) } }
+                    }
+                }
+            };
+
+            // act
+            var (response, data) = await PatchAsync<OperationsDocument>("api/bulk", content);
+
+            // assert
+            Assert.NotNull(response);
+            Assert.NotNull(data);
+            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+            Assert.Equal(1, data.Operations.Count);
+            var resourceObject = data.Operations.Single().DataObject;
+            Assert.Equal(author.Id.ToString(), resourceObject.Id);
+            Assert.Equal("authors", resourceObject.Type);
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,6 @@`
`1`		`-using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Text;`
`4`		`-`
`5`	`1`	`namespace JsonApiDotNetCore.Builders`
`6`	`2`	`{`
`7`		`- public struct DocumentBuilderOptions`
	`3`	`+ public struct DocumentBuilderOptions`
`8`	`4`	`{`
`9`	`5`	`public DocumentBuilderOptions(bool omitNullValuedAttributes = false)`
`10`	`6`	`{`