feat(javascript): expose maximum number of retries (generated)

algolia/api-clients-automation#6353

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Eric Zaharia <94015633+eric-zaharia@users.noreply.github.com>

Author: algolia-bot

packages/algoliasearch/builds/browser.ts

@@ -67,6 +67,7 @@ export type Algoliasearch = SearchClient & {
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
    * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param saveObjects.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.
+   * @param saveObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   saveObjectsWithTransformation: (
@@ -84,6 +85,7 @@ export type Algoliasearch = SearchClient & {
    * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail.
    * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param partialUpdateObjects.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.
+   * @param partialUpdateObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   partialUpdateObjectsWithTransformation: (
@@ -100,6 +102,7 @@ export type Algoliasearch = SearchClient & {
    * @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 `objects.length / batchSize`. Defaults to 1000.
    * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+   * @param replaceAllObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push`, `operationIndex` and `getEvent` method and merged with the transporter requestOptions.
    */
   replaceAllObjectsWithTransformation: (
@@ -162,7 +165,7 @@ export function algoliasearch(
     ...client,
 
     async saveObjectsWithTransformation(
-      { indexName, objects, waitForTasks },
+      { indexName, objects, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -172,13 +175,13 @@ export function algoliasearch(
       }
 
       return ingestionTransporter.chunkedPush(
-        { indexName, objects, action: 'addObject', waitForTasks },
+        { indexName, objects, action: 'addObject', waitForTasks, maxRetries },
         requestOptions,
       );
     },
 
     async partialUpdateObjectsWithTransformation(
-      { indexName, objects, createIfNotExists, waitForTasks },
+      { indexName, objects, createIfNotExists, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -193,13 +196,14 @@ export function algoliasearch(
           objects,
           action: createIfNotExists ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate',
           waitForTasks,
+          maxRetries,
         },
         requestOptions,
       );
     },
 
     async replaceAllObjectsWithTransformation(
-      { indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions,
+      { indexName, objects, batchSize, scopes, maxRetries = 100 }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions | undefined,
     ): Promise<ReplaceAllObjectsWithTransformationResponse> {
       if (!ingestionTransporter) {
@@ -229,13 +233,21 @@ export function algoliasearch(
         );
 
         const watchResponses = await ingestionTransporter.chunkedPush(
-          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, referenceIndexName: indexName },
+          {
+            indexName: tmpIndexName,
+            objects,
+            waitForTasks: true,
+            batchSize,
+            referenceIndexName: indexName,
+            maxRetries,
+          },
           requestOptions,
         );
 
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         copyOperationResponse = await this.operationIndex(
@@ -252,6 +264,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         const moveOperationResponse = await this.operationIndex(
@@ -264,6 +277,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: moveOperationResponse.taskID,
+          maxRetries,
         });
 
         return { copyOperationResponse, watchResponses, moveOperationResponse };

packages/algoliasearch/builds/fetch.ts

@@ -67,6 +67,7 @@ export type Algoliasearch = SearchClient & {
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
    * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param saveObjects.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.
+   * @param saveObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   saveObjectsWithTransformation: (
@@ -84,6 +85,7 @@ export type Algoliasearch = SearchClient & {
    * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail.
    * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param partialUpdateObjects.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.
+   * @param partialUpdateObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   partialUpdateObjectsWithTransformation: (
@@ -100,6 +102,7 @@ export type Algoliasearch = SearchClient & {
    * @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 `objects.length / batchSize`. Defaults to 1000.
    * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+   * @param replaceAllObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push`, `operationIndex` and `getEvent` method and merged with the transporter requestOptions.
    */
   replaceAllObjectsWithTransformation: (
@@ -162,7 +165,7 @@ export function algoliasearch(
     ...client,
 
     async saveObjectsWithTransformation(
-      { indexName, objects, waitForTasks },
+      { indexName, objects, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -172,13 +175,13 @@ export function algoliasearch(
       }
 
       return ingestionTransporter.chunkedPush(
-        { indexName, objects, action: 'addObject', waitForTasks },
+        { indexName, objects, action: 'addObject', waitForTasks, maxRetries },
         requestOptions,
       );
     },
 
     async partialUpdateObjectsWithTransformation(
-      { indexName, objects, createIfNotExists, waitForTasks },
+      { indexName, objects, createIfNotExists, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -193,13 +196,14 @@ export function algoliasearch(
           objects,
           action: createIfNotExists ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate',
           waitForTasks,
+          maxRetries,
         },
         requestOptions,
       );
     },
 
     async replaceAllObjectsWithTransformation(
-      { indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions,
+      { indexName, objects, batchSize, scopes, maxRetries = 100 }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions | undefined,
     ): Promise<ReplaceAllObjectsWithTransformationResponse> {
       if (!ingestionTransporter) {
@@ -229,13 +233,21 @@ export function algoliasearch(
         );
 
         const watchResponses = await ingestionTransporter.chunkedPush(
-          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, referenceIndexName: indexName },
+          {
+            indexName: tmpIndexName,
+            objects,
+            waitForTasks: true,
+            batchSize,
+            referenceIndexName: indexName,
+            maxRetries,
+          },
           requestOptions,
         );
 
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         copyOperationResponse = await this.operationIndex(
@@ -252,6 +264,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         const moveOperationResponse = await this.operationIndex(
@@ -264,6 +277,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: moveOperationResponse.taskID,
+          maxRetries,
         });
 
         return { copyOperationResponse, watchResponses, moveOperationResponse };

packages/algoliasearch/builds/node.ts

@@ -67,6 +67,7 @@ export type Algoliasearch = SearchClient & {
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
    * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param saveObjects.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.
+   * @param saveObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   saveObjectsWithTransformation: (
@@ -84,6 +85,7 @@ export type Algoliasearch = SearchClient & {
    * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail.
    * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
    * @param partialUpdateObjects.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.
+   * @param partialUpdateObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
    */
   partialUpdateObjectsWithTransformation: (
@@ -100,6 +102,7 @@ export type Algoliasearch = SearchClient & {
    * @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 `objects.length / batchSize`. Defaults to 1000.
    * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+   * @param replaceAllObjects.maxRetries - The maximum number of retries when polling for task completion. 100 by default.
    * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push`, `operationIndex` and `getEvent` method and merged with the transporter requestOptions.
    */
   replaceAllObjectsWithTransformation: (
@@ -162,7 +165,7 @@ export function algoliasearch(
     ...client,
 
     async saveObjectsWithTransformation(
-      { indexName, objects, waitForTasks },
+      { indexName, objects, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -172,13 +175,13 @@ export function algoliasearch(
       }
 
       return ingestionTransporter.chunkedPush(
-        { indexName, objects, action: 'addObject', waitForTasks },
+        { indexName, objects, action: 'addObject', waitForTasks, maxRetries },
         requestOptions,
       );
     },
 
     async partialUpdateObjectsWithTransformation(
-      { indexName, objects, createIfNotExists, waitForTasks },
+      { indexName, objects, createIfNotExists, waitForTasks, maxRetries },
       requestOptions,
     ): Promise<Array<WatchResponse>> {
       if (!ingestionTransporter) {
@@ -193,13 +196,14 @@ export function algoliasearch(
           objects,
           action: createIfNotExists ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate',
           waitForTasks,
+          maxRetries,
         },
         requestOptions,
       );
     },
 
     async replaceAllObjectsWithTransformation(
-      { indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions,
+      { indexName, objects, batchSize, scopes, maxRetries = 100 }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions | undefined,
     ): Promise<ReplaceAllObjectsWithTransformationResponse> {
       if (!ingestionTransporter) {
@@ -229,13 +233,21 @@ export function algoliasearch(
         );
 
         const watchResponses = await ingestionTransporter.chunkedPush(
-          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, referenceIndexName: indexName },
+          {
+            indexName: tmpIndexName,
+            objects,
+            waitForTasks: true,
+            batchSize,
+            referenceIndexName: indexName,
+            maxRetries,
+          },
           requestOptions,
         );
 
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         copyOperationResponse = await this.operationIndex(
@@ -252,6 +264,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: copyOperationResponse.taskID,
+          maxRetries,
         });
 
         const moveOperationResponse = await this.operationIndex(
@@ -264,6 +277,7 @@ export function algoliasearch(
         await this.waitForTask({
           indexName: tmpIndexName,
           taskID: moveOperationResponse.taskID,
+          maxRetries,
         });
 
         return { copyOperationResponse, watchResponses, moveOperationResponse };