C#•3y ago

✅ How to edit and save specific appsettings.json (project root) section?

Hello, I have issue with editing specific section in the appsettings.json in project root folder, but now it overwrites all he file although it should overwrite only the specific section

public void SetYear(int year)
        {
            var config = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddEnvironmentVariables()
                .Build()
                .Get<Config>();

            config.ConfigurableYear = year;

            var jsonWriteOptions = new JsonSerializerOptions()
            {
                WriteIndented = true,
                
            };

            var newJson = JsonSerializer.Serialize(config, jsonWriteOptions);

            var appSettingsPath = Path.Combine(Directory.GetCurrentDirectory(), "appsettings.json");
            File.WriteAllText(appSettingsPath, newJson);
            
        }

public void SetYear(int year)
        {
            var config = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddEnvironmentVariables()
                .Build()
                .Get<Config>();

            config.ConfigurableYear = year;

            var jsonWriteOptions = new JsonSerializerOptions()
            {
                WriteIndented = true,
                
            };

            var newJson = JsonSerializer.Serialize(config, jsonWriteOptions);

            var appSettingsPath = Path.Combine(Directory.GetCurrentDirectory(), "appsettings.json");
            File.WriteAllText(appSettingsPath, newJson);
            
        }

TeBeCo•1/23/23, 3:18 PM

is that in the same application that runs ?

TeBeCo•1/23/23, 3:19 PM

or is that executed on the CI before deployment ?

TeBeCo•1/23/23, 3:19 PM

and when is called if that's done while the application run

kaziuxOP•1/23/23, 3:19 PM

I use on the local env. This is service function which used on the api endpoint

TeBeCo•1/23/23, 3:20 PM

can you share a bit more ?

TeBeCo•1/23/23, 3:20 PM

what means "I use on the local env"

TeBeCo•1/23/23, 3:20 PM

do you run that BEFORE you run your app locally ?

TeBeCo•1/23/23, 3:20 PM

or is that code ran in the middle of no where while still running ?

kaziuxOP•1/23/23, 3:21 PM

nope, I do just API call.

TeBeCo•1/23/23, 3:21 PM

so that code is executed inside aController action for example ?

kaziuxOP•1/23/23, 3:21 PM

inside controller aka endpoint

TeBeCo•1/23/23, 3:24 PM

soooooo

TeBeCo•1/23/23, 3:24 PM

it look like you're looking for or

TeBeCo•1/23/23, 3:24 PM

which most of your code above could be deleted

TeBeCo•1/23/23, 3:25 PM

and you could only stick to in that code

TeBeCo•1/23/23, 3:25 PM

and nothing more

TeBeCo•1/23/23, 3:25 PM

you don't need to know the source of the file

TeBeCo•1/23/23, 3:25 PM

you don't need to edit the file

TeBeCo•1/23/23, 3:26 PM

completly replace the idea of

TeBeCo•1/23/23, 3:26 PM

as is not super helpfull in the long run

TeBeCo•1/23/23, 3:26 PM

does what .Get do but way more

TeBeCo•1/23/23, 3:26 PM

like validation but also DI support

TeBeCo•1/23/23, 3:26 PM

meaning you could possibly mute the value of the property that is already in DI

kaziuxOP•1/23/23, 5:47 PM

Also, I do in this Startup.cs to bind this section

TeBeCo•1/23/23, 6:11 PM

$options

TTeBeCo $options

MODiX•1/23/23, 6:11 PM

appsettings.json:

{
  "My": {
    "Foo": {
      "Kix": 5
    }
  }
}

{
  "My": {
    "Foo": {
      "Kix": 5
    }
  }
}

src/Foo/FooOptions.cs:

public class FooOptions
{
  public const string SectionName = "My:Foo";

  public string Bar {get;set;} = "default value for bar";
  public int Kix {get;set;} = -1;
  public DateTime? Pouet {get;set;} = default;
}

public class FooOptions
{
  public const string SectionName = "My:Foo";

  public string Bar {get;set;} = "default value for bar";
  public int Kix {get;set;} = -1;
  public DateTime? Pouet {get;set;} = default;
}

src/Foo/FooServiceCollectionExtensions.cs:

