[ODS-6390] Release v7.1-patch2 (#1077)

Co-authored-by: Jesus Flores <[email protected]>
Co-authored-by: Geoffrey McElhanon <[email protected]>

Application/EdFi.Ods.Api/Container/Modules/ApplicationModule.cs

@@ -26,6 +26,7 @@
 using EdFi.Ods.Api.Middleware;
 using EdFi.Ods.Api.Providers;
 using EdFi.Ods.Api.Security.Authentication;
+using EdFi.Ods.Api.Serialization;
 using EdFi.Ods.Api.Validation;
 using EdFi.Ods.Common;
 using EdFi.Ods.Common.Caching;
@@ -55,6 +56,7 @@
 using Microsoft.AspNetCore.Mvc.ApplicationModels;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.Extensions.Options;
+using Newtonsoft.Json.Serialization;
 using Module = Autofac.Module;
 
 namespace EdFi.Ods.Api.Container.Modules
@@ -91,6 +93,15 @@ protected override void Load(ContainerBuilder builder)
                 .As<IConfigureOptions<MvcOptions>>()
                 .SingleInstance();
 
+            builder.RegisterType<ProfilesAwareContractResolver>()
+                .WithProperty("NamingStrategy", 
+                    new CamelCaseNamingStrategy
+                    {
+                        ProcessDictionaryKeys = true,
+                        OverrideSpecifiedNames = true
+                    })
+                .SingleInstance();
+
             builder.RegisterType<VersionRouteConvention>()
                 .As<IApplicationModelConvention>()
                 .SingleInstance();

Application/EdFi.Ods.Api/Filters/EnforceAssignedProfileUsageFilter.cs

@@ -22,7 +22,7 @@
 
 namespace EdFi.Ods.Api.Filters;
 
-public class EnforceAssignedProfileUsageFilter : IAsyncActionFilter
+public class EnforceAssignedProfileUsageFilter : IAsyncResourceFilter
 {
     private readonly IApiClientContextProvider _apiClientContextProvider;
     private readonly IContextProvider<DataManagementResourceContext> _dataManagementResourceContextProvider;
@@ -49,7 +49,7 @@ public EnforceAssignedProfileUsageFilter(
         _isEnabled = apiSettings.IsFeatureEnabled("Profiles");
     }
 
-    public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
+    public async Task OnResourceExecutionAsync(ResourceExecutingContext context, ResourceExecutionDelegate next)
     {
         // If Profiles feature is not enabled, don't do any processing.
         if (!_isEnabled)

Application/EdFi.Ods.Api/Serialization/ProfilesAwareContractResolver.cs

@@ -15,6 +15,7 @@
 using EdFi.Ods.Common.Profiles;
 using EdFi.Ods.Common.Security.Claims;
 using EdFi.Ods.Common.Utils.Profiles;
+using log4net;
 using Microsoft.Extensions.Primitives;
 using Newtonsoft.Json.Serialization;
 
@@ -40,6 +41,7 @@ public class ProfilesAwareContractResolver : DefaultContractResolver
     private readonly string _resourcesNamespacePrefix = $"{Namespaces.Resources.BaseNamespace}.";
     private readonly ISchemaNameMapProvider _schemaNameMapProvider;
     private static readonly char[] _decimalAsCharArray = { '.' };
+    private readonly ILog _logger = LogManager.GetLogger(typeof(ProfilesAwareContractResolver));
 
     public ProfilesAwareContractResolver(
         IContextProvider<ProfileContentTypeContext> profileContentTypeContextProvider,
@@ -212,4 +214,14 @@ protected override List<MemberInfo> GetSerializableMembers(Type objectType)
 
         return profileConstrainedMembers;
     }
+
+    public void Clear()
+    {
+        if (_logger.IsDebugEnabled)
+        {
+            _logger.Debug("Clears profile contracts due to profile metadata cache expiration...");
+        }
+
+        _contractByKey.Clear();
+    }
 }

Application/EdFi.Ods.Api/Startup/NewtonsoftJsonOptionConfigurator.cs

@@ -3,13 +3,16 @@
 // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
 // See the LICENSE and NOTICES files in the project root for more information.
 
+using System;
 using EdFi.Ods.Api.Serialization;
 using EdFi.Ods.Common;
 using EdFi.Ods.Common.Context;
 using EdFi.Ods.Common.Models;
 using EdFi.Ods.Common.Profiles;
 using EdFi.Ods.Common.Security.Claims;
+using EdFi.Ods.Common.Serialization;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
@@ -22,21 +25,11 @@ namespace EdFi.Ods.Api.Startup;
 /// </summary>
 public class NewtonsoftJsonOptionConfigurator : IConfigureOptions<MvcNewtonsoftJsonOptions>
 {
-    private readonly IContextProvider<ProfileContentTypeContext> _profileContentTypeContextProvider;
-    private readonly IContextProvider<DataManagementResourceContext> _dataManagementResourceContextProvider;
-    private readonly IProfileResourceModelProvider _profileResourceModelProvider;
-    private readonly ISchemaNameMapProvider _schemaNameMapProvider;
+    private readonly IServiceProvider _serviceProvider;
 
-    public NewtonsoftJsonOptionConfigurator(
-        IContextProvider<ProfileContentTypeContext> profileContentTypeContextProvider,
-        IContextProvider<DataManagementResourceContext> dataManagementResourceContextProvider,
-        IProfileResourceModelProvider profileResourceModelProvider,
-        ISchemaNameMapProvider schemaNameMapProvider)
+    public NewtonsoftJsonOptionConfigurator(IServiceProvider serviceProvider)
     {
-        _profileContentTypeContextProvider = profileContentTypeContextProvider;
-        _dataManagementResourceContextProvider = dataManagementResourceContextProvider;
-        _profileResourceModelProvider = profileResourceModelProvider;
-        _schemaNameMapProvider = schemaNameMapProvider;
+        _serviceProvider = serviceProvider;
     }
 
     public void Configure(MvcNewtonsoftJsonOptions options)
@@ -45,18 +38,9 @@ public void Configure(MvcNewtonsoftJsonOptions options)
         options.SerializerSettings.DateTimeZoneHandling = DateTimeZoneHandling.Utc;
         options.SerializerSettings.DateParseHandling = DateParseHandling.None;
         options.SerializerSettings.Formatting = Formatting.Indented;
-        options.SerializerSettings.ContractResolver 
-            = new ProfilesAwareContractResolver(
-                _profileContentTypeContextProvider, 
-                _dataManagementResourceContextProvider, 
-                _profileResourceModelProvider,
-                _schemaNameMapProvider)
-            {
-                NamingStrategy = new CamelCaseNamingStrategy
-                {
-                    ProcessDictionaryKeys = true,
-                    OverrideSpecifiedNames = true
-                }
-            };
+
+        var contactResolver = _serviceProvider.GetService<ProfilesAwareContractResolver>();
+
+        options.SerializerSettings.ContractResolver = contactResolver;
     }
-}
+}

