Renamed ResourceContext to ResourceType and exposed it through relationship left/right. This enabled to reduce many resource graph lookups from the codebase.

Author: Bart Koelman

benchmarks/Deserialization/DeserializationBenchmarkBase.cs

@@ -37,14 +37,14 @@ protected DeserializationBenchmarkBase()
             var targetedFields = new TargetedFields();
 
             var resourceIdentifierObjectAdapter = new ResourceIdentifierObjectAdapter(resourceGraph, resourceFactory);
-            var relationshipDataAdapter = new RelationshipDataAdapter(resourceGraph, resourceIdentifierObjectAdapter);
+            var relationshipDataAdapter = new RelationshipDataAdapter(resourceIdentifierObjectAdapter);
             var resourceObjectAdapter = new ResourceObjectAdapter(resourceGraph, resourceFactory, options, relationshipDataAdapter);
             var resourceDataAdapter = new ResourceDataAdapter(resourceDefinitionAccessor, resourceObjectAdapter);
 
             var atomicReferenceAdapter = new AtomicReferenceAdapter(resourceGraph, resourceFactory);
             var atomicOperationResourceDataAdapter = new ResourceDataInOperationsRequestAdapter(resourceDefinitionAccessor, resourceObjectAdapter);
 
-            var atomicOperationObjectAdapter = new AtomicOperationObjectAdapter(resourceGraph, options, atomicReferenceAdapter,
+            var atomicOperationObjectAdapter = new AtomicOperationObjectAdapter(options, atomicReferenceAdapter,
                 atomicOperationResourceDataAdapter, relationshipDataAdapter);
 
             var resourceDocumentAdapter = new DocumentInResourceOrRelationshipRequestAdapter(options, resourceDataAdapter, relationshipDataAdapter);

benchmarks/Deserialization/ResourceDeserializationBenchmarks.cs

@@ -143,7 +143,7 @@ protected override JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGr
             return new()
             {
                 Kind = EndpointKind.Primary,
-                PrimaryResource = resourceGraph.GetResourceContext<ResourceA>(),
+                PrimaryResourceType = resourceGraph.GetResourceType<ResourceA>(),
                 WriteOperation = WriteOperationKind.CreateResource
             };
         }

benchmarks/Query/QueryParserBenchmarks.cs

@@ -36,7 +36,7 @@ public QueryParserBenchmarks()
 
             var request = new JsonApiRequest
             {
-                PrimaryResource = resourceGraph.GetResourceContext(typeof(BenchmarkResource)),
+                PrimaryResourceType = resourceGraph.GetResourceType(typeof(BenchmarkResource)),
                 IsCollection = true
             };
 

benchmarks/Serialization/OperationsSerializationBenchmarks.cs

@@ -122,10 +122,10 @@ public string SerializeOperationsResponse()
 
         protected override JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGraph)
         {
-            return new JsonApiRequest
+            return new()
             {
                 Kind = EndpointKind.AtomicOperations,
-                PrimaryResource = resourceGraph.GetResourceContext<ResourceA>()
+                PrimaryResourceType = resourceGraph.GetResourceType<ResourceA>()
             };
         }
 

benchmarks/Serialization/ResourceSerializationBenchmarks.cs

