feat(OSS-846): Added an optional customHeaders parameter for FaunaCli… (#158)

Author: parkhomenko

FaunaDB.Client.Test/ClientTest.cs

@@ -231,6 +231,37 @@ public async Task TestGetAnInstance()
             Assert.AreEqual("Magic Missile", document.Get(NAME_FIELD));
         }
 
+        [Test]
+        public async Task TestGetAnInstanceWithCustomHeaders()
+        {
+            var clientWithCustomHeaders = new FaunaClient(
+                secret: faunaSecret,
+                endpoint: faunaEndpoint,
+                customHeaders: new Dictionary<string, string>
+                {
+                    { "test-header-1", "test-value-1" },
+                    { "test-header-2", "test-value-2" },
+                }
+            );
+
+            await clientWithCustomHeaders.Query(
+                CreateCollection(
+                    Obj("name", "magic_spells"))
+            );
+
+            var magicFireball = GetRef(await clientWithCustomHeaders.Query(
+                Create(Collection("magic_spells"),
+                    Obj("data",
+                        Obj(
+                            "name", "Fire Ball",
+                            "element", "arcane",
+                            "cost", 10)))
+            ));
+
+            Value document = await clientWithCustomHeaders.Query(Get(magicFireball));
+            Assert.AreEqual("Fire Ball", document.Get(NAME_FIELD));
+        }
+
         [Test]
         public async Task TestIssueABatchedQueryWithVarargs()
         {

FaunaDB.Client.Test/TestCase.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Net;
 using System.Net.Http;
 using System.Text;

FaunaDB.Client/Client/DefaultClientIO.cs

@@ -24,13 +24,15 @@ internal class DefaultClientIO : IClientIO
         private readonly HttpClient client;
         private readonly AuthenticationHeaderValue authHeader;
 
+        private readonly IReadOnlyDictionary<string, string> customHeaders;
+
         private LastSeen lastSeen;
         private Version httpVersion;
 
         public const string StreamingPath = "stream";
         public const HttpMethodKind StreamingHttpMethod = HttpMethodKind.Post;
 
-        internal DefaultClientIO(HttpClient client, AuthenticationHeaderValue authHeader, LastSeen lastSeen, Uri endpoint, TimeSpan? timeout, Version httpVersion)
+        internal DefaultClientIO(HttpClient client, AuthenticationHeaderValue authHeader, LastSeen lastSeen, Uri endpoint, TimeSpan? timeout, Version httpVersion, IReadOnlyDictionary<string, string> customHeaders)
         {
             client.AssertNotNull(nameof(client));
             authHeader.AssertNotNull(nameof(authHeader));
@@ -42,19 +44,20 @@ internal DefaultClientIO(HttpClient client, AuthenticationHeaderValue authHeader
             this.lastSeen = lastSeen;
             this.endpoint = endpoint;
             this.clientTimeout = timeout;
+            this.customHeaders = customHeaders;
 #if NETSTANDARD2_1
             this.httpVersion = httpVersion == null ? new Version(2, 0) : httpVersion;
 #else
             this.httpVersion = httpVersion == null ? new Version(1, 1) : httpVersion;
 #endif
         }
 
-        public DefaultClientIO(string secret, Uri endpoint, TimeSpan? timeout = null, HttpClient httpClient = null, Version httpVersion = null)
-            : this(httpClient ?? CreateClient(), AuthHeader(secret), new LastSeen(), endpoint, timeout, httpVersion)
+        public DefaultClientIO(string secret, Uri endpoint, TimeSpan? timeout = null, HttpClient httpClient = null, Version httpVersion = null, IReadOnlyDictionary<string, string> customHeaders = null)
+            : this(httpClient ?? CreateClient(), AuthHeader(secret), new LastSeen(), endpoint, timeout, httpVersion, customHeaders)
         { }
 
         public IClientIO NewSessionClient(string secret) =>
-            new DefaultClientIO(client, AuthHeader(secret), lastSeen, endpoint, clientTimeout, httpVersion);
+            new DefaultClientIO(client, AuthHeader(secret), lastSeen, endpoint, clientTimeout, httpVersion, customHeaders);
 
         public Task<RequestResult> DoRequest(HttpMethodKind method, string path, string data, IReadOnlyDictionary<string, string> query = null, TimeSpan? queryTimeout = null) =>
             DoRequestAsync(method, path, data, query, queryTimeout);
@@ -82,6 +85,15 @@ private async Task<RequestResult> DoRequestAsync(HttpMethodKind method, string p
             message.Headers.Add("X-Driver-Env", RuntimeEnvironmentHeader.Construct(EnvironmentEditor.Create()));
             message.Version = httpVersion;
 
+            // adding custom headers provided during the client creation
+            if (customHeaders != null)
+            {
+                foreach (KeyValuePair<string, string> header in customHeaders)
+                {
+                    message.Headers.Add(header.Key, header.Value);
+                }
+            }
+
             var last = lastSeen.Txn;
             if (last.HasValue)
             {
@@ -141,6 +153,15 @@ private async Task<StreamingRequestResult> DoStreamingRequestAsync(string data,
             message.Version = httpVersion;
             message.SetTimeout(Timeout.InfiniteTimeSpan);
 
+            // adding custom headers provided during the client creation
+            if (customHeaders != null)
+            {
+                foreach (KeyValuePair<string, string> header in customHeaders)
+                {
+                    message.Headers.Add(header.Key, header.Value);
+                }
+            }
+
             var last = lastSeen.Txn;
             if (last.HasValue)
             {

FaunaDB.Client/Client/FaunaClient.cs

@@ -40,8 +40,9 @@ public FaunaClient(
             TimeSpan? timeout = null,
             HttpClient httpClient = null,
             Version httpVersion = null,
-            bool checkNewVersion = true)
-            : this(CreateClient(secret, endpoint, timeout, httpClient, httpVersion, checkNewVersion))
+            bool checkNewVersion = true,
+            IReadOnlyDictionary<string, string> customHeaders = null)
+            : this(CreateClient(secret, endpoint, timeout, httpClient, httpVersion, checkNewVersion, customHeaders))
         { }
 
         /// <summary>
@@ -253,7 +254,8 @@ private static IClientIO CreateClient(
             TimeSpan? timeout = null,
             HttpClient httpClient = null,
             Version httpVersion = null,
-            bool checkNewVersion = true)
+            bool checkNewVersion = true,
+            IReadOnlyDictionary<string, string> customHeaders = null)
         {
             secret.AssertNotNull(nameof(secret));
             endpoint.AssertNotNull(nameof(endpoint));