Scan the EF Core model for entity types (removed the requirement to expose them as DbSet properties on DbContext). Removed error on duplicates, to enable first scanning EF Core models, then add all resource definitons etc. from the assembly.

Bart Koelman · Bart Koelman · commit 26faa2dcda1c · 2020-04-29T12:41:32.000+02:00
diff --git a/src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs b/src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs
@@ -12,19 +12,17 @@ public sealed class AppDbContext : DbContext
         public DbSet<KebabCasedModel> KebabCasedModels { get; set; }
         public DbSet<Article> Articles { get; set; }
         public DbSet<Author> AuthorDifferentDbContextName { get; set; }
-        public DbSet<NonJsonApiResource> NonJsonApiResources { get; set; }
         public DbSet<User> Users { get; set; }
-        public DbSet<SuperUser> SuperUsers { get; set; }
         public DbSet<PersonRole> PersonRoles { get; set; }
         public DbSet<ArticleTag> ArticleTags { get; set; }
-        public DbSet<IdentifiableArticleTag> IdentifiableArticleTags { get; set; }
         public DbSet<Tag> Tags { get; set; }
-        public DbSet<ThrowingResource> ThrowingResources { get; set; }
 
         public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }
 
         protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
+            modelBuilder.Entity<ThrowingResource>();
+
             modelBuilder.Entity<SuperUser>().HasBaseType<User>();
 
             modelBuilder.Entity<TodoItem>()
diff --git a/src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs b/src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs
@@ -40,7 +40,7 @@ public virtual void ConfigureServices(IServiceCollection services)
                         .EnableSensitiveDataLogging()
                         .UseNpgsql(GetDbConnectionString(), innerOptions => innerOptions.SetPostgresVersion(new Version(9,6)));
                 }, ServiceLifetime.Transient)
-                .AddJsonApi(ConfigureJsonApiOptions, discovery => discovery.AddCurrentAssembly());
+                .AddJsonApi<AppDbContext>(ConfigureJsonApiOptions, discovery => discovery.AddCurrentAssembly());
             
             // once all tests have been moved to WebApplicationFactory format we can get rid of this line below
             services.AddClientSerialization();
diff --git a/src/JsonApiDotNetCore/Builders/IResourceGraphBuilder.cs b/src/JsonApiDotNetCore/Builders/IResourceGraphBuilder.cs
@@ -33,12 +33,12 @@ public interface IResourceGraphBuilder
         /// <summary>
         /// Add a Json:Api resource
         /// </summary>
-        /// <param name="entityType">The resource model type</param>
+        /// <param name="resourceType">The resource model type</param>
         /// <param name="idType">The resource model identifier type</param>
         /// <param name="pluralizedTypeName">
         /// The pluralized name that should be exposed by the API. 
         /// If nothing is specified, the configured name formatter will be used.
         /// </param>
-        IResourceGraphBuilder AddResource(Type entityType, Type idType, string pluralizedTypeName = null);
+        IResourceGraphBuilder AddResource(Type resourceType, Type idType = null, string pluralizedTypeName = null);
     }
 }
diff --git a/src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs b/src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs
@@ -1,7 +1,6 @@
 using System;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Data;
-using JsonApiDotNetCore.Extensions.EntityFrameworkCore;
 using JsonApiDotNetCore.Formatters;
 using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal;
