Merge branch 'improvement/MemberAccess-integration' into develop

When we first introduced `MemberAccessor` (a82f7e6), we provided the bare-minimum integration in order to incorporate it with `TopicMappingService`, which was the primary target. In doing so, other internal classes, such as `BindingModelValidator`, continued to operate off of `MemberInfo` instances (namely `PropertyInfo`). In addition to being inconsistent, this also means those classes continued to operate off of direct calls to reflection. Instead, the preference is to go through `MemberAccessor` not only for consistency, but also performance, as the `MemberAccessor` instances are cached via the `TypeAccessorCache`. By passing a `MemberAccessor` around directly, we get access to more metadata, a more consistent interface, and potential performance improvements by ensuring use of our optimizations of reflection calls and avoidance of additional `TypeAccessorCache` lookups (e.g., when we already have a `MemberAccessor` in a calling class).

As part of this, I updated `ReverseTopicMappingService` (3d4c9c4), `BindingModelValidator` (825bb8b), `PropertyConfiguration`'s `Validate()` method (39d1703), and `TopicMappingService`'s `SetCollectionValueAsync()` (385bfec) method to use `MemberAccessor` instead of e.g. `MemberInfo`. I also updated `ItemConfiguration` to operate off of `List<Attribute>`, thus preventing the need to make multiple calls to `GetCustomAttributes()` (9705824).

Though, in a future release, we should consider updating `ItemConfiguration` to operate off of `MemberAccessor`; this isn't done today because `MemberAccessor` doesn't support parameters.

Author: JeremyCaney

OnTopic.ViewModels/TopicViewModelLookupService.cs

