Merge pull request #1463 from algolia/feature/MAGE-813

Created a way for customers to change timeout values for Algolia PHP Client

Author: mohitalgolia

Helper/AlgoliaHelper.php

@@ -6,6 +6,7 @@
 use Algolia\AlgoliaSearch\Response\AbstractResponse;
 use Algolia\AlgoliaSearch\Response\BatchIndexingResponse;
 use Algolia\AlgoliaSearch\Response\MultiResponse;
+use Algolia\AlgoliaSearch\Config\SearchConfig;
 use Algolia\AlgoliaSearch\SearchClient;
 use Algolia\AlgoliaSearch\SearchIndex;
 use Algolia\AlgoliaSearch\Support\UserAgent;
@@ -89,10 +90,11 @@ public function getRequest()
     public function resetCredentialsFromConfig()
     {
         if ($this->config->getApplicationID() && $this->config->getAPIKey()) {
-            $this->client = SearchClient::create(
-                $this->config->getApplicationID(),
-                $this->config->getAPIKey()
-            );
+            $config = SearchConfig::create($this->config->getApplicationID(), $this->config->getAPIKey());
+            $config->setConnectTimeout($this->config->getConnectionTimeout());
+            $config->setReadTimeout($this->config->getReadTimeout());
+            $config->setWriteTimeout($this->config->getWriteTimeout());
+            $this->client = SearchClient::createWithConfig($config);
         }
     }
 

Helper/ConfigHelper.php

@@ -100,6 +100,9 @@ class ConfigHelper
         'algoliasearch_advanced/advanced/backend_rendering_allowed_user_agents';
     public const NON_CASTABLE_ATTRIBUTES = 'algoliasearch_advanced/advanced/non_castable_attributes';
     public const MAX_RECORD_SIZE_LIMIT = 'algoliasearch_advanced/advanced/max_record_size_limit';
+    public const CONNECTION_TIMEOUT = 'algoliasearch_advanced/advanced/connection_timeout';
+    public const READ_TIMEOUT = 'algoliasearch_advanced/advanced/read_timeout';
+    public const WRITE_TIMEOUT = 'algoliasearch_advanced/advanced/write_timeout';
 
     public const SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock';
 
@@ -1174,6 +1177,33 @@ public function getIndexPrefix($storeId = null)
         return $this->configInterface->getValue(self::INDEX_PREFIX, ScopeInterface::SCOPE_STORE, $storeId);
     }
 
+    /**
+     * @param $storeId
+     * @return mixed'
+     */
+    public function getConnectionTimeout($storeId = null)
+    {
+        return $this->configInterface->getValue(self::CONNECTION_TIMEOUT, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
+    /**
+     * @param $storeId
+     * @return mixed'
+     */
+    public function getReadTimeout($storeId = null)
+    {
+        return $this->configInterface->getValue(self::READ_TIMEOUT, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
+    /**
+     * @param $storeId
+     * @return mixed'
+     */
+    public function getWriteTimeout($storeId = null)
+    {
+        return $this->configInterface->getValue(self::WRITE_TIMEOUT, ScopeInterface::SCOPE_STORE, $storeId);
+    }
+
     /**
      * @param $storeId
      * @return array|bool|float|int|mixed|string

etc/adminhtml/system.xml

@@ -1259,6 +1259,15 @@
                             If your Algolia plan allows a higher record size limit, you can customize the record size limit.]]>
                     </comment>
                 </field>
+                <field id="connection_timeout" translate="label comment" type="text" sortOrder="100" showInDefault="1">
+                    <label>Connection Timeout (In Seconds)</label>
+                </field>
+                <field id="read_timeout" translate="label comment" type="text" sortOrder="105" showInDefault="1">
+                    <label>Read Timeout (In Seconds)</label>
+                </field>
+                <field id="write_timeout" translate="label comment" type="text" sortOrder="110" showInDefault="1">
+                    <label>Write Timeout (In Seconds)</label>
+                </field>
             </group>
             <group id="queue" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Indexing Queue</label>

etc/config.xml

@@ -81,6 +81,9 @@
         <algoliasearch_advanced>
             <advanced>
                 <max_record_size_limit>10000</max_record_size_limit>
+                <connection_timeout>2</connection_timeout>
+                <read_timeout>30</read_timeout>
+                <write_timeout>30</write_timeout>
             </advanced>
             <queue>
                 <number_of_element_by_page>300</number_of_element_by_page>