Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend RetrieveMultipleRequestHandler #245

Merged
merged 3 commits into from
Nov 27, 2024
Merged

Extend RetrieveMultipleRequestHandler #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d529d3
Add unit tests for TopCount, Take and Skip
Nov 21, 2024
67328e7
Extend and refactor RetrieveMultipleRequestHandler to handle TopCount…
Nov 21, 2024
3953399
Resolve comments
Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 57 additions & 48 deletions src/XrmMockupShared/Requests/RetrieveMultipleRequestHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
using System;
using System.Collections.Generic;
using System.Text;
using DG.Tools.XrmMockup.Database;
using Microsoft.Crm.Sdk.Messages;
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Messages;
using Microsoft.Xrm.Sdk.Metadata;
using Microsoft.Xrm.Sdk.Query;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Crm.Sdk.Messages;
using System.ServiceModel;
using Microsoft.Xrm.Sdk.Metadata;
using DG.Tools.XrmMockup.Database;
using System.Diagnostics;
using System.Collections.Concurrent;
using System.Threading.Tasks;

namespace DG.Tools.XrmMockup {
internal class RetrieveMultipleRequestHandler : RequestHandler {
namespace DG.Tools.XrmMockup
{
internal class RetrieveMultipleRequestHandler : RequestHandler
{
internal RetrieveMultipleRequestHandler(Core core, XrmDb db, MetadataSkeleton metadata, Security security) : base(core, db, metadata, security, "RetrieveMultiple") { }

internal override OrganizationResponse Execute(OrganizationRequest orgRequest, EntityReference userRef) {
internal override OrganizationResponse Execute(OrganizationRequest orgRequest, EntityReference userRef)
{
var request = MakeRequest<RetrieveMultipleRequest>(orgRequest);
var queryExpr = request.Query as QueryExpression;
var fetchExpr = request.Query as FetchExpression;
var queryByAttr = request.Query as QueryByAttribute;
if (fetchExpr != null) {
if (fetchExpr != null)
{
queryExpr = XmlHandling.FetchXmlToQueryExpression(fetchExpr.Query);
}
else if (queryByAttr != null)
Expand Down Expand Up @@ -92,7 +94,6 @@ internal override OrganizationResponse Execute(OrganizationRequest orgRequest, E
});

var orders = queryExpr.Orders;
var orderedCollection = new EntityCollection();
IOrderedEnumerable<KeyValuePair<DbRow, Entity>> tempSortedList;

// TODO: Check the order that the orders are executed in is correct
Expand Down Expand Up @@ -120,35 +121,23 @@ internal override OrganizationResponse Execute(OrganizationRequest orgRequest, E
tempSortedList = tempSortedList.ThenBy(x => x.Key.Sequence);
}

orderedCollection.Entities.AddRange(tempSortedList.Select(y => y.Value));
var entitiesToReturn = RefineEntityAttributes(
tempSortedList.Any() ? tempSortedList.Select(x => x.Value) : collection.Select(x => x.Value),
queryExpr.ColumnSet);

var colToReturn = new EntityCollection();

if (orderedCollection.Entities.Count != 0)
{
Parallel.ForEach(orderedCollection.Entities, entity =>
{
KeepAttributesAndAliasAttributes(entity, queryExpr.ColumnSet);
}
);
colToReturn = orderedCollection;
}
else
if (queryExpr.Distinct)
{
Parallel.ForEach(collection, kvp =>
{
KeepAttributesAndAliasAttributes(kvp.Value, queryExpr.ColumnSet);
}
);
colToReturn = new EntityCollection(collection.Select(x => x.Value).ToList());
var uniqueIds = new HashSet<Guid>();
entitiesToReturn = entitiesToReturn.Where(entity => uniqueIds.Add(entity.Id));
}

if (queryExpr.Distinct)
if (queryExpr.TopCount.HasValue || (queryExpr.PageInfo?.Count ?? 0) > 0)
{
var uniqueIds = new HashSet<Guid>();
colToReturn = new EntityCollection(colToReturn.Entities.Where(entity => uniqueIds.Add(entity.Id)).ToList());
entitiesToReturn = entitiesToReturn.Take(queryExpr.TopCount ?? queryExpr.PageInfo.Count); // QueryExpression TopCount or Linq query Take operator
}

var colToReturn = new EntityCollection(entitiesToReturn.ToList());

// According to docs, should return -1 if ReturnTotalRecordCount set to false
colToReturn.TotalRecordCount = queryExpr.PageInfo.ReturnTotalRecordCount ? colToReturn.Entities.Count : -1;

Expand All @@ -159,58 +148,78 @@ internal override OrganizationResponse Execute(OrganizationRequest orgRequest, E

}

private IEnumerable<Entity> RefineEntityAttributes(IEnumerable<Entity> entities, ColumnSet columnSet)
{
Parallel.ForEach(entities, entity =>
{
KeepAttributesAndAliasAttributes(entity, columnSet);
});
return entities;
}

private List<Entity> GetAliasedValuesFromLinkentity(LinkEntity linkEntity, Entity parent, Entity toAdd, XrmDb db) {
private List<Entity> GetAliasedValuesFromLinkentity(LinkEntity linkEntity, Entity parent, Entity toAdd, XrmDb db)
{
var collection = new List<Entity>();
foreach (var linkedRow in db[linkEntity.LinkToEntityName]) {
foreach (var linkedRow in db[linkEntity.LinkToEntityName])
{
var linkedEntity = linkedRow.ToEntity();

if (linkedEntity.Attributes.ContainsKey(linkEntity.LinkToAttributeName) &&
parent.Attributes.ContainsKey(linkEntity.LinkFromAttributeName)) {
parent.Attributes.ContainsKey(linkEntity.LinkFromAttributeName))
{
var linkedAttr = Utility.ConvertToComparableObject(
linkedEntity.Attributes[linkEntity.LinkToAttributeName]);
var entAttr = Utility.ConvertToComparableObject(
parent.Attributes[linkEntity.LinkFromAttributeName]);

if (linkedAttr.Equals(entAttr)) {
if (linkedAttr.Equals(entAttr))
{
var aliasedEntity = GetEntityWithAliasAttributes(linkEntity.EntityAlias, toAdd,
metadata.EntityMetadata.GetMetadata(toAdd.LogicalName), linkedEntity.Attributes);

if (linkEntity.LinkEntities.Count > 0) {
if (linkEntity.LinkEntities.Count > 0)
{
var subEntities = new List<Entity>();
foreach (var nestedLinkEntity in linkEntity.LinkEntities) {
foreach (var nestedLinkEntity in linkEntity.LinkEntities)
{
nestedLinkEntity.LinkFromEntityName = linkEntity.LinkToEntityName;
var alliasedLinkValues = GetAliasedValuesFromLinkentity(
nestedLinkEntity, linkedEntity, aliasedEntity, db);
subEntities.AddRange(alliasedLinkValues
.Where(e => Utility.MatchesCriteria(e, linkEntity.LinkCriteria)));
}
collection.AddRange(subEntities);
} else if(Utility.MatchesCriteria(aliasedEntity, linkEntity.LinkCriteria)) {
}
else if (Utility.MatchesCriteria(aliasedEntity, linkEntity.LinkCriteria))
{
collection.Add(aliasedEntity);
}

}
}
}
if (linkEntity.JoinOperator == JoinOperator.LeftOuter && collection.Count == 0) {
if (linkEntity.JoinOperator == JoinOperator.LeftOuter && collection.Count == 0)
{
collection.Add(toAdd);
}
return collection;
}

private Entity GetEntityWithAliasAttributes(string alias, Entity toAdd, EntityMetadata metadata, AttributeCollection attributes) {
private Entity GetEntityWithAliasAttributes(string alias, Entity toAdd, EntityMetadata metadata, AttributeCollection attributes)
{
var parentClone = core.GetStronglyTypedEntity(toAdd, metadata, null);
foreach (var attr in attributes.Keys) {
foreach (var attr in attributes.Keys)
{
parentClone.Attributes.Add(alias + "." + attr, new AliasedValue(alias, attr, attributes[attr]));
}
return parentClone;
}

private void KeepAttributesAndAliasAttributes(Entity entity, ColumnSet toKeep) {
private void KeepAttributesAndAliasAttributes(Entity entity, ColumnSet toKeep)
{
var clone = entity.CloneEntity(metadata.EntityMetadata.GetMetadata(entity.LogicalName), toKeep);
if (toKeep != null && !toKeep.AllColumns)
clone.Attributes.AddRange(entity.Attributes.Where(x => x.Key.Contains(".")));
clone.Attributes.AddRange(entity.Attributes.Where(x => x.Key.Contains('.')));
entity.Attributes.Clear();
entity.Attributes.AddRange(clone.Attributes);
}
Expand All @@ -229,7 +238,7 @@ private void FillAliasIfEmpty(QueryExpression expression)

private void FillAliasIfEmpty(LinkEntity linkEntity, ref int linkCount)
{
if(linkEntity.EntityAlias == null)
if (linkEntity.EntityAlias == null)
{
linkEntity.EntityAlias = $"{linkEntity.LinkToEntityName}{linkCount}";
linkCount++;
Expand Down
59 changes: 51 additions & 8 deletions tests/SharedTests/TestRetrieveMultiple.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xrm.Sdk;
using System.Globalization;
using Microsoft.Xrm.Sdk.Query;
using DG.Tools.XrmMockup;
using DG.XrmContext;
using DG.Tools.XrmMockup;
using DG.XrmFramework.BusinessDomain.ServiceContext;
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using Xunit;

namespace DG.XrmMockupTest
Expand Down Expand Up @@ -801,7 +801,7 @@ public void RetrieveMultipleWithLinkEntitiesReturnDistinctResults()
};

var res = orgAdminService.RetrieveMultiple(query).Entities;

var distinctIdCount = res.Select(x => x.Id).Distinct().Count();

Assert.Equal(distinctIdCount, res.Count);
Expand Down Expand Up @@ -964,5 +964,48 @@ public void TestRetrieveMultipleFailWithNonExistentAttribute()

Assert.Throws<AggregateException>(() => orgAdminService.RetrieveMultiple(query));
}

[Fact]
public void TestRetrieveMultipleTopCount()
{
var query = new QueryExpression("account")
{
ColumnSet = new ColumnSet("accountid"),
TopCount = 1
};

var res = orgAdminService.RetrieveMultiple(query);

Assert.Single(res.Entities);
}

[Fact]
public void TestRetrieveMultipleTake()
{
using (var context = new Xrm(orgAdminService))
{
Assert.Single(context.AccountSet
.Select(a => a.AccountId)
.Take(1)
.ToList());
}
}

[Fact]
public void TestRetrieveMultipleSkip()
{
using (var context = new Xrm(orgAdminService))
{
Assert.Empty(context.AccountSet
.Select(a => a.AccountId)
.Skip(4)
.ToList());

Assert.Single(context.AccountSet
.Select(a => a.AccountId)
.Skip(3)
.ToList());
}
}
}
}