Skip to content

Commit

Permalink
Handle untyped entities and scalar collections in message responses, …
Browse files Browse the repository at this point in the history 
…and entity types in message reuqests

Fixes #369, #442, #494
  • Loading branch information
@MarkMpn
MarkMpn committed Sep 4, 2024
1 parent 3f328f8 commit 754e24f
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 28 deletions.
178 changes: 155 additions & 23 deletions MarkMpn.Sql4Cds.Engine/ExecutionPlan/ExecuteMessageNode.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ class ExecuteMessageNode : BaseDataNode, IDmlQueryExecutionPlanNode
{
private Dictionary<string, Func<ExpressionExecutionContext, object>> _inputParameters;
private string _primaryKeyColumn;
private bool _isExpando;

/// <summary>
/// The SQL string that the query was converted from
Expand Down Expand Up @@ -129,11 +130,23 @@ public override IDataExecutionPlanNodeInternal FoldQuery(NodeCompilationContext
{
var sourceSqlType = value.Value.GetType(expressionContext, out _);
var destNetType = ValueTypes[value.Key];
if (destNetType == typeof(Entity))
destNetType = typeof(string);
var destSqlType = SqlTypeConverter.NetToSqlType(destNetType);
var expr = value.Value.Compile(expressionContext);
var sqlConversion = SqlTypeConverter.GetConversion(sourceSqlType, destSqlType);
var netConversion = SqlTypeConverter.GetConversion(destSqlType, destNetType);
return (Func<ExpressionExecutionContext, object>) ((ExpressionExecutionContext ctx) => netConversion(sqlConversion(expr(ctx))));
var conversion = (Func<ExpressionExecutionContext, object>) ((ExpressionExecutionContext ctx) => netConversion(sqlConversion(expr(ctx))));
if (ValueTypes[value.Key] == typeof(Entity))
{
var conversionToString = conversion;
conversion = (ExpressionExecutionContext ctx) =>
{
var s = (string)conversionToString(ctx);
return DeserializeAttributeValues(s);
};
}
return conversion;
});

BypassCustomPluginExecution = GetBypassPluginExecution(hints, context.Options);
Expand Down Expand Up @@ -171,12 +184,7 @@ public override INodeSchema GetSchema(NodeCompilationContext context)
private void SetOutputSchema(DataSource dataSource, Message message, TSqlFragment source)
{
// Add the response fields to the node schema
if (message.OutputParameters.All(f => f.IsScalarType()))
{
foreach (var value in message.OutputParameters)
AddSchemaColumn(value.Name, value.GetSqlDataType(dataSource));
}
else
if (message.OutputParameters.Count == 1 && (message.OutputParameters[0].Type == typeof(Entity) || !message.OutputParameters[0].IsScalarType()))
{
var firstValue = message.OutputParameters.Single();
var audit = false;
Expand All @@ -201,22 +209,39 @@ private void SetOutputSchema(DataSource dataSource, Message message, TSqlFragmen
else
EntityCollectionResponseParameter = firstValue.Name;

foreach (var attrMetadata in dataSource.Metadata[otc.Value].Attributes.Where(a => a.AttributeOf == null))
if (otc == null)
{
AddSchemaColumn(attrMetadata.LogicalName, attrMetadata.GetAttributeSqlType(dataSource, false));
_isExpando = true;

// Add standard virtual attributes
foreach (var virtualAttr in attrMetadata.GetVirtualAttributes(dataSource, false))
AddSchemaColumn(attrMetadata.LogicalName + virtualAttr.Suffix, virtualAttr.DataType);
if (type == typeof(Entity) || type == typeof(EntityCollection))
AddSchemaColumn(firstValue.Name, DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource.DefaultCollation, CollationLabel.Implicit));
else if (type.IsArray)
AddSchemaColumn(firstValue.Name, SqlTypeConverter.NetToSqlType(type.GetElementType()).ToSqlType(dataSource));
}

if (audit)
else
{
AddSchemaColumn("newvalues", DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource.DefaultCollation, CollationLabel.CoercibleDefault));
AddSchemaColumn("oldvalues", DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource.DefaultCollation, CollationLabel.CoercibleDefault));
}
foreach (var attrMetadata in dataSource.Metadata[otc.Value].Attributes.Where(a => a.AttributeOf == null))
{
AddSchemaColumn(attrMetadata.LogicalName, attrMetadata.GetAttributeSqlType(dataSource, false));

// Add standard virtual attributes
foreach (var virtualAttr in attrMetadata.GetVirtualAttributes(dataSource, false))
AddSchemaColumn(attrMetadata.LogicalName + virtualAttr.Suffix, virtualAttr.DataType);
}

_primaryKeyColumn = PrefixWithAlias(dataSource.Metadata[otc.Value].PrimaryIdAttribute);
if (audit)
{
AddSchemaColumn("newvalues", DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource.DefaultCollation, CollationLabel.CoercibleDefault));
AddSchemaColumn("oldvalues", DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource.DefaultCollation, CollationLabel.CoercibleDefault));
}

