fix(php): Use api config to generate hosts (#133)

algolia · Feb 10, 2022 · e21f6dc · e21f6dc
1 parent 5854261
commit e21f6dc
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 45 deletions.
diff --git a/clients/algoliasearch-client-php/lib/Api/AbtestingApi.php b/clients/algoliasearch-client-php/lib/Api/AbtestingApi.php
@@ -66,7 +66,7 @@ public static function createWithConfig(AbTestingConfig $config)
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::createForAnalytics($config->getAppId());
+            $clusterHosts = ClusterHosts::create('analytics.'.$config->getRegion().'.algolia.com');
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php b/clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php
@@ -66,7 +66,7 @@ public static function createWithConfig(AnalyticsConfig $config)
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::createForAnalytics($config->getAppId());
+            $clusterHosts = ClusterHosts::create('analytics.'.$config->getRegion().'.algolia.com');
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/Api/InsightsApi.php b/clients/algoliasearch-client-php/lib/Api/InsightsApi.php
@@ -65,7 +65,7 @@ public static function createWithConfig(InsightsConfig $config)
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::createForInsights($config->getAppId());
+            $clusterHosts = ClusterHosts::create('insights.'.$config->getRegion().'.algolia.io');
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php b/clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php
@@ -66,7 +66,7 @@ public static function createWithConfig(PersonalizationConfig $config)
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::createForRecommendation($config->getAppId());
+            $clusterHosts = ClusterHosts::create('personalization.'.$config->getRegion().'.algolia.com');
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php b/clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php
@@ -66,7 +66,7 @@ public static function createWithConfig(QuerySuggestionsConfig $config)
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::createForQuerySuggestions($config->getAppId());
+            $clusterHosts = ClusterHosts::create('query-suggestions.'.$config->getRegion().'.algolia.com');
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/Api/RecommendApi.php b/clients/algoliasearch-client-php/lib/Api/RecommendApi.php
@@ -38,18 +38,14 @@ public function __construct(ApiWrapperInterface $apiWrapper, RecommendConfig $co
     }
 
     /**
-     * Instantiate the client with basic credentials and region
+     * Instantiate the client with basic credentials
      *
      * @param string $appId  Application ID
      * @param string $apiKey Algolia API Key
-     * @param string $region Region
      */
-    public static function create($appId = null, $apiKey = null, $region = null)
+    public static function create($appId = null, $apiKey = null)
     {
-        $allowedRegions = explode('-', 'us-de');
-        $config = RecommendConfig::create($appId, $apiKey, $region, $allowedRegions);
-
-        return static::createWithConfig($config);
+        return static::createWithConfig(RecommendConfig::create($appId, $apiKey));
     }
 
     /**
@@ -61,11 +57,16 @@ public static function createWithConfig(RecommendConfig $config)
     {
         $config = clone $config;
 
+        $cacheKey = sprintf('%s-clusterHosts-%s', __CLASS__, $config->getAppId());
+
         if ($hosts = $config->getHosts()) {
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
-        } else {
-            $clusterHosts = ClusterHosts::createFromAppId($config->getAppId());
+        } elseif (false === ($clusterHosts = ClusterHosts::createFromCache($cacheKey))) {
+            // We'll try to restore the ClusterHost from cache, if we cannot
+            // we create a new instance and set the cache key
+            $clusterHosts = ClusterHosts::createFromAppId($config->getAppId())
+                ->setCacheKey($cacheKey);
         }
 
         $apiWrapper = new ApiWrapper(

diff --git a/clients/algoliasearch-client-php/lib/RetryStrategy/ClusterHosts.php b/clients/algoliasearch-client-php/lib/RetryStrategy/ClusterHosts.php
@@ -64,26 +64,6 @@ public static function createFromAppId($applicationId)
         return static::create($read, $write);
     }
 
-    public static function createForAnalytics($region)
-    {
-        return static::create('analytics.'.$region.'.algolia.com');
-    }
-
-    public static function createForInsights($region)
-    {
-        return static::create('insights.'.$region.'.algolia.io');
-    }
-
-    public static function createForRecommendation($region)
-    {
-        return static::create('recommendation.'.$region.'.algolia.com');
-    }
-
-    public static function createForQuerySuggestions($region)
-    {
-        return static::create('query-suggestions.'.$region.'.algolia.com');
-    }
-
     public static function createFromCache($cacheKey)
     {
         if (!Algolia::isCacheEnabled()) {

diff --git a/openapitools.json b/openapitools.json
@@ -227,7 +227,6 @@
         "modelPackage": "Model\\Search",
         "additionalProperties": {
           "configClassname": "SearchConfig",
-          "clusterHostsMethod": "createFromAppId",
           "useCache": true,
           "variableNamingConvention": "camelCase",
           "packageName": "algoliasearch-client-php"
@@ -246,9 +245,7 @@
         "modelPackage": "Model\\Recommend",
         "additionalProperties": {
           "configClassname": "RecommendConfig",
-          "clusterHostsMethod": "createFromAppId",
-          "hasRegionalHost": true,
-          "allowedRegions": "us-de",
+          "useCache": true,
           "variableNamingConvention": "camelCase",
           "packageName": "algoliasearch-client-php"
         }
@@ -266,7 +263,6 @@
         "modelPackage": "Model\\Personalization",
         "additionalProperties": {
           "configClassname": "PersonalizationConfig",
-          "clusterHostsMethod": "createForRecommendation",
           "hasRegionalHost": true,
           "allowedRegions": "us-eu",
           "variableNamingConvention": "camelCase",
@@ -289,7 +285,6 @@
         "modelPackage": "Model\\Analytics",
         "additionalProperties": {
           "configClassname": "AnalyticsConfig",
-          "clusterHostsMethod": "createForAnalytics",
           "hasRegionalHost": true,
           "allowedRegions": "us-de",
           "variableNamingConvention": "camelCase",
@@ -313,7 +308,6 @@
         "modelPackage": "Model\\Insights",
         "additionalProperties": {
           "configClassname": "InsightsConfig",
-          "clusterHostsMethod": "createForInsights",
           "hasRegionalHost": true,
           "allowedRegions": "us-de",
           "variableNamingConvention": "camelCase",
@@ -337,7 +331,6 @@
         "modelPackage": "Model\\ABTesting",
         "additionalProperties": {
           "configClassname": "AbTestingConfig",
-          "clusterHostsMethod": "createForAnalytics",
           "hasRegionalHost": true,
           "allowedRegions": "us-de",
           "variableNamingConvention": "camelCase",
@@ -361,7 +354,6 @@
         "modelPackage": "Model\\QuerySuggestions",
         "additionalProperties": {
           "configClassname": "QuerySuggestionsConfig",
-          "clusterHostsMethod": "createForQuerySuggestions",
           "hasRegionalHost": true,
           "allowedRegions": "us-eu",
           "variableNamingConvention": "camelCase",

diff --git a/templates/php/api.mustache b/templates/php/api.mustache
@@ -92,7 +92,7 @@ use {{invokerPackage}}\RetryStrategy\ClusterHosts;
         } elseif (false === ($clusterHosts = ClusterHosts::createFromCache($cacheKey))) {
             // We'll try to restore the ClusterHost from cache, if we cannot
             // we create a new instance and set the cache key
-            $clusterHosts = ClusterHosts::{{clusterHostsMethod}}($config->getAppId())
+            $clusterHosts = ClusterHosts::createFromAppId($config->getAppId())
                 ->setCacheKey($cacheKey);
         }
         {{/useCache}}
@@ -102,7 +102,7 @@ use {{invokerPackage}}\RetryStrategy\ClusterHosts;
             // If a list of hosts was passed, we ignore the cache
             $clusterHosts = ClusterHosts::create($hosts);
         } else {
-            $clusterHosts = ClusterHosts::{{clusterHostsMethod}}($config->getAppId());
+            $clusterHosts = ClusterHosts::create('{{host}}.'.$config->getRegion().'.algolia.{{topLevelDomain}}');
         }
         {{/useCache}}