@@ -48,6 +48,7 @@ public TopicViewModelLookupService(IEnumerable<Type>? types = null) : base(types
       \-----------------------------------------------------------------------------------------------------------------------*/
       TryAdd(typeof(ItemTopicViewModel));
       TryAdd(typeof(ContentItemTopicViewModel));
+      TryAdd(typeof(CacheProfileTopicViewModel));
       TryAdd(typeof(LookupListItemTopicViewModel));
       TryAdd(typeof(SlideTopicViewModel));
 

OnTopic/Internal/Reflection/MemberAccessor.cs

@@ -26,6 +26,7 @@ internal class MemberAccessor {
     \-------------------------------------------------------------------------------------------------------------------------*/
     private                     Action<object, object?>?        _setter;
     private                     Func<object, object?>?          _getter;
+    private                     List<Attribute>                 _customAttributes               = default!;
 
     /*==========================================================================================================================
     | CONSTRUCTOR
@@ -122,6 +123,19 @@ internal MemberAccessor(MemberInfo memberInfo) {
     /// </remarks>
     internal bool CanWrite { get; private set; }
 
+    /*==========================================================================================================================
+    | CUSTOM ATTRIBUTES
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Provides a cached list of custom attributes associated with member.
+    /// </summary>
+    internal List<Attribute> CustomAttributes {
+      get {
+        _customAttributes ??= MemberInfo.GetCustomAttributes(true).OfType<Attribute>().ToList();
+        return _customAttributes;
+      }
+    }
+
     /*==========================================================================================================================
     | METHOD: IS SETTABLE?
     \-------------------------------------------------------------------------------------------------------------------------*/

OnTopic/Mapping/Internal/ItemConfiguration.cs

@@ -15,7 +15,7 @@ namespace OnTopic.Mapping.Internal {
   | CLASS: ITEM CONFIGURATION
   \---------------------------------------------------------------------------------------------------------------------------*/
   /// <summary>
-  ///   Evaluates the <see cref="ICustomAttributeProvider"/> for a given instance for a <see cref="ParameterInfo"/> or <see cref
+  ///   Evaluates the <see cref="IEnumerable{Attribute}"/> of a given instance for a <see cref="ParameterInfo"/> or <see cref
   ///   ="PropertyInfo"/>, and exposes known <see cref="Attribute"/>s through a set of property values.
   /// </summary>
   /// <remarks>
@@ -41,20 +41,21 @@ internal class ItemConfiguration {
     | CONSTRUCTOR
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Given an <see cref="ICustomAttributeProvider"/> instance, exposes a set of properties associated with known <see cref=
-    ///   "Attribute"/> instances.
+    ///   Given an <see cref="IEnumerable{Attribute}"/> instance, exposes a set of properties associated with known
+    ///   <see cref="Attribute"/> instances.
     /// </summary>
-    /// <param name="source">
-    ///   The <see cref="ICustomAttributeProvider"/> instance to check for <see cref="Attribute"/> values.
+    /// <param name="customAttributes">
+    ///   The <see cref="IEnumerable{Attribute}"/> instance to check for <see cref="Attribute"/> values.
     /// </param>
     /// <param name="name">The name of the <see cref="ParameterInfo"/> or <see cref="PropertyInfo"/>.</param>
     /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
-    internal ItemConfiguration(ICustomAttributeProvider source, string name, string? attributePrefix = "") {
+    internal ItemConfiguration(IEnumerable<Attribute> customAttributes, string name, string? attributePrefix = "") {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Set backing property
       \-----------------------------------------------------------------------------------------------------------------------*/
-      Source = source;
+      CustomAttributes          = customAttributes;
+      var source                = customAttributes;
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Set default values
@@ -74,23 +75,22 @@ internal ItemConfiguration(ICustomAttributeProvider source, string name, string?
       /*------------------------------------------------------------------------------------------------------------------------
       | Attributes: Retrieve basic attributes
       \-----------------------------------------------------------------------------------------------------------------------*/
-      GetAttributeValue<MapAsAttribute>(source,               a => MapAs = a.Type);
-      GetAttributeValue<DefaultValueAttribute>(source,        a => DefaultValue = a.Value);
-      GetAttributeValue<InheritAttribute>(source,             a => InheritValue = true);
-      GetAttributeValue<AttributeKeyAttribute>(source,        a => AttributeKey = attributePrefix + a.Key);
-      GetAttributeValue<MapToParentAttribute>(source,         a => MapToParent = true);
-      GetAttributeValue<MapToParentAttribute>(source,         a => AttributePrefix += (a.AttributePrefix?? name));
-      GetAttributeValue<IncludeAttribute>(source,             a => IncludeAssociations = a.Associations);
-      GetAttributeValue<FlattenAttribute>(source,             a => FlattenChildren = true);
-      GetAttributeValue<MetadataAttribute>(source,            a => MetadataKey = a.Key);
-      GetAttributeValue<DisableMappingAttribute>(source,      a => DisableMapping = true);
-      GetAttributeValue<FilterByContentTypeAttribute>(source, a => ContentTypeFilter = a.ContentType);
+      GetAttributeValue<MapAsAttribute>(                        a => MapAs = a.Type);
+      GetAttributeValue<DefaultValueAttribute>(                 a => DefaultValue = a.Value);
+      GetAttributeValue<InheritAttribute>(                      a => InheritValue = true);
+      GetAttributeValue<AttributeKeyAttribute>(                 a => AttributeKey = attributePrefix + a.Key);
+      GetAttributeValue<MapToParentAttribute>(                  a => MapToParent = true);
+      GetAttributeValue<MapToParentAttribute>(                  a => AttributePrefix += (a.AttributePrefix?? name));
+      GetAttributeValue<IncludeAttribute>(                      a => IncludeAssociations = a.Associations);
+      GetAttributeValue<FlattenAttribute>(                      a => FlattenChildren = true);
+      GetAttributeValue<MetadataAttribute>(                     a => MetadataKey = a.Key);
+      GetAttributeValue<DisableMappingAttribute>(               a => DisableMapping = true);
+      GetAttributeValue<FilterByContentTypeAttribute>(          a => ContentTypeFilter = a.ContentType);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Attributes: Determine collection key and type
       \-----------------------------------------------------------------------------------------------------------------------*/
       GetAttributeValue<CollectionAttribute>(
-        source,
         a => {
           CollectionKey = a.Key ?? CollectionKey;
           CollectionType = a.Type;
@@ -104,7 +104,7 @@ internal ItemConfiguration(ICustomAttributeProvider source, string name, string?
       /*------------------------------------------------------------------------------------------------------------------------
       | Attributes: Set attribute filters
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var filterByAttributes = (FilterByAttributeAttribute[])source.GetCustomAttributes(typeof(FilterByAttributeAttribute), true);
+      var filterByAttributes = source.OfType<FilterByAttributeAttribute>();
       if (filterByAttributes is not null && filterByAttributes.Any()) {
         foreach (var filter in filterByAttributes) {
           AttributeFilters.Add(filter.Key, filter.Value);
@@ -114,12 +114,12 @@ internal ItemConfiguration(ICustomAttributeProvider source, string name, string?
     }
 
     /*==========================================================================================================================
-    | PROPERTY: SOURCE
+    | PROPERTY: CUSTOM ATTRIBUTES
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   The <see cref="ICustomAttributeProvider"/> that the current <see cref="ItemConfiguration"/> is associated with.
+    ///   The <see cref="IEnumerable{Attribute}"/> that the current <see cref="ItemConfiguration"/> is associated with.
     /// </summary>
-    internal ICustomAttributeProvider Source { get; }
+    protected IEnumerable<Attribute> CustomAttributes { get; }
 
     /*==========================================================================================================================
     | PROPERTY: ATTRIBUTE KEY
@@ -438,18 +438,28 @@ internal bool SatisfiesAttributeFilters(Topic source) =>
         source?.Attributes?.GetValue(f.Key, "")?.Equals(f.Value, StringComparison.OrdinalIgnoreCase)?? false
       );
 
+    /*==========================================================================================================================
+    | PRIVATE: GET ATTRIBUTE
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Helper function identifies whether a <typeparamref name="T"/> exists in the <see cref="CustomAttributes"/> and, if so,
+    ///   returns the value.
+    /// </summary>
+    /// <typeparam name="T">An <see cref="Attribute"/> type to evaluate.</typeparam>
+    private T? GetAttribute<T>() where T : Attribute =>
+      CustomAttributes.OfType<T>().FirstOrDefault();
+
     /*==========================================================================================================================
     | PRIVATE: GET ATTRIBUTE VALUE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Helper function evaluates an attribute and then, if it exists, executes an <see cref="Action{T1}"/> to process the
+    ///   Helper function evaluates an attribute and then, if it exists, executes an <see cref="Action{T}"/> to process the
     ///   results.
     /// </summary>
     /// <typeparam name="T">An <see cref="Attribute"/> type to evaluate.</typeparam>
-    /// <param name="source">The <see cref="ICustomAttributeProvider"/> instance to pull the attribute from.</param>
     /// <param name="action">The <see cref="Action{T}"/> to execute on the attribute.</param>
-    private static void GetAttributeValue<T>(ICustomAttributeProvider source, Action<T> action) where T : Attribute {
-      var attribute = (T)source.GetCustomAttributes(typeof(T), true).FirstOrDefault();
+    private void GetAttributeValue<T>(Action<T> action) where T : Attribute {
+      var attribute = GetAttribute<T>();
       if (attribute is not null) {
         action(attribute);
       }

OnTopic/Mapping/Internal/PropertyConfiguration.cs

@@ -5,6 +5,7 @@
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
 using System.Reflection;
+using OnTopic.Internal.Reflection;
 using OnTopic.Mapping.Annotations;
 
 namespace OnTopic.Mapping.Internal {
@@ -35,24 +36,26 @@ internal class PropertyConfiguration: ItemConfiguration {
     | CONSTRUCTOR
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Given a <see cref="PropertyInfo"/> instance, exposes a set of properties associated with known <see cref="Attribute"/>
-    ///   instances.
+    ///   Given a <see cref="MemberAccessor"/> instance, exposes a set of properties associated with known <see cref="Attribute"
+    ///   /> instances.
     /// </summary>
-    /// <param name="property">The <see cref="PropertyInfo"/> instance to check for <see cref="Attribute"/> values.</param>
+    /// <param name="memberAccessor">
+    ///   The <see cref="MemberAccessor"/> instance to check for <see cref="Attribute"/> values.
+    /// </param>
     /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
-    internal PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""):
-      base(property, property.Name, attributePrefix)
+    internal PropertyConfiguration(MemberAccessor memberAccessor, string? attributePrefix = ""):
+      base(memberAccessor.CustomAttributes, memberAccessor.Name, attributePrefix)
     {
-      Property = property;
+      MemberAccessor            = memberAccessor;
     }
 
     /*==========================================================================================================================
-    | PROPERTY: PROPERTY
+    | PROPERTY: MEMBER ACCESSOR
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   The <see cref="PropertyInfo"/> that the current <see cref="PropertyConfiguration"/> is associated with.
+    ///   The <see cref="MemberAccessor"/> that the current <see cref="PropertyConfiguration"/> is associated with.
     /// </summary>
-    internal PropertyInfo Property { get; }
+    internal MemberAccessor MemberAccessor { get; }
 
     /*==========================================================================================================================
     | METHOD: VALIDATE
@@ -63,8 +66,8 @@ internal PropertyConfiguration(PropertyInfo property, string? attributePrefix =
     /// </summary>
     /// <param name="target">The target DTO to validate the current property on.</param>
     internal void Validate(object target) {
-      foreach (ValidationAttribute validator in Property.GetCustomAttributes(typeof(ValidationAttribute))) {
-        validator.Validate(Property.GetValue(target), Property.Name);
+      foreach (ValidationAttribute validator in CustomAttributes.OfType<ValidationAttribute>()) {
+        validator.Validate(MemberAccessor.GetValue(target), MemberAccessor.Name);
       }
     }