return 404 if get by id returns null

Author: jaredcnance

src/JsonApiDotNetCore/Services/Operations/Processors/GetOpProcessor.cs

@@ -90,6 +90,14 @@ private async Task<object> GetByIdAsync(Operation operation)
         {
             var id = TypeHelper.ConvertType<TId>(operation.Ref.Id);
             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
+            // in the future it would probably be better to return a result status along with the doc to 
+            // avoid throwing exceptions on 4xx errors.
+            // consider response type (status, document)
+            if (result == null)
+                throw new JsonApiException(404, $"Could not find '{operation.Ref.Type}' record with id '{operation.Ref.Id}'");
+
             var doc = _documentBuilder.GetData(
                 _contextGraph.GetContextEntity(operation.GetResourceTypeName()),
                 result);

test/OperationsExampleTests/Get/GetByIdTests.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net;
+using System.Threading.Tasks;
+using Bogus;
+using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Models.Operations;
+using JsonApiDotNetCoreExample.Data;
+using OperationsExampleTests.Factories;
+using Xunit;
+
+namespace OperationsExampleTests
+{
+    public class GetTests : Fixture, IDisposable
+    {
+        private readonly Faker _faker = new Faker();
+
+        [Fact]
+        public async Task Can_Get_Author_By_Id()
+        {
+            // arrange
+            var context = GetService<AppDbContext>();
+            var author = AuthorFactory.Get();
+            context.Authors.Add(author);
+            context.SaveChanges();
+
+            var content = new
+            {
+                operations = new[] {
+                    new Dictionary<string, object> {
+                        { "op", "get"},
+                        { "ref",  new { type = "authors", id = author.StringId } }
+                    }
+                }
+            };
+
+            // act
+            var result = await PatchAsync<OperationsDocument>("api/bulk", content);
+
+            // assert
+            Assert.NotNull(result.response);
+            Assert.NotNull(result.data);
+            Assert.Equal(HttpStatusCode.OK, result.response.StatusCode);
+            Assert.Equal(1, result.data.Operations.Count);
+            Assert.Equal(author.Id.ToString(), result.data.Operations.Single().DataObject.Id);
+        }
+
+        [Fact]
+        public async Task Get_Author_By_Id_Returns_404_If_NotFound()
+        {
+            // arrange
+            var authorId = _faker.Random.Int(max: 0).ToString();
+
+            var content = new
+            {
+                operations = new[] {
+                    new Dictionary<string, object> {
+                        { "op", "get"},
+                        { "ref",  new { type = "authors", id = authorId } }
+                    }
+                }
+            };
+
+            // act
+            var (response, data) = await PatchAsync<ErrorCollection>("api/bulk", content);
+
+            // assert
+            Assert.NotNull(response);
+            Assert.Equal(HttpStatusCode.NotFound, response.StatusCode);
+            Assert.NotNull(data);
+            Assert.Equal(1, data.Errors.Count);
+            Assert.True(data.Errors[0].Detail.Contains("authors"), "The error detail should contain the name of the entity that could not be found.");
+            Assert.True(data.Errors[0].Detail.Contains(authorId), "The error detail should contain the entity id that could not be found");
+            Assert.True(data.Errors[0].Title.Contains("operation[0]"), "The error title should contain the operation identifier that failed");
+        }
+    }
+}

test/OperationsExampleTests/Get/GetTests.cs

@@ -11,7 +11,7 @@
 
 namespace OperationsExampleTests
 {
-    public class GetTests : Fixture, IDisposable
+    public class GetByIdTests : Fixture, IDisposable
     {
         private readonly Faker _faker = new Faker();
 
@@ -46,36 +46,6 @@ public async Task Can_Get_Authors()
             Assert.Equal(HttpStatusCode.OK, result.response.StatusCode);
             Assert.Equal(1, result.data.Operations.Count);
             Assert.Equal(expectedCount, result.data.Operations.Single().DataList.Count);
-        }
-
-        [Fact]
-        public async Task Can_Get_Author_By_Id()
-        {
-            // arrange
-            var context = GetService<AppDbContext>();
-            var author = AuthorFactory.Get();
-            context.Authors.Add(author);
-            context.SaveChanges();
-
-            var content = new
-            {
-                operations = new[] {
-                    new Dictionary<string, object> {
-                        { "op", "get"},
-                        { "ref",  new { type = "authors", id = author.StringId } }
-                    }
-                }
-            };
-
-            // act
-            var result = await PatchAsync<OperationsDocument>("api/bulk", content);
-
-            // assert
-            Assert.NotNull(result.response);
-            Assert.NotNull(result.data);
-            Assert.Equal(HttpStatusCode.OK, result.response.StatusCode);
-            Assert.Equal(1, result.data.Operations.Count);
-            Assert.Equal(author.Id.ToString(), result.data.Operations.Single().DataObject.Id);
         }
     }
 }