_primaryKeyColumn = PrefixWithAlias(dataSource.Metadata[otc.Value].PrimaryIdAttribute);
}
}
else
{
foreach (var value in message.OutputParameters)
AddSchemaColumn(value.Name, value.GetSqlDataType(dataSource));
}

if (!String.IsNullOrEmpty(PagingParameter) && EntityCollectionResponseParameter == null)
Expand Down Expand Up @@ -327,9 +352,34 @@ private EntityCollection GetEntityCollection(OrganizationResponse response)
entities.PagingCookie = audit.PagingCookie;
entities.TotalRecordCount = audit.TotalRecordCount;
}
else
else if (response[EntityCollectionResponseParameter] is EntityCollection collection)
{
entities = (EntityCollection)response[EntityCollectionResponseParameter];

if (_isExpando)
{
// Convert entity to JSON
for (var i = 0; i < entities.Entities.Count; i++)
{
var json = SerializeAttributeValues(entities.Entities[i]);
var entity = new Entity
{
[EntityCollectionResponseParameter] = json
};
entities.Entities[i] = entity;
}
}
}
else if (response[EntityCollectionResponseParameter].GetType().IsArray)
{
entities = new EntityCollection();

foreach (var value in (Array)response[EntityCollectionResponseParameter])
entities.Entities.Add(new Entity { [EntityCollectionResponseParameter] = value });
}
else
{
throw new QueryExecutionException($"Unexpected response type for {EntityCollectionResponseParameter}");
}
}
else if (EntityResponseParameter != null)
Expand All @@ -339,6 +389,8 @@ private EntityCollection GetEntityCollection(OrganizationResponse response)

if (response[EntityResponseParameter] is AuditDetail audit)
entity = GetAuditEntity(audit);
else if (_isExpando)
entity = new Entity { [EntityResponseParameter] = SerializeAttributeValues((Entity)response[EntityResponseParameter]) };
else
entity = (Entity)response[EntityResponseParameter];

Expand Down Expand Up @@ -369,18 +421,27 @@ private Entity GetAuditEntity(AuditDetail audit)
// Attribute list could vary from record to record depending on the entity type being audited,
// so can't expose this as a definite list of columns. Instead, serialize them as a string and
// allow the values to be accessed later using some custom functions.
entity["newvalues"] = SerializeAttributeAuditValues(attributeAudit.NewValue);
entity["oldvalues"] = SerializeAttributeAuditValues(attributeAudit.OldValue);
entity["newvalues"] = SerializeAttributeValues(attributeAudit.NewValue);
entity["oldvalues"] = SerializeAttributeValues(attributeAudit.OldValue);
}

return entity;
}

private string SerializeAttributeAuditValues(Entity entity)
private string SerializeAttributeValues(Entity entity)
{
if (entity == null)
return null;

var values = new Dictionary<string, object>();

if (entity != null && entity.Attributes != null)
if (!String.IsNullOrEmpty(entity.LogicalName))
values["@odata.type"] = entity.LogicalName;

if (entity.Id != Guid.Empty)
values["@odata.id"] = entity.Id;

if (entity.Attributes != null)
{
foreach (var attribute in entity.Attributes)
{
Expand All @@ -402,12 +463,82 @@ private string SerializeAttributeAuditValues(Entity entity)
{
values[attribute.Key] = attribute.Value;
}

// Add type annotation for any types that aren't going to be natively deserialized to the same type
if (attribute.Value != null && !(attribute.Value is string) && !(attribute.Value is bool) && !(attribute.Value is int))
values[attribute.Key + "@odata.type"] = attribute.Value.GetType().Name;
}
}

return JsonConvert.SerializeObject(values);
}