Application/EdFi.Ods.Api/Startup/OdsStartupBase.cs

@@ -220,6 +220,14 @@ public void ConfigureServices(IServiceCollection services)
             services.AddHealthCheck(Configuration, _apiSettings);
             services.AddScheduledJobs();
 
+            // Identify all EdFi.Ods.* assemblies
+            var mediatorAssemblies = AppDomain.CurrentDomain.GetAssemblies()
+                .Where(a => a.GetName().Name.StartsWith("EdFi.Ods."))
+                .ToArray();
+
+            // Add all the MediatR services from the Ed-Fi assemblies
+            services.AddMediatR(configuration => configuration.RegisterServicesFromAssemblies(mediatorAssemblies));
+
             ConfigurePluginsServices();
 
             void ConfigurePluginsServices()

Application/EdFi.Ods.Common/Caching/CachingInterceptor.cs

@@ -9,7 +9,7 @@
 
 namespace EdFi.Ods.Common.Caching;
 
-public class CachingInterceptor : IInterceptor
+public class CachingInterceptor : IInterceptor, IClearable
 {
     private readonly ICacheProvider<ulong> _cacheProvider;
 
@@ -75,4 +75,16 @@ protected virtual ulong GenerateCacheKey(MethodInfo method, object[] arguments)
                     "Support for generating cache keys for more than 3 arguments has not been implemented.");
         }
     }