@@ -34,7 +33,7 @@ internal sealed class JsonApiApplicationBuilder
     {
         private readonly JsonApiOptions _options = new JsonApiOptions();
         private IResourceGraphBuilder _resourceGraphBuilder;
-        private bool _usesDbContext;
+        private Type _dbContextType;
         private readonly IServiceCollection _services;
         private IServiceDiscoveryFacade _serviceDiscoveryFacade;
         private readonly IMvcCoreBuilder _mvcBuilder;
@@ -59,13 +58,17 @@ public void ConfigureJsonApiOptions(Action<JsonApiOptions> options)
         /// <see cref="IResourceGraphBuilder"/>, <see cref="IServiceDiscoveryFacade"/>, <see cref="IJsonApiExceptionFilterProvider"/>,
         /// <see cref="IJsonApiTypeMatchFilterProvider"/> and <see cref="IJsonApiRoutingConvention"/>.
         /// </summary>
-        public void ConfigureMvc()
+        public void ConfigureMvc(Type dbContextType)
         {
             RegisterJsonApiStartupServices();
 
             var intermediateProvider = _services.BuildServiceProvider();
             _resourceGraphBuilder = intermediateProvider.GetRequiredService<IResourceGraphBuilder>();
             _serviceDiscoveryFacade = intermediateProvider.GetRequiredService<IServiceDiscoveryFacade>();
+            _dbContextType = dbContextType;
+            
+            AddResourceTypesFromDbContext(intermediateProvider);
+
             var exceptionFilterProvider = intermediateProvider.GetRequiredService<IJsonApiExceptionFilterProvider>();
             var typeMatchFilterProvider = intermediateProvider.GetRequiredService<IJsonApiTypeMatchFilterProvider>();
             var routingConvention = intermediateProvider.GetRequiredService<IJsonApiRoutingConvention>();
@@ -89,6 +92,19 @@ public void ConfigureMvc()
             _services.AddSingleton<IControllerResourceMapping>(routingConvention);
         }
 
+        private void AddResourceTypesFromDbContext(ServiceProvider intermediateProvider)
+        {
+            if (_dbContextType != null)
+            {
+                var dbContext = (DbContext) intermediateProvider.GetRequiredService(_dbContextType);
+
+                foreach (var entityType in dbContext.Model.GetEntityTypes())
+                {
+                    _resourceGraphBuilder.AddResource(entityType.ClrType);
+                }
+            }
+        }
+
         /// <summary>
         /// Executes auto-discovery of JADNC services.
         /// </summary>
@@ -97,16 +113,6 @@ public void AutoDiscover(Action<IServiceDiscoveryFacade> autoDiscover)
             autoDiscover?.Invoke(_serviceDiscoveryFacade);
         }
 
-        public void ConfigureResourcesFromDbContext<TDbContext>(Action<IResourceGraphBuilder> resources)
-            where TDbContext : DbContext
-        {
-            _resourceGraphBuilder.AddDbContext<TDbContext>();
-            _usesDbContext = true;
-            _services.AddScoped<IDbContextResolver, DbContextResolver<TDbContext>>();
-
-            ConfigureResources(resources);
-        }
-
         /// <summary>
         /// Executes the action provided by the user to configure the resources using <see cref="IResourceGraphBuilder"/>
         /// </summary>
