NatsOpts.ConfigureWebSocketOpts callback handler

[wolfman42]

As discussed in #305 this PR is adding support for manipulating the ClientWebSocketOptions used for WebSocket connections. Among other things, this allows setting an authorization header.

[wolfman42]

I left this in draft state to see if it'll pass all tests within the pipeline first. If a maintainer could approve running the pipeline I'd appreciate. @mtmk

[galvesribeiro]

@wolfman42 done.

[wolfman42]

@galvesribeiro I think (hope) the issues are fixed now.

[galvesribeiro]

@wolfman42 convert it out of draft when you feel ready and others can review it.

[mtmk]

Thanks @wolfman42. Could you also sing your commits please? it's a CNCF requirement we need to follow.

[wolfman42]

I checked but don't think my changes could affect this failing unit test: NATS.Client.JetStream.Tests.ConsumerConsumeTest.Consume_dispose_test Perhaps run the tests again?

[mtmk]

I checked but don't think my changes could affect this failing unit test: NATS.Client.JetStream.Tests.ConsumerConsumeTest.Consume_dispose_test Perhaps run the tests again?

it's a flapper. I'm rerunning it now.

[mtmk]

Thanks @wolfman42. Could you also sing your commits please? it's a CNCF requirement we need to follow.

sorry @wolfman42 could you sign all your commits please? (you will have to force push, which should be fine) we set github checks, unfortunately can't merge with unsigned commits. thanks.

[wolfman42]

Thanks @wolfman42. Could you also sing your commits please? it's a CNCF requirement we need to follow.

sorry @wolfman42 could you sign all your commits please? (you will have to force push, which should be fine) we set github checks, unfortunately can't merge with unsigned commits. thanks.

Done. I went ahead and squashed the 3 commits as well.

[caleblloyd]

A couple more ideas, which could be done in a follow-up before releasing:

1. Do we want to nest this option under NatsWebSocketOpts instead of setting it directly in NatsOpts? This could make it easier to offer a shortcuts for popular options such as adding headers:

public sealed record NatsWebSocketOpts
{
    public Dictionary<string, StringValues>? RequestHeaders { get; init; }

    public Func<Uri, ClientWebSocketOptions, CancellationToken, ValueTask>? ConfigureWebSocketOptions { get; init; }
}

2. We probably want to invoke NatsTlsOpts.AuthenticateAsClientOptionsAsync and copy both ClientCertificates and RemoteCertificateValidationCallback to ClientWebSocketOptions prior to passing it to the callback

[mtmk]

A couple more ideas, which could be done in a follow-up before releasing:

Great ideas @caleblloyd created #610 so we don't forget ;) let us know if you want more changes to this PR? We might release a preview with this PR but we'll make sure #610 is resolved before a stable release.

[mtmk]

merging so @Ivandemidov00 can have a look with #610