feat: add write conflict resolution options by evansims · Pull Request #136 · openfga/dotnet-sdk

evansims · 2025-10-16T23:15:06Z

Description

Implements support for write conflict resolution options introduced in OpenFGA v1.10.0, allowing users to control behavior for duplicate writes and missing deletes.

Added OnDuplicateWrites enum: Error (default) | Ignore - controls behavior when writing a tuple that already exists
Added OnMissingDeletes enum: Error (default) | Ignore - controls behavior when deleting a non-existent tuple
Added ConflictOptions class with properties for both enum types
Exposed via ClientWriteOptions.Conflict property
Default values (Error) are explicitly sent to the API when not specified by the user

Usage Example:

var options = new ClientWriteOptions {
  Conflict = new ConflictOptions {
      OnDuplicateWrites = OnDuplicateWrites.Ignore,
      OnMissingDeletes = OnMissingDeletes.Ignore
  }
};

await fgaClient.Write(body, options);

References

Generated from → openfga/sdk-generator#644
Issue → #121

Review Checklist

I have clicked on "allow edits by maintainers".
I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
The correct base branch is being used, if not main
I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

Release Notes

New Features
- Introduced write conflict resolution options allowing control over duplicate writes and missing deletes with Error or Ignore settings.
- API methods now accept optional request options parameter (breaking change).
Documentation
- Added guidance for configuring conflict options in write operations.
Bug Fixes
- Fixed header validation error message wording.

coderabbitai · 2025-10-16T23:15:22Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

This PR introduces write conflict resolution options to the SDK, adding OnDuplicateWrites and OnMissingDeletes enums within ConflictOptions to control write operation behavior. The client implementation maps these options into request bodies. A breaking change adds optional IRequestOptions parameters to all OpenFgaApi methods. Extensive test coverage validates conflict option propagation and header handling across operations.

Changes

Cohort / File(s)	Summary
Conflict Options & Model `src/OpenFga.Sdk/Client/Model/ClientWriteOptions.cs`	Added `OnDuplicateWrites` and `OnMissingDeletes` enums; introduced `IConflictOptions` interface and `ConflictOptions` class with properties for duplicate writes and missing deletes behavior; extended `IClientWriteOptions` and `ClientWriteOptions` with `Conflict` and `Headers` properties.
Client Implementation `src/OpenFga.Sdk/Client/Client.cs`	Added private mapping methods `MapOnDuplicateWrites()` and `MapOnMissingDeletes()` to convert enums to request body enums; updated Write path to pass conflict mappings into request bodies for writes and deletes; expanded `ClientWriteOptions` construction to propagate `Conflict` from options.
Test Coverage `src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs`	Added comprehensive test cases for conflict resolution (OnDuplicateWrites/OnMissingDeletes with Error/Ignore values, combined scenarios, null behavior); expanded header propagation tests validating per-request header overrides, reserved header protection, and concurrent request isolation across Check, Read, Expand, List, and store operations.
Documentation `README.md`	Added documentation section explaining Conflict Options for Write Operations with `OnDuplicateWrites` and `OnMissingDeletes` values and configuration example via `ClientWriteOptions`.
Build Metadata `CHANGELOG.md`	Documented addition of `ConflictOptions`, breaking API changes to OpenFgaApi (optional `IRequestOptions` parameter on all methods), and interface renaming (`ClientRequestOptions` → `IClientRequestOptions`).

Sequence Diagram

sequenceDiagram
    participant User as User Code
    participant Client as Client
    participant Mapper as Mapper Logic
    participant API as WriteRequest Body

    User->>Client: Write with ClientWriteOptions<br/>(Conflict: OnDuplicateWrites.Ignore)
    Client->>Mapper: MapOnDuplicateWrites(Ignore)
    Mapper-->>Client: WriteRequestWrites.OnDuplicateEnum.Ignore
    Client->>Mapper: MapOnMissingDeletes(null)
    Mapper-->>Client: WriteRequestDeletes.OnMissingEnum.Error<br/>(default)
    Client->>API: WriteRequest with<br/>Writes.OnDuplicate=Ignore<br/>Deletes.OnMissing=Error
    API-->>Client: Response
    Client-->>User: Result

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

The changes introduce straightforward enum mappings and conflict option propagation with consistent patterns across test cases. While the test file is large with extensive scenarios, the logic density is moderate—primarily validation of option threading through request paths and header precedence. The breaking API surface change (optional IRequestOptions on all methods) is well-scoped but requires verification across method signatures.

Possibly related issues

[All SDKs] Add on_duplicate/on_missing options support for Write operations sdk-generator#610: Implements the same write-conflict feature (OnDuplicateWrites/OnMissingDeletes with ConflictOptions), directly addressing the core objective of this PR.

Possibly related PRs