+
+    public void Clear()
+    {
+        if (_cacheProvider is IClearable clearable)
+        {
+            clearable.Clear();
+
+            return;
+        }
+
+        throw new NotSupportedException($"Unable to clear the underlying data associated with the {nameof(CachingInterceptor)}.");
+    }
 }

Application/EdFi.Ods.Common/Caching/InterceptorCacheKeys.cs

@@ -0,0 +1,11 @@
+namespace EdFi.Ods.Common.Caching;
+
+public static class InterceptorCacheKeys
+{
+    public const string Security = "cache-security";
+    public const string Descriptors = "cache-descriptors";
+    public const string OdsInstances = "cache-ods-instances";
+    public const string ProfileMetadata = "cache-profile-metadata";
+    public const string ApiClientDetails = "cache-api-client-details";
+    public const string ModelStateKey = "cache-model-state-key";
+}

Application/EdFi.Ods.Common/Models/IMappingContractProvider.cs

@@ -3,6 +3,7 @@
 // The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
 // See the LICENSE and NOTICES files in the project root for more information.
 
+using EdFi.Ods.Common.Caching;
 using EdFi.Ods.Common.Models.Domain;
 
 namespace EdFi.Ods.Common.Models;
@@ -11,7 +12,7 @@ namespace EdFi.Ods.Common.Models;
 /// Defines a method for obtaining a mapping contract appropriate for a resource/entity in the current context that indicates
 /// what should be mapped/synchronized between entities/resources.
 /// </summary>
-public interface IMappingContractProvider
+public interface IMappingContractProvider : IClearable
 {
     /// <summary>
     /// Gets a mapping contract appropriate for a resource/entity in the current context.

Application/EdFi.Ods.Common/Models/MappingContractProvider.cs

@@ -16,6 +16,7 @@
 using EdFi.Ods.Common.Profiles;
 using EdFi.Ods.Common.Security.Claims;
 using EdFi.Ods.Common.Utils.Profiles;
+using log4net;
 
 namespace EdFi.Ods.Common.Models;
 
@@ -25,6 +26,7 @@ public class MappingContractProvider : IMappingContractProvider
     private readonly IContextProvider<ProfileContentTypeContext> _profileContentTypeContextProvider;
     private readonly IProfileResourceModelProvider _profileResourceModelProvider;
     private readonly ISchemaNameMapProvider _schemaNameMapProvider;
+    private readonly ILog _logger = LogManager.GetLogger(typeof(MappingContractProvider));
 
     private readonly ConcurrentDictionary<MappingContractKey, IMappingContract>
         _mappingContractByKey = new();
@@ -65,7 +67,7 @@ public IMappingContract GetMappingContract(FullName resourceClassFullName)
             throw new BadRequestException(
                 "The resource in the profile-based content type does not match the resource targeted by the request.");
         }
-        
+
         var mappingContractKey = new MappingContractKey(
             resourceClassFullName,
             profileContentTypeContext.ProfileName,
@@ -177,7 +179,8 @@ private IMappingContract GetOrCreateMappingContract(MappingContractKey mappingCo
 
                                 return profileResourceClass.AllPropertyByName.ContainsKey(memberName) ||
                                        profileResourceClass.EmbeddedObjectByName.ContainsKey(memberName) ||
-                                       profileResourceClass.CollectionByName.ContainsKey(memberName);
+                                       profileResourceClass.CollectionByName.ContainsKey(memberName) ||
+                                       profileResourceClass.ReferenceByName.ContainsKey(memberName);
                             }
 
                             if (parameterInfo.Name.EndsWith("Included"))
@@ -211,6 +214,16 @@ private IMappingContract GetOrCreateMappingContract(MappingContractKey mappingCo
 
         return mappingContract;
     }
+
+    public void Clear()
+    {
+        if (_logger.IsDebugEnabled)
+        {
+            _logger.Debug("Clears mapping Contracts due to profile metadata cache expiration...");
+        }
+
+        _mappingContractByKey.Clear();
+    }
 }
 
 public class MappingContractKey : IEquatable<MappingContractKey>
