Added injectable ISystemClock to AppDbContext, which is used by User resource to set LastPasswordChange

Author: Bart Koelman

benchmarks/Serialization/JsonApiDeserializerBenchmarks.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.ComponentModel.Design;
 using BenchmarkDotNet.Attributes;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Internal.Contracts;
@@ -37,7 +38,7 @@ public JsonApiDeserializerBenchmarks()
             IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
             var targetedFields = new TargetedFields();
 
-            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, targetedFields);
+            _jsonApiDeserializer = new RequestDeserializer(resourceGraph, new ServiceContainer(), targetedFields);
         }
 
         [Benchmark]

src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs

@@ -1,10 +1,14 @@
+using System;
 using JsonApiDotNetCoreExample.Models;
+using Microsoft.AspNetCore.Authentication;
 using Microsoft.EntityFrameworkCore;
 
 namespace JsonApiDotNetCoreExample.Data
 {
     public sealed class AppDbContext : DbContext
     {
+        public ISystemClock SystemClock { get; }
+
         public DbSet<TodoItem> TodoItems { get; set; }
         public DbSet<Passport> Passports { get; set; }
         public DbSet<Person> People { get; set; }
@@ -17,7 +21,10 @@ public sealed class AppDbContext : DbContext
         public DbSet<ArticleTag> ArticleTags { get; set; }
         public DbSet<Tag> Tags { get; set; }
 
-        public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }
+        public AppDbContext(DbContextOptions<AppDbContext> options, ISystemClock systemClock) : base(options)
+        {
+            SystemClock = systemClock ?? throw new ArgumentNullException(nameof(systemClock));
+        }
 
         protected override void OnModelCreating(ModelBuilder modelBuilder)
         {

src/Examples/JsonApiDotNetCoreExample/Models/User.cs

@@ -1,10 +1,13 @@
 using System;
 using JsonApiDotNetCore.Models;
+using JsonApiDotNetCoreExample.Data;
+using Microsoft.AspNetCore.Authentication;
 
 namespace JsonApiDotNetCoreExample.Models
 {
     public class User : Identifiable
     {
+        private readonly ISystemClock _systemClock;
         private string _password;
 
         [Attr] public string Username { get; set; }
@@ -18,16 +21,25 @@ public string Password
                 if (value != _password)
                 {
                     _password = value;
-                    LastPasswordChange = DateTime.Now;
+                    LastPasswordChange = _systemClock.UtcNow.LocalDateTime;
                 }
             }
         }
 
         [Attr] public DateTime LastPasswordChange { get; set; }
+
+        public User(AppDbContext appDbContext)
+        {
+            _systemClock = appDbContext.SystemClock;
+        }
     }
 
     public sealed class SuperUser : User
     {
         [Attr] public int SecurityLevel { get; set; }
+
+        public SuperUser(AppDbContext appDbContext) : base(appDbContext)
+        {
+        }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -4,12 +4,12 @@
 using Microsoft.Extensions.DependencyInjection;
 using JsonApiDotNetCoreExample.Data;
 using Microsoft.EntityFrameworkCore;
-using JsonApiDotNetCore.Extensions;
 using System;
 using JsonApiDotNetCore;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Query;
 using JsonApiDotNetCoreExample.Services;
+using Microsoft.AspNetCore.Authentication;
 using Newtonsoft.Json.Converters;
 
 namespace JsonApiDotNetCoreExample
@@ -30,6 +30,7 @@ public Startup(IWebHostEnvironment env)
 
         public virtual void ConfigureServices(IServiceCollection services)
         {
+            services.AddSingleton<ISystemClock, SystemClock>();
             services.AddScoped<SkipCacheQueryParameterService>();
             services.AddScoped<IQueryParameterService>(sp => sp.GetService<SkipCacheQueryParameterService>());
 

src/JsonApiDotNetCore/Extensions/TypeExtensions.cs

@@ -3,6 +3,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using JsonApiDotNetCore.Models;
 
 namespace JsonApiDotNetCore.Extensions
@@ -75,5 +76,12 @@ public static bool IsOrImplementsInterface(this Type source, Type interfaceType)
 
             return source == interfaceType || source.GetInterfaces().Any(type => type == interfaceType);
         }
+
+        public static bool HasSingleConstructorWithoutParameters(this Type type)
+        {
+            ConstructorInfo[] constructors = type.GetConstructors();
+
+            return constructors.Length == 1 && constructors[0].GetParameters().Length == 0;
+        }
     }
 }

src/JsonApiDotNetCore/Internal/TypeHelper.cs

@@ -6,6 +6,7 @@
 using System.Linq.Expressions;
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Models;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace JsonApiDotNetCore.Internal
 {
@@ -237,5 +238,39 @@ public static object CreateInstance(Type type)
                 throw new InvalidOperationException($"Failed to create an instance of '{type.FullName}' using its default constructor.", exception);
             }
         }
