feat(clients): helper to switch API key in use (#3616)

Co-authored-by: Pierre Millot <[email protected]>

Author: Fluf22

clients/algoliasearch-client-csharp/algoliasearch/Clients/AlgoliaConfig.cs

@@ -45,7 +45,7 @@ protected AlgoliaConfig(string appId, string apiKey, string clientName, string c
     /// The admin API Key
     /// </summary>
     /// <returns></returns>
-    public string ApiKey { get; }
+    public string ApiKey { get; set; }
 
     /// <summary>
     /// Configurations hosts
@@ -97,5 +97,16 @@ internal Dictionary<string, string> BuildHeaders()
       DefaultHeaders[Defaults.UserAgentHeader.ToLowerInvariant()] = UserAgent.ToString();
       return DefaultHeaders;
     }
+
+    /// <summary>
+    /// Helper to switch the API key sent with each request
+    /// </summary>
+    /// <param name="apiKey">Your API Key</param>
+    /// <returns></returns>
+    public void SetClientApiKey(string apiKey)
+    {
+      ApiKey = apiKey;
+      DefaultHeaders[Defaults.AlgoliaApiKeyHeader.ToLowerInvariant()] = apiKey;
+    }
   }
 }

clients/algoliasearch-client-csharp/algoliasearch/Transport/HttpTransport.cs

@@ -24,7 +24,7 @@ internal class HttpTransport
   private readonly IHttpRequester _httpClient;
   private readonly ISerializer _serializer;
   private readonly RetryStrategy _retryStrategy;
-  private readonly AlgoliaConfig _algoliaConfig;
+  internal AlgoliaConfig _algoliaConfig;
   private string _errorMessage;
   private readonly ILogger<HttpTransport> _logger;
 

clients/algoliasearch-client-dart/packages/client_core/lib/src/api_client.dart

@@ -2,15 +2,12 @@ import 'package:algolia_client_core/src/config/client_options.dart';
 
 /// An abstract class representing an API client with specific properties and options.
 abstract interface class ApiClient {
-  /// The unique identifier for the application using the API client.
-  String get appId;
-
-  /// The API key used for authentication.
-  String get apiKey;
-
   /// A set of custom client options to configure the behavior of the API client.
   ClientOptions get options;
 
+  /// Allow switching the API key used to authenticate requests.
+  void setClientApiKey({required String apiKey});
+
   /// Dispose of underlying resources.
   void dispose();
 }

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/dio/auth_interceptor.dart

