feat: remove GetEntityFromControllerName from ResourceGraph

Author: maurei

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsCustomController.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
@@ -13,26 +14,30 @@ namespace JsonApiDotNetCoreExample.Controllers
  public class TodoItemsCustomController : CustomJsonApiController<TodoItem>
  {
  public TodoItemsCustomController(
+ IJsonApiOptions options,
  IResourceService<TodoItem> resourceService,
  ILoggerFactory loggerFactory) 
- : base(resourceService, loggerFactory)
+ : base(options, resourceService, loggerFactory)
  { }
  }
 
  public class CustomJsonApiController<T>
  : CustomJsonApiController<T, int> where T : class, IIdentifiable<int>
  {
  public CustomJsonApiController(
+ IJsonApiOptions options,
  IResourceService<T, int> resourceService,
  ILoggerFactory loggerFactory)
- : base(resourceService, loggerFactory)
- { }
+ : base(options, resourceService, loggerFactory)
+ {
+ }
  }
 
  public class CustomJsonApiController<T, TId>
  : ControllerBase where T : class, IIdentifiable<TId>
  {
  private readonly ILogger _logger;
+ private readonly IJsonApiOptions _options;
  private readonly IResourceService<T, TId> _resourceService;
 
  protected IActionResult Forbidden()
@@ -41,11 +46,13 @@ protected IActionResult Forbidden()
  }
 
  public CustomJsonApiController(
+ IJsonApiOptions options,
  IResourceService<T, TId> resourceService,
  ILoggerFactory loggerFactory)
  {
+ _options = options;
  _resourceService = resourceService;
- _logger = loggerFactory.CreateLogger<JsonApiDotNetCore.Controllers.JsonApiController<T, TId>>();
+ _logger = loggerFactory.CreateLogger<JsonApiController<T, TId>>();
  }
 
  public CustomJsonApiController(
@@ -95,8 +102,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 (_options.AllowClientGeneratedIds && !string.IsNullOrEmpty(entity.StringId))
+ return Forbidden();
 
  entity = await _resourceService.CreateAsync(entity);
 

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -121,7 +121,9 @@ private static void ConfigureMvc(IServiceCollection services, IMvcCoreBuilder mv
  // register services that allow user to override behaviour that is configured on startup, like routing conventions
  AddStartupConfigurationServices(services, options);
  var intermediateProvider = services.BuildServiceProvider();
- mvcBuilder.AddMvcOptions(opt => opt.Conventions.Insert(0, intermediateProvider.GetRequiredService<IJsonApiRoutingConvention>()));
+ var routingConvention = intermediateProvider.GetRequiredService<IJsonApiRoutingConvention>();
+ mvcBuilder.AddMvcOptions(opt => opt.Conventions.Insert(0, routingConvention));
+ services.AddSingleton(routingConvention);
  }
 
  private static void AddMvcOptions(MvcOptions options, JsonApiOptions config)

src/JsonApiDotNetCore/Internal/Contracts/IResourceGraph.cs

@@ -16,7 +16,5 @@ public interface IResourceGraph : IContextEntityProvider
  /// Was built against an EntityFrameworkCore DbContext ?
  /// </summary>
  bool UsesDbContext { get; }
-
- ContextEntity GetEntityFromControllerName(string pathParsed);
  }
 }

src/JsonApiDotNetCore/Internal/DefaultRoutingConvention.cs

@@ -6,7 +6,10 @@
 using System.Reflection;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Graph;
+using JsonApiDotNetCore.Models;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ApplicationModels;
 
 namespace JsonApiDotNetCore.Internal
@@ -37,17 +40,29 @@ public class DefaultRoutingConvention : IJsonApiRoutingConvention
  private readonly string _namespace;
  private readonly IResourceNameFormatter _formatter;
  private readonly HashSet<string> _registeredTemplates = new HashSet<string>();
+ private readonly Dictionary<string, Type> _registeredResources = new Dictionary<string, Type>();
  public DefaultRoutingConvention(IJsonApiOptions options, IResourceNameFormatter formatter)
  {
  _namespace = options.Namespace;
  _formatter = formatter;
  }
 
