Merge branch 'release/3.825.0'

Author: vc-ci

Directory.Build.props

@@ -2,7 +2,7 @@
 <Project>
   <!-- These properties will be shared for all projects -->
   <PropertyGroup>
-    <VersionPrefix>3.824.0</VersionPrefix>
+    <VersionPrefix>3.825.0</VersionPrefix>
     <VersionSuffix>
     </VersionSuffix>
     <VersionSuffix Condition=" '$(VersionSuffix)' != '' AND '$(BuildNumber)' != '' ">$(VersionSuffix)-$(BuildNumber)</VersionSuffix>

README.md

@@ -1,14 +1,14 @@
-# Overview
+# Virto Commerce Customer Module
 
 [![CI status](https://github.com/VirtoCommerce/vc-module-customer/workflows/Module%20CI/badge.svg?branch=dev)](https://github.com/VirtoCommerce/vc-module-customer/actions?query=workflow%3A"Module+CI") [![Quality gate](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-customer&metric=alert_status&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-customer) [![Reliability rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-customer&metric=reliability_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-customer) [![Security rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-customer&metric=security_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-customer) [![Sqale rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-customer&metric=sqale_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-customer)
 
-The Virto Commerce Customer module represents contacts management system. The main purpose of this functionality is to keep the users contact information. The VC Customer Module helps to view, search and edit contact information.
+The Virto Commerce Customer module represents contacts management system. The main purpose of this functionality is to keep the users contact information. The Customer Module helps to view, search, and edit contact information.
 
 ## Key features
 
 * Сontacts arrangement in hierarchical structure
 * Module extensibility with custom contact types
-* "Organization", "Employee", "Customer" and "Vendor" contact types supported out of the box
+* **Organization**, **Employee**, **Customer** and **Vendor** contact types supported out of the box
 
 ## Documentation
 

src/VirtoCommerce.CustomerModule.Data/Services/MemberService.cs

@@ -56,50 +56,27 @@ public MemberService(
         public virtual Task<Member[]> GetByIdsAsync(string[] memberIds, string responseGroup = null, string[] memberTypes = null)
         {
             var cacheKey = CacheKey.With(GetType(), nameof(GetByIdsAsync), string.Join("-", memberIds), responseGroup, memberTypes == null ? null : string.Join("-", memberTypes));
-            return _platformMemoryCache.GetOrCreateExclusiveAsync(cacheKey, async (cacheEntry) =>
+            return _platformMemoryCache.GetOrCreateExclusiveAsync(cacheKey, async cacheEntry =>
             {
-                var members = new List<Member>();
-
+                IList<Member> members;
                 using (var repository = _repositoryFactory())
                 {
-                    //It is so important to generate change tokens for all ids even for not existing members to prevent an issue
-                    //with caching of empty results for non - existing objects that have the infinitive lifetime in the cache
-                    //and future unavailability to create objects with these ids.
-                    cacheEntry.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(memberIds));
                     repository.DisableChangesTracking();
                     //There is loading for all corresponding members conceptual model entities types
                     //query performance when TPT inheritance used it is too slow, for improve performance we are passing concrete member types in to the repository
                     var memberTypeInfos = AbstractTypeFactory<Member>.AllTypeInfos.Where(t => t.MappedType != null);
                     if (memberTypes != null)
                     {
-                        memberTypeInfos = memberTypeInfos.Where(x => memberTypes.Any(mt => x.IsAssignableTo(mt)));
+                        var types = memberTypes;
+                        memberTypeInfos = memberTypeInfos.Where(x => types.Any(x.IsAssignableTo));
                     }
 
                     memberTypes = memberTypeInfos.Select(t => t.MappedType.AssemblyQualifiedName).Distinct().ToArray();
 
                     var dataMembers = await repository.GetMembersByIdsAsync(memberIds, responseGroup, memberTypes);
-                    foreach (var dataMember in dataMembers)
-                    {
-                        var member = AbstractTypeFactory<Member>.TryCreateInstance(dataMember.MemberType);
-                        if (member is null) continue;
-
-                        dataMember.ToModel(member);
-                        member.ReduceDetails(responseGroup);
-                        members.Add(member);
-                    }
+                    members = ProcessModels(dataMembers, responseGroup);
 
-                    var ancestorIds = dataMembers.SelectMany(r => r.MemberRelations)
-                        .Where(x => !string.IsNullOrEmpty(x.AncestorId))
-                        .Select(x => x.AncestorId)
-                        .ToArray();
-
-                    var descendantIds = dataMembers.SelectMany(x => x.MemberRelations)
-                        .Where(x => !string.IsNullOrEmpty(x.DescendantId))
-                        .Select(x => x.DescendantId)
-                        .ToArray();
-
-                    cacheEntry.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(ancestorIds));
-                    cacheEntry.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(descendantIds));
+                    ConfigureCache(cacheEntry, memberIds, dataMembers, members);
                 }
 
                 #region Load member security accounts by separate request
@@ -110,22 +87,22 @@ public virtual Task<Member[]> GetByIdsAsync(string[] memberIds, string responseG
                 }
 
                 var hasSecurityAccountMembers = members.OfType<IHasSecurityAccounts>().ToArray();
-                if (!hasSecurityAccountMembers.Any())
+                if (hasSecurityAccountMembers.Length == 0)
                 {
                     return members.ToArray();
                 }
 
                 var usersSearchResult = await _userSearchService.SearchUsersAsync(new UserSearchCriteria
                 {
                     MemberIds = hasSecurityAccountMembers.Select(x => x.Id).ToList(),
-                    Take = int.MaxValue
+                    Take = int.MaxValue,
                 });
 
                 foreach (var hasAccountMember in hasSecurityAccountMembers)
                 {
                     hasAccountMember.SecurityAccounts = usersSearchResult.Results.Where(x => x.MemberId.EqualsInvariant(hasAccountMember.Id)).ToList();
 
-                    if (hasAccountMember.SecurityAccounts.Any())
+                    if (hasAccountMember.SecurityAccounts.Count > 0)
                     {
                         hasAccountMember.SecurityAccounts.ToList().ForEach(x => cacheEntry.AddExpirationToken(SecurityCacheRegion.CreateChangeTokenForUser(x)));
                     }
@@ -165,82 +142,151 @@ public virtual async Task SaveChangesAsync(Member[] members)
             var pkMap = new PrimaryKeyResolvingMap();
             var changedEntries = new List<GenericChangedEntry<Member>>();
 
-            using (var repository = _repositoryFactory())
+            using var repository = _repositoryFactory();
+
+            var existingMemberEntities = await repository.GetMembersByIdsAsync(members.Where(m => !m.IsTransient()).Select(m => m.Id).ToArray());
+
+            foreach (var member in members)
             {
-                var existingMemberEntities = await repository.GetMembersByIdsAsync(members.Where(m => !m.IsTransient()).Select(m => m.Id).ToArray());
+                var dataSourceMember = FromModel(member, pkMap);
 
-                foreach (var member in members)
+                var dataTargetMember = existingMemberEntities.FirstOrDefault(m => m.Id == member.Id);
+                if (dataTargetMember != null)
                 {
-                    var memberEntityType = AbstractTypeFactory<Member>.AllTypeInfos.Where(t => t.MappedType != null && t.IsAssignableTo(member.MemberType)).Select(t => t.MappedType).FirstOrDefault();
-                    ArgumentNullException.ThrowIfNull(memberEntityType);
-
-                    var dataSourceMember = AbstractTypeFactory<MemberEntity>.TryCreateInstance(memberEntityType.Name);
-                    ArgumentNullException.ThrowIfNull(dataSourceMember);
+                    // Workaround to trigger update of auditable fields when only updating navigation properties.
+                    // Otherwise on update trigger is fired only when non navigation properties are updated.
+                    dataTargetMember.ModifiedDate = DateTime.UtcNow;
 
-                    dataSourceMember.FromModel(member, pkMap);
+                    // This extension is allow to get around breaking changes is introduced in EF Core 3.0 that leads to throw
+                    // Database operation expected to affect 1 row(s) but actually affected 0 row(s) exception when trying to add the new children entities with manually set keys
+                    // https://docs.microsoft.com/en-us/ef/core/what-is-new/ef-core-3.0/breaking-changes#detectchanges-honors-store-generated-key-values
+                    repository.TrackModifiedAsAddedForNewChildEntities(dataTargetMember);
 
-                    var dataTargetMember = existingMemberEntities.FirstOrDefault(m => m.Id == member.Id);
-                    if (dataTargetMember != null)
+                    if (!dataTargetMember.GetType().IsInstanceOfType(dataSourceMember))
                     {
-                        /// Workaround to trigger update of auditable fields when only updating navigation properties.
-                        /// Otherwise on update trigger is fired only when non navigation properties are updated.
-                        dataTargetMember.ModifiedDate = DateTime.UtcNow;
-
-                        /// This extension is allow to get around breaking changes is introduced in EF Core 3.0 that leads to throw
-                        /// Database operation expected to affect 1 row(s) but actually affected 0 row(s) exception when trying to add the new children entities with manually set keys
-                        /// https://docs.microsoft.com/en-us/ef/core/what-is-new/ef-core-3.0/breaking-changes#detectchanges-honors-store-generated-key-values
-                        repository.TrackModifiedAsAddedForNewChildEntities(dataTargetMember);
-
-                        if (!dataTargetMember.GetType().IsInstanceOfType(dataSourceMember))
-                        {
-                            throw new OperationCanceledException($"Unable to update an member with type {dataTargetMember.MemberType} by an member with type {dataSourceMember.MemberType} because they aren't in the inheritance hierarchy");
-                        }
-                        changedEntries.Add(new GenericChangedEntry<Member>(member, dataTargetMember.ToModel(AbstractTypeFactory<Member>.TryCreateInstance(member.MemberType)), EntryState.Modified));
-                        dataSourceMember.Patch(dataTargetMember);
-                    }
-                    else
-                    {
-                        repository.Add(dataSourceMember);
-                        changedEntries.Add(new GenericChangedEntry<Member>(member, EntryState.Added));
+                        throw new OperationCanceledException($"Unable to update an member with type {dataTargetMember.MemberType} by an member with type {dataSourceMember.MemberType} because they aren't in the inheritance hierarchy");
                     }
+                    changedEntries.Add(new GenericChangedEntry<Member>(member, dataTargetMember.ToModel(AbstractTypeFactory<Member>.TryCreateInstance(member.MemberType)), EntryState.Modified));
+                    dataSourceMember.Patch(dataTargetMember);
+                }
+                else
+                {
+                    repository.Add(dataSourceMember);
+                    changedEntries.Add(new GenericChangedEntry<Member>(member, EntryState.Added));
                 }
-                //Raise domain events
+            }
+            //Raise domain events
+            await _eventPublisher.Publish(new MemberChangingEvent(changedEntries));
+            await repository.UnitOfWork.CommitAsync();
+            pkMap.ResolvePrimaryKeys();
+            ClearCache(members);
+
+            await _eventPublisher.Publish(new MemberChangedEvent(changedEntries));
+        }
+
+        public virtual async Task DeleteAsync(string[] ids, string[] memberTypes = null)
+        {
+            using var repository = _repositoryFactory();
+
+            var members = await GetByIdsAsync(ids, null, memberTypes);
+            if (members?.Length > 0)
+            {
+                var changedEntries = members.Select(x => new GenericChangedEntry<Member>(x, EntryState.Deleted)).ToArray();
                 await _eventPublisher.Publish(new MemberChangingEvent(changedEntries));
+
+                await repository.RemoveMembersByIdsAsync(members.Select(m => m.Id).ToArray());
                 await repository.UnitOfWork.CommitAsync();
-                pkMap.ResolvePrimaryKeys();
                 ClearCache(members);
 
                 await _eventPublisher.Publish(new MemberChangedEvent(changedEntries));
             }
         }
 
-        public virtual async Task DeleteAsync(string[] ids, string[] memberTypes = null)
+        protected virtual void ConfigureCache(MemoryCacheEntryOptions cacheOptions, string[] memberIds, IList<MemberEntity> entities, IList<Member> models)
         {
-            using (var repository = _repositoryFactory())
-            {
-                var members = await GetByIdsAsync(ids, null, memberTypes);
-                if (!members.IsNullOrEmpty())
-                {
-                    var changedEntries = members.Select(x => new GenericChangedEntry<Member>(x, EntryState.Deleted)).ToArray();
-                    await _eventPublisher.Publish(new MemberChangingEvent(changedEntries));
+            //It is so important to generate change tokens for all ids even for not existing members to prevent an issue
+            //with caching of empty results for non - existing objects that have the infinitive lifetime in the cache
+            //and future unavailability to create objects with these ids.
+            cacheOptions.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(memberIds));
+
+            var ancestorIds = entities.SelectMany(r => r.MemberRelations)
+                .Where(x => !string.IsNullOrEmpty(x.AncestorId))
+                .Select(x => x.AncestorId)
+                .ToArray();
+
+            var descendantIds = entities.SelectMany(x => x.MemberRelations)
+                .Where(x => !string.IsNullOrEmpty(x.DescendantId))
+                .Select(x => x.DescendantId)
+                .ToArray();
+
+            cacheOptions.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(ancestorIds));
+            cacheOptions.AddExpirationToken(CustomerCacheRegion.CreateChangeToken(descendantIds));
+        }
 
-                    await repository.RemoveMembersByIdsAsync(members.Select(m => m.Id).ToArray());
-                    await repository.UnitOfWork.CommitAsync();
-                    ClearCache(members);
+        protected virtual void ClearCache(IEnumerable<Member> members)
+        {
+            var models = members as Member[] ?? members.ToArray();
+            ClearSearchCache(models);
 
-                    await _eventPublisher.Publish(new MemberChangedEvent(changedEntries));
-                }
+            foreach (var member in models.Where(x => !x.IsTransient()))
+            {
+                CustomerCacheRegion.ExpireMemberById(member.Id);
             }
         }
 
-        protected virtual void ClearCache(IEnumerable<Member> members)
+        protected virtual void ClearSearchCache(IList<Member> models)
         {
             CustomerSearchCacheRegion.ExpireRegion();
+        }
+
+        protected virtual IList<Member> ProcessModels(IList<MemberEntity> entities, string responseGroup)
+        {
+            return entities?
+                .Select(x =>
+                {
+                    var model = ToModel(x);
+                    return model is null ? null : ProcessModel(responseGroup, x, model);
+                })
+                .Where(x => x is not null)
+                .ToArray();
+        }
 
-            foreach (var member in members.Where(x => !x.IsTransient()))
+        protected virtual Member ToModel(MemberEntity entity)
+        {
+            var model = AbstractTypeFactory<Member>.TryCreateInstance(entity.MemberType);
+            if (model is null)
             {
-                CustomerCacheRegion.ExpireMemberById(member.Id);
+                return null;
             }
+
+            entity.ToModel(model);
+            return model;
+        }
+
+        /// <summary>
+        /// Post-read processing of the model instance.
+        /// A good place to make some additional actions, tune model data.
+        /// Override to add some model data changes, calculations, etc...
+        /// </summary>
+        protected virtual Member ProcessModel(string responseGroup, MemberEntity entity, Member model)
+        {
+            model.ReduceDetails(responseGroup);
+            return model;
+        }
+
+        protected virtual MemberEntity FromModel(Member model, PrimaryKeyResolvingMap keyMap)
+        {
+            var memberEntityType = AbstractTypeFactory<Member>.AllTypeInfos
+                .Where(t => t.MappedType != null && t.IsAssignableTo(model.MemberType))
+                .Select(t => t.MappedType)
+                .FirstOrDefault()
+                ?? throw new InvalidOperationException($"Cannot find entity type for member type: {model.MemberType}");
+
+            var dataSourceMember = AbstractTypeFactory<MemberEntity>.TryCreateInstance(memberEntityType.Name)
+                ?? throw new InvalidOperationException($"Cannot create instance of entity type: {memberEntityType.Name}");
+
+            dataSourceMember.FromModel(model, keyMap);
+            return dataSourceMember;
         }
 
         #endregion IMemberService Members

src/VirtoCommerce.CustomerModule.Web/module.manifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <module xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <id>VirtoCommerce.Customer</id>
-  <version>3.824.0</version>
+  <version>3.825.0</version>
   <version-tag />
 
   <platformVersion>3.879.0</platformVersion>