Add JetStream NATS Client Extensions by mtmk · Pull Request #598 · nats-io/nats.net

mtmk · 2024-08-06T12:54:03Z

This PR introduces an interface-based Core API dependency for the JetStream API and an extension to INatsClient interface:

await using var client = new NatsClient();
var js = client.CreateJetStreamContext(); // extension method usage

As a result of this change, several internal APIs will need to be made public. This will enable application developers to extend some of the lower-level features. This aligns with our overall mission to establish INatsClient as the default API level, providing the opportunity to introduce lower-level functions from our library through INatsConnection.

INatsConnection: Opened functions mostly useful for creating custom subscribers which are used in JetStream consumer implementation.
NatsSubBase: Reviewed and documented subscription base class to be inherited for custom subscriptions.
INatsSubscriptionManager: Exposed the subscription manager as an interface, only having the single function opened used in current implementations. This could be opened up more as we see opportunities or demand.
JetStream NatsClientExtensions: Convenience extension to create JetStream context.

to11mtm

very minor stuff (If it wasn't handled before I finally submitted >_<)

to11mtm · 2024-08-07T20:32:42Z

+    /// <param name="pending">The number of pending messages at the time the drop occurred.</param>
+    /// <param name="msg">The dropped message represented by <see cref="NatsMsg{T}"/>.</param>
+    /// <typeparam name="T">Specifies the type of data in the dropped message.</typeparam>
+    void OnMessageDropped<T>(NatsSubBase natsSub, int pending, NatsMsg<T> msg);


If I had one 'thought' here...

maybe as <remarks> XmlDoc... explaining to people why this -isn't- a valuetask... e.x.

<remarks>This method is expected to complete quickly to avoid further delays in processing; if complex work is required, it is recommended to offload to a channel or other out-of-band processor</remarks>

but... as usual may be overthinking >_<

I think it is an important detail to mention

to11mtm · 2024-08-07T20:35:27Z

 }

-internal class InboxSubBuilder : ISubscriptionManager
+internal class InboxSubBuilder : INatsSubscriptionManager


Almost left a comment here but see that ISubscriptionManager was internal so it shouldn't break things for sane consumers.

true. I guess it will break binary compatibility but we're coming out with a few breaking changes here applications will need to rebuild anyway.

to11mtm · 2024-08-07T20:36:06Z

+public interface INatsSubscriptionManager
+{
+    public ValueTask RemoveAsync(NatsSubBase sub);
+}


If this is public now should we XMLDoc it?

(If 'public but really internal' perhaps an XMLDoc stating it is an internal API subject to change?)

# Conflicts: # sandbox/Example.Client/Example.Client.csproj # sandbox/Example.Client/Program.cs # tests/NATS.Client.Simplified.Tests/ClientTest.cs

darkwatchuk · 2024-09-08T09:47:13Z

Hi,

As part of this PR would it please be possible to expose the INatsConnection Connection property from NatsJSContext, either by making it Public, or a function like INatsConnection GetConnection() ?

In the same way, could NatsKVStore and NatsObjStore expose the underlying NatsJSContext?

This would be really handy as it would allow developers to easily add their own extension methods if need be.

Would be great if this was possible! Many thanks!

mtmk · 2024-09-09T07:53:22Z

As part of this PR would it please be possible to expose the INatsConnection Connection property from NatsJSContext, either by making it Public, or a function like INatsConnection GetConnection() ?

Good idea! done as a property.

In the same way, could NatsKVStore and NatsObjStore expose the underlying NatsJSContext?

We have a few issues as todo items for those, added a note to do that:

thanks @darkwatchuk 💯

darkwatchuk · 2024-09-09T12:09:01Z

That's great - thank you

rickdotnet

LGTM! Nice work.

mtmk · 2024-09-14T17:32:02Z

LGTM! Nice work.

thanks @rickdotnet 💯

I will merge just after 2.4 stable release which I'm planning to do first thing next week

* Added Domain support for stream mirroring and sourcing and KV full support for the same. (#631) * Adds type-forwarders NET 5.0+ (#641) * Run core tests on Windows and test run stability (#464) * Add JetStream NATS Client Extensions (#598)

* Add placement configuration to key-value and object store (#650) * Bump System.Text.Json from 8.0.4 to 8.0.5 in /src/NATS.Client.Core (#649) * Add other client extensions (#637) * Add Domain support for stream mirroring and sourcing and KV full support for the same. (#631) * Add type-forwarders NET 5.0+ (#641) * Add JetStream NATS Client Extensions (#598)

mtmk added 4 commits August 6, 2024 13:31

Expose subscription manager

fb1f98c

Separate subscription manager internal usage

0b26f93

Use INatsConnection in JS

93405e2

Revert subscription manager internal

6971b20

mtmk changed the title ~~Nats client js changes~~ WIP Nats client js changes Aug 6, 2024

mtmk added 4 commits August 6, 2024 14:54

Tidy up connection interface

1b9dde4

Expose base sub for extension

f76397d

Connection docs

080bc93

JetStream client extensions

5789094

mtmk changed the title ~~WIP Nats client js changes~~ Add JetStream NATS Client Extensions Aug 6, 2024

dotnet format

f7c1d51

mtmk marked this pull request as ready for review August 6, 2024 18:49

to11mtm reviewed Aug 8, 2024

View reviewed changes

mtmk added 3 commits August 23, 2024 11:40

Merge branch 'main' into nats-client-js-changes

9d6ff1f

# Conflicts: # sandbox/Example.Client/Example.Client.csproj # sandbox/Example.Client/Program.cs # tests/NATS.Client.Simplified.Tests/ClientTest.cs

Format

854b413

XMLDocs

5b32c3e

mtmk added this to the 2.4.0 milestone Aug 24, 2024

mtmk added 2 commits September 9, 2024 08:40

Merge branch 'main' into nats-client-js-changes

dc5668a

Expose connection

0308bd3

mtmk modified the milestones: 2.4.0, 2.5.0 Sep 9, 2024

rickdotnet approved these changes Sep 14, 2024

View reviewed changes

mtmk merged commit 442db86 into main Sep 18, 2024

mtmk deleted the nats-client-js-changes branch September 18, 2024 07:04

mtmk mentioned this pull request Oct 1, 2024

Release 2.5.0-preview.1 #644

Merged

mtmk mentioned this pull request Oct 9, 2024

Release 2.5.0 #651

Merged

mtmk mentioned this pull request Oct 28, 2024

[PROPOSAL] Make ad-hoc JSON Serialization the Default with INatsClient and Make INatsConnection a low-level API #503

Closed

Uh oh!

Conversation

mtmk commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

to11mtm left a comment

Choose a reason for hiding this comment

Uh oh!

to11mtm Aug 7, 2024

Choose a reason for hiding this comment

Uh oh!

mtmk Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

mtmk Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

to11mtm Aug 7, 2024

Choose a reason for hiding this comment

Uh oh!

mtmk Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

to11mtm Aug 7, 2024

Choose a reason for hiding this comment

Uh oh!

mtmk Aug 23, 2024

Choose a reason for hiding this comment

Uh oh!

darkwatchuk commented Sep 8, 2024

Uh oh!

mtmk commented Sep 9, 2024

Uh oh!

darkwatchuk commented Sep 9, 2024

Uh oh!

rickdotnet left a comment

Choose a reason for hiding this comment

Uh oh!

mtmk commented Sep 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mtmk commented Aug 6, 2024 •

edited

Loading