+ /// <inheritdoc/>
+ public Type GetAssociatedResource(string controllerName)
+ {
+ _registeredResources.TryGetValue(controllerName, out Type type);
+ return type;
+ }
+
  /// <inheritdoc/>
  public void Apply(ApplicationModel application)
  {
  foreach (var controller in application.Controllers)
  {
+ var resourceType = GetResourceTypeFromController(controller.ControllerType);
+ if (resourceType != null)
+ _registeredResources.Add(controller.ControllerName, resourceType);
+
  if (RoutingConventionDisabled(controller) == false)
  continue;
 
@@ -74,12 +89,12 @@ private bool RoutingConventionDisabled(ControllerModel controller)
  /// </summary>
  private string TemplateFromResource(ControllerModel model)
  {
- var resourceType = GetResourceTypeFromController(model.ControllerType);
- if (resourceType != null)
+ if (_registeredResources.TryGetValue(model.ControllerName, out Type resourceType))
  {
  var template = $"{_namespace}/{_formatter.FormatResourceName(resourceType)}";
- if (_registeredTemplates.Add(template))
+ if (_registeredTemplates.Add(template)) 
  return template;
+
  }
  return null;
  }
@@ -100,12 +115,30 @@ private string TemplateFromController(ControllerModel model)
  /// </summary>
  private Type GetResourceTypeFromController(Type type)
  {
+ var controllerBase = typeof(ControllerBase);
+ var jsonApiMixin = typeof(JsonApiControllerMixin);
  var target = typeof(BaseJsonApiController<,>);
- var currentBaseType = type.BaseType;
+ var identifiable = typeof(IIdentifiable);
+ var currentBaseType = type;
+ if (type.Name.Contains("TodoItemsCustom"))
+ {
+ var x = 123;
+ }
+ 
  while (!currentBaseType.IsGenericType || currentBaseType.GetGenericTypeDefinition() != target)
  {
- currentBaseType = currentBaseType.BaseType;
- if (currentBaseType == null) break;
+ var nextBaseType = currentBaseType.BaseType;
+
+ if ( (nextBaseType == controllerBase || nextBaseType == jsonApiMixin) && currentBaseType.IsGenericType)
+ {
+ var potentialResource = currentBaseType.GetGenericArguments().FirstOrDefault(t => t.Inherits(identifiable));
+ if (potentialResource != null)
+ return potentialResource;
+ }
+
+ currentBaseType = nextBaseType;
+ if (nextBaseType == null)
+ break;
  }
  return currentBaseType?.GetGenericArguments().First();
  }

src/JsonApiDotNetCore/Internal/IJsonApiRoutingConvention.cs

@@ -1,10 +1,14 @@
-using Microsoft.AspNetCore.Mvc.ApplicationModels;
+using System;
+using Microsoft.AspNetCore.Mvc.ApplicationModels;
 
 namespace JsonApiDotNetCore.Internal
 {
  /// <summary>
  /// Service for specifying which routing convention to use. This can be overriden to customize
  /// the relation between controllers and mapped routes.
  /// </summary>
- public interface IJsonApiRoutingConvention : IApplicationModelConvention { }
+ public interface IJsonApiRoutingConvention : IApplicationModelConvention
+ {
+ Type GetAssociatedResource(string controllerName);
+ }
 }

src/JsonApiDotNetCore/Internal/ResourceGraph.cs

@@ -35,10 +35,6 @@ public ResourceGraph(List<ContextEntity> entities, bool usesDbContext)
  Instance = this;
  }
 
- // eventually, this is the planned public constructor
- // to avoid breaking changes, we will be leaving the original constructor in place
- // until the context graph validation process is completed
- // you can track progress on this issue here: https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/170
  internal ResourceGraph(List<ContextEntity> entities, bool usesDbContext, List<ValidationResult> validationResults, List<ControllerResourceMap> controllerContexts)
  {
  ControllerResourceMap = controllerContexts;
@@ -57,23 +53,6 @@ public RelationshipAttribute GetInverseRelationship(RelationshipAttribute relati
  return GetContextEntity(relationship.DependentType).Relationships.SingleOrDefault(r => r.InternalRelationshipName == relationship.InverseNavigation);
  }
 
- public ContextEntity GetEntityFromControllerName(string controllerName)
- {
-
- if (ControllerResourceMap.Any()) 
- {
- // Autodiscovery was used, so there is a well defined mapping between exposed resources and their associated controllers
- var resourceType = ControllerResourceMap.FirstOrDefault(cm => cm.ControllerName == controllerName)?.Resource;
- if (resourceType == null) return null;
- return Entities.First(e => e.EntityType == resourceType);
-
- } else
- {
- // No autodiscovery: try to guess contextentity from controller name.
- return Entities.FirstOrDefault(e => e.EntityName.ToLower().Replace("-", "") == controllerName.ToLower());
- }
- }
-
  /// <inheritdoc />
  public ContextEntity GetContextEntity(string entityName)
  => Entities.SingleOrDefault(e => string.Equals(e.EntityName, entityName, StringComparison.OrdinalIgnoreCase));

src/JsonApiDotNetCore/Middleware/RequestMiddleware.cs

@@ -21,22 +21,25 @@ public class CurrentRequestMiddleware
  private readonly RequestDelegate _next;
  private HttpContext _httpContext;
  private ICurrentRequest _currentRequest;
- private IResourceGraph _resourceGraph;
+ private IContextEntityProvider _contextEntityProvider;
  private IJsonApiOptions _options;
+ private IJsonApiRoutingConvention _routingConvention;
 
  public CurrentRequestMiddleware(RequestDelegate next)
  {
  _next = next;
  }
 
  public async Task Invoke(HttpContext httpContext,
+ IJsonApiRoutingConvention routingConvention,
  IJsonApiOptions options,
  ICurrentRequest currentRequest,
- IResourceGraph resourceGraph)
+ IContextEntityProvider contextEntityProvider)
  { 
  _httpContext = httpContext;
  _currentRequest = currentRequest;
- _resourceGraph = resourceGraph;
+ _routingConvention = routingConvention;
+ _contextEntityProvider = contextEntityProvider;
  _options = options;
  var requestResource = GetCurrentEntity();
  if (requestResource != null)
@@ -60,10 +63,7 @@ private string GetBasePath(string entityName)
  {
  return GetNamespaceFromPath(r.Path, entityName);
  }
- else
- {
- return $"{r.Scheme}://{r.Host}{GetNamespaceFromPath(r.Path, entityName)}";
- }
+ return $"{r.Scheme}://{r.Host}{GetNamespaceFromPath(r.Path, entityName)}";
  }
  internal static string GetNamespaceFromPath(string path, string entityName)
  {
@@ -162,15 +162,15 @@ private void FlushResponse(HttpContext context, int statusCode)
  /// <summary>
  /// Gets the current entity that we need for serialization and deserialization.
  /// </summary>
- /// <param name="context"></param>
- /// <param name="resourceGraph"></param>
  /// <returns></returns>
  private ContextEntity GetCurrentEntity()
  {
  var controllerName = (string)_httpContext.GetRouteData().Values["controller"];
+ var resourceType = _routingConvention.GetAssociatedResource(controllerName);
+ var requestResource = _contextEntityProvider.GetContextEntity(resourceType);
+ if (requestResource == null)
+ return requestResource;
  var rd = _httpContext.GetRouteData().Values;
- var requestResource = _resourceGraph.GetEntityFromControllerName(controllerName);
-
  if (rd.TryGetValue("relationshipName", out object relationshipName))
  _currentRequest.RequestRelationship = requestResource.Relationships.Single(r => r.PublicRelationshipName == (string)relationshipName);
  return requestResource;

test/UnitTests/Controllers/BaseJsonApiController_Tests.cs

@@ -146,8 +146,6 @@ public async Task PatchAsync_Calls_Service()
  const int id = 0;
  var resource = new Resource();
  var serviceMock = new Mock<IUpdateService<Resource>>();
- //_resourceGraph.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_resourceGraph.Object);
-
 
  var controller = new BaseJsonApiController<Resource>(new JsonApiOptions(), update: serviceMock.Object);
 
@@ -165,8 +163,6 @@ public async Task PatchAsync_ModelStateInvalid_ValidateModelStateDisbled()
  const int id = 0;
  var resource = new Resource();
  var serviceMock = new Mock<IUpdateService<Resource>>();
- //_resourceGraph.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_resourceGraph.Object);
-
  var controller = new BaseJsonApiController<Resource>(new JsonApiOptions(), update: serviceMock.Object);
 
  // act
@@ -218,7 +214,6 @@ public async Task PostAsync_Calls_Service()
  // arrange
  var resource = new Resource();
  var serviceMock = new Mock<ICreateService<Resource>>();
- // _resourceGraph.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_resourceGraph.Object);
 
  var controller = new BaseJsonApiController<Resource>(new JsonApiOptions(), create: serviceMock.Object);
  serviceMock.Setup(m => m.CreateAsync(It.IsAny<Resource>())).ReturnsAsync(resource);