Cleanup Serializers (#15633)

--------- Co-authored-by: Sára El-Saig <sara.el-saig@lombiq.com>
OrchardCMS · Apr 1, 2024 · bd0c019 · bd0c019
1 parent 0fbcf21
commit bd0c019
Show file tree

Hide file tree

Showing 25 changed files with 36 additions and 35 deletions.
diff --git a/src/OrchardCore.Modules/OrchardCore.AdminMenu/Deployment/AdminMenuDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.AdminMenu/Deployment/AdminMenuDeploymentSource.cs
@@ -14,7 +14,7 @@ public class AdminMenuDeploymentSource : IDeploymentSource
         private readonly JsonSerializerOptions _serializationOptions;
 
         public AdminMenuDeploymentSource(IAdminMenuService adminMenuService,
-            IOptions<ContentSerializerJsonOptions> serializationOptions)
+            IOptions<DocumentJsonSerializerOptions> serializationOptions)
         {
             _adminMenuService = adminMenuService;
             _serializationOptions = serializationOptions.Value.SerializerOptions;

diff --git a/src/OrchardCore.Modules/OrchardCore.AdminMenu/Recipes/AdminMenuStep.cs b/src/OrchardCore.Modules/OrchardCore.AdminMenu/Recipes/AdminMenuStep.cs
@@ -21,7 +21,7 @@ public class AdminMenuStep : IRecipeStepHandler
 
         public AdminMenuStep(
             IAdminMenuService adminMenuService,
-            IOptions<ContentSerializerJsonOptions> serializationOptions)
+            IOptions<DocumentJsonSerializerOptions> serializationOptions)
         {
             _adminMenuService = adminMenuService;
 

diff --git a/src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/Startup.cs b/src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/Startup.cs
@@ -56,8 +56,8 @@ public override void ConfigureServices(IServiceCollection services)
                 // Common types of converters are already configured in the assembly "GraphQL.SystemTextJson".
                 options.Converters.Add(GraphQLNamedQueryRequestJsonConverter.Instance);
 
-                var contentSerializerJsonOptions = sp.GetRequiredService<IOptions<ContentSerializerJsonOptions>>().Value;
-                options.Merge(contentSerializerJsonOptions.SerializerOptions);
+                var documentJsonSerializerOptions = sp.GetRequiredService<IOptions<DocumentJsonSerializerOptions>>().Value;
+                options.Merge(documentJsonSerializerOptions.SerializerOptions);
             }));
 
             services.AddOptions<GraphQLSettings>().Configure<IShellConfiguration>((c, configuration) =>

diff --git a/src/OrchardCore.Modules/OrchardCore.Deployment/Deployment/DeploymentPlanDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.Deployment/Deployment/DeploymentPlanDeploymentSource.cs
@@ -17,7 +17,7 @@ public class DeploymentPlanDeploymentSource : IDeploymentSource
         public DeploymentPlanDeploymentSource(
             IDeploymentPlanService deploymentPlanService,
             IEnumerable<IDeploymentStepFactory> deploymentStepFactories,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
         {
             _deploymentPlanService = deploymentPlanService;
             _deploymentStepFactories = deploymentStepFactories;

diff --git a/src/OrchardCore.Modules/OrchardCore.Deployment/Recipes/DeploymentPlansRecipeStep.cs b/src/OrchardCore.Modules/OrchardCore.Deployment/Recipes/DeploymentPlansRecipeStep.cs
@@ -23,7 +23,7 @@ public class DeploymentPlansRecipeStep : IRecipeStepHandler
 
         public DeploymentPlansRecipeStep(
             IServiceProvider serviceProvider,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions,
             IDeploymentPlanService deploymentPlanService)
         {
             _serviceProvider = serviceProvider;

diff --git a/src/OrchardCore.Modules/OrchardCore.Layers/Deployment/AllLayersDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.Layers/Deployment/AllLayersDeploymentSource.cs
@@ -19,7 +19,7 @@ public class AllLayersDeploymentSource : IDeploymentSource
         public AllLayersDeploymentSource(
             ILayerService layerService,
             ISiteService siteService,
-            IOptions<ContentSerializerJsonOptions> serializationOptions)
+            IOptions<DocumentJsonSerializerOptions> serializationOptions)
         {
             _layerService = layerService;
             _siteService = siteService;

diff --git a/src/OrchardCore.Modules/OrchardCore.Layers/Recipes/LayerStep.cs b/src/OrchardCore.Modules/OrchardCore.Layers/Recipes/LayerStep.cs
@@ -31,7 +31,7 @@ public LayerStep(
             IRuleMigrator ruleMigrator,
             IConditionIdGenerator conditionIdGenerator,
             IEnumerable<IConditionFactory> factories,
-            IOptions<ContentSerializerJsonOptions> serializationOptions)
+            IOptions<DocumentJsonSerializerOptions> serializationOptions)
         {
             _layerService = layerService;
             _ruleMigrator = ruleMigrator;

diff --git a/src/OrchardCore.Modules/OrchardCore.Placements/Deployment/PlacementsDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.Placements/Deployment/PlacementsDeploymentSource.cs
@@ -15,7 +15,7 @@ public class PlacementsDeploymentSource : IDeploymentSource
 
         public PlacementsDeploymentSource(
             PlacementsManager placementsManager,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
         {
             _placementsManager = placementsManager;
             _jsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;

diff --git a/src/OrchardCore.Modules/OrchardCore.Queries/Deployment/AllQueriesDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.Queries/Deployment/AllQueriesDeploymentSource.cs
@@ -14,7 +14,7 @@ public class AllQueriesDeploymentSource : IDeploymentSource
 
         public AllQueriesDeploymentSource(
             IQueryManager queryManager,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
         {
             _queryManager = queryManager;
             _jsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;

diff --git a/src/OrchardCore.Modules/OrchardCore.Queries/Recipes/QueryStep.cs b/src/OrchardCore.Modules/OrchardCore.Queries/Recipes/QueryStep.cs
@@ -25,7 +25,7 @@ public class QueryStep : IRecipeStepHandler
         public QueryStep(
             IQueryManager queryManager,
             IEnumerable<IQuerySource> querySources,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions,
             ILogger<QueryStep> logger)
         {
             _queryManager = queryManager;

diff --git a/src/OrchardCore.Modules/OrchardCore.Queries/Sql/SqlQuerySource.cs b/src/OrchardCore.Modules/OrchardCore.Queries/Sql/SqlQuerySource.cs
@@ -28,7 +28,7 @@ public SqlQuerySource(
             ILiquidTemplateManager liquidTemplateManager,
             IDbConnectionAccessor dbConnectionAccessor,
             ISession session,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions,
             IOptions<TemplateOptions> templateOptions)
         {
             _liquidTemplateManager = liquidTemplateManager;

diff --git a/src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs b/src/OrchardCore.Modules/OrchardCore.Workflows/Deployment/AllWorkflowTypeDeploymentSource.cs
@@ -15,7 +15,7 @@ public class AllWorkflowTypeDeploymentSource : IDeploymentSource
 
         public AllWorkflowTypeDeploymentSource(
             IWorkflowTypeStore workflowTypeStore,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
         {
             _workflowTypeStore = workflowTypeStore;
             _jsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;

diff --git a/src/OrchardCore.Modules/OrchardCore.Workflows/Recipes/WorkflowTypeStep.cs b/src/OrchardCore.Modules/OrchardCore.Workflows/Recipes/WorkflowTypeStep.cs
@@ -30,7 +30,7 @@ public WorkflowTypeStep(IWorkflowTypeStore workflowTypeStore,
             ISecurityTokenService securityTokenService,
             IActionContextAccessor actionContextAccessor,
             IUrlHelperFactory urlHelperFactory,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
         {
             _workflowTypeStore = workflowTypeStore;
             _securityTokenService = securityTokenService;

diff --git a/src/OrchardCore.Modules/OrchardCore.Workflows/Services/WorkflowManager.cs b/src/OrchardCore.Modules/OrchardCore.Workflows/Services/WorkflowManager.cs
@@ -51,7 +51,7 @@ public WorkflowManager
             ILogger<WorkflowManager> logger,
             ILogger<MissingActivity> missingActivityLogger,
             IStringLocalizer<MissingActivity> missingActivityLocalizer,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions,
             IClock clock)
         {
             _activityLibrary = activityLibrary;

diff --git a/...OrchardCore.Modules/OrchardCore.Workflows/UserTasks/Drivers/UserTaskEventContentDriver.cs b/...OrchardCore.Modules/OrchardCore.Workflows/UserTasks/Drivers/UserTaskEventContentDriver.cs
@@ -39,7 +39,7 @@ public UserTaskEventContentDriver(
             IWorkflowManager workflowManager,
             INotifier notifier,
             IHtmlLocalizer<UserTaskEventContentDriver> localizer,
-            IOptions<ContentSerializerJsonOptions> jsonSerializerOptions,
+            IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions,
             IHttpContextAccessor httpContextAccessor)
         {
             _workflowStore = workflowStore;

diff --git a/...tentSerializerJsonOptionsConfiguration.cs → ...mentJsonSerializerOptionsConfiguration.cs b/...tentSerializerJsonOptionsConfiguration.cs → ...mentJsonSerializerOptionsConfiguration.cs
@@ -6,16 +6,16 @@
 
 namespace OrchardCore.Extensions;
 
-public class ContentSerializerJsonOptionsConfiguration : IConfigureOptions<ContentSerializerJsonOptions>
+public sealed class DocumentJsonSerializerOptionsConfiguration : IConfigureOptions<DocumentJsonSerializerOptions>
 {
     private readonly JsonDerivedTypesOptions _derivedTypesOptions;
 
-    public ContentSerializerJsonOptionsConfiguration(IOptions<JsonDerivedTypesOptions> derivedTypesOptions)
+    public DocumentJsonSerializerOptionsConfiguration(IOptions<JsonDerivedTypesOptions> derivedTypesOptions)
     {
         _derivedTypesOptions = derivedTypesOptions.Value;
     }
 
-    public void Configure(ContentSerializerJsonOptions options)
+    public void Configure(DocumentJsonSerializerOptions options)
     {
         options.SerializerOptions.DefaultIgnoreCondition = JOptions.Base.DefaultIgnoreCondition;
         options.SerializerOptions.ReferenceHandler = JOptions.Base.ReferenceHandler;

diff --git a/...ions/Json/ContentSerializerJsonOptions.cs → ...ons/Json/DocumentJsonSerializerOptions.cs b/...ions/Json/ContentSerializerJsonOptions.cs → ...ons/Json/DocumentJsonSerializerOptions.cs
@@ -2,7 +2,7 @@
 
 namespace OrchardCore.Json;
 
-public class ContentSerializerJsonOptions
+public class DocumentJsonSerializerOptions
 {
     public JsonSerializerOptions SerializerOptions { get; } = new JsonSerializerOptions();
 }
diff --git a/src/OrchardCore/OrchardCore.Abstractions/Json/JsonDerivedTypesOptions.cs b/src/OrchardCore/OrchardCore.Abstractions/Json/JsonDerivedTypesOptions.cs
@@ -3,6 +3,7 @@
 using System.Text.Json.Serialization;
 
 namespace OrchardCore.Json;
+
 public class JsonDerivedTypesOptions
 {
     internal Dictionary<Type, List<IJsonDerivedTypeInfo>> DerivedTypes { get; } = [];

diff --git a/src/OrchardCore/OrchardCore.Abstractions/Json/JsonOptionsConfigurations.cs b/src/OrchardCore/OrchardCore.Abstractions/Json/JsonOptionsConfigurations.cs
@@ -5,11 +5,11 @@
 
 namespace OrchardCore.Json;
 
-public class JsonOptionsConfigurations : IConfigureOptions<JsonOptions>
+internal sealed class JsonOptionsConfigurations : IConfigureOptions<JsonOptions>
 {
     private readonly JsonSerializerOptions _jsonSerializerOptions;
 
-    public JsonOptionsConfigurations(IOptions<ContentSerializerJsonOptions> jsonSerializerOptions)
+    public JsonOptionsConfigurations(IOptions<DocumentJsonSerializerOptions> jsonSerializerOptions)
     {
         _jsonSerializerOptions = jsonSerializerOptions.Value.SerializerOptions;
     }

diff --git a/...ta.YesSql/DefaultJsonContentSerializer.cs → ...ta.YesSql/DefaultContentJsonSerializer.cs b/...ta.YesSql/DefaultJsonContentSerializer.cs → ...ta.YesSql/DefaultContentJsonSerializer.cs
@@ -5,16 +5,16 @@
 
 namespace YesSql.Serialization
 {
-    public class DefaultJsonContentSerializer : IContentSerializer
+    public class DefaultContentJsonSerializer : IContentSerializer
     {
         private readonly JsonSerializerOptions _options;
 
-        public DefaultJsonContentSerializer(IOptions<ContentSerializerJsonOptions> options)
+        public DefaultContentJsonSerializer(IOptions<DocumentJsonSerializerOptions> options)
         {
             _options = options.Value.SerializerOptions;
         }
 
-        public DefaultJsonContentSerializer(JsonSerializerOptions options)
+        public DefaultContentJsonSerializer(JsonSerializerOptions options)
             => _options = options;
 
         public object Deserialize(string content, Type type)

diff --git a/src/OrchardCore/OrchardCore.Data.YesSql/OrchardCoreBuilderExtensions.cs b/src/OrchardCore/OrchardCore.Data.YesSql/OrchardCoreBuilderExtensions.cs
@@ -180,7 +180,7 @@ private static YesSql.Configuration GetStoreConfiguration(IServiceProvider sp, Y
             var tableNameFactory = sp.GetRequiredService<ITableNameConventionFactory>();
             var loggerFactory = sp.GetRequiredService<ILoggerFactory>();
 
-            var serializerOptions = sp.GetRequiredService<IOptions<ContentSerializerJsonOptions>>();
+            var serializerOptions = sp.GetRequiredService<IOptions<DocumentJsonSerializerOptions>>();
 
             var storeConfiguration = new YesSql.Configuration
             {
@@ -189,7 +189,7 @@ private static YesSql.Configuration GetStoreConfiguration(IServiceProvider sp, Y
                 TableNameConvention = tableNameFactory.Create(databaseTableOptions),
                 IdentityColumnSize = Enum.Parse<IdentityColumnSize>(databaseTableOptions.IdentityColumnSize),
                 Logger = loggerFactory.CreateLogger("YesSql"),
-                ContentSerializer = new DefaultJsonContentSerializer(serializerOptions.Value.SerializerOptions)
+                ContentSerializer = new DefaultContentJsonSerializer(serializerOptions.Value.SerializerOptions)
             };
 
             if (yesSqlOptions.IdGenerator != null)

diff --git a/src/OrchardCore/OrchardCore.Users.Core/Extensions/UsersServiceCollectionExtensions.cs b/src/OrchardCore/OrchardCore.Users.Core/Extensions/UsersServiceCollectionExtensions.cs
@@ -58,7 +58,7 @@ public static IServiceCollection AddUsers(this IServiceCollection services)
             services.AddScoped<ITwoFactorAuthenticationHandler, DefaultTwoFactorAuthenticationHandler>();
             services.AddScoped<ITwoFactorAuthenticationHandlerCoordinator, DefaultTwoFactorAuthenticationHandlerCoordinator>();
 
-            services.Configure<ContentSerializerJsonOptions>(options =>
+            services.Configure<DocumentJsonSerializerOptions>(options =>
             {
                 options.SerializerOptions.Converters.Add(new LoginInfoJsonConverter());
             });

diff --git a/src/OrchardCore/OrchardCore/Modules/Extensions/ServiceCollectionExtensions.cs b/src/OrchardCore/OrchardCore/Modules/Extensions/ServiceCollectionExtensions.cs
@@ -156,7 +156,7 @@ private static void AddDefaultServices(OrchardCoreBuilder builder)
             services.AddSingleton<IPoweredByMiddlewareOptions, PoweredByMiddlewareOptions>();
 
             services.AddTransient<IConfigureOptions<JsonOptions>, JsonOptionsConfigurations>();
-            services.AddTransient<IConfigureOptions<ContentSerializerJsonOptions>, ContentSerializerJsonOptionsConfiguration>();
+            services.AddTransient<IConfigureOptions<DocumentJsonSerializerOptions>, DocumentJsonSerializerOptionsConfiguration>();
 
             services.AddScoped<IOrchardHelper, DefaultOrchardHelper>();
             services.AddSingleton<IClientIPAddressAccessor, DefaultClientIPAddressAccessor>();

diff --git a/test/OrchardCore.Tests/Apis/GraphQL/ContentItemsFieldTypeTests.cs b/test/OrchardCore.Tests/Apis/GraphQL/ContentItemsFieldTypeTests.cs
@@ -42,16 +42,16 @@ public async Task InitializeAsync()
             derivedOptions.Setup(x => x.Value)
                 .Returns(new JsonDerivedTypesOptions());
 
-            var configuration = new ContentSerializerJsonOptionsConfiguration(derivedOptions.Object);
+            var configuration = new DocumentJsonSerializerOptionsConfiguration(derivedOptions.Object);
 
-            var jsonOptions = new ContentSerializerJsonOptions();
+            var jsonOptions = new DocumentJsonSerializerOptions();
             configuration.Configure(jsonOptions);
 
-            var jsonSerializerOptions = new Mock<IOptions<ContentSerializerJsonOptions>>();
+            var jsonSerializerOptions = new Mock<IOptions<DocumentJsonSerializerOptions>>();
             jsonSerializerOptions.Setup(x => x.Value)
                 .Returns(jsonOptions);
 
-            var contentSerializer = new DefaultJsonContentSerializer(jsonSerializerOptions.Object);
+            var contentSerializer = new DefaultContentJsonSerializer(jsonSerializerOptions.Object);
 
             _store.Configuration.ContentSerializer = contentSerializer;
             _prefixedStore.Configuration.ContentSerializer = contentSerializer;

diff --git a/test/OrchardCore.Tests/Workflows/WorkflowManagerTests.cs b/test/OrchardCore.Tests/Workflows/WorkflowManagerTests.cs
@@ -114,9 +114,9 @@ WorkflowType workflowType
             var missingActivityLocalizer = new Mock<IStringLocalizer<MissingActivity>>();
             var clock = new Mock<IClock>();
             var workflowFaultHandler = new Mock<IWorkflowFaultHandler>();
-            var jsonOptionsMock = new Mock<IOptions<ContentSerializerJsonOptions>>();
+            var jsonOptionsMock = new Mock<IOptions<DocumentJsonSerializerOptions>>();
             jsonOptionsMock.Setup(x => x.Value)
-                .Returns(new ContentSerializerJsonOptions());
+                .Returns(new DocumentJsonSerializerOptions());
 
             var workflowManager = new WorkflowManager(
                 activityLibrary.Object,