@@ -314,4 +327,4 @@ public override int GetHashCode()
             return hashCode;
         }
     }
-}
+}

Application/EdFi.Ods.Features/Container/Modules/OpenApiMetadataModule.cs

@@ -29,7 +29,7 @@ public OpenApiMetadataModule(ApiSettings apiSettings)
         public override void ApplyConfigurationSpecificRegistrations(ContainerBuilder builder)
         {
             builder.RegisterType<OpenApiMetadataCacheProvider>()
-                .AsImplementedInterfaces()
+                .As<IOpenApiMetadataCacheProvider>()
                 .SingleInstance();
 
             builder.RegisterType<InitializeOpenApiMetadataCache>()

Application/EdFi.Ods.Features/Container/Modules/ProfilesModule.cs

@@ -73,7 +73,7 @@ public override void ApplyConfigurationSpecificRegistrations(ContainerBuilder bu
 
             builder.RegisterType<ProfileMetadataCacheExpiredNotificationHandler>()
                 .AsImplementedInterfaces()
-                .SingleInstance();
+                .SingleInstance();                
 
             builder.RegisterType<AdminProfileNamesPublisherTask>()
                 .As<IExternalTask>()

Application/EdFi.Ods.Features/OpenApiMetadata/Providers/OpenApiMetadataCacheProvider.cs

@@ -8,26 +8,22 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
-using System.Threading;
-using System.Threading.Tasks;
 using EdFi.Common.Extensions;
 using EdFi.Ods.Api.Constants;
 using EdFi.Ods.Api.Models;
 using EdFi.Ods.Api.Providers;
 using EdFi.Ods.Api.Routing;
 using EdFi.Ods.Common.Models;
-using EdFi.Ods.Common.Profiles;
 using EdFi.Ods.Features.OpenApiMetadata.Dtos;
 using EdFi.Ods.Features.OpenApiMetadata.Factories;
 using EdFi.Ods.Features.OpenApiMetadata.Strategies.ResourceStrategies;
 using log4net;
-using MediatR;
 using Microsoft.OpenApi;
 using OpenApiMetadataSections = EdFi.Ods.Api.Constants.OpenApiMetadataSections;
 
 namespace EdFi.Ods.Features.OpenApiMetadata.Providers
 {
-    public class OpenApiMetadataCacheProvider : IOpenApiMetadataCacheProvider, INotificationHandler<ProfileMetadataCacheExpired>
+    public class OpenApiMetadataCacheProvider : IOpenApiMetadataCacheProvider
     {
         private const string Descriptors = "descriptors";
         private const string Resources = "resources";
@@ -110,6 +106,11 @@ public OpenApiContent GetOpenApiContentByFeedName(string feedName)
 
         public void ResetCacheInitialization()
         {
+            if (_logger.IsDebugEnabled)
+            {
+                _logger.Debug("Resetting OpenApiMetadata initialization due to profile metadata cache expiration...");
+            }
+
             // Reset the underlying cache
             _openApiMetadataMetadataCache = new Lazy<ConcurrentDictionary<string, OpenApiContent>>(LazyInitializeCache);
         }
@@ -224,17 +225,5 @@ void AddToCache(IEnumerable<OpenApiContent> openApiContents)
                 }
             }
         }
-
-        public Task Handle(ProfileMetadataCacheExpired notification, CancellationToken cancellationToken)
-        {
-            if (_logger.IsDebugEnabled)
-            {
-                _logger.Debug("Resetting OpenApiMetadata initialization due to profile metadata cache expiration...");
-            }
-
-            ResetCacheInitialization();
-
-            return Task.CompletedTask;
-        }
     }
 }