chore(dotnet-sdk): fixes and sync back sdk changes (#526)

Author: rhamzeh

.github/workflows/main.yaml

@@ -93,6 +93,8 @@ jobs:
 
       - name: Run All Tests
         run: make test-client-dotnet
+        env:
+          OPEN_API_REF: f9709139a3693f6624efda12a001e242c5d506b6
 
       - name: Check for SDK changes
         run: |

config/clients/dotnet/CHANGELOG.md.mustache

@@ -3,6 +3,18 @@
 ## [Unreleased](https://github.com/openfga/dotnet-sdk/compare/v{{packageVersion}}...HEAD)
 
 - feat: add support for `start_time` parameter in `ReadChanges` endpoint
+- feat: update API definitions
+- feat: support assertions context and contextual tuples
+- feat: support contextual tuples in `Expand`
+- feat!: support passing in name to filter in `ListStores`
+- fix: remove dependency on OpenTelemetry.Api (#100) - thanks @m4tchl0ck
+- fix: limit default retries to `3` from `15` (https://github.com/openfga/sdk-generator/pull/420) - thanks @ovindu-a
+- fix: `ListRelations` should not swallow errors
+- chore(docs): replace readable names with uuid to discourage storing PII in OpenFGA (https://github.com/openfga/sdk-generator/pull/433) - thanks @sccalabr
+
+[!WARNING]
+BREAKING CHANGES:
+- The `ListStores` method now accepts a body parameter with an optional `Name` to filter the stores. This is a breaking change as it changes the method contract to allow passing in a body with the name.
 
 ## v0.5.1
 

config/clients/dotnet/config.overrides.json

@@ -79,6 +79,10 @@
       "destinationFilename": "src/OpenFga.Sdk/Client/Model/ClientBatchCheckResponse.cs",
       "templateType": "SupportingFiles"
     },
+    "Client/Model/ClientBatchCheckResponseTest.mustache": {
+      "destinationFilename": "src/OpenFga.Sdk.Test/Models/Client/ClientBatchCheckResponseTest.cs",
+      "templateType": "SupportingFiles"
+    },
     "Client/Model/ClientCheckOptions.mustache": {
       "destinationFilename": "src/OpenFga.Sdk/Client/Model/ClientCheckOptions.cs",
       "templateType": "SupportingFiles"
@@ -131,6 +135,10 @@
       "destinationFilename": "src/OpenFga.Sdk/Client/Model/ClientListStoresOptions.cs",
       "templateType": "SupportingFiles"
     },
+    "Client/Model/ClientListStoresRequest.mustache": {
+      "destinationFilename": "src/OpenFga.Sdk/Client/Model/ClientListStoresRequest.cs",
+      "templateType": "SupportingFiles"
+    },
     "Client/Model/ClientListUsersOptions.mustache": {
       "destinationFilename": "src/OpenFga.Sdk/Client/Model/ClientListUsersOptions.cs",
       "templateType": "SupportingFiles"

config/clients/dotnet/template/Client/Client.mustache

@@ -72,9 +72,9 @@ public class {{appShortName}}Client : IDisposable {
     /**
    * ListStores - Get a paginated list of stores.
    */
-    public async Task<ListStoresResponse> ListStores(IClientListStoresOptions? options = default,
+    public async Task<ListStoresResponse> ListStores(IClientListStoresRequest? body, IClientListStoresOptions? options = default,
         CancellationToken cancellationToken = default) =>
-        await api.ListStores(options?.PageSize, options?.ContinuationToken, cancellationToken);
+        await api.ListStores(options?.PageSize, options?.ContinuationToken, body?.Name, cancellationToken);
 
     /**
    * CreateStore - Initialize a store
@@ -334,6 +334,11 @@ public class {{appShortName}}Client : IDisposable {
             GetStoreId(options),
             new ExpandRequest {
                 TupleKey = new ExpandRequestTupleKey {Relation = body.Relation, Object = body.Object},
+                ContextualTuples =
+                    new ContextualTupleKeys {
+                        TupleKeys = body.ContextualTuples?.ConvertAll(tupleKey => tupleKey.ToTupleKey()) ??
+                                    new List<TupleKey>()
+                    },
                 AuthorizationModelId = GetAuthorizationModelId(options),
                 Consistency = options?.Consistency
             }, cancellationToken);
@@ -384,8 +389,12 @@ public class {{appShortName}}Client : IDisposable {
 
         var batchCheckResponse = await BatchCheck(batchCheckRequests, options, cancellationToken);
 
-        for (var index = 0; index < batchCheckResponse.Responses.Count; index++) {
-            var batchCheckSingleResponse = batchCheckResponse.Responses[index];
+
+        foreach (var batchCheckSingleResponse in batchCheckResponse.Responses) {
+            if (batchCheckSingleResponse.Error != null) {
+                throw batchCheckSingleResponse.Error;
+            }
+
             if (batchCheckSingleResponse.Allowed && batchCheckSingleResponse.Request?.Relation != null) {
                 responses.AddRelation(batchCheckSingleResponse.Request.Relation);
             }

config/clients/dotnet/template/Client/Model/ClientBatchCheckResponse.mustache

@@ -43,7 +43,26 @@ public class BatchCheckSingleResponse : IEquatable<BatchCheckSingleResponse>, IV
     [JsonPropertyName("error")]
     public Exception? Error { get; set; }
 
-    public bool Equals(BatchCheckSingleResponse? other) => throw new NotImplementedException();
+    /// <inheritdoc />
+    public bool Equals(BatchCheckSingleResponse? other)
+    {
+        if (other == null) return false;
+        if (ReferenceEquals(this, other)) return true;
+
+        return Allowed == other.Allowed &&
+               EqualityComparer<ClientCheckRequest>.Default.Equals(Request, other.Request) &&
+               EqualityComparer<Exception>.Default.Equals(Error, other.Error);
+    }
+
+    /// <inheritdoc />
+    public override bool Equals(object obj)
+    {
+        if (obj is BatchCheckSingleResponse other)
+        {
+            return Equals(other);
+        }
+        return false;
+    }
 
     public IEnumerable<ValidationResult> Validate(ValidationContext validationContext) =>
         throw new NotImplementedException();
@@ -72,7 +91,24 @@ public class ClientBatchCheckClientResponse : IEquatable<ClientBatchCheckClientR
     [JsonPropertyName("responses")]
     public List<BatchCheckSingleResponse> Responses { get; set; }
 
-    public bool Equals(ClientBatchCheckClientResponse? other) => throw new NotImplementedException();
+    /// <inheritdoc />
+    public bool Equals(ClientBatchCheckClientResponse? other)
+    {
+        if (other == null) return false;
+        if (ReferenceEquals(this, other)) return true;
+
+        return Responses.SequenceEqual(other.Responses);
+    }
+
+    /// <inheritdoc />
+    public override bool Equals(object obj)
+    {
+        if (obj is ClientBatchCheckClientResponse other)
+        {
+            return Equals(other);
+        }
+        return false;
+    }
 
     public IEnumerable<ValidationResult> Validate(ValidationContext validationContext) =>
         throw new NotImplementedException();
@@ -82,4 +118,4 @@ public class ClientBatchCheckClientResponse : IEquatable<ClientBatchCheckClientR
     /// </summary>
     /// <param name="response"></param>
     public void AppendResponse(BatchCheckSingleResponse response) => Responses.Add(response);
-}
+}

config/clients/dotnet/template/Client/Model/ClientBatchCheckResponseTest.mustache

@@ -0,0 +1,41 @@
+{{>partial_header}}
+
+using {{packageName}}.Client.Model;
+using System.Collections.Generic;
+using Xunit;
+
+public class ClientBatchCheckClientResponseTests
+{
+    [Fact]
+    public void Equals_ReturnsTrue_WhenResponsesAreEqual()
+    {
+        var response1 = new BatchCheckSingleResponse(true, new ClientCheckRequest(), null);
+        var response2 = new BatchCheckSingleResponse(true, new ClientCheckRequest(), null);
+        var clientResponse1 = new ClientBatchCheckClientResponse(new List<BatchCheckSingleResponse> { response1 });
+        var clientResponse2 = new ClientBatchCheckClientResponse(new List<BatchCheckSingleResponse> { response2 });
+
+        Assert.True(clientResponse1.Equals(clientResponse2));
+    }
+
+    [Fact]
+    public void Equals_ReturnsFalse_WhenResponsesAreNotEqual()
+    {
+        var response1 = new BatchCheckSingleResponse(true, new ClientCheckRequest(), null);
+        var response2 = new BatchCheckSingleResponse(false, new ClientCheckRequest(), null);
+        var clientResponse1 = new ClientBatchCheckClientResponse(new List<BatchCheckSingleResponse> { response1 });
+        var clientResponse2 = new ClientBatchCheckClientResponse(new List<BatchCheckSingleResponse> { response2 });
+
+        Assert.False(clientResponse1.Equals(clientResponse2));
+    }
+
+    [Fact]
+    public void AppendResponse_AddsResponseToList()
+    {
+        var clientResponse = new ClientBatchCheckClientResponse();
+        var response = new BatchCheckSingleResponse(true, new ClientCheckRequest(), null);
+
+        clientResponse.AppendResponse(response);
+
+        Assert.Contains(response, clientResponse.Responses);
+    }
+}

config/clients/dotnet/template/Client/Model/ClientExpandRequest.mustache

@@ -1,5 +1,6 @@
 {{>partial_header}}
 
+using {{packageName}}.Model;
 using System.ComponentModel.DataAnnotations;
 using System.Runtime.Serialization;
 using System.Text.Json;
@@ -20,6 +21,8 @@ public interface IClientExpandRequest {
     ///     Object
     /// </summary>
     public string Object { get; set; }
+    
+    public List<ClientTupleKey>? ContextualTuples { get; set; }
 }
 
 /// <inheritdoc />
@@ -35,6 +38,13 @@ public class ClientExpandRequest : IClientExpandRequest, IEquatable<ClientExpand
 
     public string Object { get; set; }
 
+    /// <summary>
+    ///     Gets or Sets Contextual Tuples
+    /// </summary>
+    [DataMember(Name = "contextual_tuples", EmitDefaultValue = false)]
+    [JsonPropertyName("contextual_tuples")]
+    public List<ClientTupleKey>? ContextualTuples { get; set; }
+
     public bool Equals(ClientExpandRequest input) {
         if (input == null) {
             return false;
@@ -50,6 +60,11 @@ public class ClientExpandRequest : IClientExpandRequest, IEquatable<ClientExpand
                 Object == input.Object ||
                 (Object != null &&
                  Object.Equals(input.Object))
+            ) &&
+            (
+                ContextualTuples == input.ContextualTuples ||
+                (ContextualTuples != null &&
+                 ContextualTuples.Equals(input.ContextualTuples))
             );
     }
 
@@ -76,7 +91,11 @@ public class ClientExpandRequest : IClientExpandRequest, IEquatable<ClientExpand
                 hashCode = (hashCode * {{hashCodeMultiplierPrimeNumber}}) + Object.GetHashCode();
             }
 
+            if (ContextualTuples != null) {
+                hashCode = (hashCode * {{hashCodeMultiplierPrimeNumber}}) + ContextualTuples.GetHashCode();
+            }
+
             return hashCode;
         }
     }
-}
+}

config/clients/dotnet/template/Client/Model/ClientListStoresRequest.mustache

@@ -0,0 +1,62 @@
+{{>partial_header}}
+
+using System.ComponentModel.DataAnnotations;
+using System.Runtime.Serialization;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace {{packageName}}.Client.Model;
+
+public interface IClientListStoresRequest {
+    public string? Name { get; set; }
+}
+
+/// <summary>
+///     ClientListStoresRequest
+/// </summary>
+public class ClientListStoresRequest : IClientListStoresRequest, IEquatable<ClientListStoresRequest>,
+    IValidatableObject {
+    /// <summary>
+    /// Gets or Sets Name
+    /// </summary>
+    [DataMember(Name = "name", EmitDefaultValue = false)]
+    [JsonPropertyName("name")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string? Name { get; set; }
+
+    public bool Equals(ClientListStoresRequest input) {
+        if (input == null) {
+            return false;
+        }
+
+        return
+            (
+                Name == input.Name ||
+                (Name != null &&
+                 Name.Equals(input.Name))
+            );
+    }
+
+    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext) {
+        yield break;
+    }
+
+    public virtual string ToJson() => JsonSerializer.Serialize(this);
+
+    public static ClientListStoresRequest FromJson(string jsonString) =>
+        JsonSerializer.Deserialize<ClientListStoresRequest>(jsonString) ?? throw new InvalidOperationException();
+
+    public override bool Equals(object input) => Equals(input as ClientListStoresRequest);
+
+    public override int GetHashCode() {
+        unchecked // Overflow is fine, just wrap
+        {
+            var hashCode = 9661;
+            if (Name != null) {
+                hashCode = (hashCode * 9923) + Name.GetHashCode();
+            }
+
+            return hashCode;
+        }
+    }
+}