@@ -113,21 +113,21 @@ public string SerializeResourceResponse()
 
         protected override JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGraph)
         {
-            return new JsonApiRequest
+            return new()
             {
                 Kind = EndpointKind.Primary,
-                PrimaryResource = resourceGraph.GetResourceContext<ResourceA>()
+                PrimaryResourceType = resourceGraph.GetResourceType<ResourceA>()
             };
         }
 
         protected override IEvaluatedIncludeCache CreateEvaluatedIncludeCache(IResourceGraph resourceGraph)
         {
-            ResourceContext resourceContext = resourceGraph.GetResourceContext<ResourceA>();
+            ResourceType resourceAType = resourceGraph.GetResourceType<ResourceA>();
 
-            RelationshipAttribute single2 = resourceContext.GetRelationshipByPropertyName(nameof(ResourceA.Single2));
-            RelationshipAttribute single3 = resourceContext.GetRelationshipByPropertyName(nameof(ResourceA.Single3));
-            RelationshipAttribute multi4 = resourceContext.GetRelationshipByPropertyName(nameof(ResourceA.Multi4));
-            RelationshipAttribute multi5 = resourceContext.GetRelationshipByPropertyName(nameof(ResourceA.Multi5));
+            RelationshipAttribute single2 = resourceAType.GetRelationshipByPropertyName(nameof(ResourceA.Single2));
+            RelationshipAttribute single3 = resourceAType.GetRelationshipByPropertyName(nameof(ResourceA.Single3));
+            RelationshipAttribute multi4 = resourceAType.GetRelationshipByPropertyName(nameof(ResourceA.Multi4));
+            RelationshipAttribute multi5 = resourceAType.GetRelationshipByPropertyName(nameof(ResourceA.Multi5));
 
             ImmutableArray<ResourceFieldAttribute> chain = ArrayFactory.Create<ResourceFieldAttribute>(single2, single3, multi4, multi5).ToImmutableArray();
             IEnumerable<ResourceFieldChainExpression> chains = new ResourceFieldChainExpression(chain).AsEnumerable();

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -55,8 +55,8 @@ protected SerializationBenchmarkBase()
             var sparseFieldSetCache = new SparseFieldSetCache(constraintProviders, resourceDefinitionAccessor);
             var requestQueryStringAccessor = new FakeRequestQueryStringAccessor();
 
-            ResponseModelAdapter = new ResponseModelAdapter(request, options, ResourceGraph, linkBuilder, metaBuilder, resourceDefinitionAccessor,
-                evaluatedIncludeCache, sparseFieldSetCache, requestQueryStringAccessor);
+            ResponseModelAdapter = new ResponseModelAdapter(request, options, linkBuilder, metaBuilder, resourceDefinitionAccessor, evaluatedIncludeCache,
+                sparseFieldSetCache, requestQueryStringAccessor);
         }
 
         protected abstract JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGraph);
