| | | 1 | | using System.Reflection; |
| | | 2 | | using System.Runtime.CompilerServices; |
| | | 3 | | using System.Text.Json; |
| | | 4 | | using System.Text.Json.Serialization; |
| | | 5 | | using Elsa.Extensions; |
| | | 6 | | using Elsa.Workflows.Attributes; |
| | | 7 | | |
| | | 8 | | namespace Elsa.Workflows.Serialization.Converters; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Serializes an object to JSON, excluding properties marked with <see cref="ExcludeFromHashAttribute"/>. |
| | | 12 | | /// Properties ignored by <see cref="JsonIgnoreAttribute"/> are also excluded according to their configured ignore condi |
| | | 13 | | /// avoid adding or changing these attributes on bookmark or stimulus payloads whose hashes must remain compatible with |
| | | 14 | | /// </summary> |
| | | 15 | | public class ExcludeFromHashConverter : JsonConverter<object> |
| | | 16 | | { |
| | 1 | 17 | | private static readonly ConditionalWeakTable<Type, PropertyMetadata[]> PropertyCache = new(); |
| | | 18 | | private JsonSerializerOptions? _options; |
| | | 19 | | |
| | | 20 | | /// <inheritdoc /> |
| | | 21 | | public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) |
| | | 22 | | { |
| | 0 | 23 | | throw new NotSupportedException(); |
| | | 24 | | } |
| | | 25 | | |
| | | 26 | | /// <inheritdoc /> |
| | | 27 | | public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options) |
| | | 28 | | { |
| | 12242 | 29 | | writer.WriteStartObject(); |
| | 12242 | 30 | | var newOptions = GetClonedOptions(options); |
| | | 31 | | |
| | 336766 | 32 | | foreach (var metadata in GetSerializableProperties(value.GetType())) |
| | | 33 | | { |
| | 156141 | 34 | | var property = metadata.Property; |
| | 156141 | 35 | | var propertyValue = property.GetValue(value); |
| | | 36 | | |
| | 156141 | 37 | | if (ShouldIgnoreProperty(metadata.JsonIgnoreCondition, property.PropertyType, propertyValue)) |
| | | 38 | | { |
| | | 39 | | continue; |
| | | 40 | | } |
| | | 41 | | |
| | 156141 | 42 | | writer.WritePropertyName(property.Name); |
| | 156141 | 43 | | JsonSerializer.Serialize(writer, propertyValue, newOptions); |
| | | 44 | | } |
| | | 45 | | |
| | 12242 | 46 | | writer.WriteEndObject(); |
| | 12242 | 47 | | } |
| | | 48 | | |
| | | 49 | | private static PropertyMetadata[] GetSerializableProperties(Type type) |
| | | 50 | | { |
| | 12257 | 51 | | return PropertyCache.GetValue(type, static itemType => GetPublicInstanceProperties(itemType) |
| | 49 | 52 | | .Where(property => property.GetIndexParameters().Length == 0) |
| | 49 | 53 | | .Select(property => new |
| | 49 | 54 | | { |
| | 49 | 55 | | Property = property, |
| | 49 | 56 | | ExcludeFromHash = property.GetCustomAttribute<ExcludeFromHashAttribute>(), |
| | 49 | 57 | | JsonIgnore = property.GetCustomAttribute<JsonIgnoreAttribute>() |
| | 49 | 58 | | }) |
| | 49 | 59 | | .Where(x => x.ExcludeFromHash == null && !ShouldAlwaysIgnoreProperty(x.JsonIgnore?.Condition)) |
| | 42 | 60 | | .Select(x => new PropertyMetadata(x.Property, x.JsonIgnore?.Condition)) |
| | 12257 | 61 | | .ToArray()); |
| | | 62 | | } |
| | | 63 | | |
| | | 64 | | private static IEnumerable<PropertyInfo> GetPublicInstanceProperties(Type type) |
| | | 65 | | { |
| | 64 | 66 | | for (var currentType = type; currentType != null && currentType != typeof(object); currentType = currentType.Bas |
| | | 67 | | { |
| | 132 | 68 | | foreach (var property in currentType |
| | 17 | 69 | | .GetProperties(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public) |
| | | 70 | | .OrderBy(x => x.MetadataToken)) |
| | | 71 | | { |
| | 49 | 72 | | yield return property; |
| | | 73 | | } |
| | | 74 | | } |
| | 15 | 75 | | } |
| | | 76 | | |
| | | 77 | | private static bool ShouldAlwaysIgnoreProperty(JsonIgnoreCondition? condition) |
| | | 78 | | { |
| | 44 | 79 | | return condition == JsonIgnoreCondition.Always; |
| | | 80 | | } |
| | | 81 | | |
| | | 82 | | private static bool ShouldIgnoreProperty(JsonIgnoreCondition? condition, Type declaredType, object? value) |
| | | 83 | | { |
| | 156141 | 84 | | return condition switch |
| | 156141 | 85 | | { |
| | 156141 | 86 | | null => false, |
| | 0 | 87 | | JsonIgnoreCondition.Never => false, |
| | 0 | 88 | | JsonIgnoreCondition.Always => true, |
| | 0 | 89 | | JsonIgnoreCondition.WhenWritingNull => value == null, |
| | 0 | 90 | | JsonIgnoreCondition.WhenWritingDefault => value == null || IsDefaultValue(declaredType, value), |
| | 0 | 91 | | _ => false |
| | 156141 | 92 | | }; |
| | | 93 | | } |
| | | 94 | | |
| | | 95 | | private static bool IsDefaultValue(Type declaredType, object value) |
| | | 96 | | { |
| | 0 | 97 | | return declaredType.IsValueType && value.Equals(Activator.CreateInstance(declaredType)); |
| | | 98 | | } |
| | | 99 | | |
| | 312324 | 100 | | private sealed record PropertyMetadata(PropertyInfo Property, JsonIgnoreCondition? JsonIgnoreCondition); |
| | | 101 | | |
| | | 102 | | private JsonSerializerOptions GetClonedOptions(JsonSerializerOptions options) |
| | | 103 | | { |
| | 12242 | 104 | | if(_options != null) |
| | 12217 | 105 | | return _options; |
| | | 106 | | |
| | 25 | 107 | | var newOptions = new JsonSerializerOptions(options); |
| | 75 | 108 | | newOptions.Converters.RemoveWhere(x => x is ExcludeFromHashConverterFactory); |
| | 25 | 109 | | return _options = newOptions; |
| | | 110 | | } |
| | | 111 | | } |
| | | 112 | | |
| | | 113 | | /// <summary> |
| | | 114 | | /// A factory for creating <see cref="ExcludeFromHashConverter"/> instances. |
| | | 115 | | /// </summary> |
| | | 116 | | public class ExcludeFromHashConverterFactory : JsonConverterFactory |
| | | 117 | | { |
| | | 118 | | /// <inheritdoc /> |
| | | 119 | | public override bool CanConvert(Type typeToConvert) => true; |
| | | 120 | | |
| | | 121 | | /// <inheritdoc /> |
| | | 122 | | public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) => new ExcludeFromH |
| | | 123 | | } |