+
+        public static T CreateEntityInstance<T>(IServiceProvider serviceProvider)
+        {
+            return (T) CreateEntityInstance(typeof(T), serviceProvider);
+        }
+
+        public static object CreateEntityInstance(Type type, IServiceProvider serviceProvider)
+        {
+            if (type == null)
+            {
+                throw new ArgumentNullException(nameof(type));
+            }
+
+            if (serviceProvider == null)
+            {
+                throw new ArgumentNullException(nameof(serviceProvider));
+            }
+
+            bool hasSingleConstructorWithoutParameters = type.HasSingleConstructorWithoutParameters();
+
+            try
+            {
+                return hasSingleConstructorWithoutParameters
+                    ? Activator.CreateInstance(type)
+                    : ActivatorUtilities.CreateInstance(serviceProvider, type);
+            }
+            catch (Exception exception)
+            {
+                throw new InvalidOperationException(hasSingleConstructorWithoutParameters
+                        ? $"Failed to create an instance of '{type.FullName}' using its default constructor."
+                        : $"Failed to create an instance of '{type.FullName}' using injected constructor parameters.",
+                    exception);
+            }
+        }
     }
 }

src/JsonApiDotNetCore/Serialization/Client/ResponseDeserializer.cs

@@ -13,7 +13,7 @@ namespace JsonApiDotNetCore.Serialization.Client
     /// </summary>
     public class ResponseDeserializer : BaseDocumentParser, IResponseDeserializer
     {
-        public ResponseDeserializer(IResourceContextProvider provider) : base(provider) { }
+        public ResponseDeserializer(IResourceContextProvider contextProvider, IServiceProvider serviceProvider) : base(contextProvider, serviceProvider) { }
 
         /// <inheritdoc/>
         public DeserializedSingleResponse<TResource> DeserializeSingle<TResource>(string body) where TResource : class, IIdentifiable
@@ -87,7 +87,7 @@ private IIdentifiable ParseIncludedRelationship(RelationshipAttribute relationsh
             if (includedResource == null)
                 return relatedInstance;
 
-            var resourceContext = _provider.GetResourceContext(relatedResourceIdentifier.Type);
+            var resourceContext = _contextProvider.GetResourceContext(relatedResourceIdentifier.Type);
             if (resourceContext == null)
                 throw new InvalidOperationException($"Included type '{relationshipAttr.RightType}' is not a registered json:api resource.");
 

src/JsonApiDotNetCore/Serialization/Common/BaseDocumentParser.cs

@@ -21,12 +21,14 @@ namespace JsonApiDotNetCore.Serialization
     /// </summary>
     public abstract class BaseDocumentParser
     {
-        protected readonly IResourceContextProvider _provider;
+        protected readonly IResourceContextProvider _contextProvider;
+        private readonly IServiceProvider _serviceProvider;
         protected Document _document;
 
-        protected BaseDocumentParser(IResourceContextProvider provider)
+        protected BaseDocumentParser(IResourceContextProvider contextProvider, IServiceProvider serviceProvider)
         {
-            _provider = provider;
+            _contextProvider = contextProvider;
+            _serviceProvider = serviceProvider;
         }
 
         /// <summary>
@@ -131,7 +133,7 @@ private JToken LoadJToken(string body)
         /// <returns>The parsed entity</returns>
         private IIdentifiable ParseResourceObject(ResourceObject data)
         {
-            var resourceContext = _provider.GetResourceContext(data.Type);
+            var resourceContext = _contextProvider.GetResourceContext(data.Type);
             if (resourceContext == null)
             {
                 throw new InvalidRequestBodyException("Payload includes unknown resource type.",
@@ -140,7 +142,7 @@ private IIdentifiable ParseResourceObject(ResourceObject data)
                     "If you have manually registered the resource, check that the call to AddResource correctly sets the public name.", null);
             }
 
-            var entity = (IIdentifiable)TypeHelper.CreateInstance(resourceContext.ResourceType);
+            var entity = (IIdentifiable)TypeHelper.CreateEntityInstance(resourceContext.ResourceType, _serviceProvider);
 
             entity = SetAttributes(entity, data.Attributes, resourceContext.Attributes);
             entity = SetRelationships(entity, data.Relationships, resourceContext.Relationships);

src/JsonApiDotNetCore/Serialization/Server/RequestDeserializer.cs

@@ -11,8 +11,8 @@ public class RequestDeserializer : BaseDocumentParser, IJsonApiDeserializer
     {
         private readonly ITargetedFields  _targetedFields;
 
-        public RequestDeserializer(IResourceContextProvider provider,
-                                  ITargetedFields  targetedFields) : base(provider)
+        public RequestDeserializer(IResourceContextProvider contextProvider, IServiceProvider serviceProvider, ITargetedFields  targetedFields) 
+            : base(contextProvider, serviceProvider)
         {
             _targetedFields = targetedFields;
         }

test/IntegrationTests/Data/EntityRepositoryTests.cs

@@ -10,6 +10,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using IntegrationTests;
 using JsonApiDotNetCore.Configuration;
 using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
@@ -174,7 +175,7 @@ private AppDbContext GetContext(Guid? seed = null)
             var options = new DbContextOptionsBuilder<AppDbContext>()
                 .UseInMemoryDatabase(databaseName: $"IntegrationDatabaseRepository{actualSeed}")
                 .Options;
-            var context = new AppDbContext(options);
+            var context = new AppDbContext(options, new FrozenSystemClock());
 
             context.TodoItems.RemoveRange(context.TodoItems);
             return context;