Cleanup of public overloads for ILoggerFactory (#674)

* Cleanup of public overloads for `ILoggerFactory`

Ensured consistent passing along of `ILoggerFactory` parameter downwards to base classes and dependencies. I ended up making them all non-optional, because it is easy to forget passing it (compiler does not warn).
Callers can still pass `null` as a value, but that should be very rare, since ASP.NET Core includes built-in logging that is automatically registered.

In the process, I added some missing namespaces in examples (types were in global namespace).

`BaseJsonApiController<T>` and `BaseJsonApiController<T, TId>`:
- Made types abstract with protected constructors, fixed related tests
- Ensure all overloads have `ILoggerFactory` parameter and its value is passed downwards
- Have overloads call each other, so that fields assignment occurs only once

`JsonApiCmdController<T>` and `JsonApiCmdController<T, TId>`, `JsonApiQueryController<T>` and `JsonApiQueryController<T, TId>`:
- Ensure all overloads have `ILoggerFactory` parameter and its value is passed downwards
- Changed `IResourceService<>` parameter into `IResourceQueryService<>` / `IResourceCmdService` (still allows to pass `IResourceService<>`, because it implements both)
- Aligned parameter names with base class

`JsonApiController<T>` and `JsonApiController<T, TId>`:
- Bugfix where loggerFactory was assigned the value `null` while passing it downwards!
- Ensure all overloads have `ILoggerFactory` parameter and its value is passed downwards

`DefaultResourceRepository<TResource>` and `DefaultResourceRepository<TResource, TId>`:
- Removed unneeded constructor overload

`DefaultExceptionFilter`:
- Added null conditional operator, because at logging time the logger is assumed to be possibly `null`.

All unit tests succeed with these changes.

* Fixed broken build after merge

* Fix broken logging configuration

After removing all custom log setup, logging started to actually work, in Kestrel Console window and VS Debug Output. Console and Debug writers are added automatically by the runtime. And levels from appsettings.json are also picked up automatically.

* Fixed: do not create logger when no factory is available.

* Revert style changes

* - Changed ILoggerFactory into a required parameter.
- Added single trace-level log message to controller, service and repository (to make sure we have no crashing tests because they incorrectly pass null).
- Removed conditional logging statement

Author: Bart Koelman

src/Examples/GettingStarted/Controllers/ArticlesController.cs

@@ -2,15 +2,17 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
 
 namespace GettingStarted
 {
     public class ArticlesController : JsonApiController<Article>
     {
         public ArticlesController(
             IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
             IResourceService<Article> resourceService)
-            : base(jsonApiOptions, resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/GettingStarted/Controllers/PeopleController.cs

@@ -2,15 +2,17 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
 
 namespace GettingStarted
 {
     public class PeopleController : JsonApiController<Person>
     {
         public PeopleController(
             IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
             IResourceService<Person> resourceService)
-          : base(jsonApiOptions, resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/GettingStarted/ResourceDefinitionExample/ModelsController.cs

@@ -1,15 +1,17 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
 
 namespace GettingStarted.ResourceDefinitionExample
 {
     public class ModelsController : JsonApiController<Model>
     {
         public ModelsController(
             IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
             IResourceService<Model> resourceService)
-          : base(jsonApiOptions, resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/ArticlesController.cs

@@ -2,15 +2,17 @@
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
+using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
     public class ArticlesController : JsonApiController<Article>
     {
         public ArticlesController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<Article> resourceService) 
-            : base(jsonApiOptions, resourceService)
+            ILoggerFactory loggerFactory,
+            IResourceService<Article> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/CamelCasedModelsController.cs

@@ -10,9 +10,9 @@ public class KebabCasedModelsController : JsonApiController<KebabCasedModel>
     {
         public KebabCasedModelsController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<KebabCasedModel> resourceService,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<KebabCasedModel> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/PassportsController.cs

@@ -8,11 +8,11 @@ namespace JsonApiDotNetCoreExample.Controllers
 {
     public class PassportsController : JsonApiController<Passport>
     {
-        public PassportsController(IJsonApiOptions jsonApiOptions,
-                                   IResourceService<Passport, int> resourceService,
-                                   ILoggerFactory loggerFactory = null)
-            : base(jsonApiOptions, resourceService, loggerFactory)
-        {
-        }
+        public PassportsController(
+            IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
+            IResourceService<Passport, int> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
+        { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/PeopleController.cs

@@ -10,9 +10,9 @@ public class PeopleController : JsonApiController<Person>
     {
         public PeopleController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<Person> resourceService,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<Person> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/PersonRolesController.cs

@@ -10,9 +10,9 @@ public class PersonRolesController : JsonApiController<PersonRole>
     {
         public PersonRolesController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<PersonRole> resourceService,
-            ILoggerFactory loggerFactory)
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<PersonRole> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/TagsController.cs

@@ -10,9 +10,9 @@ public class TagsController : JsonApiController<Tag>
     {
         public TagsController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<Tag> resourceService,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<Tag, int> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoCollectionsController.cs

@@ -4,7 +4,6 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Data;
-using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
 using Microsoft.AspNetCore.Mvc;
@@ -18,11 +17,11 @@ public class TodoCollectionsController : JsonApiController<TodoItemCollection, G
         readonly IDbContextResolver _dbResolver;
 
         public TodoCollectionsController(
-            IJsonApiOptions jsonApiOptions, 
-           IDbContextResolver contextResolver,
-           IResourceService<TodoItemCollection, Guid> resourceService,
-           ILoggerFactory loggerFactory)
-           : base(jsonApiOptions, resourceService, loggerFactory)
+            IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
+            IDbContextResolver contextResolver,
+            IResourceService<TodoItemCollection, Guid> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         {
             _dbResolver = contextResolver;
         }

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsController.cs

@@ -10,9 +10,9 @@ public class TodoItemsController : JsonApiController<TodoItem>
     {
         public TodoItemsController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<TodoItem> resourceService,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<TodoItem> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsTestController.cs

@@ -13,9 +13,9 @@ public abstract class AbstractTodoItemsController<T>
     {
         protected AbstractTodoItemsController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<T, int> service,
-            ILoggerFactory loggerFactory)
-            : base(jsonApiOptions, service, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<T, int> service)
+            : base(jsonApiOptions, loggerFactory, service)
         { }
     }
 
@@ -24,9 +24,9 @@ public class TodoItemsTestController : AbstractTodoItemsController<TodoItem>
     {
         public TodoItemsTestController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<TodoItem> service,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, service, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<TodoItem> service)
+            : base(jsonApiOptions, loggerFactory, service)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Controllers/UsersController.cs

@@ -10,19 +10,19 @@ public class UsersController : JsonApiController<User>
     {
         public UsersController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<User> resourceService,
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<User> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 
     public class SuperUsersController : JsonApiController<SuperUser>
     {
         public SuperUsersController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<SuperUser> resourceService,
-            ILoggerFactory loggerFactory)
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<SuperUser> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Services/CustomArticleService.cs

@@ -14,13 +14,15 @@ namespace JsonApiDotNetCoreExample.Services
 {
     public class CustomArticleService : DefaultResourceService<Article>
     {
-        public CustomArticleService(IEnumerable<IQueryParameterService> queryParameters,
-                                    IJsonApiOptions options,
-                                    IResourceRepository<Article, int> repository,
-                                    IResourceContextProvider provider,
-                                    IResourceHookExecutor hookExecutor = null,
-                                    ILoggerFactory loggerFactory = null)
-            : base(queryParameters, options, repository, provider, hookExecutor, loggerFactory) { }
+        public CustomArticleService(
+            IEnumerable<IQueryParameterService> queryParameters,
+            IJsonApiOptions options,
+            ILoggerFactory loggerFactory,
+            IResourceRepository<Article, int> repository,
+            IResourceContextProvider provider,
+            IResourceHookExecutor hookExecutor = null)
+            : base(queryParameters, options, loggerFactory, repository, provider, hookExecutor)
+        { }
 
         public override async Task<Article> GetAsync(int id)
         {

src/Examples/JsonApiDotNetCoreExample/Startups/NoDefaultPageSizeStartup.cs

@@ -1,6 +1,5 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Logging;
 using JsonApiDotNetCoreExample.Data;
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
@@ -18,14 +17,8 @@ public NoDefaultPageSizeStartup(IWebHostEnvironment env) : base(env) { }
 
         public override void ConfigureServices(IServiceCollection services)
         {
-            var loggerFactory = new LoggerFactory();
             var mvcBuilder = services.AddMvcCore();
             services
-                .AddSingleton<ILoggerFactory>(loggerFactory)
-                .AddLogging(builder =>
-                {
-                    builder.AddConsole();
-                })
                 .AddDbContext<AppDbContext>(options => options.UseNpgsql(GetDbConnectionString()), ServiceLifetime.Transient)
                 .AddJsonApi(options => {
                     options.Namespace = "api/v1";

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -2,12 +2,10 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Logging;
 using JsonApiDotNetCoreExample.Data;
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
 using System;
-using Microsoft.Extensions.Logging.Debug;
 
 namespace JsonApiDotNetCoreExample
 {
@@ -27,19 +25,12 @@ public Startup(IWebHostEnvironment env)
 
         public virtual void ConfigureServices(IServiceCollection services)
         {
-            var loggerFactory = new LoggerFactory();
             services
-                .AddSingleton<ILoggerFactory>(loggerFactory)
-                .AddLogging(builder =>
-                {
-                    builder.AddConsole();
-                    builder.AddConfiguration(Config.GetSection("Logging"));
-                })
                 .AddDbContext<AppDbContext>(options =>
                 {
-                    options.UseLoggerFactory(new LoggerFactory(new[] { new DebugLoggerProvider() }))
-                           .EnableSensitiveDataLogging()
-                           .UseNpgsql(GetDbConnectionString(), options => options.SetPostgresVersion(new Version(9,6)));
+                    options
+                        .EnableSensitiveDataLogging()
+                        .UseNpgsql(GetDbConnectionString(), options => options.SetPostgresVersion(new Version(9,6)));
                 }, ServiceLifetime.Transient)
                 .AddJsonApi(options =>
                 {

src/Examples/JsonApiDotNetCoreExample/appsettings.json

@@ -5,7 +5,7 @@
     "Logging": {
         "IncludeScopes": false,
         "LogLevel": {
-            "Default": "Warning",
+            "Default": "Debug",
             "System": "Warning",
             "Microsoft": "Warning",
             "Microsoft.EntityFrameworkCore": "Debug"

src/Examples/NoEntityFrameworkExample/Controllers/TodoItemsController.cs

@@ -10,9 +10,9 @@ public class TodoItemsController : JsonApiController<TodoItem>
     {
         public TodoItemsController(
             IJsonApiOptions jsonApiOptions,
-            IResourceService<TodoItem> resourceService, 
-            ILoggerFactory loggerFactory) 
-            : base(jsonApiOptions, resourceService, loggerFactory)
+            ILoggerFactory loggerFactory,
+            IResourceService<TodoItem> resourceService)
+            : base(jsonApiOptions, loggerFactory, resourceService)
         { }
     }
 }

src/Examples/NoEntityFrameworkExample/Startup.cs

@@ -4,7 +4,6 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Logging;
 using NoEntityFrameworkExample.Services;
 using Microsoft.EntityFrameworkCore;
 using NoEntityFrameworkExample.Data;
@@ -31,11 +30,7 @@ public virtual void ConfigureServices(IServiceCollection services)
         {
             // Add framework services.
             var mvcBuilder = services.AddMvcCore();
-            services.AddLogging(builder =>
-                {
-                    builder.AddConfiguration(Configuration.GetSection("Logging"));
-                    builder.AddConsole();
-                }).AddJsonApi(
+            services.AddJsonApi(
                     options => options.Namespace = "api/v1",
                     resources: resources => resources.AddResource<TodoItem>("todoItems"),
                     mvcBuilder: mvcBuilder

src/Examples/ReportsExample/Controllers/ReportsController.cs

@@ -2,18 +2,20 @@
 using Microsoft.AspNetCore.Mvc;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
-using JsonApiDotNetCore.Configuration;
-using JsonApiDotNetCore.Internal.Contracts;
-
+using JsonApiDotNetCore.Configuration;
+using Microsoft.Extensions.Logging;
+using ReportsExample.Models;
+
 namespace ReportsExample.Controllers
 {
     [Route("api/[controller]")]
     public class ReportsController : BaseJsonApiController<Report, int> 
     {
         public ReportsController(
-            IJsonApiOptions jsonApiOptions,
+            IJsonApiOptions jsonApiOptions,
+            ILoggerFactory loggerFactory,
             IGetAllService<Report> getAll)
-        : base(jsonApiOptions, getAll: getAll)
+            : base(jsonApiOptions, loggerFactory, getAll)
         { }
 
         [HttpGet]