fix(clients): link to support/help center on unreachable hosts (#5305)

Author: shortcuts

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

@@ -223,7 +223,7 @@ private async Task<TResult> ExecuteRequestAsync<TResult, TData>(
     }
 
     throw new AlgoliaUnreachableHostException(
-      "RetryStrategy failed to connect to Algolia. Reason: " + _errorMessage
+      "RetryStrategy failed to connect to Algolia. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support Reason: " + _errorMessage
     );
   }
 

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

@@ -73,12 +73,14 @@ final class AlgoliaWaitException implements AlgoliaException {
 final class UnreachableHostsException implements AlgoliaException {
   /// The list of errors associated with each unreachable host.
   final List<AlgoliaException> errors;
+  final String message =
+      "If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support";
 
   /// Constructs an [UnreachableHostsException] with the provided list of errors.
   const UnreachableHostsException(this.errors);
 
   @override
   String toString() {
-    return 'UnreachableHostsException{errors: $errors}';
+    return 'UnreachableHostsException{errors: $errors, message: $message}';
   }
 }

clients/algoliasearch-client-go/algolia/errs/no_more_host_to_try_err.go

@@ -22,10 +22,12 @@ func (e *NoMoreHostToTryError) IntermediateNetworkErrors() []error {
 }
 
 func (e *NoMoreHostToTryError) Error() string {
+	baseErr := "all hosts have been contacted unsuccessfully, it can either be a server or a network error or wrong appID/key credentials were used. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support"
+
 	if len(e.intermediateNetworkErrors) > 0 {
-		return fmt.Errorf("all hosts have been contacted unsuccessfully, it can either be a server or a network error or wrong appID/key credentials were used. %w", errors.Join(e.intermediateNetworkErrors...)).Error()
+		return fmt.Errorf("%s %w", baseErr, errors.Join(e.intermediateNetworkErrors...)).Error()
 	}
-	return "all hosts have been contacted unsuccessfully, it can either be a server or a network error or wrong appID/key credentials were used. You can use 'ExposeIntermediateNetworkErrors: true' in the config to investigate."
+	return fmt.Sprintf("%s You can use 'ExposeIntermediateNetworkErrors: true' in the config to investigate.", baseErr)
 }
 
 func (n NoMoreHostToTryError) Is(target error) bool {

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/exceptions/AlgoliaRetryException.java

@@ -12,7 +12,7 @@ public class AlgoliaRetryException extends AlgoliaRuntimeException {
   private final List<Throwable> errors;
 
   public AlgoliaRetryException(List<Throwable> errors) {
-    super("Error(s) while processing the retry strategy", errors.get(errors.size() - 1));
+    super("Error(s) while processing the retry strategy. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support", errors.get(errors.size() - 1));
     this.errors = errors;
   }
 

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

@@ -43,7 +43,7 @@ export class ErrorWithStackTrace extends AlgoliaError {
 export class RetryError extends ErrorWithStackTrace {
   constructor(stackTrace: StackFrame[]) {
     super(
-      'Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.',
+      'Unreachable hosts - your application id may be incorrect. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support',
       stackTrace,
       'RetryError',
     );

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/exception/AlgoliaRuntimeException.kt

@@ -43,7 +43,7 @@ public class AlgoliaApiException(
  */
 public class AlgoliaRetryException(
   public val exceptions: List<Throwable>,
-) : AlgoliaRuntimeException("Error(s) while processing the retry strategy", exceptions.last())
+) : AlgoliaRuntimeException("Error(s) while processing the retry strategy. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support", exceptions.last())
 
 /**
  * Exception thrown when an error occurs during the wait strategy. For example: maximum number of

clients/algoliasearch-client-php/lib/Exceptions/UnreachableException.php

@@ -8,7 +8,7 @@ public function __construct($message = '', $code = 0, $previous = null)
     {
         if (!$message) {
             $message
-                = 'Impossible to connect, please check your Algolia Application Id.';
+                = 'Impossible to connect, please check your Algolia Application Id. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support';
         }
 
         parent::__construct($message, $code, $previous);

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

@@ -99,7 +99,7 @@ async def request(
 
                 raise RequestException(content, response.status_code)
 
-        raise AlgoliaUnreachableHostException("Unreachable hosts")
+        raise AlgoliaUnreachableHostException("Unreachable hosts. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support")
 
 
 class EchoTransporter(Transporter):

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

@@ -112,7 +112,7 @@ def request(
 
                 raise RequestException(content, response.status_code)
 
-        raise AlgoliaUnreachableHostException("Unreachable hosts")
+        raise AlgoliaUnreachableHostException("Unreachable hosts. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support")
 
 
 class EchoTransporterSync(TransporterSync):

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

@@ -85,7 +85,7 @@ def request(call_type, method, path, body, opts = {})
           end
         end
 
-        raise Algolia::AlgoliaUnreachableHostError.new("Unreachable hosts.", retry_errors)
+        raise Algolia::AlgoliaUnreachableHostError.new("Unreachable hosts. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support", retry_errors)
       end
 
       private