@@ -129,37 +129,37 @@ public sealed class ResourceA : Identifiable
 
         private sealed class FakeResourceDefinitionAccessor : IResourceDefinitionAccessor
         {
-            public IImmutableSet<IncludeElementExpression> OnApplyIncludes(Type resourceType, IImmutableSet<IncludeElementExpression> existingIncludes)
+            public IImmutableSet<IncludeElementExpression> OnApplyIncludes(ResourceType resourceType, IImmutableSet<IncludeElementExpression> existingIncludes)
             {
                 return existingIncludes;
             }
 
-            public FilterExpression OnApplyFilter(Type resourceType, FilterExpression existingFilter)
+            public FilterExpression OnApplyFilter(ResourceType resourceType, FilterExpression existingFilter)
             {
                 return existingFilter;
             }
 
-            public SortExpression OnApplySort(Type resourceType, SortExpression existingSort)
+            public SortExpression OnApplySort(ResourceType resourceType, SortExpression existingSort)
             {
                 return existingSort;
             }
 
-            public PaginationExpression OnApplyPagination(Type resourceType, PaginationExpression existingPagination)
+            public PaginationExpression OnApplyPagination(ResourceType resourceType, PaginationExpression existingPagination)
             {
                 return existingPagination;
             }
 
-            public SparseFieldSetExpression OnApplySparseFieldSet(Type resourceType, SparseFieldSetExpression existingSparseFieldSet)
+            public SparseFieldSetExpression OnApplySparseFieldSet(ResourceType resourceType, SparseFieldSetExpression existingSparseFieldSet)
             {
                 return existingSparseFieldSet;
             }
 
-            public object GetQueryableHandlerForQueryStringParameter(Type resourceType, string parameterName)
+            public object GetQueryableHandlerForQueryStringParameter(Type resourceClrType, string parameterName)
             {
                 return null;
             }
 
-            public IDictionary<string, object> GetMeta(Type resourceType, IIdentifiable resourceInstance)
+            public IDictionary<string, object> GetMeta(ResourceType resourceType, IIdentifiable resourceInstance)
             {
                 return null;
             }
@@ -223,23 +223,23 @@ private sealed class FakeLinkBuilder : ILinkBuilder
         {
             public TopLevelLinks GetTopLevelLinks()
             {
-                return new TopLevelLinks
+                return new()
                 {
                     Self = "TopLevel:Self"
                 };
             }
 
-            public ResourceLinks GetResourceLinks(string resourceName, string id)
+            public ResourceLinks GetResourceLinks(ResourceType resourceType, string id)
             {
-                return new ResourceLinks
+                return new()
                 {
                     Self = "Resource:Self"
                 };
             }
 
             public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
             {
-                return new RelationshipLinks
+                return new()
                 {
                     Self = "Relationship:Self",
                     Related = "Relationship:Related"

docs/getting-started/step-by-step.md

@@ -114,18 +114,18 @@ public void Configure(IApplicationBuilder app)
 One way to seed the database is in your Configure method:
 
 ```c#
-public void Configure(IApplicationBuilder app, AppDbContext context)
+public void Configure(IApplicationBuilder app, AppDbContext dbContext)
 {
-    context.Database.EnsureCreated();
+    dbContext.Database.EnsureCreated();
 
-    if (!context.People.Any())
+    if (!dbContext.People.Any())
     {
-        context.People.Add(new Person
+        dbContext.People.Add(new Person
         {
             Name = "John Doe"
         });
 
-        context.SaveChanges();
+        dbContext.SaveChanges();
     }
 
     app.UseRouting();

docs/usage/extensibility/repositories.md

@@ -39,12 +39,12 @@ public class ArticleRepository : EntityFrameworkCoreRepository<Article>
     private readonly IAuthenticationService _authenticationService;
 
     public ArticleRepository(IAuthenticationService authenticationService,
-        ITargetedFields targetedFields, IDbContextResolver contextResolver,
+        ITargetedFields targetedFields, IDbContextResolver dbContextResolver,
         IResourceGraph resourceGraph, IGenericServiceFactory genericServiceFactory,
         IResourceFactory resourceFactory,
         IEnumerable<IQueryConstraintProvider> constraintProviders,
         ILoggerFactory loggerFactory)
-        : base(targetedFields, contextResolver, resourceGraph, genericServiceFactory,
+        : base(targetedFields, dbContextResolver, resourceGraph, genericServiceFactory,
             resourceFactory, constraintProviders, loggerFactory) 
     {
         _authenticationService = authenticationService;
@@ -68,13 +68,13 @@ public class DbContextARepository<TResource> : EntityFrameworkCoreRepository<TRe
     where TResource : class, IIdentifiable<int>
 {
     public DbContextARepository(ITargetedFields targetedFields,
-        DbContextResolver<DbContextA> contextResolver,
+        DbContextResolver<DbContextA> dbContextResolver,
     //  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
         IResourceGraph resourceGraph, IGenericServiceFactory genericServiceFactory,
         IResourceFactory resourceFactory,
         IEnumerable<IQueryConstraintProvider> constraintProviders,
         ILoggerFactory loggerFactory)
-        : base(targetedFields, contextResolver, resourceGraph, genericServiceFactory,
+        : base(targetedFields, dbContextResolver, resourceGraph, genericServiceFactory,
             resourceFactory, constraintProviders, loggerFactory)
     {
     }

docs/usage/extensibility/resource-definitions.md

@@ -172,11 +172,8 @@ public class AccountDefinition : JsonApiResourceDefinition<Account>
 
     public override FilterExpression OnApplyFilter(FilterExpression existingFilter)
     {
-        var resourceContext = ResourceGraph.GetResourceContext<Account>();
-
-        var isSuspendedAttribute =
-            resourceContext.Attributes.Single(account =>
-                account.Property.Name == nameof(Account.IsSuspended));
+        var isSuspendedAttribute = ResourceType.Attributes.Single(account =>
+            account.Property.Name == nameof(Account.IsSuspended));
 
         var isNotSuspended = new ComparisonExpression(ComparisonOperator.Equals,
             new ResourceFieldChainExpression(isSuspendedAttribute),

src/Examples/GettingStarted/Startup.cs

@@ -26,22 +26,22 @@ public void ConfigureServices(IServiceCollection services)
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
         [UsedImplicitly]
-        public void Configure(IApplicationBuilder app, SampleDbContext context)
+        public void Configure(IApplicationBuilder app, SampleDbContext dbContext)
         {
-            context.Database.EnsureDeleted();
-            context.Database.EnsureCreated();
-            CreateSampleData(context);
+            dbContext.Database.EnsureDeleted();
+            dbContext.Database.EnsureCreated();
+            CreateSampleData(dbContext);
 
             app.UseRouting();
             app.UseJsonApi();
             app.UseEndpoints(endpoints => endpoints.MapControllers());
         }
 
-        private static void CreateSampleData(SampleDbContext context)
+        private static void CreateSampleData(SampleDbContext dbContext)
         {
             // Note: The generate-examples.ps1 script (to create example requests in documentation) depends on these.
 
-            context.Books.AddRange(new Book
+            dbContext.Books.AddRange(new Book
             {
                 Title = "Frankenstein",
                 PublishYear = 1818,
@@ -67,7 +67,7 @@ private static void CreateSampleData(SampleDbContext context)
                 }
             });
 
-            context.SaveChanges();
+            dbContext.SaveChanges();
         }
     }
 }

src/Examples/MultiDbContextExample/Repositories/DbContextARepository.cs

@@ -13,10 +13,10 @@ namespace MultiDbContextExample.Repositories
     public sealed class DbContextARepository<TResource> : EntityFrameworkCoreRepository<TResource>
         where TResource : class, IIdentifiable<int>
     {
-        public DbContextARepository(ITargetedFields targetedFields, DbContextResolver<DbContextA> contextResolver, IResourceGraph resourceGraph,
+        public DbContextARepository(ITargetedFields targetedFields, DbContextResolver<DbContextA> dbContextResolver, IResourceGraph resourceGraph,
             IResourceFactory resourceFactory, IEnumerable<IQueryConstraintProvider> constraintProviders, ILoggerFactory loggerFactory,
             IResourceDefinitionAccessor resourceDefinitionAccessor)
-            : base(targetedFields, contextResolver, resourceGraph, resourceFactory, constraintProviders, loggerFactory, resourceDefinitionAccessor)
+            : base(targetedFields, dbContextResolver, resourceGraph, resourceFactory, constraintProviders, loggerFactory, resourceDefinitionAccessor)
         {
         }
     }

src/Examples/MultiDbContextExample/Repositories/DbContextBRepository.cs

@@ -13,10 +13,10 @@ namespace MultiDbContextExample.Repositories
     public sealed class DbContextBRepository<TResource> : EntityFrameworkCoreRepository<TResource>
         where TResource : class, IIdentifiable<int>
     {
-        public DbContextBRepository(ITargetedFields targetedFields, DbContextResolver<DbContextB> contextResolver, IResourceGraph resourceGraph,
+        public DbContextBRepository(ITargetedFields targetedFields, DbContextResolver<DbContextB> dbContextResolver, IResourceGraph resourceGraph,
             IResourceFactory resourceFactory, IEnumerable<IQueryConstraintProvider> constraintProviders, ILoggerFactory loggerFactory,
             IResourceDefinitionAccessor resourceDefinitionAccessor)
-            : base(targetedFields, contextResolver, resourceGraph, resourceFactory, constraintProviders, loggerFactory, resourceDefinitionAccessor)
+            : base(targetedFields, dbContextResolver, resourceGraph, resourceFactory, constraintProviders, loggerFactory, resourceDefinitionAccessor)
         {
         }
     }

src/Examples/NoEntityFrameworkExample/Startup.cs

@@ -34,9 +34,9 @@ public void ConfigureServices(IServiceCollection services)
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
         [UsedImplicitly]
-        public void Configure(IApplicationBuilder app, AppDbContext context)
+        public void Configure(IApplicationBuilder app, AppDbContext dbContext)
         {
-            context.Database.EnsureCreated();
+            dbContext.Database.EnsureCreated();
 
             app.UseRouting();
             app.UseJsonApi();

src/JsonApiDotNetCore/AtomicOperations/LocalIdValidator.cs

@@ -59,7 +59,7 @@ private void ValidateOperation(OperationContainer operation)
         {
             if (operation.Request.WriteOperation == WriteOperationKind.CreateResource)
             {
-                DeclareLocalId(operation.Resource);
+                DeclareLocalId(operation.Resource, operation.Request.PrimaryResourceType);
             }
             else
             {
@@ -73,34 +73,32 @@ private void ValidateOperation(OperationContainer operation)
 
             if (operation.Request.WriteOperation == WriteOperationKind.CreateResource)
             {
-                AssignLocalId(operation);
+                AssignLocalId(operation, operation.Request.PrimaryResourceType);
             }
         }
 
-        private void DeclareLocalId(IIdentifiable resource)
+        private void DeclareLocalId(IIdentifiable resource, ResourceType resourceType)
         {
             if (resource.LocalId != null)
             {
-                ResourceContext resourceContext = _resourceGraph.GetResourceContext(resource.GetType());
-                _localIdTracker.Declare(resource.LocalId, resourceContext.PublicName);
+                _localIdTracker.Declare(resource.LocalId, resourceType.PublicName);
             }
         }
 
-        private void AssignLocalId(OperationContainer operation)
+        private void AssignLocalId(OperationContainer operation, ResourceType resourceType)
         {
             if (operation.Resource.LocalId != null)
             {
-                ResourceContext resourceContext = _resourceGraph.GetResourceContext(operation.Resource.GetType());
-                _localIdTracker.Assign(operation.Resource.LocalId, resourceContext.PublicName, "placeholder");
+                _localIdTracker.Assign(operation.Resource.LocalId, resourceType.PublicName, "placeholder");
             }
         }
 
         private void AssertLocalIdIsAssigned(IIdentifiable resource)
         {
             if (resource.LocalId != null)
             {
-                ResourceContext resourceContext = _resourceGraph.GetResourceContext(resource.GetType());
-                _localIdTracker.GetValue(resource.LocalId, resourceContext.PublicName);
+                ResourceType resourceType = _resourceGraph.GetResourceType(resource.GetType());
+                _localIdTracker.GetValue(resource.LocalId, resourceType.PublicName);
             }
         }
     }

src/JsonApiDotNetCore/AtomicOperations/OperationProcessorAccessor.cs

@@ -14,15 +14,12 @@ namespace JsonApiDotNetCore.AtomicOperations
     [PublicAPI]
     public class OperationProcessorAccessor : IOperationProcessorAccessor
     {
-        private readonly IResourceGraph _resourceGraph;
         private readonly IServiceProvider _serviceProvider;
 
-        public OperationProcessorAccessor(IResourceGraph resourceGraph, IServiceProvider serviceProvider)
+        public OperationProcessorAccessor(IServiceProvider serviceProvider)
         {
-            ArgumentGuard.NotNull(resourceGraph, nameof(resourceGraph));
             ArgumentGuard.NotNull(serviceProvider, nameof(serviceProvider));
 
-            _resourceGraph = resourceGraph;
             _serviceProvider = serviceProvider;
         }
 
@@ -38,9 +35,9 @@ public Task<OperationContainer> ProcessAsync(OperationContainer operation, Cance
         protected virtual IOperationProcessor ResolveProcessor(OperationContainer operation)
         {
             Type processorInterface = GetProcessorInterface(operation.Request.WriteOperation.GetValueOrDefault());
-            ResourceContext resourceContext = _resourceGraph.GetResourceContext(operation.Resource.GetType());
+            ResourceType resourceType = operation.Request.PrimaryResourceType;
 
-            Type processorType = processorInterface.MakeGenericType(resourceContext.ResourceType, resourceContext.IdentityType);
+            Type processorType = processorInterface.MakeGenericType(resourceType.ClrType, resourceType.IdentityClrType);
             return (IOperationProcessor)_serviceProvider.GetRequiredService(processorType);
         }