feat: Add IsTlsEnabled client option (#35)

Add `IsTlsEnabled` client option

When `true`, https is used when generating index clients, when `false`, http is used.

---------

Co-authored-by: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>

Author: fern-support

README.md

@@ -649,6 +649,7 @@ Control Plane endpoints are accessed via standard HTTP requests. You can configu
 - **Timeout**: The time limit for each request before it times out. Default is `30 seconds`.
 - **BaseUrl**: The base URL for all requests.
 - **HttpClient**: The HTTP client to be used for all requests.
+- **IsTlsEnabled**: The client will default to using HTTPS if `true`, and to HTTP if `false`. Default is `true`.
 
 Example usage:
 
@@ -657,8 +658,9 @@ var pinecone = new PineconeClient("PINECONE_API_KEY", new ClientOptions
 {
     MaxRetries = 3,
     Timeout = TimeSpan.FromSeconds(60),
-    HttpClient = ... // Override the Http Client
-    BaseUrl = ... // Override the Base URL
+    HttpClient = ..., // Override the Http Client
+    BaseUrl = ..., // Override the Base URL
+    IsTlsEnabled = true
 });
 ```
 

src/Pinecone.Test/Integration/Control/Setup.cs

@@ -19,7 +19,11 @@ public async Task GlobalSetup()
             Console.WriteLine("Initializing control plane integration tests...");
             Client = new PineconeClient(
                 apiKey: Helpers.GetEnvironmentVar("PINECONE_API_KEY"),
-                new ClientOptions { SourceTag = "test-tag" }
+                new ClientOptions
+                {
+                    SourceTag = "test-tag", 
+                    BaseUrl = Helpers.GetEnvironmentVar("PINECONE_BASE_URL", BasePineconeEnvironment.Default)
+                }
             );
             PineconeEnvironment = "us-west1-gcp";
             Dimension = 2;

src/Pinecone.Test/Integration/Data/Setup.cs

@@ -20,7 +20,11 @@ public async Task GlobalSetup()
         Console.WriteLine("Initializing data plane integration tests...");
         Client = new PineconeClient(
             apiKey: Helpers.GetEnvironmentVar("PINECONE_API_KEY"),
-            new ClientOptions { SourceTag = "test-tag" }
+            new ClientOptions
+            {
+                SourceTag = "test-tag",
+                BaseUrl = Helpers.GetEnvironmentVar("PINECONE_BASE_URL", BasePineconeEnvironment.Default)
+            }
         );
         Metric = CreateIndexRequestMetric.Cosine;
         Spec = new ServerlessIndexSpec
@@ -84,4 +88,4 @@ private static async Task SeedData()
         Console.WriteLine("Seeding data in namespace \"\"");
         await Seed.SetupData(IndexClient, "", true);
     }
-}
+}

src/Pinecone.Test/Integration/Data/TestSetupUpsertErrors.cs

@@ -9,7 +9,10 @@ public class TestSetupUpsertErrors : BaseTest
     [Test]
     public void TestUpsertFailsWhenApiKeyInvalid()
     {
-        var pinecone = new PineconeClient(Helpers.FakeApiKey());
+        var pinecone = new PineconeClient(Helpers.FakeApiKey(), new ClientOptions
+        {
+            BaseUrl = Helpers.GetEnvironmentVar("PINECONE_BASE_URL", BasePineconeEnvironment.Default)
+        });
         var e = Assert.ThrowsAsync<PineconeApiException>(async () =>
         {
             var index = pinecone.Index(null, IndexHost);

src/Pinecone/Core/Public/IsTlsEnabledOption.cs

@@ -0,0 +1,10 @@
+namespace Pinecone;
+
+public partial class ClientOptions
+{
+    /// <summary>
+    /// When TLS is enabled, the client will default to using HTTPS, and when disabled, it will default to using HTTP.
+    /// Defaults to true.
+    /// </summary>
+    public bool IsTlsEnabled { get; init; } = true;
+}

src/Pinecone/Core/Public/Version.cs

@@ -2,5 +2,5 @@ namespace Pinecone;
 
 internal class Version
 {
-    public const string Current = "2.0.0";
+    public const string Current = "2.1.0";
 }

src/Pinecone/Core/RawGrpcClient.cs

@@ -1,4 +1,3 @@
-using System;
 using Grpc.Core;
 using Grpc.Net.Client;
 
@@ -21,10 +20,7 @@ public RawGrpcClient(ClientOptions clientOptions)
         _clientOptions = clientOptions;
 
         var grpcOptions = PrepareGrpcChannelOptions();
-        Channel =
-            grpcOptions != null
-                ? GrpcChannel.ForAddress(_clientOptions.BaseUrl, grpcOptions)
-                : GrpcChannel.ForAddress(_clientOptions.BaseUrl);
+        Channel = GrpcChannel.ForAddress(_clientOptions.BaseUrl, grpcOptions);
     }
 
     /// <summary>
@@ -65,15 +61,11 @@ private void SetHeaders(global::Grpc.Core.Metadata metadata, Headers headers)
         }
     }
 
-    private GrpcChannelOptions? PrepareGrpcChannelOptions()
+    private GrpcChannelOptions PrepareGrpcChannelOptions()
     {
-        var grpcChannelOptions = _clientOptions.GrpcOptions;
-        if (grpcChannelOptions == null)
-        {
-            return null;
-        }
+        var grpcChannelOptions = _clientOptions.GrpcOptions ?? new GrpcChannelOptions();
         grpcChannelOptions.HttpClient ??= _clientOptions.HttpClient;
         grpcChannelOptions.MaxRetryAttempts ??= _clientOptions.MaxRetries;
         return grpcChannelOptions;
     }
-}
+}

src/Pinecone/Pinecone.csproj

@@ -8,7 +8,7 @@
         <NuGetAudit>false</NuGetAudit>
         <LangVersion>12</LangVersion>
         <Nullable>enable</Nullable>
-        <Version>2.0.0</Version>
+        <Version>2.1.0</Version>
         <AssemblyVersion>$(Version)</AssemblyVersion>
         <FileVersion>$(Version)</FileVersion>
         <PackageReadmeFile>README.md</PackageReadmeFile>

src/Pinecone/PineconeClient.cs

@@ -38,7 +38,7 @@ public PineconeClient(string? apiKey = "", ClientOptions? clientOptions = null)
         var client = new RawClient(
             new ClientOptions
             {
-                BaseUrl = NormalizeHost(host),
+                BaseUrl = NormalizeHost(host, clientOptions.IsTlsEnabled),
                 HttpClient = clientOptions.HttpClient,
                 MaxRetries = clientOptions.MaxRetries,
                 Timeout = clientOptions.Timeout,
@@ -76,25 +76,28 @@ private static ClientOptions PrepareClientOptions(
                 clientOptions.Headers[header.Key] = header.Value;
             }
         }
+
         if (clientOptions.SourceTag != null)
         {
             clientOptions.Headers["User-Agent"] =
                 $"lang=C#; version={Version.Current}; source_tag={clientOptions.SourceTag}";
         }
+
         return clientOptions;
     }
 
-    private string NormalizeHost(string host)
+    private static string NormalizeHost(string host, bool isTlsEnabled)
     {
-        if (host.StartsWith("https://") || host.StartsWith("http://"))
+        if(host.StartsWith("http://") || host.StartsWith("https://"))
         {
             return host;
         }
-        return "https://" + host;
+        
+        return $"{(isTlsEnabled ? "https" : "http")}://{host}";
     }
 
     private static string GetFromEnvironmentOrThrow(string env, string message)
     {
         return Environment.GetEnvironmentVariable(env) ?? throw new Exception(message);
     }
-}
+}