[UPDATED] Add NATS Options Pattern DI Support #888

AdamSendible · 2025-06-30T16:17:35Z

Description

This pull request introduces an enhancement to the NATS DI configuration framework by adopting the options pattern. The changes are designed to improve the readability, maintainability, and flexibility of options configuration in NATS projects.

Key Changes

Added Microsoft.Extensions.Options package reference to support options pattern.
Introduced NatsOptsBuilder to encapsulate configuration for NatsOpts and connection.
Deprecated direct options configuration methods in favor of options pattern using OptionsBuilder<NatsOptsBuilder>.
Refactored existing configuration methods to leverage OptionsBuilder for greater clarity and flexibility.
Removed manual options retrieval and defaults adjustment logic, instead utilizing dependency injection for IOptions<NatsOptsBuilder>.
Updated unit tests to leverage the newly introduced methods

Related Issue

Resolves Use conventional approach for Dependency Injection #886

Copilot

Pull Request Overview

This PR modernizes NATS DI configuration by adopting the Microsoft options pattern for NatsOpts, centralizing defaults and deprecating the older direct‐configuration methods.

Introduces a new NatsOptsBuilder type and wires it into the DI container via IOptions<NatsOptsBuilder>.
Refactors all ConfigureOptions and ConfigureConnection overloads to use an OptionsBuilder<NatsOptsBuilder> approach and marks the old APIs obsolete.
Updates the project file to reference Microsoft.Extensions.Options and expands the test suite to cover the new options‐builder patterns and backward compatibility.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
tests/NATS.Extensions.Microsoft.DependencyInjection.Tests/NatsHostingExtensionsTests.cs	Added tests for the new `ConfigureOptions` overloads and options‐builder variants, including backward compatibility checks.
src/NATS.Extensions.Microsoft.DependencyInjection/NatsBuilder.cs	Introduced `NatsOptsBuilder` and rewrote `ConfigureOptions`/`ConfigureConnection` to use `OptionsBuilder<NatsOptsBuilder>`.
src/NATS.Extensions.Microsoft.DependencyInjection/NATS.Extensions.Microsoft.DependencyInjection.csproj	Added `Microsoft.Extensions.Options` package references for .NET6/8 targets.

Comments suppressed due to low confidence (1)

src/NATS.Extensions.Microsoft.DependencyInjection/NatsBuilder.cs:13

Add XML documentation for NatsOptsBuilder and its public members to explain their role in capturing and configuring NATS options via the options pattern.

public class NatsOptsBuilder

Copilot · 2025-07-02T10:09:21Z

src/NATS.Extensions.Microsoft.DependencyInjection/NatsBuilder.cs

-
-            return optsFactory(serviceProvider, opts);
-        };
+        builder(_services.AddOptions<NatsOptsBuilder>());


Each call to ConfigureOptions invokes AddOptions<NatsOptsBuilder>() again, registering duplicate configuration actions. Consider storing the initial OptionsBuilder<NatsOptsBuilder> in a private field and reusing it for subsequent Configure calls to avoid redundant registrations.

Suggested change

builder(_services.AddOptions<NatsOptsBuilder>());

builder(_optionsBuilder);

yes, this should be done build time.

Ive updated to cache the initial options builder in a field.

Copilot · 2025-07-02T10:09:21Z

src/NATS.Extensions.Microsoft.DependencyInjection/NatsBuilder.cs

    private Func<IServiceProvider, int> _poolSizeConfigurer = _ => 1;
-    private Func<IServiceProvider, NatsOpts, NatsOpts>? _configureOpts;
-    private Action<IServiceProvider, NatsConnection>? _configureConnection;
    private object? _diKey = null;


The private field _diKey is no longer referenced in the builder implementation. Remove it to clean up dead code and reduce maintenance overhead.

Suggested change

private object? _diKey = null;

I must be missing something. this is still used, no?

Indeed it is still used. I didn't touch the usage around the DI key as it is a builder concern rather than a service configuration one

Copilot · 2025-07-02T10:09:21Z

src/NATS.Extensions.Microsoft.DependencyInjection/NatsBuilder.cs

-        };
+    public NatsBuilder ConfigureConnection(Action<IServiceProvider, NatsConnection> configureConnection) =>
+        ConfigureOptions(builder => builder.Configure<IServiceProvider>((opts, provider) =>
+            opts.ConfigureConnection = configureConnection));


[nitpick] This method overwrites any existing ConfigureConnection action rather than chaining multiple calls. If users may call this multiple times, consider merging the new delegate with the existing one to avoid losing previously configured behaviors.

Suggested change

opts.ConfigureConnection = configureConnection));

