Merge pull request #10732 from abpframework/maliming/IValueValidatorF…

…actory Add `IValueValidatorFactory`
abpframework · Jan 10, 2022 · bc00752 · bc00752
2 parents b5b9fb3 + 3b12c26
commit bc00752
Show file tree

Hide file tree

Showing 12 changed files with 154 additions and 19 deletions.
diff --git a/...on.Contracts/Volo/Abp/FeatureManagement/AbpFeatureManagementApplicationContractsModule.cs b/...on.Contracts/Volo/Abp/FeatureManagement/AbpFeatureManagementApplicationContractsModule.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using Microsoft.Extensions.DependencyInjection;
 using Volo.Abp.Application;
 using Volo.Abp.Authorization;
 using Volo.Abp.FeatureManagement.JsonConverters;
@@ -25,14 +26,20 @@ public override void ConfigureServices(ServiceConfigurationContext context)
             options.FileSets.AddEmbedded<AbpFeatureManagementApplicationContractsModule>();
         });
 
+        var contractsOptionsActions = context.Services.GetPreConfigureActions<AbpFeatureManagementApplicationContractsOptions>();
+        Configure<AbpFeatureManagementApplicationContractsOptions>(options =>
+        {
+            contractsOptionsActions.Configure(options);
+        });
+
         Configure<AbpNewtonsoftJsonSerializerOptions>(options =>
         {
             options.Converters.Add<NewtonsoftStringValueTypeJsonConverter>();
         });
 
         Configure<AbpSystemTextJsonSerializerOptions>(options =>
         {
-            options.JsonSerializerOptions.Converters.AddIfNotContains(new StringValueTypeJsonConverter());
+            options.JsonSerializerOptions.Converters.AddIfNotContains(new StringValueTypeJsonConverter(contractsOptionsActions.Configure()));
         });
     }
 }