private Entity DeserializeAttributeValues(string s)
{
if (String.IsNullOrEmpty(s))
return null;

var values = JsonConvert.DeserializeObject<Dictionary<string, object>>(s);
var entity = new Entity();

// Extrac the type and ID from known fields
if (values.TryGetValue("@odata.type", out var type))
entity.LogicalName = (string)type;

if (values.TryGetValue("@odata.id", out var id))
entity.Id = Guid.Parse((string)id);

// Look for any other typed values
foreach (var value in values)
{
if (value.Key.StartsWith("@odata.") || value.Key.EndsWith("@odata.type"))
continue;

if ((value.Key.EndsWith("name") || value.Key.EndsWith("type")) && values.ContainsKey(value.Key.Substring(0, value.Key.Length - 4) + "@odata.type"))
continue;

if (!values.TryGetValue(value.Key + "@odata.type", out var valueType))
{
// Pass through the value as-is
entity[value.Key] = value.Value;
}
else
{
// Convert the value to the requested XRM type
switch ((string)valueType)
{

case "OptionSetValue":
entity[value.Key] = new OptionSetValue((int)value.Value);
break;

case "Money":
entity[value.Key] = new Money((decimal)value.Value);
break;

case "EntityReference":
var er = new EntityReference();
er.Id = Guid.Parse((string)value.Value);

if (values.TryGetValue(value.Key + "type", out var erType))
er.LogicalName = (string)erType;

if (values.TryGetValue(value.Key + "name", out var erName))
er.Name = (string)erName;

entity[value.Key] = er;
break;

default:
entity[value.Key] = value.Value;
break;
}
}
}

return entity;
}

private void OnRetrievedEntity(Entity entity, IQueryExecutionOptions options, DataSource dataSource)
{
// Expose any formatted values for OptionSetValue and EntityReference values
Expand Down Expand Up @@ -490,6 +621,7 @@ public override object Clone()
BypassCustomPluginExecution = BypassCustomPluginExecution,
_primaryKeyColumn = _primaryKeyColumn,
PagingParameter = PagingParameter,
_isExpando = _isExpando,
};

foreach (var value in Values)
Expand Down
27 changes: 22 additions & 5 deletions MarkMpn.Sql4Cds.Engine/MessageCache.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,8 @@ private bool IsValid(bool requireOutput)
// 2. The response fields must be EITHER:
// a. A single field of an entity-derived type, OR
// b. A single field of an entity collection, OR
// c. one or more fields of a scalar type
// c. A single field of an array of a scalar type, OR
// d. one or more fields of a scalar type

if (InputParameters.Any(p => p.Type == null))
return false;
Expand Down Expand Up @@ -384,10 +385,13 @@ private bool IsValid(bool requireOutput)
if (OutputParameters.Count > 1)
return false;

if ((OutputParameters[0].Type == typeof(Entity) && OutputParameters[0].OTC != null) || OutputParameters[0].Type == typeof(AuditDetail))
if (OutputParameters[0].Type == typeof(Entity) || OutputParameters[0].Type == typeof(AuditDetail))
return true;

if ((OutputParameters[0].Type == typeof(EntityCollection) && OutputParameters[0].OTC != null) || OutputParameters[0].Type == typeof(AuditDetailCollection))
if (OutputParameters[0].Type == typeof(EntityCollection) || OutputParameters[0].Type == typeof(AuditDetailCollection))
return true;

if (OutputParameters[0].Type.IsArray && MessageParameter.IsScalarType(OutputParameters[0].Type.GetElementType()))
return true;

return false;
Expand Down Expand Up @@ -430,8 +434,11 @@ public class MessageParameter
/// <returns><c>true</c> if the <see cref="Type"/> is a scalar type</returns>
public bool IsScalarType()
{
var type = Type;
return IsScalarType(Type);
}

internal static bool IsScalarType(Type type)
{
if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>))
type = type.GetGenericArguments()[0];

Expand All @@ -440,12 +447,22 @@ public bool IsScalarType()
type == typeof(Money))
return true;

// Entity values can be converted to JSON strings and so can be treated as scalar values
if (type == typeof(Entity))
return true;

return false;
}

/// <summary>
/// Returns the SQL data type for the parameter
/// </summary>
public Microsoft.SqlServer.TransactSql.ScriptDom.DataTypeReference GetSqlDataType(DataSource dataSource) => SqlTypeConverter.NetToSqlType(Type).ToSqlType(dataSource);
public Microsoft.SqlServer.TransactSql.ScriptDom.DataTypeReference GetSqlDataType(DataSource dataSource)
{
if (Type == typeof(Entity))
return DataTypeHelpers.NVarChar(Int32.MaxValue, dataSource?.DefaultCollation ?? Collation.USEnglish, CollationLabel.Implicit);

return SqlTypeConverter.NetToSqlType(Type).ToSqlType(dataSource);
}
}
}

0 comments on commit 754e24f

Please sign in to comment.