@algolia/client-search 5.56.0 → 5.57.0

package/dist/builds/node.js

@@ -8,7 +8,8 @@ import {
   createMemoryCache,
   createNullCache,
   createNullLogger,
-  serializeQueryParameters
+  serializeQueryParameters,
+  withRequestId as withRequestId2
 } from "@algolia/client-common";
 import { createHttpRequester } from "@algolia/requester-node-http";
 
@@ -20,10 +21,12 @@ import {
   createIterablePromise,
   createTransporter,
   getAlgoliaAgent,
+  logWarning,
   shuffle,
-  validateRequired
+  validateRequired,
+  withRequestId
 } from "@algolia/client-common";
-var apiClientVersion = "5.56.0";
+var apiClientVersion = "5.57.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -143,6 +146,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       return createIterablePromise({
         func: () => this.getTask({ indexName, taskID }, requestOptions),
@@ -170,6 +174,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       return createIterablePromise({
         func: () => this.getAppTask({ taskID }, requestOptions),
@@ -201,6 +206,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let retryCount = 0;
       const baseIteratorOptions = {
         aggregator: () => retryCount += 1,
@@ -256,6 +262,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
     browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       return createIterablePromise({
         func: (previousResponse) => {
           return this.browse(
@@ -286,6 +293,7 @@ function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       const params = {
         ...searchRulesParams,
         hitsPerPage: (searchRulesParams == null ? void 0 : searchRulesParams.hitsPerPage) || 1e3
@@ -323,6 +331,7 @@ function createSearchClient({
       searchSynonymsParams,
       ...browseSynonymsOptions
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       const params = {
         ...searchSynonymsParams,
         page: (searchSynonymsParams == null ? void 0 : searchSynonymsParams.page) || 0,
@@ -368,6 +377,7 @@ function createSearchClient({
       batchSize = 1e3,
       maxRetries = 100
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
       let requests = [];
       const responses = [];
       const objectEntries = objects.entries();
@@ -380,7 +390,7 @@ function createSearchClient({
       }
       if (waitForTasks) {
         for (const resp of responses) {
-          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries });
+          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries }, requestOptions);
         }
       }
       return responses;
@@ -458,6 +468,8 @@ function createSearchClient({
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -474,6 +486,13 @@ function createSearchClient({
       scopes,
       maxRetries = DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES
     }, requestOptions) {
+      requestOptions = withRequestId(transporter, requestOptions);
+      if (objects.length === 0) {
+        logWarning(
+          transporter.logger,
+          `replaceAllObjects was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`
+        );
+      }
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
       if (scopes === void 0) {
@@ -495,11 +514,14 @@ function createSearchClient({
           { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, maxRetries },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         copyOperationResponse = await this.operationIndex(
           {
             indexName,
@@ -511,11 +533,14 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         const moveOperationResponse = await this.operationIndex(
           {
             indexName: tmpIndexName,
@@ -523,20 +548,23 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: moveOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: moveOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         return { copyOperationResponse, batchResponses, moveOperationResponse };
       } catch (error) {
-        await this.deleteIndex({ indexName: tmpIndexName });
+        await this.deleteIndex({ indexName: tmpIndexName }, requestOptions);
         throw error;
       }
     },
-    async indexExists({ indexName }) {
+    async indexExists({ indexName }, requestOptions) {
       try {
-        await this.getSettings({ indexName });
+        await this.getSettings({ indexName }, requestOptions);
       } catch (error) {
         if (error instanceof ApiError && error.status === 404) {
           return false;
@@ -4020,6 +4048,7 @@ function searchClient(appId, apiKey, options) {
       logger: createNullLogger(),
       requester: createHttpRequester(),
       algoliaAgents: [{ segment: "Node.js", version: process.versions.node }],
+      requestIdChannel: "headers",
       responsesCache: createNullCache(),
       requestsCache: createNullCache(),
       hostsCache: createMemoryCache(),
@@ -4077,11 +4106,12 @@ function searchClient(appId, apiKey, options) {
       batchSize,
       maxRetries = 100
     }, requestOptions) {
+      requestOptions = withRequestId2(this.transporter, requestOptions);
       const responses = [];
       if (this.appId === destinationAppID) {
         throw new IndicesInSameAppError();
       }
-      if (!await this.indexExists({ indexName: sourceIndexName })) {
+      if (!await this.indexExists({ indexName: sourceIndexName }, requestOptions)) {
         throw new IndexNotFoundError(sourceIndexName);
       }
       const destinationClient = createSearchClient({
@@ -4100,54 +4130,66 @@ function searchClient(appId, apiKey, options) {
         hostsCache: createMemoryCache(),
         ...options
       });
-      if (await destinationClient.indexExists({ indexName: destinationIndexName })) {
+      if (await destinationClient.indexExists({ indexName: destinationIndexName }, requestOptions)) {
         throw new IndexAlreadyExistsError(destinationIndexName);
       }
       responses.push(
         await destinationClient.setSettings(
           {
             indexName: destinationIndexName,
-            indexSettings: await this.getSettings({ indexName: sourceIndexName })
+            indexSettings: await this.getSettings({ indexName: sourceIndexName }, requestOptions)
           },
           requestOptions
         )
       );
-      await this.browseRules({
-        indexName: sourceIndexName,
-        async aggregator(response) {
-          responses.push(
-            await destinationClient.saveRules(
-              { indexName: destinationIndexName, rules: response.hits },
-              requestOptions
-            )
-          );
-        }
-      });
-      await this.browseSynonyms({
-        indexName: sourceIndexName,
-        async aggregator(response) {
-          responses.push(
-            await destinationClient.saveSynonyms(
-              { indexName: destinationIndexName, synonymHit: response.hits },
-              requestOptions
-            )
-          );
-        }
-      });
-      await this.browseObjects({
-        indexName: sourceIndexName,
-        browseParams: batchSize ? { hitsPerPage: batchSize } : void 0,
-        async aggregator(response) {
-          responses.push(
-            ...await destinationClient.saveObjects(
-              { indexName: destinationIndexName, objects: response.hits, batchSize },
-              requestOptions
-            )
-          );
-        }
-      });
+      await this.browseRules(
+        {
+          indexName: sourceIndexName,
+          async aggregator(response) {
+            responses.push(
+              await destinationClient.saveRules(
+                { indexName: destinationIndexName, rules: response.hits },
+                requestOptions
+              )
+            );
+          }
+        },
+        requestOptions
+      );
+      await this.browseSynonyms(
+        {
+          indexName: sourceIndexName,
+          async aggregator(response) {
+            responses.push(
+              await destinationClient.saveSynonyms(
+                { indexName: destinationIndexName, synonymHit: response.hits },
+                requestOptions
+              )
+            );
+          }
+        },
+        requestOptions
+      );
+      await this.browseObjects(
+        {
+          indexName: sourceIndexName,
+          browseParams: batchSize ? { hitsPerPage: batchSize } : void 0,
+          async aggregator(response) {
+            responses.push(
+              ...await destinationClient.saveObjects(
+                { indexName: destinationIndexName, objects: response.hits, batchSize },
+                requestOptions
+              )
+            );
+          }
+        },
+        requestOptions
+      );
       for (const response of responses) {
-        await destinationClient.waitForTask({ indexName: destinationIndexName, taskID: response.taskID, maxRetries });
+        await destinationClient.waitForTask(
+          { indexName: destinationIndexName, taskID: response.taskID, maxRetries },
+          requestOptions
+        );
       }
     },
     /**