JetStream API clean-up

[mtmk]

• Removed opinionated method overloads for create consumer and stream.
• Removed publish overload for sending empty messages. Doesn't feel like a common operation in JS. Removed to reduce the API footprint.
• A few format fixes.
• A couple of potential test flapper timeout fixes.

/cc @Jarema

[caleblloyd]

I do miss the simplicity, it's no longer clear what settings are actually required. Would it make sense to provide some static helpers/extensions

// helpers
static StreamConfig(string streamName, IEnumerable<string> subjects) StreamCreateRequest
static ConsumerConfig(string streamName, string consumerName) ConsumerCreateRequest

// extensions
static ConsumerConfig(INatsJetStream streamName, string consumerName) ConsumerCreateRequest

That way if I want an R3 stream I could do

var sc = new StreamConfig("my-stream", []{"my-stream"}) with {Replicas = 3}

Much simpler in my opinion than having to look into the detials of the record to discover that Name and Subjects are required for me to actually get a working stream

Also - not sure how often people create Ephemeral consumers explicitly. Might be worth making the helpers explicit for DurableConsumerConfig and EphemeralConsumerConfig. Ephemeral Consumers in that case could have random names.

It takes some deep knowledge to know that you must supply Name and DurableName

[caleblloyd]

Any interest in shortening the models ConsumerConfiguration => ConsumerConfig and StreamConfiguration => StreamConfig... And any other model with Configuration => Config... It is a long word 😄

[caleblloyd]

LGTM

[Jarema]

I like the change to Config!

[oising]

Framework guidelines dictate that enum names should be Pascal cased -- then you could avoid the ugly at escape on explicit.

[mtmk]

Unfortunately I had an issue with the JSON serializer not using the attributed name then had to make it same case as the JSON property to make it work.

[oising]

For S.T.Json, the way I do this [net8] is:

builder.Services
   .AddJsonOptions(
        options =>
        {
            options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter<PassportIssuingSettings>(JsonNamingPolicy.CamelCase));
            options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
            
            options.JsonSerializerOptions.TypeInfoResolver = PassportJsonSerializationContext.Default;

[oising]

PassportJsonSerializationContext is my source generator context for my structures. I'd imagine you guys are using that code path too?

[oising]

Here's the partial context I declared:

[JsonSerializable(typeof(Passport))]
[JsonSerializable(typeof(PassportIssuingSettings))]
[JsonSerializable(typeof(Visa))]
[JsonSerializable(typeof(ValidationProblemDetails))]
[JsonSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
public partial class PassportJsonSerializationContext : JsonSerializerContext
{
}

This is for AOT ready serialization etc.

[oising]

Tbh, some of my declarations are probably redundant - anything in the AddJsonOptions setup can probably be applied to the context instead. I went through an evolution making things work from net6 to net8 :/ - but it works. My enums are serialized to camel case, declared in dotnet as pascal.

[mtmk]

Yes we have a context, that attribute solution looks promising. Do you still have to set the option?

[oising]

I think the option is only for when you don't use a context. I started out that way, then added a context later but never took away the option. I assume the attributes on the context are enough :) But maybe the converter registration only works in options. A quick experiment on your side should tell you quickly enough.

[oising]

Oh, so you can pass in options director to the context ctor too:

_jsonSerializationContext = new PassportJsonSerializationContext(
    new JsonSerializerOptions
    {
        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
        Converters = {  }
    });

Then you don't need the entry point AddJsonOptions fluff.

[mtmk]

hmmm. it doesn't seem to work (see example https://github.com/mtmk/example-json-enum)

Need to implement a convertor I think.