feat(cts): add client test for retry strategy (#2633)

.github/.cache_version

@@ -1 +1 @@
-1.0.11
+1.0.13

clients/algoliasearch-client-dart/packages/client_core/lib/src/config/host.dart

@@ -3,30 +3,43 @@ final class Host {
   /// Host url.
   final String url;
 
+  // url port
+  final int? port;
+
   /// Host protocol (i.e. `http`, `https`)
   final String scheme;
 
   /// Whether this host should be used for [CallType.read] or [CallType.write] requests.
   final CallType? callType;
 
   /// Constructs a [Host] instance with the provided parameters.
-  const Host({required this.url, this.scheme = 'https', this.callType});
+  const Host({required this.url, this.port, this.scheme = 'https', this.callType});
+
+  factory Host.create({required String url, String scheme = 'https', CallType? callType}) {
+    if (url.contains(':')) {
+      final parts = url.split(':');
+      return Host(url: parts[0], port: int.parse(parts[1]), scheme: scheme, callType: callType);
+    }
+
+    return Host(url: url, scheme: scheme, callType: callType);
+  }
 
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is Host &&
           runtimeType == other.runtimeType &&
           url == other.url &&
+          port == other.port &&
           scheme == other.scheme &&
           callType == other.callType;
 
   @override
-  int get hashCode => url.hashCode ^ scheme.hashCode ^ callType.hashCode;
+  int get hashCode => url.hashCode ^ (port ?? 1) ^ scheme.hashCode ^ callType.hashCode;
 
   @override
   String toString() {
-    return 'Host{url: $url, scheme: $scheme, callType: $callType}';
+    return 'Host{url: $url, port: $port, scheme: $scheme, callType: $callType}';
   }
 }
 

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

@@ -94,6 +94,7 @@ class DioRequester implements Requester {
     Uri uri = Uri(
       scheme: request.host.scheme,
       host: request.host.url,
+      port: request.host.port,
       path: request.path,
     );
     if (request.queryParameters.isNotEmpty) {

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/config/Host.java

@@ -6,6 +6,7 @@
 public final class Host {
 
   private final String url;
+  private final int port;
 
   private final Set<CallType> callTypes;
 
@@ -16,7 +17,12 @@ public Host(@Nonnull String url, @Nonnull Set<CallType> callType) {
   }
 
   public Host(String url, Set<CallType> callType, String scheme) {
+    this(url, callType, scheme, -1);
+  }
+
+  public Host(String url, Set<CallType> callType, String scheme, int port) {
     this.url = url;
+    this.port = port;
     this.callTypes = callType;
     this.scheme = scheme;
   }
@@ -26,6 +32,10 @@ public String getUrl() {
     return url;
   }
 
+  public int getPort() {
+    return port;
+  }
+
   @Nonnull
   public Set<CallType> getCallTypes() {
     return callTypes;
@@ -44,13 +54,15 @@ public boolean equals(Object o) {
     Host host = (Host) o;
 
     if (!url.equals(host.url)) return false;
+    if (port != host.port) return false;
     if (!callTypes.equals(host.callTypes)) return false;
     return scheme.equals(host.scheme);
   }
 
   @Override
   public int hashCode() {
     int result = url.hashCode();
+    result = 31 * result + port;
     result = 31 * result + callTypes.hashCode();
     result = 31 * result + scheme.hashCode();
     return result;

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

@@ -21,6 +21,10 @@ public String getHost() {
     return host.getUrl();
   }
 
+  public int getPort() {
+    return host.getPort();
+  }
+
   public String getScheme() {
     return this.host.getScheme();
   }

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

@@ -63,7 +63,11 @@ public Response intercept(@Nonnull Chain chain) {
   /** Processes the request for a given host. */
   @Nonnull
   private Response processRequest(@Nonnull Chain chain, @Nonnull Request request, StatefulHost host) throws IOException {
-    HttpUrl newUrl = request.url().newBuilder().scheme(host.getScheme()).host(host.getHost()).build();
+    HttpUrl.Builder urlBuilder = request.url().newBuilder().scheme(host.getScheme()).host(host.getHost());
+    if (host.getPort() != -1) {
+      urlBuilder.port(host.getPort());
+    }
+    HttpUrl newUrl = urlBuilder.build();
     Request newRequest = request.newBuilder().url(newUrl).build();
     chain.withConnectTimeout(chain.connectTimeoutMillis() * (host.getRetryCount() + 1), TimeUnit.MILLISECONDS);
     Response response = chain.proceed(newRequest);

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/helpers.ts

@@ -30,7 +30,7 @@ export function serializeUrl(
   queryParameters: QueryParameters
 ): string {
   const queryParametersAsString = serializeQueryParameters(queryParameters);
-  let url = `${host.protocol}://${host.url}/${
+  let url = `${host.protocol}://${host.url}${host.port ? `:${host.port}` : ''}/${
     path.charAt(0) === '/' ? path.substr(1) : path
   }`;
 

clients/algoliasearch-client-javascript/packages/client-common/src/types/host.ts

@@ -13,6 +13,11 @@ export type Host = {
    * The protocol of the host URL.
    */
   protocol: 'http' | 'https';
+
+  /**
+   * The port of the host URL.
+   */
+  port?: number;
 };
 
 export type StatefulHost = Host & {

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

@@ -8,4 +8,6 @@ package com.algolia.client.configuration
 public data class Host(
   public val url: String,
   public val callType: CallType? = null,
+  public val protocol: String = "https",
+  public val port: Int? = null,
 )

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

@@ -49,7 +49,11 @@ public class KtorRequester(
     val requestBuilder = httpRequestBuilderOf(requestConfig, requestOptions)
 
     for (host in hosts) {
+      requestBuilder.url.protocol = URLProtocol.createOrDefault(host.protocol)
       requestBuilder.url.host = host.url
+      if (host.port != null) {
+        requestBuilder.url.port = host.port!!
+      }
       requestBuilder.setTimeout(requestOptions, callType, host)
       try {
         val response = httpClient.request(requestBuilder)
@@ -132,8 +136,6 @@ public class KtorRequester(
   ): HttpRequestBuilder {
     return HttpRequestBuilder().apply {
       url {
-        protocol = URLProtocol.HTTPS
-        port = URLProtocol.HTTPS.defaultPort
         pathSegments = requestConfig.path
       }
       method = requestConfig.method.ktorHttpMethod

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

@@ -13,9 +13,12 @@ import com.algolia.client.configuration.Host
 internal data class RetryableHost(
   private val host: Host,
 ) {
-
   val url
     get() = host.url
+  val protocol
+    get() = host.protocol
+  val port
+    get() = host.port
   val callType
     get() = host.callType
 

clients/algoliasearch-client-php/lib/Http/Psr7/Uri.php

@@ -28,15 +28,6 @@ class Uri implements UriInterface
     private static $defaultPorts = [
         'http' => 80,
         'https' => 443,
-        'ftp' => 21,
-        'gopher' => 70,
-        'nntp' => 119,
-        'news' => 119,
-        'telnet' => 23,
-        'tn3270' => 23,
-        'imap' => 143,
-        'pop' => 110,
-        'ldap' => 389,
     ];
 
     private static $charUnreserved = 'a-zA-Z0-9_\-\.~';

clients/algoliasearch-client-php/lib/RetryStrategy/ApiWrapper.php

@@ -33,6 +33,11 @@ final class ApiWrapper implements ApiWrapperInterface
      */
     private $clusterHosts;
 
+    /**
+     * @var Configuration
+     */
+    private $config;
+
     /**
      * @var RequestOptionsFactory
      */
@@ -57,6 +62,7 @@ public function __construct(
     ) {
         $this->http = $http;
         $this->clusterHosts = $clusterHosts;
+        $this->config = $config;
         $this->requestOptionsFactory =
             $RqstOptsFactory ?: new RequestOptionsFactory($config);
         $this->logger = $logger ?: Algolia::getLogger();
@@ -148,7 +154,16 @@ private function request(
 
         $retry = 1;
         foreach ($hosts as $host) {
-            $uri = $uri->withHost($host);
+            if ($this->config->getHasFullHosts()) {
+                $host = explode(':', $host);
+                $uri = $uri->withHost(trim($host[1], '/'))
+                    ->withScheme($host[0])
+                    ->withPort($host[2])
+                ;
+            } else {
+                $uri = $uri->withHost($host);
+            }
+
             $request = null;
             $logParams['retryNumber'] = $retry;
             $logParams['host'] = (string) $uri;

clients/algoliasearch-client-php/lib/RetryStrategy/ClusterHosts.php

@@ -64,7 +64,7 @@ public static function createFromAppId($applicationId)
         $read[$applicationId.'-dsn.algolia.net'] = 10;
         $write[$applicationId.'.algolia.net'] = 10;
 
-        return self::create($read, $write);
+        return self::create($read, $write)->shuffle();
     }
 
     public static function createFromCache($cacheKey)

clients/algoliasearch-client-php/lib/RetryStrategy/HostCollection.php

@@ -12,8 +12,6 @@ final class HostCollection
     public function __construct(array $hosts)
     {
         $this->hosts = $hosts;
-
-        $this->shuffle();
     }
 
     public static function create(array $urlsWithPriority)

clients/algoliasearch-client-python/algoliasearch/http/hosts.py

@@ -6,9 +6,16 @@ class Host:
     TTL = 300.0
 
     def __init__(
-        self, url: str, priority: Optional[int] = 0, accept: Optional[int] = None
+        self,
+        url: str,
+        scheme: str = "https",
+        port: Optional[int] = None,
+        priority: Optional[int] = 0,
+        accept: Optional[int] = None,
     ) -> None:
         self.url = url
+        self.scheme = scheme
+        self.port = port
         self.priority = cast(int, priority)
         self.accept = (CallType.WRITE | CallType.READ) if accept is None else accept
 
@@ -21,15 +28,15 @@ def reset(self) -> None:
 
 
 class HostsCollection:
-    def __init__(self, hosts: List[Host]) -> None:
+    def __init__(self, hosts: List[Host], reorder_hosts=False) -> None:
         self._hosts = hosts
 
         for host in self._hosts:
             host.reset()
 
-        shuffle(self._hosts)
-
-        self._hosts = sorted(self._hosts, key=lambda x: x.priority, reverse=True)
+        if reorder_hosts:
+            shuffle(self._hosts)
+            self._hosts = sorted(self._hosts, key=lambda x: x.priority, reverse=True)
 
     def read(self) -> List[Host]:
         return [host for host in self._hosts if host.accept & CallType.READ]

clients/algoliasearch-client-python/algoliasearch/http/transporter.py

@@ -93,7 +93,7 @@ async def request(
             )
 
         for host in self._retry_strategy.valid_hosts(self._hosts):
-            url = "https://{}{}".format(host.url, path)
+            url = "{}://{}{}".format(host.scheme, host.url + (":{}".format(host.port) if host.port else ""), path)
 
             proxy = None
             if url.startswith("https"):
@@ -102,7 +102,7 @@ async def request(
                 proxy = self._config.proxies.get("http")
 
             try:
-                async with timeout(self._timeout):
+                async with timeout(self._timeout / 1000):
                     resp = await self._session.request(
                         method=verb,
                         url=url,

clients/algoliasearch-client-ruby/lib/algolia/transport/http/http_requester.rb

@@ -56,7 +56,7 @@ def send_request(host, method, path, body, query_params, headers, timeout, conne
       # @return [Faraday::Connection]
       #
       def connection(host)
-        @connections[host.url] ||= Faraday.new(build_url(host)) do |f|
+        @connections[build_url(host)] ||= Faraday.new(build_url(host)) do |f|
           f.adapter @adapter.to_sym
         end
       end
@@ -68,7 +68,7 @@ def connection(host)
       # @return [String]
       #
       def build_url(host)
-        host.protocol + host.url
+        host.protocol + host.url + (host.port.nil? ? '' : ":#{host.port}")
       end
 
       # Convert query_params to a full query string

clients/algoliasearch-client-ruby/lib/algolia/transport/stateful_host.rb

@@ -3,7 +3,7 @@ module Transport
     class StatefulHost
       include CallType
 
-      attr_reader :url, :protocol, :accept
+      attr_reader :url, :protocol, :accept, :port
       attr_accessor :last_use, :retry_count, :up
 
       # @param url [String] host url
@@ -15,6 +15,7 @@ class StatefulHost
       def initialize(url, opts = {})
         @url         = url
         @protocol    = opts[:protocol] || 'https://'
+        @port        = opts[:port]
         @accept      = opts[:accept] || (READ | WRITE)
         @last_use    = opts[:last_use] || Time.now.utc
         @retry_count = opts[:retry_count] || 0

clients/algoliasearch-client-ruby/lib/algolia/transport/transport.rb

@@ -54,12 +54,12 @@ def request(call_type, method, path, body, opts = {})
           outcome = @retry_strategy.decide(host, http_response_code: response.status, is_timed_out: response.has_timed_out, network_failure: response.network_failure)
           if outcome == FAILURE
             decoded_error = JSON.parse(response.error, :symbolize_names => true)
-            raise AlgoliaHttpError.new(decoded_error[:status], decoded_error[:message])
+            raise Algolia::AlgoliaHttpError.new(decoded_error[:status], decoded_error[:message])
           end
           return response unless outcome == RETRY
         end
 
-        raise Algolia::AlgoliaUnreachableHostError('Unreachable hosts')
+        raise Algolia::AlgoliaUnreachableHostError.new('Unreachable hosts')
       end
 
       private

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/config/Host.scala

@@ -8,5 +8,7 @@ package algoliasearch.config
   *   Whether this host should be used for read and/or write requests.
   * @param scheme
   *   Host protocol (i.e. `http`, `https`)
+  * @param port
+  *   Host port
   */
-case class Host(url: String, callTypes: Set[CallType], scheme: String = "https")
+case class Host(url: String, callTypes: Set[CallType], scheme: String = "https", port: Option[Int] = None)

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/internal/StatefulHost.scala

@@ -15,6 +15,8 @@ private[algoliasearch] class StatefulHost(private val host: Host) {
 
   def getScheme: String = host.scheme
 
+  def getPort: Option[Int] = host.port
+
   def isUp: Boolean = up
 
   def getRetryCount: Int = retryCount