chore: sync generator at api@0ac19aa #120: Introduces identical write conflict controls with OnDuplicate/OnMissing enums and updates Write request models, sharing the same API-level conflict field modifications.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "feat: add write conflict resolution options" directly and clearly describes the primary objective of the changeset. The main feature being introduced is the addition of conflict resolution options for write operations, specifically the OnDuplicateWrites and OnMissingDeletes enums, the ConflictOptions class, and their exposure via ClientWriteOptions.Conflict. The title is concise, specific, and avoids generic terms—it accurately captures the core functionality being added. While the PR also includes other changes such as breaking API modifications and test additions, these are supporting changes to implement the stated feature.
Docstring Coverage	✅ Passed	Docstring coverage is 84.21% which is sufficient. The required threshold is 80.00%.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a040c45 and 0731319.

📒 Files selected for processing (26)

.openapi-generator/FILES (1 hunks)
CHANGELOG.md (8 hunks)
README.md (2 hunks)
src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs (5 hunks)
src/OpenFga.Sdk/Api/OpenFgaApi.cs (31 hunks)
src/OpenFga.Sdk/ApiClient/ApiClient.cs (3 hunks)
src/OpenFga.Sdk/Client/Client.cs (19 hunks)
src/OpenFga.Sdk/Client/ClientConfiguration.cs (4 hunks)
src/OpenFga.Sdk/Client/Model/ClientBatchCheckOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientCheckOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientCreateStoreOptions.cs (1 hunks)
src/OpenFga.Sdk/Client/Model/ClientExpandOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientListObjectsOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientListRelationsOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientListStoresOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientListUsersOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientReadAssertionsOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientReadAuthorizaionModelOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientReadAuthorizaionModelsOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientReadChangesOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientReadOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientRequestOptions.cs (1 hunks)
src/OpenFga.Sdk/Client/Model/ClientRequestOptsWithStoreId.cs (1 hunks)
src/OpenFga.Sdk/Client/Model/ClientWriteAssertionsOptions.cs (2 hunks)
src/OpenFga.Sdk/Client/Model/ClientWriteOptions.cs (3 hunks)
src/OpenFga.Sdk/Model/RequestOptions.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (22)

src/OpenFga.Sdk/Client/Model/ClientReadOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientExpandOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientListRelationsOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientReadAuthorizaionModelOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientCheckOptions.cs (1)

src/OpenFga.Sdk/Model/RequestOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientListObjectsOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientCreateStoreOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientReadAuthorizaionModelsOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientReadAssertionsOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientWriteAssertionsOptions.cs (1)

src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs (4)

src/OpenFga.Sdk/Client/Model/ClientReadChangesOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientWriteOptions.cs (1)

src/OpenFga.Sdk/Client/ClientConfiguration.cs (1)

src/OpenFga.Sdk/Client/Model/ClientListUsersOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientRequestOptions.cs (1)

src/OpenFga.Sdk/Client/Client.cs (7)

src/OpenFga.Sdk/ApiClient/ApiClient.cs (2)

src/OpenFga.Sdk/Client/Model/ClientListStoresOptions.cs (1)

src/OpenFga.Sdk/Client/Model/ClientBatchCheckOptions.cs (1)

src/OpenFga.Sdk/Api/OpenFgaApi.cs (1)

🪛 LanguageTool

README.md

[grammar] ~210-~210: There might be a mistake here.
Context: ...### Custom Headers #### Default Headers You can set default headers that will be...

(QB_NEW_EN)

CHANGELOG.md

[grammar] ~6-~6: There might be a mistake here.
Context: ...ionfor headers sent with every request - per-request headers support viaHeaders...

(QB_NEW_EN)

[grammar] ~9-~9: There might be a mistake here.
Context: ...s` class for client-level header support - add header validation to prevent overidi...

(QB_NEW_EN)

[grammar] ~10-~10: Ensure spelling is correct
Context: ...rt - add header validation to prevent overiding of reserved headers - feat: add write c...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~10-~10: There might be a mistake here.
Context: ...to prevent overiding of reserved headers - feat: add write conflict resolution opti...

(QB_NEW_EN)

[grammar] ~14-~14: There might be a mistake here.
Context: ...norefor handling missing tuple deletes - Available inClientWriteOptions.Conflic...

(QB_NEW_EN)

[grammar] ~17-~17: There might be a mistake here.
Context: ...teOptions.Conflict` property [!WARNING] BREAKING CHANGES: - **OpenFgaApi method...

(QB_NEW_EN)

[grammar] ~59-~59: There might be a mistake here.
Context: ...d 2.0, .NET 8.0 and .NET 9.0 [!WARNING] BREAKING CHANGES: - While we have dropp...

(QB_NEW_EN)

[grammar] ~62-~62: There might be a mistake here.
Context: ... can still be used in .NET 6.0 projects. - We have updated the underlying OpenAPI g...