@@ -9,7 +9,7 @@ class AuthInterceptor extends Interceptor {
   final String appId;
 
   /// The API key used for Algolia authentication.
-  final String apiKey;
+  String apiKey;
 
   /// Constructs an [AuthInterceptor] with the provided application id and API key.
   AuthInterceptor({

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/dio/dio_requester.dart

@@ -16,7 +16,8 @@ import 'package:dio/dio.dart';
 /// response conversion and error handling.
 class DioRequester implements Requester {
   /// The underlying Dio client.
-  final Dio _client;
+  final AuthInterceptor _authInterceptor;
+  late final Dio _client;
 
   /// Constructs a [DioRequester] with the given [appId], [apiKey], and [options].
   DioRequester({
@@ -28,29 +29,30 @@ class DioRequester implements Requester {
     Function(Object?)? logger,
     Iterable<Interceptor>? interceptors,
     HttpClientAdapter? httpClientAdapter,
-  }) : _client = Dio(
-          BaseOptions(
-            headers: headers,
-            connectTimeout: connectTimeout,
+  }) : _authInterceptor = AuthInterceptor(
+          appId: appId,
+          apiKey: apiKey,
+        ) {
+    _client = Dio(
+      BaseOptions(
+        headers: headers,
+        connectTimeout: connectTimeout,
+      ),
+    )..interceptors.addAll([
+        _authInterceptor,
+        AgentInterceptor(
+          agent: AlgoliaAgent(packageVersion)
+            ..addAll(clientSegments ?? const [])
+            ..addAll(Platform.agentSegments()),
+        ),
+        if (logger != null)
+          LogInterceptor(
+            requestBody: true,
+            responseBody: true,
+            logPrint: logger,
           ),
-        )..interceptors.addAll([
-            AuthInterceptor(
-              appId: appId,
-              apiKey: apiKey,
-            ),
-            AgentInterceptor(
-              agent: AlgoliaAgent(packageVersion)
-                ..addAll(clientSegments ?? const [])
-                ..addAll(Platform.agentSegments()),
-            ),
-            if (logger != null)
-              LogInterceptor(
-                requestBody: true,
-                responseBody: true,
-                logPrint: logger,
-              ),
-            if (interceptors != null) ...interceptors,
-          ]) {
+        if (interceptors != null) ...interceptors,
+      ]);
     if (httpClientAdapter != null) {
       _client.httpClientAdapter = httpClientAdapter;
     }
@@ -114,4 +116,9 @@ class DioRequester implements Requester {
 
   @override
   void close() => _client.close();
+
+  @override
+  void setClientApiKey(String apiKey) {
+    _authInterceptor.apiKey = apiKey;
+  }
 }

clients/algoliasearch-client-dart/packages/client_core/lib/src/transport/requester.dart

@@ -11,6 +11,9 @@ abstract class Requester {
   /// The method returns a Future that resolves to an [HttpResponse].
   Future<HttpResponse> perform(HttpRequest request);
 
+  /// Allows to switch the API key used to authenticate requests.
+  void setClientApiKey(String apiKey);
+
   /// Closes any underlying resources that the Requester might be using.
   ///
   /// By default, it does nothing (no-op), but it can be implemented to handle resource cleanup

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java

@@ -16,6 +16,7 @@
 import java.util.concurrent.ExecutorService;
 import java.util.stream.Collectors;
 import org.jetbrains.annotations.Nullable;
+import javax.annotation.Nonnull;
 
 /**
  * Represents a base client for making API requests. The client uses a {@link Requester} for
@@ -26,6 +27,7 @@ public abstract class ApiClient implements Closeable {
 
   private final Requester requester;
   private final ExecutorService executor;
+  private AuthInterceptor authInterceptor;
 
   /** Constructs a new instance of the {@link ApiClient}. */
   protected ApiClient(String appId, String apiKey, String clientName, @Nullable ClientOptions options, List<Host> defaultHosts) {
@@ -52,8 +54,9 @@ private Requester defaultRequester(String appId, String apiKey, String clientNam
     List<StatefulHost> statefulHosts = hosts.stream().map(StatefulHost::new).collect(Collectors.toList());
 
     JsonSerializer serializer = JsonSerializer.builder().setCustomConfig(options.getMapperConfig()).build();
+    this.authInterceptor = new AuthInterceptor(appId, apiKey);
     HttpRequester.Builder builder = new HttpRequester.Builder(serializer)
-      .addInterceptor(new AuthInterceptor(appId, apiKey))
+      .addInterceptor(authInterceptor)
       .addInterceptor(new UserAgentInterceptor(algoliaAgent))
       .addInterceptor(new RetryStrategy(statefulHosts));
     if (options.getRequesterConfig() != null) {
@@ -62,6 +65,15 @@ private Requester defaultRequester(String appId, String apiKey, String clientNam
     return builder.build(options);
   }
 
+  /**
+   * Helper method to switch the API key used to authenticate the requests.
+   *
+   * @param apiKey The new API key to be used from now on.
+   */
+  public void setClientApiKey(@Nonnull String apiKey) {
+    this.authInterceptor.setApiKey(apiKey);
+  }
+
   /**
    * Executes an HTTP request asynchronously and returns a {@link CompletableFuture} of the response
    * deserialized into a specified type.

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/interceptors/AuthInterceptor.java

@@ -12,13 +12,17 @@ public final class AuthInterceptor implements Interceptor {
   private static final String HEADER_API_KEY = "x-algolia-api-key";
 
   private final String applicationId;
-  private final String apiKey;
+  private String apiKey;
 
   public AuthInterceptor(String applicationId, String apiKey) {
     this.applicationId = applicationId;
     this.apiKey = apiKey;
   }
 
+  public void setApiKey(String apiKey) {
+    this.apiKey = apiKey;
+  }
+
   @Nonnull
   @Override
   public Response intercept(Chain chain) throws IOException {

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/configuration/internal/HttpClient.kt

@@ -9,7 +9,7 @@ import io.ktor.client.request.*
 import io.ktor.serialization.kotlinx.json.*
 
 private const val HEADER_APPLICATION_ID = "x-algolia-application-id"
-private const val HEADER_APIKEY = "x-algolia-api-key"
+public const val HEADER_APIKEY: String = "x-algolia-api-key"
 
 internal fun algoliaHttpClient(
   appId: String,

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/Requester.kt

@@ -30,4 +30,6 @@ public interface Requester {
     requestOptions: RequestOptions? = null,
     returnType: TypeInfo,
   ): T
+
+  public fun setClientApiKey(apiKey: String);
 }