Feat/serializer context decoupling (#558)

* feat: started work on decoupling * feat: add total record count * feat: green tests, new managers * feat: changed startup * feat: most annoying commit of my life, rewriting dozens of controllers * feat: rename: QueryManager -> RequestManager, deeper seperation of concerns, 12 tests running... * feat: removed JsonApiContext dependency from controller, fixed namespaced tests * feat: decoupled controllers * chore: renamed resourcegraphbuilder, took out some extensions, made benchmarks work again * feat: json api context decoupling mroe and more * chore: readded solutions * feat: upgrading to 2.2, setting contextentity in middleware * fix: removed outdated authorization test * fix: requestmeta tests * fix: some acceptance tests * fix: pagination * fix: total records in meta * feat: introduced JsonApiActionFilter * fix: more tests * feat: decoupled deserializer and serializer * chore: remove / cleanup old serializers * chore: remove operation services * tests: unit tests client/server (de)serializers * chore: various edits to run tests * fix: rm dasherized resolver * chore: remove JsonApiContext and corresponding interface * chore: reorganize namespaces * chore: rm old tests * chore: rm unused document builder * chore: add comments to deserialization classes * chore: add comments * chore: rm IJsonApiContext from sort attr instantiation * feat: (re)introduced omit null value behaviour (and now omit default value behaviour too) using a serializer options provider * chore: remove more jsonapicontext references * chore: minor renames, add wiki for serialization * chore: improve wiki * chore: wiki * chore: wiki * chore: add a bunch of comments, renamed a few services * chore: wired up nested sparse field selection * chore: wired up omit behaviour * chore: prettied some comments * chore: remove (almost) all references to jsonapicontext in unit tests project * chore: removed last bits of jsonapicontext * fix: tests serialization passing again * chore: rename included query service to include query service * chore: improve comment * chore: improve comment * chore: delete jsonapicontext tests * chore: remove space * test: email config * chore: rename client / server (de)serializer to request/response (de)serializer * chore: rename client / server (de)serializer to request/response (de)serializer * feat: introduce IQueryParameter * chore: move request/response (de)serializer to client/server namespace for easier future isolation * chore: update namespaces * chore: rm textfile * chore: fixing failing unit tests * chore: rename query services, adjustment namespace * chore: reorganised test files for serialization, added relationship path serialization tests * feat: request relationship in response serializer * chore: wired up response serializer in formatter layer * feat: IGetRelationshipService now returns TResource instead of object, which decouples it from serializers requirements * fix: support for serving document of resource type different from request resource, as required by resourceservice.getrelationships() * chore: simplified linkbuilders * chore: several fixes for e2e tests * fix: various e2e tests, decoupled service layer from serialization format * fix: inclusion edgecase * chore: fix error formatting tests * chore: naming consistency sparsefield and include query services * chore: various adjustments to make e2e test project build and pass again * chore: fix build various e2e tests * chore: fix build various e2e tests * fix: e2e test Can_Include_Nested_Relationships * fix: e2e test Can_Patch_Entity * fix: e2e test Patch_Entity_With_HasMany_Does_Not_Include_Relationships * fix: e2e test Can_Create_Entity_With_Client_Defined_Id_If_Configured * chore: rename base document parser and builder * fix: e2e test Can_Create_Guid_Identifiable_Entity_With_Client_Defined_Id_If_Configured * fix: unit tests various * feat: reorganisation inheritance serialization layer * fix: unit tests after inheritance update * fix: wire up correct resource object builder implementation in serializers * fix: e2e remaining CreatingDataTests * chore: refactor creatingdata tests * fix: e2e test paging * fix: e2e controller tests * chore: wiring up new resource object builders to dependency graph * chore: response resource object builder unit test, restored repo and resourcedef unit tests * chore: finishing touches comments serialization * Feat/serialization wiki (#561) * docs: add decoupling architecture, wiki folder * docs: add v4 wiki * chore: restructure of intro * chore: v4

Author: maurei

benchmarks/Program.cs

@@ -9,7 +9,7 @@ namespace Benchmarks {
  class Program {
  static void Main(string[] args) {
  var switcher = new BenchmarkSwitcher(new[] {
- typeof(JsonApiDeserializer_Benchmarks),
+ typeof(JsonApideserializer_Benchmarks),
  //typeof(JsonApiSerializer_Benchmarks),
  typeof(QueryParser_Benchmarks),
  typeof(LinkBuilder_GetNamespaceFromPath_Benchmarks),

benchmarks/Query/QueryParser_Benchmarks.cs

@@ -22,8 +22,8 @@ public class QueryParser_Benchmarks {
  private const string DESCENDING_SORT = "-" + ATTRIBUTE;
 
  public QueryParser_Benchmarks() {
- var requestMock = new Mock<IRequestManager>();
- requestMock.Setup(m => m.GetContextEntity()).Returns(new ContextEntity {
+ var requestMock = new Mock<IRequestContext>();
+ requestMock.Setup(m => m.GetRequestResource()).Returns(new ContextEntity {
  Attributes = new List<AttrAttribute> {
  new AttrAttribute(ATTRIBUTE, ATTRIBUTE)
  }
@@ -59,8 +59,8 @@ private void Run(int iterations, Action action) {
  // this facade allows us to expose and micro-benchmark protected methods
  private class BenchmarkFacade : QueryParser {
  public BenchmarkFacade(
- IRequestManager requestManager,
- JsonApiOptions options) : base(requestManager, options) { }
+ IRequestContext currentRequest,
+ JsonApiOptions options) : base(currentRequest, options) { }
 
  public void _ParseSortParameters(string value) => base.ParseSortParameters(value);
  }

benchmarks/Serialization/JsonApiDeserializer_Benchmarks.cs

@@ -7,6 +7,8 @@
 using JsonApiDotNetCore.Managers.Contracts;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Serialization;
+using JsonApiDotNetCore.Serialization.Contracts;
+
 using JsonApiDotNetCore.Services;
 using Moq;
 using Newtonsoft.Json;
@@ -15,7 +17,7 @@
 namespace Benchmarks.Serialization
 {
  [MarkdownExporter]
- public class JsonApiDeserializer_Benchmarks {
+ public class JsonApideserializer_Benchmarks {
  private const string TYPE_NAME = "simple-types";
  private static readonly string Content = JsonConvert.SerializeObject(new Document {
  Data = new ResourceObject {
@@ -30,15 +32,15 @@ public class JsonApiDeserializer_Benchmarks {
  }
  });
 
- private readonly JsonApiDeSerializer _jsonApiDeSerializer;
+ private readonly JsonApideserializer _jsonApideserializer;
 
- public JsonApiDeserializer_Benchmarks() {
+ public JsonApideserializer_Benchmarks() {
  var resourceGraphBuilder = new ResourceGraphBuilder();
  resourceGraphBuilder.AddResource<SimpleType>(TYPE_NAME);
  var resourceGraph = resourceGraphBuilder.Build();
- var requestManagerMock = new Mock<IRequestManager>();
+ var currentRequestMock = new Mock<IRequestContext>();
 
- requestManagerMock.Setup(m => m.GetUpdatedAttributes()).Returns(new Dictionary<AttrAttribute, object>());
+ currentRequestMock.Setup(m => m.GetUpdatedAttributes()).Returns(new Dictionary<AttrAttribute, object>());
 
  var jsonApiContextMock = new Mock<IJsonApiContext>();
  jsonApiContextMock.SetupAllProperties();
@@ -50,11 +52,11 @@ public JsonApiDeserializer_Benchmarks() {
  jsonApiContextMock.Setup(m => m.Options).Returns(jsonApiOptions);
 
 
- _jsonApiDeSerializer = new JsonApiDeSerializer(jsonApiContextMock.Object, requestManagerMock.Object);
+ _jsonApideserializer = new JsonApideserializer(jsonApiContextMock.Object, currentRequestMock.Object);
  }
 
  [Benchmark]
- public object DeserializeSimpleObject() => _jsonApiDeSerializer.Deserialize<SimpleType>(Content);
+ public object DeserializeSimpleObject() => _jsonApideserializer.Deserialize<SimpleType>(Content);
 
  private class SimpleType : Identifiable {
  [Attr("name")]

benchmarks/Serialization/JsonApiSerializer_Benchmarks.cs

@@ -6,6 +6,8 @@
 //using JsonApiDotNetCore.Internal.Generics;
 //using JsonApiDotNetCore.Models;
 //using JsonApiDotNetCore.Serialization;
+using JsonApiDotNetCore.Serialization.Contracts;
+
 //using JsonApiDotNetCore.Services;
 //using Moq;
 //using Newtonsoft.Json.Serialization;
@@ -34,7 +36,7 @@
 
 // var genericProcessorFactoryMock = new Mock<IGenericProcessorFactory>();
 
-// var documentBuilder = new DocumentBuilder(jsonApiContextMock.Object);
+// var documentBuilder = new BaseDocumentBuilder(jsonApiContextMock.Object);
 // _jsonApiSerializer = new JsonApiSerializer(jsonApiContextMock.Object, documentBuilder);
 // }
 

src/Examples/GettingStarted/Models/Article.cs

@@ -6,7 +6,6 @@ public class Article : Identifiable
  {
  [Attr]
  public string Title { get; set; }
-
  [HasOne]
  public Person Author { get; set; }
  public int AuthorId { get; set; }

src/Examples/JsonApiDotNetCoreExample/Controllers/PassportsController.cs

@@ -1,15 +1,16 @@
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
+using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
  public class PassportsController : JsonApiController<Passport>
  {
- public PassportsController(
- IJsonApiContext jsonApiContext,
- IResourceService<Passport> resourceService)
- : base(jsonApiContext, resourceService)
- { }
+ public PassportsController(IJsonApiOptions jsonApiOptions, IResourceGraph resourceGraph, IResourceService<Passport, int> resourceService, ILoggerFactory loggerFactory = null) : base(jsonApiOptions, resourceGraph, resourceService, loggerFactory)
+ {
+ }
  }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsCustomController.cs

@@ -13,21 +13,19 @@ namespace JsonApiDotNetCoreExample.Controllers
  public class TodoItemsCustomController : CustomJsonApiController<TodoItem>
  {
  public TodoItemsCustomController(
- IJsonApiContext jsonApiContext,
  IResourceService<TodoItem> resourceService,
  ILoggerFactory loggerFactory) 
- : base(jsonApiContext, resourceService, loggerFactory)
+ : base(resourceService, loggerFactory)
  { }
  }
 
  public class CustomJsonApiController<T>
  : CustomJsonApiController<T, int> where T : class, IIdentifiable<int>
  {
  public CustomJsonApiController(
- IJsonApiContext jsonApiContext,
  IResourceService<T, int> resourceService,
  ILoggerFactory loggerFactory)
- : base(jsonApiContext, resourceService, loggerFactory)
+ : base(resourceService, loggerFactory)
  { }
  }
 
@@ -36,28 +34,23 @@ public class CustomJsonApiController<T, TId>
  {
  private readonly ILogger _logger;
  private readonly IResourceService<T, TId> _resourceService;
- private readonly IJsonApiContext _jsonApiContext;
 
  protected IActionResult Forbidden()
  {
  return new StatusCodeResult(403);
  }
 
  public CustomJsonApiController(
- IJsonApiContext jsonApiContext,
  IResourceService<T, TId> resourceService,
  ILoggerFactory loggerFactory)
  {
- _jsonApiContext = jsonApiContext.ApplyContext<T>(this);
  _resourceService = resourceService;
  _logger = loggerFactory.CreateLogger<JsonApiDotNetCore.Controllers.JsonApiController<T, TId>>();
  }
 
  public CustomJsonApiController(
- IJsonApiContext jsonApiContext,
  IResourceService<T, TId> resourceService)
  {
- _jsonApiContext = jsonApiContext.ApplyContext<T>(this);
  _resourceService = resourceService;
  }
 
@@ -102,8 +95,8 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
  if (entity == null)
  return UnprocessableEntity();
 
- if (!_jsonApiContext.Options.AllowClientGeneratedIds && !string.IsNullOrEmpty(entity.StringId))
- return Forbidden();
+ //if (!_jsonApiContext.Options.AllowClientGeneratedIds && !string.IsNullOrEmpty(entity.StringId))
+ // return Forbidden();
 
  entity = await _resourceService.CreateAsync(entity);
 

src/Examples/JsonApiDotNetCoreExample/Models/Person.cs

@@ -1,7 +1,6 @@
-using System;
 using System.Collections.Generic;
 using JsonApiDotNetCore.Models;
-using JsonApiDotNetCore.Services;
+using JsonApiDotNetCore.Models.Links;
 
 namespace JsonApiDotNetCoreExample.Models
 {
@@ -11,7 +10,7 @@ public class PersonRole : Identifiable
  public Person Person { get; set; }
  }
 
- public class Person : Identifiable, IHasMeta, IIsLockable
+ public class Person : Identifiable, IIsLockable
  {
  public bool IsLocked { get; set; }
 
@@ -45,21 +44,13 @@ public class Person : Identifiable, IHasMeta, IIsLockable
  public virtual TodoItem StakeHolderTodo { get; set; }
  public virtual int? StakeHolderTodoId { get; set; }
 
- [HasOne("unincludeable-item", documentLinks: Link.All, canInclude: false)]
+ [HasOne("unincludeable-item", links: Link.All, canInclude: false)]
  public virtual TodoItem UnIncludeableItem { get; set; }
 
  public int? PassportId { get; set; }
 
  [HasOne("passport")]
  public virtual Passport Passport { get; set; }
 
- public Dictionary<string, object> GetMeta(IJsonApiContext context)
- {
- return new Dictionary<string, object> {
- { "copyright", "Copyright 2015 Example Corp." },
- { "authors", new string[] { "Jared Nance" } }
- };
- }
-
  }
 }

src/Examples/JsonApiDotNetCoreExample/Models/TodoItemCollection.cs

@@ -9,12 +9,12 @@ public class TodoItemCollection : Identifiable<Guid>
  {
  [Attr("name")]
  public string Name { get; set; }
- public int OwnerId { get; set; }
 
  [HasMany("todo-items")]
  public virtual List<TodoItem> TodoItems { get; set; }
 
  [HasOne("owner")]
  public virtual Person Owner { get; set; }
+ public int? OwnerId { get; set; }
  }
 }

src/Examples/JsonApiDotNetCoreExample/Models/User.cs

@@ -1,10 +1,11 @@
+using System;
 using JsonApiDotNetCore.Models;
 
 namespace JsonApiDotNetCoreExample.Models
 {
  public class User : Identifiable
  {
- [Attr("username")] public string Username { get; set; }
- [Attr("password")] public string Password { get; set; }
+ [Attr] public string Username { get; set; }
+ [Attr] public string Password { get; set; }
  }
 }