feat(clients): add replaceAllObjectsWithTransformation (generated)

algolia/api-clients-automation#5013

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

lib/Api/IngestionClient.php

@@ -2842,8 +2842,8 @@ public function chunkedPush(
         $objects,
         $action = 'addObject',
         $waitForTasks = true,
-        $referenceIndexName = null,
         $batchSize = 1000,
+        $referenceIndexName = null,
         $requestOptions = []
     ) {
         $responses = [];
@@ -2852,6 +2852,7 @@ public function chunkedPush(
 
         foreach ($objects as $object) {
             $records[] = $object;
+            $ok = false;
 
             if (sizeof($records) === $batchSize || $count === sizeof($objects) - 1) {
                 $responses[] = $this->push($indexName, ['action' => $action, 'records' => $records], false, $referenceIndexName, $requestOptions);
@@ -2869,18 +2870,17 @@ public function chunkedPush(
             $timeoutCalculation = 'Algolia\AlgoliaSearch\Support\Helpers::linearTimeout';
 
             foreach ($responses as $response) {
-                $this->waitForTask($indexName, $response['taskID']);
                 $retry = 0;
 
                 while ($retry < 50) {
                     try {
-                        $resp = $this->getEvent($response->runID, $response->eventID);
+                        $this->getEvent($response['runID'], $response['eventID']);
+
+                        $ok = true;
 
                         break;
                     } catch (NotFoundException $e) {
-                        if (404 === $e->getCode()) {
-                            return null;
-                        }
+                        // just retry
                     }
 
                     ++$retry;
@@ -2889,7 +2889,9 @@ public function chunkedPush(
                     );
                 }
 
-                throw new ExceededRetriesException('Maximum number of retries (50) exceeded.');
+                if (false === $ok) {
+                    throw new ExceededRetriesException('Maximum number of retries (50) exceeded.');
+                }
             }
         }
 

lib/Api/SearchClient.php

@@ -2958,6 +2958,73 @@ public function browseSynonyms($indexName, $requestOptions = [])
         return new SynonymIterator($indexName, $this, $requestOptions);
     }
 
+    /**
+     * Helper: Similar to the `replaceAllObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
+     *
+     * @param string $indexName      the `indexName` to replace `objects` in
+     * @param array  $objects        the array of `objects` to store in the given Algolia `indexName`
+     * @param array  $batchSize      The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param array  $requestOptions Request options
+     * @param mixed  $scopes
+     */
+    public function replaceAllObjectsWithTransformation($indexName, $objects, $batchSize = 1000, $scopes = ['settings', 'rules', 'synonyms'], $requestOptions = [])
+    {
+        if (null == $this->ingestionTransporter) {
+            throw new \InvalidArgumentException('`setTransformationRegion` must have been called before calling this method.');
+        }
+
+        $tmpIndexName = $indexName.'_tmp_'.rand(10000000, 99999999);
+
+        try {
+            $copyOperationResponse = $this->operationIndex(
+                $indexName,
+                [
+                    'operation' => 'copy',
+                    'destination' => $tmpIndexName,
+                    'scope' => $scopes,
+                ],
+                $requestOptions
+            );
+
+            $watchResponses = $this->ingestionTransporter->chunkedPush($tmpIndexName, $objects, 'addObject', true, $batchSize, $indexName, $requestOptions);
+
+            $this->waitForTask($tmpIndexName, $copyOperationResponse['taskID']);
+
+            $copyOperationResponse = $this->operationIndex(
+                $indexName,
+                [
+                    'operation' => 'copy',
+                    'destination' => $tmpIndexName,
+                    'scope' => $scopes,
+                ],
+                $requestOptions
+            );
+
+            $this->waitForTask($tmpIndexName, $copyOperationResponse['taskID']);
+
+            $moveOperationResponse = $this->operationIndex(
+                $tmpIndexName,
+                [
+                    'operation' => 'move',
+                    'destination' => $indexName,
+                ],
+                $requestOptions
+            );
+
+            $this->waitForTask($tmpIndexName, $moveOperationResponse['taskID']);
+
+            return [
+                'copyOperationResponse' => $copyOperationResponse,
+                'watchResponses' => $watchResponses,
+                'moveOperationResponse' => $moveOperationResponse,
+            ];
+        } catch (\Throwable $e) {
+            $this->deleteIndex($tmpIndexName);
+
+            throw $e;
+        }
+    }
+
     /**
      * Helper: Replace all objects in an index using a temporary one.
      * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.