{

opts.ConfigureConnection = opts.ConfigureConnection == null

? configureConnection

: (sp, connection) =>

{

opts.ConfigureConnection?.Invoke(sp, connection);

configureConnection(sp, connection);

};

}));

@AdamSendible this one has some merit. do you mind if we include this change as well?

I've applied a change to match the existing behaviour

mtmk · 2025-07-02T10:12:52Z

thanks @AdamSendible. looks good. could you GPG sign your commits please? it's a project requirement we need to follow

AdamSendible · 2025-07-03T17:28:57Z

thanks @AdamSendible. looks good. could you GPG sign your commits please? it's a project requirement we need to follow

That's done

AdamSendible · 2025-07-16T12:29:44Z

Hi @mtmk ,

Just checking in on the status of this PR. Seems that all the checks have passed now. Let me know if you need anything else from my side. Thanks!

mtmk · 2025-07-16T12:46:09Z

thanks for the nudge @AdamSendible, looks good to me actually. @rickdotnet do you have any objections?

rickdotnet · 2025-07-16T14:01:08Z

Looks good to me. Thanks @AdamSendible !

mtmk

LGTM thanks @AdamSendible

* Fix kv wrong last sequence exception (#895) * add ttl Update/TryUpdate to INatsKvStore (#852) * [UPDATED] Add NATS Options Pattern DI Support (#888)

AdamSendible marked this pull request as ready for review July 1, 2025 09:30

mtmk requested a review from Copilot July 2, 2025 10:07

Copilot AI reviewed Jul 2, 2025

View reviewed changes

AdamSendible force-pushed the use-options-builder-di branch from 80fd6fb to f2d2a83 Compare July 3, 2025 17:24

AdamSendible added 4 commits July 3, 2025 18:25

Refactor NatsBuilder to use OptionsBuilder

ce91fe6

Update unit tests for NatsHostingExtensionsTests

d3d08d2

Store initial OptionsBuilder in NatsBuilder

3f834af

Revert to use ConfigureConnection chaining behaviour

4b1ece3

AdamSendible force-pushed the use-options-builder-di branch from f2d2a83 to 4b1ece3 Compare July 3, 2025 17:25

mtmk approved these changes Jul 18, 2025

View reviewed changes

mtmk merged commit 4dfb362 into nats-io:main Jul 18, 2025
21 of 22 checks passed

mtmk added a commit that referenced this pull request Jul 18, 2025

Release 2.6.5

917f01e

* Fix kv wrong last sequence exception (#895) * add ttl Update/TryUpdate to INatsKvStore (#852) * [UPDATED] Add NATS Options Pattern DI Support (#888)

mtmk mentioned this pull request Jul 18, 2025

Release 2.6.5 #906

Merged

mtmk added a commit that referenced this pull request Jul 21, 2025

Release 2.6.5 (#906)

29c5fb6

* Fix kv wrong last sequence exception (#895) * add ttl Update/TryUpdate to INatsKvStore (#852) * [UPDATED] Add NATS Options Pattern DI Support (#888)

mtmk mentioned this pull request Sep 22, 2025

Release 2.7 #874

Merged

dependabot bot mentioned this pull request Dec 22, 2025

chore(deps): Bump NATS.Net from 2.6.11 to 2.7.0 four-robots/dotgnatly#85

Closed

dependabot bot mentioned this pull request Jan 12, 2026

chore(deps): Bump NATS.Net from 2.6.11 to 2.7.1 four-robots/dotgnatly#86

Open

	builder(_services.AddOptions<NatsOptsBuilder>());
	builder(_optionsBuilder);

-            opts.ConfigureConnection = configureConnection));
+        {
+            opts.ConfigureConnection = opts.ConfigureConnection == null
+                ? configureConnection
+                : (sp, connection) =>
+                {
+                    opts.ConfigureConnection?.Invoke(sp, connection);
+                    configureConnection(sp, connection);
+                };
+        }));

[UPDATED] Add NATS Options Pattern DI Support #888

[UPDATED] Add NATS Options Pattern DI Support #888

Uh oh!

Conversation

AdamSendible commented Jun 30, 2025

Description

Key Changes

Related Issue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

mtmk Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

AdamSendible Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

mtmk Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

AdamSendible Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

mtmk Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

AdamSendible Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

mtmk commented Jul 2, 2025

Uh oh!

AdamSendible commented Jul 3, 2025

Uh oh!

AdamSendible commented Jul 16, 2025

Uh oh!

mtmk commented Jul 16, 2025

Uh oh!

rickdotnet commented Jul 16, 2025

Uh oh!

mtmk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants