Add NewtonSoft SerializerSettings globally in startup when PiranhaManager is present

[aaguilera88]

Hello everyone.
I have an existing .NET Core 3.1 project which needs to set the NewtonSoft SerializerSettings contract resolver to be the ContractResolver. The problem is, when i setup this and include the services and middleware relative to PiranhaManager, the serializer settigns are ignored. This is my actual startup (with the piranhamanager commented to made the application works).

Can some one help me with this issue?

 public void ConfigureServices(IServiceCollection services)
        {
            //Culture
            services.Configure<RequestLocalizationOptions>(options =>
            {
                options.DefaultRequestCulture = new RequestCulture("es-MX");
                options.SupportedCultures = new List<CultureInfo> { new CultureInfo("es-MX") };

            });
            //Syncfusion
            Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("");

            //DB Context
            services.AddDbContext<HammurabiSistemaContext>(options => options.UseSqlServer(_config.GetConnectionString("Ham"), b => b.MigrationsAssembly("HammurabiWeb")));
            //Repositorios
            services.AddScoped<IRepository, Repository<HammurabiSistemaContext>>();
            //Identity
            services.AddIdentity<IdentityUser, IdentityRole>(opt =>
            {
                opt.Password.RequiredLength = 7;
                opt.Password.RequireDigit = false;
                opt.Password.RequireUppercase = false;
                opt.Password.RequireNonAlphanumeric = false;
            })
           .AddEntityFrameworkStores<HammurabiSistemaContext>()
           .AddDefaultTokenProviders();
            //Custom claims
            services.AddScoped<IUserClaimsPrincipalFactory<IdentityUser>, CustomClaimsFactory>();
            //App Cookie
            services.ConfigureApplicationCookie(options =>
            {
                options.AccessDeniedPath = new PathString("/Sistema/Home/AccessDenied");
                options.LoginPath = new PathString("/Sistema/Home/Login");
                options.ReturnUrlParameter = CookieAuthenticationDefaults.ReturnUrlParameter;
                options.SlidingExpiration = true;
            });
            //Autorizacion
            services.AddAuthorization(options =>
            {
                options.AddPolicy("ResourceAccessSistema", policy => policy.Requirements.Add(new ResourceAccessRequirementSistema()));
            });
            services.AddScoped<IAuthorizationHandler, ResourceAccessHandlerSistema>();

            // Configure controllers with Localization
            services.AddControllersWithViews()
            .AddNewtonsoftJson(options =>
            {
                options.SerializerSettings.ContractResolver = new DefaultContractResolver();
                options.SerializerSettings.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                options.SerializerSettings.DateTimeZoneHandling = Newtonsoft.Json.DateTimeZoneHandling.Utc;
            });
            // Configure Razor Pages with json serializer
            services.AddRazorPages()
            .AddNewtonsoftJson(options =>
            {
                options.SerializerSettings.ContractResolver = new DefaultContractResolver();
                options.SerializerSettings.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;
                options.SerializerSettings.DateTimeZoneHandling = Newtonsoft.Json.DateTimeZoneHandling.Utc;
            })
            .AddRazorRuntimeCompilation();
            //.AddPiranhaManagerOptions();

            // Add PiranhaCMS
            services.AddPiranha();
            services.AddPiranhaApplication();
            services.AddPiranhaBlobStorage(_config.GetConnectionString("blobstorage"));
            services.AddPiranhaImageSharp();
            //services.AddPiranhaManager();
            services.AddPiranhaTinyMCE();
            services.AddPiranhaMemoryCache();
            services.AddPiranhaEF<SQLServerDb>(db => db.UseSqlServer(_config.GetConnectionString("Ham")));

            // http context
            services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();
            // Implementación de ISecurity para Manager de Piranha
            services.AddTransient<Piranha.ISecurity, CustomPiranhaSecurity>();
            //Twilio
            services.AddScoped<IMessage, SmsMessage>();
        }


        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApi api)        
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            // Initialize Piranha
            App.Init(api);

            // Build content types
            new ContentTypeBuilder(api)
                .AddAssembly(typeof(Startup).Assembly)
                .Build()
                .DeleteOrphans();

            // Configure Tiny MCE
            EditorConfig.FromFile("editorconfig.json");

            app.UseHttpsRedirection();
            app.UseStaticFiles();

            // Add call to use Piranha
            app.UsePiranha();

            app.UseRouting();
            app.UseAuthentication();
            app.UseAuthorization();

            // Configure Piranha            
            //app.UsePiranhaManager();
            app.UsePiranhaTinyMCE();

            //culture
            var cultureInfo = new CultureInfo("es-MX");
            CultureInfo.DefaultThreadCurrentCulture = cultureInfo;
            CultureInfo.DefaultThreadCurrentUICulture = cultureInfo;

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");

                endpoints.MapControllerRoute(
                name: "areas",
                pattern: "{area}/{controller=Home}/{did?}/{action=Index}/{id?}");

                endpoints.MapRazorPages();

               // endpoints.MapPiranhaManager();

            });

           
        }

[tidyui]

Good point, we’ll take a look at how we can achieve this. The reason Piranha sets this up internally is that it also needs to configure the JsonOptions in order to work.

https://github.com/PiranhaCMS/piranha.core/blob/master/core/Piranha.Manager/ManagerExtensions.cs#L267

[aaguilera88]

Great. Hope you can find a way. THX

[zoinkydoink]

FYI, given that .NET 5 has better support built in for Json (System.Text.Json), might look into implementing that where possible instead of Newtonsoft

[tidyui]

Hi there @zoinkydoink. We will look into System.Text.Json when we start the migration process to .NET 5. The reason for not using it in .NET Core 3 is that it doesn't support serialization of properties which are declared as interfaces or base classes, it only serializes finite types.

[zoinkydoink]

Yes the support of System.Json.Text in 3.1 is purely garbage, I thought I would throw that comment in there about .NET 5 because it is suppose to have a lot of newtonsoft functionality.

[tidyui]

We will most likely not be able to use System.Text.Json until Microsoft releases a LTS release, because up to that point we most likely need to compile for multiple targets supporting both 3.1 (since it's LTS) and 5.

[tidyui]

Which according to their release plan seems to be 6.0 scheduled for November 2021.

[tidyui]

This will be available in ConfigureService when calling UseManager()

services.AddPiranha(options =>
{
    ...

    options.UseManager(jsonOptions =>
    {
        ...
    });

    ...
});