@@ -122,7 +128,12 @@ public void ConfigureServices()
         {
             var resourceGraph = _resourceGraphBuilder.Build();
 
-            if (!_usesDbContext)
+            if (_dbContextType != null)
+            {
+                var contextResolverType = typeof(DbContextResolver<>).MakeGenericType(_dbContextType);
+                _services.AddScoped(typeof(IDbContextResolver), contextResolverType);
+            }
+            else
             {
                 _services.AddScoped<DbContext>();
                 _services.AddSingleton(new DbContextOptionsBuilder().Options);
diff --git a/src/JsonApiDotNetCore/Builders/ResourceGraphBuilder.cs b/src/JsonApiDotNetCore/Builders/ResourceGraphBuilder.cs
@@ -56,22 +56,25 @@ public IResourceGraphBuilder AddResource<TResource, TId>(string pluralizedTypeNa
         /// <inheritdoc />
         public IResourceGraphBuilder AddResource(Type resourceType, Type idType = null, string pluralizedTypeName = null)
         {
-            AssertEntityIsNotAlreadyDefined(resourceType);
-            if (resourceType.Implements<IIdentifiable>())
+            if (_resources.All(e => e.ResourceType != resourceType))
             {
-                pluralizedTypeName ??= FormatResourceName(resourceType);
-                idType ??= TypeLocator.GetIdType(resourceType);
-                _resources.Add(GetEntity(pluralizedTypeName, resourceType, idType));
-            }
-            else
-            {
-                _validationResults.Add(new ValidationResult(LogLevel.Warning, $"{resourceType} does not implement 'IIdentifiable<>'. "));
+                if (resourceType.Implements<IIdentifiable>())
+                {
+                    pluralizedTypeName ??= FormatResourceName(resourceType);
+                    idType ??= TypeLocator.GetIdType(resourceType);
+                    var resourceContext = CreateResourceContext(pluralizedTypeName, resourceType, idType);
+                    _resources.Add(resourceContext);
+                }
+                else
+                {
+                    _validationResults.Add(new ValidationResult(LogLevel.Warning, $"{resourceType} does not implement '{nameof(IIdentifiable)}'. "));
+                }
             }
 
             return this;
         }
 
-        private ResourceContext GetEntity(string pluralizedTypeName, Type entityType, Type idType) => new ResourceContext
+        private ResourceContext CreateResourceContext(string pluralizedTypeName, Type entityType, Type idType) => new ResourceContext
         {
             ResourceName = pluralizedTypeName,
             ResourceType = entityType,
@@ -213,12 +216,6 @@ private static Type TypeOrElementType(Type type)
 
         private Type GetResourceDefinitionType(Type entityType) => typeof(ResourceDefinition<>).MakeGenericType(entityType);
 
-        private void AssertEntityIsNotAlreadyDefined(Type entityType)
-        {
-            if (_resources.Any(e => e.ResourceType == entityType))
-                throw new InvalidOperationException($"Cannot add entity type {entityType} to context resourceGraph, there is already an entity of that type configured.");
-        }
-
         private string FormatResourceName(Type resourceType)
         {
             var formatter = new ResourceNameFormatter(_options);
diff --git a/src/JsonApiDotNetCore/Extensions/ResourceGraphBuilderExtensions.cs b/src/JsonApiDotNetCore/Extensions/ResourceGraphBuilderExtensions.cs
diff --git a/src/JsonApiDotNetCore/Extensions/ServiceCollectionExtensions.cs b/src/JsonApiDotNetCore/Extensions/ServiceCollectionExtensions.cs
@@ -25,11 +25,7 @@ public static IServiceCollection AddJsonApi(this IServiceCollection services,
             Action<IResourceGraphBuilder> resources = null,
             IMvcCoreBuilder mvcBuilder = null)
         {
-            var applicationBuilder = SetupApplicationBuilder(services, options, discovery, mvcBuilder);
-
-            applicationBuilder.ConfigureResources(resources);
-
-            applicationBuilder.ConfigureServices();
+            SetupApplicationBuilder(services, options, discovery, resources, mvcBuilder, null);
             return services;
         }
 
@@ -43,24 +39,21 @@ public static IServiceCollection AddJsonApi<TDbContext>(this IServiceCollection
             IMvcCoreBuilder mvcBuilder = null)
             where TDbContext : DbContext
         {
-            var applicationBuilder = SetupApplicationBuilder(services, options, discovery, mvcBuilder);
-
-            applicationBuilder.ConfigureResourcesFromDbContext<TDbContext>(resources);
-            
-            applicationBuilder.ConfigureServices();
+            SetupApplicationBuilder(services, options, discovery, resources, mvcBuilder, typeof(TDbContext));
             return services;
         }
 
-        private static JsonApiApplicationBuilder SetupApplicationBuilder(IServiceCollection services, Action<JsonApiOptions> options, Action<IServiceDiscoveryFacade> discovery,
-            IMvcCoreBuilder mvcBuilder)
+        private static void SetupApplicationBuilder(IServiceCollection services, Action<JsonApiOptions> options,
+            Action<IServiceDiscoveryFacade> discovery,
+            Action<IResourceGraphBuilder> resources, IMvcCoreBuilder mvcBuilder, Type dbContextType)
         {
             var applicationBuilder = new JsonApiApplicationBuilder(services, mvcBuilder ?? services.AddMvcCore());
 
             applicationBuilder.ConfigureJsonApiOptions(options);
-            applicationBuilder.ConfigureMvc();
+            applicationBuilder.ConfigureMvc(dbContextType);
             applicationBuilder.AutoDiscover(discovery);
-
-            return applicationBuilder;
+            applicationBuilder.ConfigureResources(resources);
+            applicationBuilder.ConfigureServices();
         }
 
         /// <summary>
diff --git a/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/CreatingDataTests.cs b/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/CreatingDataTests.cs
@@ -43,7 +43,7 @@ public async Task CreateResource_ModelWithEntityFrameworkInheritance_IsCreated()
             // Assert
             AssertEqualStatusCode(HttpStatusCode.Created, response);
             var createdSuperUser = _deserializer.DeserializeSingle<SuperUser>(body).Data;
-            var first = _dbContext.SuperUsers.FirstOrDefault(e => e.Id.Equals(createdSuperUser.Id));
+            var first = _dbContext.Set<SuperUser>().FirstOrDefault(e => e.Id.Equals(createdSuperUser.Id));
             Assert.NotNull(first);
         }
 
diff --git a/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/UpdatingDataTests.cs b/test/JsonApiDotNetCoreExampleTests/Acceptance/Spec/UpdatingDataTests.cs
@@ -49,7 +49,7 @@ public async Task PatchResource_ModelWithEntityFrameworkInheritance_IsPatched()
             var dbContext = PrepareTest<Startup>();
             var serializer = GetSerializer<SuperUser>(e => new { e.SecurityLevel, e.Username, e.Password });
             var superUser = new SuperUser { SecurityLevel = 1337, Username = "Super", Password = "User", LastPasswordChange = DateTime.Now.AddMinutes(-15) };
-            dbContext.SuperUsers.Add(superUser);
+            dbContext.Set<SuperUser>().Add(superUser);
             dbContext.SaveChanges();
             var su = new SuperUser { Id = superUser.Id, SecurityLevel = 2674, Username = "Power", Password = "secret" };
             var content = serializer.Serialize(su);
diff --git a/test/UnitTests/Builders/ContextGraphBuilder_Tests.cs b/test/UnitTests/Builders/ContextGraphBuilder_Tests.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using JsonApiDotNetCore;
@@ -20,13 +21,20 @@ private sealed class DbResource : Identifiable { }
         private class TestContext : DbContext
         {
             public DbSet<DbResource> DbResources { get; set; }
+
+            protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
+            {
+                optionsBuilder.UseInMemoryDatabase(Guid.NewGuid().ToString());
+            }
         }
 
         [Fact]
         public void Can_Build_ResourceGraph_Using_Builder()
         {
             // Arrange
             var services = new ServiceCollection();
+            services.AddDbContext<TestContext>();
+            
             services.AddJsonApi<TestContext>(resources: builder => builder.AddResource<NonDbResource>("nonDbResources"));
 
             // Act
diff --git a/test/UnitTests/Extensions/IServiceCollectionExtensionsTests.cs b/test/UnitTests/Extensions/IServiceCollectionExtensionsTests.cs
@@ -19,7 +19,6 @@
 using JsonApiDotNetCore.Managers.Contracts;
 using JsonApiDotNetCore.Serialization.Server.Builders;
 using JsonApiDotNetCore.Serialization.Server;
-using JsonApiDotNetCore.Extensions.EntityFrameworkCore;
 
 namespace UnitTests.Extensions
 {
@@ -142,6 +141,7 @@ public void AddJsonApi_With_Context_Uses_Resource_Type_Name_If_NoOtherSpecified(
         {
             // Arrange
             var services = new ServiceCollection();
+            services.AddDbContext<TestContext>(options => options.UseInMemoryDatabase(Guid.NewGuid().ToString()));
 
             services.AddScoped<IScopedServiceProvider, TestScopedServiceProvider>();
 
@@ -185,6 +185,10 @@ private class GuidResourceService : IResourceService<GuidResource, Guid>
 
         public class TestContext : DbContext
         {
+            public TestContext(DbContextOptions<TestContext> options) : base(options)
+            {
+            }
+
             public DbSet<IntResource> Resource { get; set; }
         }
     }
diff --git a/test/UnitTests/Internal/ResourceGraphBuilder_Tests.cs b/test/UnitTests/Internal/ResourceGraphBuilder_Tests.cs
@@ -1,6 +1,5 @@
 using JsonApiDotNetCore.Builders;
 using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Extensions.EntityFrameworkCore;
 using JsonApiDotNetCore.Internal;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
@@ -17,8 +16,8 @@ public void AddDbContext_Does_Not_Throw_If_Context_Contains_Members_That_DoNot_I
             var resourceGraphBuilder = new ResourceGraphBuilder(new JsonApiOptions());
 
             // Act
-            resourceGraphBuilder.AddDbContext<TestContext>();
-            var resourceGraph = resourceGraphBuilder.Build() as ResourceGraph;
+            resourceGraphBuilder.AddResource(typeof(TestContext));
+            var resourceGraph = (ResourceGraph)resourceGraphBuilder.Build();
 
             // Assert
             Assert.Empty(resourceGraph.GetResourceContexts());
@@ -31,8 +30,8 @@ public void Adding_DbContext_Members_That_DoNot_Implement_IIdentifiable_Creates_
             var resourceGraphBuilder = new ResourceGraphBuilder(new JsonApiOptions());
 
             // Act
-            resourceGraphBuilder.AddDbContext<TestContext>();
-            var resourceGraph = resourceGraphBuilder.Build() as ResourceGraph;
+            resourceGraphBuilder.AddResource(typeof(TestContext));
+            var resourceGraph = (ResourceGraph)resourceGraphBuilder.Build();
 
             // Assert
             Assert.Single(resourceGraph.ValidationResults);

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public async Task CreateResource_ModelWithEntityFrameworkInheritance_IsCreated()`
`43`	`43`	`// Assert`
`44`	`44`	`AssertEqualStatusCode(HttpStatusCode.Created, response);`
`45`	`45`	`var createdSuperUser = _deserializer.DeserializeSingle<SuperUser>(body).Data;`
`46`		`- var first = _dbContext.SuperUsers.FirstOrDefault(e => e.Id.Equals(createdSuperUser.Id));`
	`46`	`+ var first = _dbContext.Set<SuperUser>().FirstOrDefault(e => e.Id.Equals(createdSuperUser.Id));`
`47`	`47`	`Assert.NotNull(first);`
`48`	`48`	`}`
`49`	`49`