(QB_NEW_EN)

[grammar] ~74-~74: There might be a mistake here.
Context: ... New Enum Value | Affected Enum | | -------------- | -------------------- ...

(QB_NEW_EN)

[grammar] ~75-~75: There might be a mistake here.
Context: ... -------------------- | -------------- | | WRITE | TUPLEOPERATIONWRITE ...

(QB_NEW_EN)

[grammar] ~76-~76: There might be a mistake here.
Context: ... TUPLEOPERATIONWRITE | TupleOperation | | DELETE | TUPLEOPERATIONDELETE ...

(QB_NEW_EN)

[grammar] ~109-~109: There might be a mistake here.
Context: ...lag enable-consistency-params enabled. See the [v1.5.7 release notes](https:/...

(QB_NEW_EN)

[grammar] ~176-~176: There might be a mistake here.
Context: ... - OpenFgaApi now requires storeId as first param when needed - `Configuratio...

(QB_NEW_EN)

[grammar] ~178-~178: There might be a mistake here.
Context: ...he following request interfaces changed: - CheckRequest: the TupleKey field is now of interfa...

(QB_NEW_EN)

[grammar] ~200-~200: There might be a mistake here.
Context: ...): read with no filter (read all tuples) - chore(deps): update dependencies ## v0....

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.18.1)

CHANGELOG.md

194-194: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Test netcoreapp3.1 on windows-latest
GitHub Check: Analyze (csharp)
GitHub Check: Test net8.0 on windows-latest
GitHub Check: Test net48 on windows-latest

🔇 Additional comments (28)

CHANGELOG.md

src/OpenFga.Sdk/ApiClient/ApiClient.cs

Copilot

Pull Request Overview

This PR implements support for custom headers and write conflict resolution options for the OpenFGA .NET SDK, bringing it in line with OpenFGA API v1.10.0 capabilities.

Adds comprehensive custom headers support at both client configuration and per-request levels
Implements write conflict resolution options for handling duplicate writes and missing deletes
Introduces proper header validation and security measures to prevent reserved header overrides

Reviewed Changes

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

Show a summary per file

File	Description
RequestOptions.cs	New interface and class for API-level header support
ClientWriteOptions.cs	Adds conflict resolution enums, options, and headers support
ClientRequestOptions.cs	Refactored to interface-based pattern with headers support
ClientConfiguration.cs	Adds default headers support with validation
Client.cs	Implements header extraction, conflict option mapping, and API integration
ApiClient.cs	Enhances header building and OAuth token management
OpenFgaApi.cs	Updates all API methods to accept optional request options
OpenFgaClientTests.cs	Comprehensive test coverage for new functionality
README.md	Documentation for custom headers and conflict options

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/OpenFga.Sdk/Client/Model/ClientWriteOptions.cs

src/OpenFga.Sdk/Client/Model/ClientReadAuthorizaionModelsOptions.cs

src/OpenFga.Sdk/Client/Model/ClientListStoresOptions.cs

src/OpenFga.Sdk/Client/Client.cs

Copilot

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/OpenFga.Sdk/Client/Client.cs

coderabbitai · 2025-10-21T00:29:09Z

✅ Actions performed

Review triggered.

SoulPancake

LG

The base branch was changed.

src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs

+                "SendAsync",
+                ItExpr.Is<HttpRequestMessage>(req =>
+                    req.RequestUri == new Uri($"{_config.BasePath}/stores/{_config.StoreId}/write") &&
+                    req.Method == HttpMethod.Post),


The most idiomatic fix is to leverage the using declaration so that HttpResponseMessage (responseMsg) is automatically disposed when it goes out of scope, rather than explicitly disposing it in a finally block. Given responseMsg is only assigned in the lambda executed during the mock handler, and not outside that, and its lifecycle is confined to the test method, we can introduce a new code block scoped via the using statement around the body of the test that consumes responseMsg. After the awaited call, assertions can be made as before. The try-finally block is removed, replaced with the using statement covering the same lifetime as the previous try block. This maintains identical functionality and guaranteed disposal in an idiomatic C# way.

Only the method WriteTuples_WithConflictOptions_ShouldPassOptionToApi requires modification (src/OpenFga.Sdk.Test/Client/OpenFgaClientTests.cs, lines 2581-2632):

Remove the try/finally block, and wrap the relevant logic (from after creating tuples) in a using block for responseMsg.

Restructure code so responseMsg is disposed when out of scope, using the latest C# using statement style if possible.

Ensure test setup, invocation, and assertions remain unchanged otherwise.

evansims requested review from a team as code owners October 16, 2025 23:15

evansims added the enhancement New feature or request label Oct 16, 2025

evansims mentioned this pull request Oct 16, 2025

feat(dotnet-sdk): add write conflict resolution options openfga/sdk-generator#644

Merged

4 tasks

evansims linked an issue Oct 16, 2025 that may be closed by this pull request

Add support for ignoring duplicate write tuple keys and missing delete tuple keys #121

Closed

1 task

github-advanced-security bot found potential problems Oct 16, 2025

View reviewed changes

coderabbitai bot reviewed Oct 16, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/OpenFga.Sdk/ApiClient/ApiClient.cs Outdated Show resolved Hide resolved

Copilot AI review requested due to automatic review settings October 16, 2025 23:53

Copilot AI reviewed Oct 16, 2025

View reviewed changes

evansims changed the base branch from main to feat/per-request-custom-headers October 16, 2025 23:54

evansims changed the title ~~eat(DXAZD-1962): add write conflict resolution options~~ feat: add write conflict resolution options Oct 16, 2025

evansims marked this pull request as draft October 17, 2025 02:27

evansims force-pushed the feat/write-conflict-options branch from 1adf577 to 5453646 Compare October 21, 2025 00:17

evansims marked this pull request as ready for review October 21, 2025 00:26

evansims requested a review from Copilot October 21, 2025 00:28

Copilot AI reviewed Oct 21, 2025

View reviewed changes

src/OpenFga.Sdk/Client/Client.cs Outdated Show resolved Hide resolved

SoulPancake previously approved these changes Oct 21, 2025

View reviewed changes

ewanharris previously approved these changes Oct 21, 2025

View reviewed changes

Base automatically changed from feat/per-request-custom-headers to main October 21, 2025 15:10

evansims added 6 commits October 21, 2025 10:19

feat: per-request custom headers

04517b7

chore: regenerate from SDK

052cff7

refactor: additional header reservations

0718071

refactor: implement @rhamzeh feedback

b3f735b

feat(DXAZD-1962): add write conflict resolution options

eee15d1

refactor: implement coderabbit feedback

b3c94e4

evansims added 4 commits October 21, 2025 10:22

refactor: implement AI feedback

6d5c9a7

refactor: implement AI feedback

8457e4e

fix: merge conflict

81f5191

refactor: implement AI feedback

7ada57e

evansims force-pushed the feat/write-conflict-options branch from a8e05da to 7ada57e Compare October 21, 2025 15:23

github-advanced-security bot found potential problems Oct 21, 2025

View reviewed changes

evansims enabled auto-merge October 21, 2025 15:58

ewanharris approved these changes Oct 21, 2025

View reviewed changes

evansims added this pull request to the merge queue Oct 21, 2025

Merged via the queue into main with commit 774dda0 Oct 21, 2025
23 checks passed

evansims deleted the feat/write-conflict-options branch October 21, 2025 16:05

rhamzeh mentioned this pull request Nov 3, 2025

feat: add support for write conflict settings openfga/js-sdk#276

Merged

4 tasks

@@ -2613,22 +2613,19 @@
                         }
                     };
-                    try {
-                        await fgaClient.WriteTuples(tuples, new ClientWriteOptions {
-                            AuthorizationModelId = "01GXSA8YR785C4FYS3C0RTG7B1",
-                            Conflict = new ConflictOptions {
-                                OnDuplicateWrites = OnDuplicateWrites.Ignore
-                            }
-                        });
+                    await fgaClient.WriteTuples(tuples, new ClientWriteOptions {
+                        AuthorizationModelId = "01GXSA8YR785C4FYS3C0RTG7B1",
+                        Conflict = new ConflictOptions {
+                            OnDuplicateWrites = OnDuplicateWrites.Ignore
+                        }
+                    });
-                        Assert.NotNull(capturedRequest);
-                        Assert.NotNull(capturedRequest.Writes);
-                        Assert.Equal(WriteRequestWrites.OnDuplicateEnum.Ignore, capturedRequest.Writes.OnDuplicate);
-                    }
-                    finally {
-                        if (responseMsg != null)
-                            responseMsg.Dispose();
-                    }
+                    Assert.NotNull(capturedRequest);
+                    Assert.NotNull(capturedRequest.Writes);
+                    Assert.Equal(WriteRequestWrites.OnDuplicateEnum.Ignore, capturedRequest.Writes.OnDuplicate);
+                    if (responseMsg != null)
+                        responseMsg.Dispose();
                 }
                 /// <summary>

Conversation

evansims commented Oct 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

References

Review Checklist

Summary by CodeRabbit

Release Notes

Uh oh!

coderabbitai bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Other AI code review bot(s) detected

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Possibly related issues

Possibly related PRs

Pre-merge checks and finishing touches

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

coderabbitai bot commented Oct 21, 2025

Uh oh!

SoulPancake left a comment

Choose a reason for hiding this comment

Uh oh!

Check notice

Uh oh!

Uh oh!

Copilot Autofix

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

evansims commented Oct 16, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 16, 2025 •

edited

Loading