diff --git a/...n.Contracts/Volo/Abp/FeatureManagement/AbpFeatureManagementApplicationContractsOptions.cs b/...n.Contracts/Volo/Abp/FeatureManagement/AbpFeatureManagementApplicationContractsOptions.cs
@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+using Volo.Abp.FeatureManagement.JsonConverters;
+using Volo.Abp.Validation.StringValues;
+
+namespace Volo.Abp.FeatureManagement;
+
+public class AbpFeatureManagementApplicationContractsOptions
+{
+    public HashSet<IValueValidatorFactory> ValueValidatorFactory { get; }
+
+    public AbpFeatureManagementApplicationContractsOptions()
+    {
+        ValueValidatorFactory = new HashSet<IValueValidatorFactory> 
+        {
+            new ValueValidatorFactory<AlwaysValidValueValidator>("NULL"),
+            new ValueValidatorFactory<BooleanValueValidator>("BOOLEAN"),
+            new ValueValidatorFactory<NumericValueValidator>("NUMERIC"),
+            new ValueValidatorFactory<StringValueValidator>("STRING")
+        };
+    }
+}
diff --git a/...Application.Contracts/Volo/Abp/FeatureManagement/JsonConverters/IValueValidatorFactory.cs b/...Application.Contracts/Volo/Abp/FeatureManagement/JsonConverters/IValueValidatorFactory.cs
@@ -0,0 +1,10 @@
+using Volo.Abp.Validation.StringValues;
+
+namespace Volo.Abp.FeatureManagement.JsonConverters;
+
+public interface IValueValidatorFactory
+{
+    bool CanCreate(string name);
+
+    IValueValidator Create();
+}
diff --git a/...racts/Volo/Abp/FeatureManagement/JsonConverters/NewtonsoftStringValueTypeJsonConverter.cs b/...racts/Volo/Abp/FeatureManagement/JsonConverters/NewtonsoftStringValueTypeJsonConverter.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using Microsoft.Extensions.Options;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Volo.Abp.DependencyInjection;
@@ -13,6 +14,13 @@ public class NewtonsoftStringValueTypeJsonConverter : JsonConverter, ITransientD
 {
     public override bool CanWrite => false;
 
+    protected readonly AbpFeatureManagementApplicationContractsOptions Options;
+
+    public NewtonsoftStringValueTypeJsonConverter(IOptions<AbpFeatureManagementApplicationContractsOptions> options)
+    {
+        Options = options.Value;
+    }
+
     public override bool CanConvert(Type objectType)
     {
         return objectType == typeof(IStringValueType);
@@ -77,13 +85,11 @@ protected virtual IStringValueType CreateStringValueTypeByName(JObject jObject,
 
     protected virtual IValueValidator CreateValueValidatorByName(JToken jObject, string name)
     {
-        return name switch
+        foreach (var factory in Options.ValueValidatorFactory.Where(factory => factory.CanCreate(name)))
         {
-            "NULL" => new AlwaysValidValueValidator(),
-            "BOOLEAN" => new BooleanValueValidator(),
-            "NUMERIC" => new NumericValueValidator(),
-            "STRING" => new StringValueValidator(),
-            _ => throw new ArgumentException($"{nameof(IValueValidator)} named {name} was not found!")
-        };
+            return factory.Create();
+        }
+
+        throw new ArgumentException($"{nameof(IValueValidator)} named {name} was cannot be created!");
     }
 }
diff --git a/...ation.Contracts/Volo/Abp/FeatureManagement/JsonConverters/StringValueTypeJsonConverter.cs b/...ation.Contracts/Volo/Abp/FeatureManagement/JsonConverters/StringValueTypeJsonConverter.cs
@@ -12,6 +12,13 @@ public class StringValueTypeJsonConverter : JsonConverter<IStringValueType>
 
     private JsonSerializerOptions _writeJsonSerializerOptions;
 
+    protected readonly AbpFeatureManagementApplicationContractsOptions Options;
+
+    public StringValueTypeJsonConverter(AbpFeatureManagementApplicationContractsOptions options)
+    {
+        Options = options;
+    }
+
     public override IStringValueType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
         var rootElement = JsonDocument.ParseValue(ref reader).RootElement;
@@ -21,7 +28,8 @@ public override IStringValueType Read(ref Utf8JsonReader reader, Type typeToConv
         {
             var name = nameJsonProperty.Value.GetString();
 
-            _readJsonSerializerOptions ??= JsonSerializerOptionsHelper.Create(options, this, new ValueValidatorJsonConverter(), new SelectionStringValueItemSourceJsonConverter());
+            _readJsonSerializerOptions ??= JsonSerializerOptionsHelper.Create(options, this, new ValueValidatorJsonConverter(Options),
+                new SelectionStringValueItemSourceJsonConverter());
 
             return name switch
             {

diff --git a/....Application.Contracts/Volo/Abp/FeatureManagement/JsonConverters/ValueValidatorFactory.cs b/....Application.Contracts/Volo/Abp/FeatureManagement/JsonConverters/ValueValidatorFactory.cs
@@ -0,0 +1,24 @@
+using Volo.Abp.Validation.StringValues;
+
+namespace Volo.Abp.FeatureManagement.JsonConverters;
+
+public class ValueValidatorFactory<TValueValidator> : IValueValidatorFactory
+    where TValueValidator : IValueValidator, new()
+{
+    protected readonly string Name;
+
+    public ValueValidatorFactory(string name)
+    {
+        Name = name;
+    }
+
+    public bool CanCreate(string name)
+    {
+        return Name == name;
+    }
+
+    public IValueValidator Create()
+    {
+        return new TValueValidator() as IValueValidator;
+    }
+}
diff --git a/...cation.Contracts/Volo/Abp/FeatureManagement/JsonConverters/ValueValidatorJsonConverter.cs b/...cation.Contracts/Volo/Abp/FeatureManagement/JsonConverters/ValueValidatorJsonConverter.cs
@@ -14,6 +14,13 @@ public class ValueValidatorJsonConverter : JsonConverter<IValueValidator>
 
     private JsonSerializerOptions _writeJsonSerializerOptions;
 
+    protected readonly AbpFeatureManagementApplicationContractsOptions Options;
+
+    public ValueValidatorJsonConverter(AbpFeatureManagementApplicationContractsOptions options)
+    {
+        Options = options;
+    }
+
     public override IValueValidator Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
         var rootElement = JsonDocument.ParseValue(ref reader).RootElement;
@@ -51,13 +58,11 @@ public override void Write(Utf8JsonWriter writer, IValueValidator value, JsonSer
 
     protected virtual IValueValidator CreateValueValidatorByName(string name)
     {
-        return name switch
+        foreach (var factory in Options.ValueValidatorFactory.Where(factory => factory.CanCreate(name)))
         {
-            "NULL" => new AlwaysValidValueValidator(),
-            "BOOLEAN" => new BooleanValueValidator(),
-            "NUMERIC" => new NumericValueValidator(),
-            "STRING" => new StringValueValidator(),
-            _ => throw new ArgumentException($"{nameof(IValueValidator)} named {name} was not found!")
-        };
+            return factory.Create();
+        }
+
+        throw new ArgumentException($"{nameof(IValueValidator)} named {name} was cannot be created!");
     }
 }
diff --git a/...FeatureManagement.HttpApi/Volo/Abp/FeatureManagement/AbpFeatureManagementHttpApiModule.cs b/...FeatureManagement.HttpApi/Volo/Abp/FeatureManagement/AbpFeatureManagementHttpApiModule.cs
@@ -32,9 +32,10 @@ public override void ConfigureServices(ServiceConfigurationContext context)
                 .AddBaseTypes(typeof(AbpUiResource));
         });
 
+        var contractsOptions = context.Services.ExecutePreConfiguredActions<AbpFeatureManagementApplicationContractsOptions>();
         Configure<JsonOptions>(options =>
         {
-            options.JsonSerializerOptions.Converters.AddIfNotContains(new StringValueTypeJsonConverter());
+            options.JsonSerializerOptions.Converters.AddIfNotContains(new StringValueTypeJsonConverter(contractsOptions));
         });
     }
 }
