fix(clients): chunked batch helper (#3154)

Author: shortcuts

playground/python/app/search.py

@@ -16,8 +16,9 @@ async def main():
 
     try:
         resp = await client.replace_all_objects(
-            index_name="test-flag",
-            objects=[{"name": f"John Doe{i}", "objectID": f"fff2bd4d-bb17-4e21-a0c4-0a8ea5e363f2{i}" } for i in range(1001)],
+            index_name="test_replace_all_objects",
+            objects=[{"name": f"John Doe{i}", "objectID": f"fff2bd4d-bb17-4e21-a0c4-0a8ea5e363f2{i}" } for i in range(33)],
+            batch_size=10
         )
 
         print(resp)

playground/python/poetry.lock

@@ -414,7 +414,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act
 	for i, obj := range objects {
 		requests = append(requests, *NewBatchRequest(*action, obj))
 
-		if i%*batchSize == 0 {
+		if len(requests) == *batchSize || i == len(objects)-1 {
 			resp, err := c.Batch(c.NewApiBatchRequest(indexName, NewBatchWriteParams(requests)))
 			if err != nil {
 				return nil, err

templates/go/search_helpers.mustache

@@ -279,9 +279,10 @@ async chunkedBatch({ indexName, objects, action = 'addObject', waitForTasks, bat
   let requests: Array<BatchRequest> = [];
   const responses: Array<BatchResponse> = [];
 
-  for (const [i, obj] of objects.entries()) {
+  const objectEntries = objects.entries();
+  for (const [i, obj] of objectEntries) {
     requests.push({action, body: obj});
-    if (i % batchSize === 0) {
+    if (requests.length === batchSize || i === objects.length-1) {
       responses.push(await this.batch({indexName, batchWriteParams: {requests}}, requestOptions));
       requests = [];
     }
@@ -303,7 +304,7 @@ async chunkedBatch({ indexName, objects, action = 'addObject', waitForTasks, bat
  * @param replaceAllObjects - The `replaceAllObjects` object.
  * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
  * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
- * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+ * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
  */
 async replaceAllObjects(

templates/javascript/clients/client/api/helpers.mustache

@@ -476,13 +476,13 @@ use {{invokerPackage}}\Support\Helpers;
                 'action' => $action,
                 'body' => $object,
             ];
-            $count++;
 
-            if ($count === $batchSize) {
+            if (sizeof($requests) === $batchSize || $count === sizeof($objects)-1) {
                 $responses[] = $this->batch($indexName, ['requests' => $requests], $requestOptions);
                 $requests = [];
-                $count = 0;
             }
+
+            $count++;
         }
 
         if (!empty($requests)) {
@@ -560,4 +560,4 @@ use {{invokerPackage}}\Support\Helpers;
         );
     }
 }
-{{/operations}}
+{{/operations}}

templates/php/api.mustache

@@ -223,7 +223,7 @@
         responses: List[BatchResponse] = []
         for i, obj in enumerate(objects):
             requests.append(BatchRequest(action=action, body=obj))
-            if i % batch_size == 0:
+            if len(requests) == batch_size or i == len(objects) - 1:
                 responses.append(
                     await self.batch(
                         index_name=index_name,
@@ -292,4 +292,4 @@
             "copy_operation_response": copy_operation_response,
             "batch_responses": batch_responses,
             "move_operation_response": move_operation_response,
-        }
+        }