namespace Microsoft.Extensions.DependencyInjection; // <==== recommanded for service.Add so that you don't clutter Startup file

public class FooServiceCollectionExtensions
{
  public static IServiceCollection AddFoo(this IServiceCollection services) =>
    services
      .AddOptions<FooOptions>()
      .BindConfiguration(FooOptions.SectionName)
      .Validate(options => options.Kix >= 0, $"The configuration key '{FooOptions.SectionName}:{nameof(Kix)}' cannot be negative")
      ;

  public static IServiceCollection AddFoo(this IServiceCollection services, Action<FooOptions> configure) =>
    services
      .AddFoo()
      .Configure(configure);

namespace Microsoft.Extensions.DependencyInjection; // <==== recommanded for service.Add so that you don't clutter Startup file

public class FooServiceCollectionExtensions
{
  public static IServiceCollection AddFoo(this IServiceCollection services) =>
    services
      .AddOptions<FooOptions>()
      .BindConfiguration(FooOptions.SectionName)
      .Validate(options => options.Kix >= 0, $"The configuration key '{FooOptions.SectionName}:{nameof(Kix)}' cannot be negative")
      ;

  public static IServiceCollection AddFoo(this IServiceCollection services, Action<FooOptions> configure) =>
    services
      .AddFoo()
      .Configure(configure);

Program.cs / Startup.cs:

services.AddFoo();
// or
services.AddFoo(fooOptions => fooOptions.Kix = 12);

services.AddFoo();
// or
services.AddFoo(fooOptions => fooOptions.Kix = 12);

Bar.cs:

public class Bar
{
  private readonly FooOptions _fooOptions;

  // .Value in ctor is fine only if it's always ever a non-changing value (no reload and/or no scoped resolution)
  public Bar(IOptions<FooOptions> fooOptions)
    => _fooOptions = fooOptions.Value;
}

public class Bar
{
  private readonly FooOptions _fooOptions;

  // .Value in ctor is fine only if it's always ever a non-changing value (no reload and/or no scoped resolution)
  public Bar(IOptions<FooOptions> fooOptions)
    => _fooOptions = fooOptions.Value;
}

TeBeCo•1/23/23, 6:11 PM

more like that @kaziux

TeBeCo•1/23/23, 6:12 PM

I strongly advice naming Options .... Options and not Config

TeBeCo•1/23/23, 6:12 PM

and completly avoid

TeBeCo•1/23/23, 6:12 PM

you don't create a service for that

TeBeCo•1/23/23, 6:13 PM

you just inject that options where you need it

TeBeCo•1/23/23, 6:13 PM

since you need the value to change you never store the no where

TeBeCo•1/23/23, 6:13 PM

else you're storing a value

TeBeCo•1/23/23, 6:17 PM

IOptions<Foo~~Configs~~Options> ~~configs~~options

kaziuxOP•1/23/23, 7:26 PM

But I must have option for user aka admin to set a value

TeBeCo•1/23/23, 7:43 PM

yes

TeBeCo•1/23/23, 7:43 PM

which is unrelated to a file change

TeBeCo•1/23/23, 7:46 PM

unless you're trying to persist value for later run of the same app if you close / restart

TeBeCo•1/23/23, 7:51 PM

in such case I would advise something else than mutating the appsettings

kaziuxOP•1/23/23, 7:54 PM

because one of requirements make that value editable. So system admin must change value who can be non-tech person

TeBeCo•1/23/23, 7:54 PM

should that new value be persited for later

TeBeCo•1/23/23, 7:54 PM

liek if the app crash and you restart the app

TeBeCo•1/23/23, 7:55 PM

sounds like what Azure AppConfiguration does / could do

TeBeCo•1/23/23, 7:55 PM

or a database

TeBeCo•1/23/23, 7:55 PM

file are not super suited for that

kaziuxOP•1/23/23, 8:24 PM

value is must set configurable runtime

TeBeCo•1/23/23, 8:25 PM

yeah i got that

TeBeCo•1/23/23, 8:25 PM

I meant once you set it

TeBeCo•1/23/23, 8:25 PM

imagine the app crash

TeBeCo•1/23/23, 8:25 PM

and restart