diff --git a/....Application.Tests/Volo/Abp/FeatureManagement/NewtonsoftStringValueJsonConverter_Tests.cs b/....Application.Tests/Volo/Abp/FeatureManagement/NewtonsoftStringValueJsonConverter_Tests.cs
@@ -9,7 +9,7 @@ protected override void AfterAddApplication(IServiceCollection services)
     {
         services.PreConfigure<AbpJsonOptions>(options =>
         {
-            options.UseHybridSerializer = true;
+            options.UseHybridSerializer = false;
         });
     }
 }
diff --git a/...Management.Application.Tests/Volo/Abp/FeatureManagement/StringValueJsonConverter_Tests.cs b/...Management.Application.Tests/Volo/Abp/FeatureManagement/StringValueJsonConverter_Tests.cs
@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
+using Microsoft.Extensions.DependencyInjection;
 using Shouldly;
+using Volo.Abp.FeatureManagement.JsonConverters;
 using Volo.Abp.Json;
 using Volo.Abp.Validation.StringValues;
 using Xunit;
@@ -16,6 +18,16 @@ public StringValueJsonConverter_Tests()
         _jsonSerializer = GetRequiredService<IJsonSerializer>();
     }
 
+    protected override void BeforeAddApplication(IServiceCollection services)
+    {
+        services.PreConfigure<AbpFeatureManagementApplicationContractsOptions>(options =>
+        {
+            options.ValueValidatorFactory.Add(new ValueValidatorFactory<UrlValueValidator>("URL"));
+        });
+
+        base.BeforeAddApplication(services);
+    }
+
     [Fact]
     public void Should_Serialize_And_Deserialize()
     {
@@ -67,6 +79,13 @@ public void Should_Serialize_And_Deserialize()
                                     Name = "FeatureName",
                                     Key = "FeatureKey"
                                 }
+                            },
+                            new FeatureDto
+                            {
+                                ValueType = new FreeTextStringValueType
+                                {
+                                    Validator = new UrlValueValidator("https")
+                                }
                             }
                         }
                     }
@@ -95,5 +114,9 @@ public void Should_Serialize_And_Deserialize()
 
         featureListDto2.Groups[0].Features[3].Provider.Name.ShouldBe("FeatureName");
         featureListDto2.Groups[0].Features[3].Provider.Key.ShouldBe("FeatureKey");
+
+        featureListDto2.Groups[0].Features[4].ValueType.ShouldBeOfType<FreeTextStringValueType>();
+        featureListDto2.Groups[0].Features[4].ValueType.Validator.ShouldBeOfType<UrlValueValidator>();
+        featureListDto2.Groups[0].Features[4].ValueType.Validator.As<UrlValueValidator>().Scheme.ShouldBe("https");
     }
 }
diff --git a/...lication.Tests/Volo/Abp/FeatureManagement/SystemTextJsonStringValueJsonConverter_Tests.cs b/...lication.Tests/Volo/Abp/FeatureManagement/SystemTextJsonStringValueJsonConverter_Tests.cs
@@ -9,7 +9,7 @@ protected override void AfterAddApplication(IServiceCollection services)
     {
         services.PreConfigure<AbpJsonOptions>(options =>
         {
-            options.UseHybridSerializer = false;
+            options.UseHybridSerializer = true;
         });
     }
 }
diff --git a/...o.Abp.FeatureManagement.Application.Tests/Volo/Abp/FeatureManagement/UrlValueValidator.cs b/...o.Abp.FeatureManagement.Application.Tests/Volo/Abp/FeatureManagement/UrlValueValidator.cs
@@ -0,0 +1,30 @@
+using System;
+using Volo.Abp.Validation.StringValues;
+
+namespace Volo.Abp.FeatureManagement;
+
+[Serializable]
+[ValueValidator("URL")]
+public class UrlValueValidator : ValueValidatorBase
+{
+    public string Scheme {
+        get => this["Scheme"].ToString();
+        set => this["Scheme"] = value;
+    }
+
+    public UrlValueValidator()
+    {
+
+    }
+
+    public UrlValueValidator(string scheme)
+    {
+        Scheme = scheme;
+    }
+
+    public override bool IsValid(object value)
+    {
+        var s = value.ToString();
+        return s != null && s.StartsWith(Scheme);
+    }
+}