feat: add keyed Dataverse client registration (#9)

* Initial plan

* feat: add named keyed Dataverse client registration

* fix: correct named options binding and rename Named to Keyed

* refactor: rename CreateNamed to CreateKeyed in ServiceClientFactory

* refactor: rename Named to Keyed in tests and update README and AGENTS docs

* fix: remove invalid name argument from Configure and Bind on OptionsBuilder

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Lars Bauer <larsbauer91@gmail.com>

Author: Copilot

AGENTS.md

@@ -2,22 +2,22 @@
 
 ## Project overview
 
-A small .NET 10 NuGet library (`BauerApps.Dataverse.Extensions.DependencyInjection`) that provides one-line DI registration for Microsoft Dataverse `ServiceClient`. The key design decision: `ServiceClient` is registered as a **singleton** (shares connection pool & metadata cache), while `IOrganizationServiceAsync2` is registered as **scoped** via `Clone()` (thread-safe per-request usage). Do not change these lifetimes.
+A small .NET 10 NuGet library (`BauerApps.Dataverse.Extensions.DependencyInjection`) that provides one-line DI registration for Microsoft Dataverse `ServiceClient`. The key design decision: `ServiceClient` is a singleton (shared connection + token cache) while `IOrganizationServiceAsync2` is scoped (per-request `Clone()`).
 
 ## Scope & non-goals
 
-The library has a single responsibility: **wire up `ServiceClient` and register it for DI** with the correct lifetimes and authentication. Keep it a thin wiring layer built only on the public, supported `ServiceClient` surface.
+The library has a single responsibility: **wire up `ServiceClient` and register it for DI** with the correct lifetimes and authentication. Keep it a thin wiring layer built only on the public, supported Dataverse SDK surface.
 
-- **In scope**: DI registration (singleton client + scoped `Clone()`), authentication (Azure.Identity + options pattern), logger wiring, startup validation.
-- **Non-goals**: behavioral wrappers/decorators over `IOrganizationService*` (request tagging/correlation, retries, caching, auditing, etc.), constructing credentials from primitive config fields (clientId/secret/etc. — accept a `TokenCredential` instead), and anything that depends on or reimplements `ServiceClient` internals or undocumented behavior.
+- **In scope**: DI registration (singleton client + scoped `Clone()`), keyed (multi-environment) client registration, authentication (Azure.Identity + options pattern), logger wiring, startup validation.
+- **Non-goals**: behavioral wrappers/decorators over `IOrganizationService*` (request tagging/correlation, retries, caching, auditing, etc.), constructing credentials from primitive config fields (tenantId/clientId/secret strings), FetchXml helpers, entity mapping.
 
-Rationale: maintainability and resilience to changes in the floating `1.*` Dataverse client dependency. Cross-cutting request behavior is the consumer's responsibility. When in doubt, prefer *not* adding the feature.
+Rationale: maintainability and resilience to changes in the floating `1.*` Dataverse client dependency. Cross-cutting request behavior is the consumer's responsibility. When in doubt, prefer *not* adding something.
 
-## Architecture (4 source files)
+## Architecture
 
-- `ServiceCollectionExtensions.cs` — Public API surface. `AddDataverseClient()` overloads (one taking `Action<DataverseClientOptions>`, one taking `IConfiguration` to bind from a config section) using C# 14 `extension` blocks. Shared wiring/validation live in private static helpers (`AddDataverseClientCore`, `ValidateDataverseClientOptions`).
+- `ServiceCollectionExtensions.cs` — Public API surface. `AddDataverseClient()` overloads: unkeyed (one taking `Action<DataverseClientOptions>`, one taking `IConfiguration`) and keyed (same two overloads with a leading `string key` parameter). Uses C# 14 `extension` block style.
 - `DataverseClientOptions.cs` — Options POCO with `OrganizationUrl` (required), `TokenCredential`, `DeferConnection`.
-- `Internal/ServiceClientFactory.cs` — Singleton factory wiring `Azure.Identity` credentials into `ConnectionOptions.AccessTokenProviderFunctionAsync`. Marked `internal`, tested via `InternalsVisibleTo`.
+- `Internal/ServiceClientFactory.cs` — Factory with two methods: `Create` (unkeyed, uses `IOptions<T>`) and `CreateKeyed` (uses `IOptionsMonitor<T>.Get(key)`). Marked `internal`, tested via `InternalsVisibleTo`.
 - Root namespace is `BauerApps.Dataverse.Extensions` (set via `<RootNamespace>` in csproj, differs from folder name).
 
 ## Build & test
@@ -27,31 +27,33 @@ dotnet build Dataverse.Extensions.slnx
 dotnet test Dataverse.Extensions.slnx
 ```
 
-Solution uses `.slnx` format (XML-based), not `.sln`. Tests use **TUnit** (not xUnit/NUnit/MSTest) — uses `[Test]` attribute and `await Assert.That(...)` fluent async assertions. The test runner is configured in `global.json` (`"runner": "Microsoft.Testing.Platform"`).
+Solution uses `.slnx` format (XML-based), not `.sln`. Tests use **TUnit** (not xUnit/NUnit/MSTest) — uses `[Test]` attribute and `await Assert.That(...)` fluent async assertions. The test runner is TUnit's own; `dotnet test` works via the adapter.
 
 ## Conventions
 
 - **Namespace**: `BauerApps.Dataverse.Extensions` (library), `BauerApps.Dataverse.Extensions.Tests` (tests). Mirror `Internal/` subfolder in both.
 - **Internal access**: `InternalsVisibleTo` is configured via `<AssemblyAttribute>` in csproj, not `AssemblyInfo.cs`.
 - **Test structure**: Mirrors source layout. `ServiceCollectionExtensionsTests.cs` at root, `Internal/ServiceClientFactoryTests.cs` for internal classes. Tests use Arrange/Act/Assert with comments.
 - **Test pattern**: All tests set `DeferConnection = true` to avoid real Dataverse connections. Use `FakeTokenCredential` (private nested class) when testing custom credentials.
+- **Test naming**: Unkeyed tests use the method name directly (e.g. `AddDataverseClient_RegistersServiceClient`). Keyed tests use `_Keyed_` segment (e.g. `AddDataverseClient_Keyed_RegistersKeyedServiceClient`). Factory tests follow `Create_` and `CreateKeyed_` prefixes.
 - **C# 14 features**: Uses `extension` blocks (not classic `static` extension methods). Keep this style for new extensions.
-- **Dependencies**: `Azure.Identity`, `Microsoft.Extensions.Options`, `Microsoft.Extensions.Options.ConfigurationExtensions` (for the `IConfiguration` binding overload), `Microsoft.PowerPlatform.Dataverse.Client`. The Dataverse client uses floating version `1.*`.
+- **Dependencies**: `Azure.Identity`, `Microsoft.Extensions.Options`, `Microsoft.Extensions.Options.ConfigurationExtensions` (for the `IConfiguration` binding overload), `Microsoft.PowerPlatform.Dataverse.Client`.
+- **Documentation**: `README.md` (user-facing) and `AGENTS.md` (agent-facing) **must both be updated** whenever a new feature is added or existing API behaviour changes. README covers usage examples; AGENTS.md covers architecture, conventions, and patterns.
 
 ## CI/CD & versioning
 
-- **Versioning**: Automated via [release-please](https://github.com/googleapis/release-please). Version is tracked in `.release-please-manifest.json` (keyed by package directory) and patched into csproj `<Version>` via the `<!-- x-release-please-version -->` marker comment.
+- **Versioning**: Automated via [release-please](https://github.com/googleapis/release-please). Version is tracked in `.release-please-manifest.json` (keyed by package directory) and patched into `<Version>` in the csproj by release-please — never edit these manually.
 - **Commit messages**: Use [Conventional Commits](https://www.conventionalcommits.org/) — `feat:` (minor bump), `fix:` (patch), `feat!:` or `BREAKING CHANGE` footer (major).
 - **CI** (`.github/workflows/ci.yml`): Builds and tests on every push/PR to `main`.
-- **Release** (`.github/workflows/release.yml`): On push to `main`, release-please opens/updates a Release PR. Merging it creates a GitHub release + tag, then publishes to NuGet via [trusted publishing](https://learn.microsoft.com/en-us/nuget/nuget-org/trusted-publishing) (OIDC via `NuGet/login@v1`, no long-lived API key).
+- **Release** (`.github/workflows/release.yml`): On push to `main`, release-please opens/updates a Release PR. Merging it creates a GitHub release + tag, then publishes to NuGet via trusted publishing.
 
 ## Release process
 
-Releases are fully automated by **release-please**; never bump the version, edit `CHANGELOG.md`, or tag manually. The version flow is driven entirely by commit messages, so writing correct [Conventional Commits](https://www.conventionalcommits.org/) is what makes the process work.
+Releases are fully automated by **release-please**; never bump the version, edit `CHANGELOG.md`, or tag manually. The version flow is driven entirely by commit messages, so writing correct [Conventional Commits](https://www.conventionalcommits.org/) is critical.
 
 **Configuration**:
 
-- `release-please-config.json` — `release-type: simple` for the single package `BauerApps.Dataverse.Extensions.DependencyInjection`. `include-component-in-tag: false` (tags are plain `vX.Y.Z`). The csproj is listed as a `generic` extra-file so its `<Version>` (marked with `<!-- x-release-please-version -->`) is updated on release. Changelog is written to `Dataverse.Extensions.DependencyInjection/CHANGELOG.md`.
+- `release-please-config.json` — `release-type: simple` for the single package `BauerApps.Dataverse.Extensions.DependencyInjection`. `include-component-in-tag: false` (tags are plain `vX.Y.Z`).
 - `.release-please-manifest.json` — the current released version, keyed by package directory. Do not edit by hand; release-please maintains it.
 
 **Commit message rules** (these determine the next version bump):
@@ -73,13 +75,19 @@ Notes:
 1. Open a PR with Conventional Commit message(s) and merge to `main`.
 2. release-please opens (or updates) a **Release PR** that bumps the version, updates `CHANGELOG.md`, and updates `.release-please-manifest.json`.
 3. Review and merge the Release PR. This creates the GitHub release + `vX.Y.Z` tag.
-4. The `publish` job (gated on `release_created`) then builds, tests, packs, and publishes the package to NuGet via trusted publishing (OIDC via `NuGet/login@v1`, `--skip-duplicate`) — no manual `dotnet nuget push` and no stored API key. It also attaches the `.nupkg` to the GitHub release and flips the Release PR label from `autorelease: tagged` to `autorelease: published`.
+4. The `publish` job (gated on `release_created`) then builds, tests, packs, and publishes the package to NuGet via trusted publishing (OIDC via `NuGet/login@v1`, `--skip-duplicate`) — no manual steps needed.
 
 ## Key patterns
 
 When adding new configuration options:
 1. Add property to `DataverseClientOptions`
-2. Add validation in `ServiceCollectionExtensions.AddDataverseClient()` via `.Validate()` if required
-3. Wire it in `ServiceClientFactory.Create()` using the options pattern (`IOptions<T>`)
+2. Add validation in `ServiceCollectionExtensions` via `.Validate()` if required
+3. Wire it in `ServiceClientFactory` using the appropriate options pattern (`IOptions<T>` for unkeyed, `IOptionsMonitor<T>` for keyed)
 4. Test both the registration (service descriptor assertions) and the factory behavior
+5. Update `README.md` with usage examples and `AGENTS.md` with any architecture or convention changes
 
+When adding a new keyed registration:
+- Use `AddKeyedSingleton` / `AddKeyedScoped` — do NOT reuse the unkeyed core path
+- Thread the key through via the keyed service factory delegate `(sp, key) => ...`
+- Use `IOptionsMonitor<T>.Get(key)` — never `IOptions<T>` for keyed registrations
+- Keep unkeyed and keyed paths fully independent to avoid `Options.DefaultName` collisions

Dataverse.Extensions.DependencyInjection.Tests/Internal/ServiceClientFactoryTests.cs

@@ -1,4 +1,5 @@
 using Azure.Core;
+using BauerApps.Dataverse.Extensions.Internal;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using Microsoft.PowerPlatform.Dataverse.Client;
@@ -80,6 +81,88 @@ public async Task Create_DoesNotThrowWhenConnectionFailsAndDeferConnectionIsTrue
         await Assert.That(client).IsNotNull();
     }
 
+    [Test]
+    public async Task CreateKeyed_UsesKeyedOptions()
+    {
+        // Arrange
+        const string key = "source";
+        var services = new ServiceCollection();
+        services.AddDataverseClient(key, options =>
+        {
+            options.OrganizationUrl = new Uri("https://keyed-org.crm4.dynamics.com");
+            options.DeferConnection = true;
+        });
+        var provider = services.BuildServiceProvider();
+
+        // Act
+        var client = ServiceClientFactory.CreateKeyed(provider, key);
+
+        // Assert
+        await Assert.That(client).IsNotNull();
+    }
+
+    [Test]
+    public async Task CreateKeyed_UsesDefaultAzureCredentialWhenTokenCredentialIsNull()
+    {
+        // Arrange
+        const string key = "source";
+        var services = new ServiceCollection();
+        services.AddDataverseClient(key, options =>
+        {
+            options.OrganizationUrl = new Uri("https://my-org.crm4.dynamics.com");
+            options.DeferConnection = true;
+        });
+        var provider = services.BuildServiceProvider();
+
+        // Act
+        var client = ServiceClientFactory.CreateKeyed(provider, key);
+
+        // Assert — client is created without throwing (deferred connection)
+        await Assert.That(client).IsNotNull();
+    }
+
+    [Test]
+    public async Task CreateKeyed_UsesCustomTokenCredential()
+    {
+        // Arrange
+        const string key = "source";
+        var customCredential = new FakeTokenCredential();
+        var services = new ServiceCollection();
+        services.AddDataverseClient(key, options =>
+        {
+            options.OrganizationUrl = new Uri("https://my-org.crm4.dynamics.com");
+            options.TokenCredential = customCredential;
+            options.DeferConnection = true;
+        });
+        var provider = services.BuildServiceProvider();
+
+        // Act
+        var client = ServiceClientFactory.CreateKeyed(provider, key);
+
+        // Assert
+        await Assert.That(client).IsNotNull();
+    }
+
+    [Test]
+    public async Task CreateKeyed_DoesNotThrowWhenConnectionFailsAndDeferConnectionIsTrue()
+    {
+        // Arrange
+        const string key = "source";
+        var services = new ServiceCollection();
+        services.AddDataverseClient(key, options =>
+        {
+            options.OrganizationUrl = new Uri("https://invalid-org.crm4.dynamics.com");
+            options.DeferConnection = true;
+        });
+        var provider = services.BuildServiceProvider();
+
+        // Act
+        var client = ServiceClientFactory.CreateKeyed(provider, key);
+
+        // Assert — deferred connection should not throw
+        await Assert.That(client).IsNotNull();
+    }
+
     /// <summary>
     /// Minimal fake TokenCredential for testing.
     /// </summary>
@@ -92,5 +175,3 @@ public override ValueTask<AccessToken> GetTokenAsync(TokenRequestContext request
             => new(new AccessToken("fake-token", DateTimeOffset.UtcNow.AddHours(1)));
     }
 }
-
-