fix(clients): WithTransformation methods retry logic (#5183) (generated) [skip ci]

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

Author: algolia-bot

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -6760,6 +6760,25 @@ public <T> List<WatchResponse> saveObjectsWithTransformation(String indexName, I
     return saveObjectsWithTransformation(indexName, objects, null);
   }
 
+  /**
+   * Helper: Similar to the `saveObjects` 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 indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   * @throws AlgoliaRetryException When the retry has failed on all hosts
+   * @throws AlgoliaApiException When the API sends an http error code
+   * @throws AlgoliaRuntimeException When an error occurred during the serialization
+   */
+  public <T> List<WatchResponse> saveObjectsWithTransformation(String indexName, Iterable<T> objects, boolean waitForTasks) {
+    return saveObjectsWithTransformation(indexName, objects, waitForTasks, null);
+  }
+
   /**
    * Helper: Similar to the `saveObjects` method but requires a Push connector
    * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)

clients/algoliasearch-client-php/lib/Configuration/IngestionConfig.php

@@ -10,6 +10,8 @@ class IngestionConfig extends ConfigWithRegion
 {
     protected $clientName = 'Ingestion';
 
+    private $defaultWaitTaskTimeBeforeRetry = 5000; // 5 sec in milliseconds
+
     public static function create($appId, $apiKey, $region = null)
     {
         $allowedRegions = ['eu', 'us'];
@@ -27,6 +29,11 @@ public static function create($appId, $apiKey, $region = null)
         return parent::create($appId, $apiKey, $region);
     }
 
+    public function getWaitTaskTimeBeforeRetry()
+    {
+        return $this->config['waitTaskTimeBeforeRetry'];
+    }
+
     public function getDefaultConfiguration()
     {
         return [
@@ -38,6 +45,7 @@ public function getDefaultConfiguration()
             'writeTimeout' => 25,
             'connectTimeout' => 25,
             'defaultHeaders' => [],
+            'waitTaskTimeBeforeRetry' => $this->defaultWaitTaskTimeBeforeRetry,
         ];
     }
 }

docs/bundled/search-snippets.json

@@ -1362,7 +1362,7 @@
       "call partialUpdateObjects with createIfNotExists=false": "response, err := client.PartialUpdateObjects(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"3\", \"name\": \"Cyril\"}, map[string]any{\"objectID\": \"4\", \"name\": \"David\"}}, search.WithCreateIfNotExists(false))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "partialUpdateObjectsWithTransformation": {
-      "default": "response, err := client.PartialUpdateObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}}, search.WithCreateIfNotExists(true))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
+      "default": "response, err := client.PartialUpdateObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}}, search.WithCreateIfNotExists(true), search.WithWaitForTasks(true))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "removeUserId": {
       "default": "response, err := client.RemoveUserId(client.NewApiRemoveUserIdRequest(\n  \"uniqueID\"))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
@@ -1391,7 +1391,7 @@
       "saveObjectsPublicUser": "response, err := client.SaveObjects(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"1\", \"visibility\": \"public\", \"name\": \"Hot 100 Billboard Charts\", \"playlistId\": \"d3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f\", \"createdAt\": \"1500240452\"}}, search.WithWaitForTasks(false), search.WithBatchSize(1000), search.WithHeaderParam(\"X-Algolia-User-ID\", \"*\"))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "saveObjectsWithTransformation": {
-      "default": "response, err := client.SaveObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}})\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
+      "default": "response, err := client.SaveObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}}, search.WithWaitForTasks(true))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}"
     },
     "saveRule": {
       "saveRule with minimal parameters": "response, err := client.SaveRule(client.NewApiSaveRuleRequest(\n  \"<YOUR_INDEX_NAME>\", \"id1\",\n  search.NewEmptyRule().SetObjectID(\"id1\").SetConditions(\n    []search.Condition{*search.NewEmptyCondition().SetPattern(\"apple\").SetAnchoring(search.Anchoring(\"contains\"))}).SetConsequence(\n    search.NewEmptyConsequence().SetParams(\n      search.NewEmptyConsequenceParams().SetFilters(\"brand:xiaomi\")))))\nif err != nil {\n  // handle the eventual error\n  panic(err)\n}",
@@ -1952,7 +1952,7 @@
       "call partialUpdateObjects with createIfNotExists=false": "client.partialUpdateObjects(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"3\");\n        put(\"name\", \"Cyril\");\n      }\n    },\n    new HashMap() {\n      {\n        put(\"objectID\", \"4\");\n        put(\"name\", \"David\");\n      }\n    }\n  ),\n  false\n);"
     },
     "partialUpdateObjectsWithTransformation": {
-      "default": "client.partialUpdateObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"1\");\n        put(\"name\", \"Adam\");\n      }\n    },\n    new HashMap() {\n      {\n        put(\"objectID\", \"2\");\n        put(\"name\", \"Benoit\");\n      }\n    }\n  ),\n  true\n);"
+      "default": "client.partialUpdateObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"1\");\n        put(\"name\", \"Adam\");\n      }\n    },\n    new HashMap() {\n      {\n        put(\"objectID\", \"2\");\n        put(\"name\", \"Benoit\");\n      }\n    }\n  ),\n  true,\n  true\n);"
     },
     "removeUserId": {
       "default": "client.removeUserId(\"uniqueID\");"
@@ -1981,7 +1981,7 @@
       "saveObjectsPublicUser": "client.saveObjects(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"1\");\n        put(\"visibility\", \"public\");\n        put(\"name\", \"Hot 100 Billboard Charts\");\n        put(\"playlistId\", \"d3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f\");\n        put(\"createdAt\", \"1500240452\");\n      }\n    }\n  ),\n  false,\n  1000,\n  new RequestOptions().addExtraHeader(\"X-Algolia-User-ID\", \"*\")\n);"
     },
     "saveObjectsWithTransformation": {
-      "default": "client.saveObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"1\");\n        put(\"name\", \"Adam\");\n      }\n    },\n    new HashMap() {\n      {\n        put(\"objectID\", \"2\");\n        put(\"name\", \"Benoit\");\n      }\n    }\n  )\n);"
+      "default": "client.saveObjectsWithTransformation(\n  \"<YOUR_INDEX_NAME>\",\n  Arrays.asList(\n    new HashMap() {\n      {\n        put(\"objectID\", \"1\");\n        put(\"name\", \"Adam\");\n      }\n    },\n    new HashMap() {\n      {\n        put(\"objectID\", \"2\");\n        put(\"name\", \"Benoit\");\n      }\n    }\n  ),\n  true\n);"
     },
     "saveRule": {
       "saveRule with minimal parameters": "client.saveRule(\n  \"<YOUR_INDEX_NAME>\",\n  \"id1\",\n  new Rule()\n    .setObjectID(\"id1\")\n    .setConditions(Arrays.asList(new Condition().setPattern(\"apple\").setAnchoring(Anchoring.CONTAINS)))\n    .setConsequence(new Consequence().setParams(new ConsequenceParams().setFilters(\"brand:xiaomi\")))\n);",
@@ -2545,7 +2545,7 @@
       "call partialUpdateObjects with createIfNotExists=false": "const response = await client.partialUpdateObjects({\n  indexName: 'cts_e2e_partialUpdateObjects_javascript',\n  objects: [\n    { objectID: '3', name: 'Cyril' },\n    { objectID: '4', name: 'David' },\n  ],\n  createIfNotExists: false,\n});"
     },
     "partialUpdateObjectsWithTransformation": {
-      "default": "const response = await client.partialUpdateObjectsWithTransformation({\n  indexName: 'cts_e2e_partialUpdateObjectsWithTransformation_javascript',\n  objects: [\n    { objectID: '1', name: 'Adam' },\n    { objectID: '2', name: 'Benoit' },\n  ],\n  createIfNotExists: true,\n});"
+      "default": "const response = await client.partialUpdateObjectsWithTransformation({\n  indexName: 'cts_e2e_partialUpdateObjectsWithTransformation_javascript',\n  objects: [\n    { objectID: '1', name: 'Adam' },\n    { objectID: '2', name: 'Benoit' },\n  ],\n  createIfNotExists: true,\n  waitForTasks: true,\n});"
     },
     "removeUserId": {
       "default": "const response = await client.removeUserId({ userID: 'uniqueID' });"
@@ -2574,7 +2574,7 @@
       "saveObjectsPublicUser": "const response = await client.saveObjects(\n  {\n    indexName: 'playlists',\n    objects: [\n      {\n        objectID: '1',\n        visibility: 'public',\n        name: 'Hot 100 Billboard Charts',\n        playlistId: 'd3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f',\n        createdAt: '1500240452',\n      },\n    ],\n    waitForTasks: false,\n    batchSize: 1000,\n  },\n  {\n    headers: { 'X-Algolia-User-ID': '*' },\n  },\n);"
     },
     "saveObjectsWithTransformation": {
-      "default": "const response = await client.saveObjectsWithTransformation({\n  indexName: 'cts_e2e_saveObjectsWithTransformation_javascript',\n  objects: [\n    { objectID: '1', name: 'Adam' },\n    { objectID: '2', name: 'Benoit' },\n  ],\n});"
+      "default": "const response = await client.saveObjectsWithTransformation({\n  indexName: 'cts_e2e_saveObjectsWithTransformation_javascript',\n  objects: [\n    { objectID: '1', name: 'Adam' },\n    { objectID: '2', name: 'Benoit' },\n  ],\n  waitForTasks: true,\n});"
     },
     "saveRule": {
       "saveRule with minimal parameters": "const response = await client.saveRule({\n  indexName: 'indexName',\n  objectID: 'id1',\n  rule: {\n    objectID: 'id1',\n    conditions: [{ pattern: 'apple', anchoring: 'contains' }],\n    consequence: { params: { filters: 'brand:xiaomi' } },\n  },\n});",
@@ -3716,7 +3716,7 @@
       "call partialUpdateObjects with createIfNotExists=false": "$response = $client->partialUpdateObjects(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '3',\n            'name' => 'Cyril',\n        ],\n\n        ['objectID' => '4',\n            'name' => 'David',\n        ],\n    ],\n    false,\n);"
     },
     "partialUpdateObjectsWithTransformation": {
-      "default": "$response = $client->partialUpdateObjectsWithTransformation(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '1',\n            'name' => 'Adam',\n        ],\n\n        ['objectID' => '2',\n            'name' => 'Benoit',\n        ],\n    ],\n    true,\n);"
+      "default": "$response = $client->partialUpdateObjectsWithTransformation(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '1',\n            'name' => 'Adam',\n        ],\n\n        ['objectID' => '2',\n            'name' => 'Benoit',\n        ],\n    ],\n    true,\n    true,\n);"
     },
     "removeUserId": {
       "default": "$response = $client->removeUserId(\n    'uniqueID',\n);"
@@ -3745,7 +3745,7 @@
       "saveObjectsPublicUser": "$response = $client->saveObjects(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '1',\n            'visibility' => 'public',\n            'name' => 'Hot 100 Billboard Charts',\n            'playlistId' => 'd3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f',\n            'createdAt' => '1500240452',\n        ],\n    ],\n    false,\n    1000,\n    [\n        'headers' => [\n            'X-Algolia-User-ID' => '*',\n        ],\n    ]\n);"
     },
     "saveObjectsWithTransformation": {
-      "default": "$response = $client->saveObjectsWithTransformation(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '1',\n            'name' => 'Adam',\n        ],\n\n        ['objectID' => '2',\n            'name' => 'Benoit',\n        ],\n    ],\n);"
+      "default": "$response = $client->saveObjectsWithTransformation(\n    '<YOUR_INDEX_NAME>',\n    [\n        ['objectID' => '1',\n            'name' => 'Adam',\n        ],\n\n        ['objectID' => '2',\n            'name' => 'Benoit',\n        ],\n    ],\n    true,\n);"
     },
     "saveRule": {
       "saveRule with minimal parameters": "$response = $client->saveRule(\n    '<YOUR_INDEX_NAME>',\n    'id1',\n    ['objectID' => 'id1',\n        'conditions' => [\n            ['pattern' => 'apple',\n                'anchoring' => 'contains',\n            ],\n        ],\n        'consequence' => ['params' => ['filters' => 'brand:xiaomi',\n        ],\n        ],\n    ],\n);",
@@ -4306,7 +4306,7 @@
       "call partialUpdateObjects with createIfNotExists=false": "response = client.partial_update_objects(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"3\",\n            \"name\": \"Cyril\",\n        },\n        {\n            \"objectID\": \"4\",\n            \"name\": \"David\",\n        },\n    ],\n    create_if_not_exists=False,\n)"
     },
     "partialUpdateObjectsWithTransformation": {
-      "default": "response = client.partial_update_objects_with_transformation(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"1\",\n            \"name\": \"Adam\",\n        },\n        {\n            \"objectID\": \"2\",\n            \"name\": \"Benoit\",\n        },\n    ],\n    create_if_not_exists=True,\n)"
+      "default": "response = client.partial_update_objects_with_transformation(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"1\",\n            \"name\": \"Adam\",\n        },\n        {\n            \"objectID\": \"2\",\n            \"name\": \"Benoit\",\n        },\n    ],\n    create_if_not_exists=True,\n    wait_for_tasks=True,\n)"
     },
     "removeUserId": {
       "default": "response = client.remove_user_id(\n    user_id=\"uniqueID\",\n)"
@@ -4335,7 +4335,7 @@
       "saveObjectsPublicUser": "response = client.save_objects(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"1\",\n            \"visibility\": \"public\",\n            \"name\": \"Hot 100 Billboard Charts\",\n            \"playlistId\": \"d3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f\",\n            \"createdAt\": \"1500240452\",\n        },\n    ],\n    wait_for_tasks=False,\n    batch_size=1000,\n    request_options={\n        \"headers\": loads(\"\"\"{\"X-Algolia-User-ID\":\"*\"}\"\"\"),\n    },\n)"
     },
     "saveObjectsWithTransformation": {
-      "default": "response = client.save_objects_with_transformation(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"1\",\n            \"name\": \"Adam\",\n        },\n        {\n            \"objectID\": \"2\",\n            \"name\": \"Benoit\",\n        },\n    ],\n)"
+      "default": "response = client.save_objects_with_transformation(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    objects=[\n        {\n            \"objectID\": \"1\",\n            \"name\": \"Adam\",\n        },\n        {\n            \"objectID\": \"2\",\n            \"name\": \"Benoit\",\n        },\n    ],\n    wait_for_tasks=True,\n)"
     },
     "saveRule": {
       "saveRule with minimal parameters": "response = client.save_rule(\n    index_name=\"<YOUR_INDEX_NAME>\",\n    object_id=\"id1\",\n    rule={\n        \"objectID\": \"id1\",\n        \"conditions\": [\n            {\n                \"pattern\": \"apple\",\n                \"anchoring\": \"contains\",\n            },\n        ],\n        \"consequence\": {\n            \"params\": {\n                \"filters\": \"brand:xiaomi\",\n            },\n        },\n    },\n)",

docs/snippets/go/src/search.go

@@ -1967,6 +1967,7 @@ void snippetForPartialUpdateObjectsWithTransformation() throws Exception {
           }
         }
       ),
+      true,
       true
     );
     // >LOG
@@ -2400,7 +2401,8 @@ void snippetForSaveObjectsWithTransformation() throws Exception {
             put("name", "Benoit");
           }
         }
-      )
+      ),
+      true
     );
     // >LOG
     // SEPARATOR<

docs/snippets/java/src/test/java/com/algolia/Search.java

@@ -2081,6 +2081,7 @@ export async function snippetForPartialUpdateObjectsWithTransformation(): Promis
       { objectID: '2', name: 'Benoit' },
     ],
     createIfNotExists: true,
+    waitForTasks: true,
   });
 
   // >LOG
@@ -2414,6 +2415,7 @@ export async function snippetForSaveObjectsWithTransformation(): Promise<void> {
       { objectID: '1', name: 'Adam' },
       { objectID: '2', name: 'Benoit' },
     ],
+    waitForTasks: true,
   });
 
   // >LOG

docs/snippets/javascript/src/search.ts

@@ -2616,6 +2616,7 @@ public function snippetForPartialUpdateObjectsWithTransformation(): void
                 ],
             ],
             true,
+            true,
         );
 
         // >LOG
@@ -3069,6 +3070,7 @@ public function snippetForSaveObjectsWithTransformation(): void
                     'name' => 'Benoit',
                 ],
             ],
+            true,
         );
 
         // >LOG

docs/snippets/php/src/Search.php

@@ -2677,6 +2677,7 @@ def snippet_for_partial_update_objects_with_transformation():
             },
         ],
         create_if_not_exists=True,
+        wait_for_tasks=True,
     )
 
     # >LOG
@@ -3138,6 +3139,7 @@ def snippet_for_save_objects_with_transformation():
                 "name": "Benoit",
             },
         ],
+        wait_for_tasks=True,
     )
 
     # >LOG