fix(javascript): add warning in replaceAllObjects for empty objects (generated)

algolia-api-clients-automation-bot[bot] · eric-zaharia · claude · algolia-api-clients-automation-bot[bot] · commit cb3174b82a5f · 2026-07-20T12:09:31.000Z
algolia/api-clients-automation#6608 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Eric Zaharia <94015633+eric-zaharia@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
       },
       {
         "path": "packages/client-search/dist/builds/browser.umd.js",
-        "maxSize": "10KB"
+        "maxSize": "11KB"
       },
       {
         "path": "packages/ingestion/dist/builds/browser.umd.js",
diff --git a/packages/algoliasearch/__tests__/algoliasearch.browser.test.ts b/packages/algoliasearch/__tests__/algoliasearch.browser.test.ts
@@ -15,19 +15,18 @@ test('sets the ua', () => {
   });
 });
 
-test('with logger', () => {
-  vi.spyOn(console, 'debug');
-  vi.spyOn(console, 'info');
-  vi.spyOn(console, 'error');
+test('with logger', async () => {
+  const consoleInfo = vi.spyOn(console, 'info').mockImplementation(() => {});
 
   const client = algoliasearch('APP_ID', 'API_KEY', {
     logger: createConsoleLogger(LogLevelEnum.Debug),
+    // every host fails, exercising the retry logging path without a real request that could outlive the test
+    requester: {
+      send: () => Promise.resolve({ content: 'internal error', isTimedOut: false, status: 500 }),
+    },
   });
 
-  expect(async () => {
-    await client.setSettings({ indexName: 'foo', indexSettings: {} });
-    expect(console.debug).toHaveBeenCalledTimes(1);
-    expect(console.info).toHaveBeenCalledTimes(1);
-    expect(console.error).toHaveBeenCalledTimes(1);
-  }).not.toThrow();
+  await expect(client.setSettings({ indexName: 'foo', indexSettings: {} })).rejects.toThrow();
+
+  expect(consoleInfo).toHaveBeenCalledWith('Retryable failure', expect.any(Object));
 });
diff --git a/packages/algoliasearch/__tests__/algoliasearch.fetch.test.ts b/packages/algoliasearch/__tests__/algoliasearch.fetch.test.ts
@@ -22,19 +22,18 @@ test('forwards node search helpers', () => {
   }).not.toThrow();
 });
 
-test('with logger', () => {
-  vi.spyOn(console, 'debug');
-  vi.spyOn(console, 'info');
-  vi.spyOn(console, 'error');
+test('with logger', async () => {
+  const consoleInfo = vi.spyOn(console, 'info').mockImplementation(() => {});
 
   const client = algoliasearch('APP_ID', 'API_KEY', {
     logger: createConsoleLogger(LogLevelEnum.Debug),
+    // every host fails, exercising the retry logging path without a real request that could outlive the test
+    requester: {
+      send: () => Promise.resolve({ content: 'internal error', isTimedOut: false, status: 500 }),
+    },
   });
 
-  expect(async () => {
-    await client.setSettings({ indexName: 'foo', indexSettings: {} });
-    expect(console.debug).toHaveBeenCalledTimes(1);
-    expect(console.info).toHaveBeenCalledTimes(1);
-    expect(console.error).toHaveBeenCalledTimes(1);
-  }).not.toThrow();
+  await expect(client.setSettings({ indexName: 'foo', indexSettings: {} })).rejects.toThrow();
+
+  expect(consoleInfo).toHaveBeenCalledWith('Retryable failure', expect.any(Object));
 });
diff --git a/packages/algoliasearch/__tests__/algoliasearch.node.test.ts b/packages/algoliasearch/__tests__/algoliasearch.node.test.ts
@@ -24,19 +24,18 @@ test('forwards node search helpers', () => {
   }).not.toThrow();
 });
 
-test('with logger', () => {
-  vi.spyOn(console, 'debug');
-  vi.spyOn(console, 'info');
-  vi.spyOn(console, 'error');
+test('with logger', async () => {
+  const consoleInfo = vi.spyOn(console, 'info').mockImplementation(() => {});
 
   const client = algoliasearch('APP_ID', 'API_KEY', {
     logger: createConsoleLogger(LogLevelEnum.Debug),
+    // every host fails, exercising the retry logging path without a real request that could outlive the test
+    requester: {
+      send: () => Promise.resolve({ content: 'internal error', isTimedOut: false, status: 500 }),
+    },
   });
 
-  expect(async () => {
-    await client.setSettings({ indexName: 'foo', indexSettings: {} });
-    expect(console.debug).toHaveBeenCalledTimes(1);
-    expect(console.info).toHaveBeenCalledTimes(1);
-    expect(console.error).toHaveBeenCalledTimes(1);
-  }).not.toThrow();
+  await expect(client.setSettings({ indexName: 'foo', indexSettings: {} })).rejects.toThrow();
+
+  expect(consoleInfo).toHaveBeenCalledWith('Retryable failure', expect.any(Object));
 });
diff --git a/packages/algoliasearch/__tests__/algoliasearch.worker.test.ts b/packages/algoliasearch/__tests__/algoliasearch.worker.test.ts
@@ -37,19 +37,18 @@ test('web crypto implementation gives the same result as node crypto', async ()
   expect(resp).toEqual(nodeResp);
 });
 
-test('with logger', () => {
-  vi.spyOn(console, 'debug');
-  vi.spyOn(console, 'info');
-  vi.spyOn(console, 'error');
+test('with logger', async () => {
+  const consoleInfo = vi.spyOn(console, 'info').mockImplementation(() => {});
 
   const client = algoliasearch('APP_ID', 'API_KEY', {
     logger: createConsoleLogger(LogLevelEnum.Debug),
+    // every host fails, exercising the retry logging path without a real request that could outlive the test
+    requester: {
+      send: () => Promise.resolve({ content: 'internal error', isTimedOut: false, status: 500 }),
+    },
   });
 
-  expect(async () => {
-    await client.setSettings({ indexName: 'foo', indexSettings: {} });
-    expect(console.debug).toHaveBeenCalledTimes(1);
-    expect(console.info).toHaveBeenCalledTimes(1);
-    expect(console.error).toHaveBeenCalledTimes(1);
-  }).not.toThrow();
+  await expect(client.setSettings({ indexName: 'foo', indexSettings: {} })).rejects.toThrow();
+
+  expect(consoleInfo).toHaveBeenCalledWith('Retryable failure', expect.any(Object));
 });
diff --git a/packages/algoliasearch/builds/browser.ts b/packages/algoliasearch/builds/browser.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ClientOptions, RequestOptions } from '@algolia/client-common';
-import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES } from '@algolia/client-common';
+import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, logWarning } from '@algolia/client-common';
 
 import type { AbtestingV3Client } from '@algolia/abtesting';
 import { abtestingV3Client } from '@algolia/abtesting';
@@ -97,6 +97,8 @@ export type Algoliasearch = SearchClient & {
   /**
    * 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.
    *
+   * 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` by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) 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.
@@ -220,6 +222,13 @@ export function algoliasearch(
         );
       }
 
+      if (objects.length === 0) {
+        logWarning(
+          client.transporter.logger,
+          `replaceAllObjectsWithTransformation was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`,
+        );
+      }
+
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
diff --git a/packages/algoliasearch/builds/fetch.ts b/packages/algoliasearch/builds/fetch.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ClientOptions, RequestOptions } from '@algolia/client-common';
-import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES } from '@algolia/client-common';
+import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, logWarning } from '@algolia/client-common';
 
 import type { AbtestingV3Client } from '@algolia/abtesting';
 import { abtestingV3Client } from '@algolia/abtesting';
@@ -97,6 +97,8 @@ export type Algoliasearch = SearchClient & {
   /**
    * 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.
    *
+   * 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` by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) 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.
@@ -220,6 +222,13 @@ export function algoliasearch(
         );
       }
 
+      if (objects.length === 0) {
+        logWarning(
+          client.transporter.logger,
+          `replaceAllObjectsWithTransformation was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`,
+        );
+      }
+
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
diff --git a/packages/algoliasearch/builds/node.ts b/packages/algoliasearch/builds/node.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ClientOptions, RequestOptions } from '@algolia/client-common';
-import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES } from '@algolia/client-common';
+import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, logWarning } from '@algolia/client-common';
 
 import type { AbtestingV3Client } from '@algolia/abtesting';
 import { abtestingV3Client } from '@algolia/abtesting';
@@ -97,6 +97,8 @@ export type Algoliasearch = SearchClient & {
   /**
    * 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.
    *
+   * 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` by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) 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.
@@ -220,6 +222,13 @@ export function algoliasearch(
         );
       }
 
+      if (objects.length === 0) {
+        logWarning(
+          client.transporter.logger,
+          `replaceAllObjectsWithTransformation was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`,
+        );
+      }
+
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
diff --git a/packages/algoliasearch/builds/worker.ts b/packages/algoliasearch/builds/worker.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ClientOptions, RequestOptions } from '@algolia/client-common';
-import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES } from '@algolia/client-common';
+import { DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES, logWarning } from '@algolia/client-common';
 
 import type { AbtestingV3Client } from '@algolia/abtesting';
 import { abtestingV3Client } from '@algolia/abtesting';
@@ -97,6 +97,8 @@ export type Algoliasearch = SearchClient & {
   /**
    * 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.
    *
+   * 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` by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) 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.
@@ -220,6 +222,13 @@ export function algoliasearch(
         );
       }
 
+      if (objects.length === 0) {
+        logWarning(
+          client.transporter.logger,
+          `replaceAllObjectsWithTransformation was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`,
+        );
+      }
+
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
diff --git a/packages/client-common/src/__tests__/logger/logWarning.test.ts b/packages/client-common/src/__tests__/logger/logWarning.test.ts
@@ -0,0 +1,26 @@
+import { describe, expect, test, vi } from 'vitest';
+
+import { createNullLogger, logWarning } from '../../logger';
+
+describe('logWarning', () => {
+  test('prefers the logger warn method when implemented', () => {
+    vi.resetAllMocks();
+    vi.spyOn(console, 'warn');
+
+    const warn = vi.fn().mockResolvedValue(undefined);
+
+    logWarning({ ...createNullLogger(), warn }, 'foo');
+
+    expect(warn).toHaveBeenCalledWith('foo');
+    expect(console.warn).toHaveBeenCalledTimes(0);
+  });
+
+  test('falls back to console.warn when the logger does not implement warn', () => {
+    vi.resetAllMocks();
+    vi.spyOn(console, 'warn');
+
+    logWarning(createNullLogger(), 'foo');
+
+    expect(console.warn).toHaveBeenCalledWith('foo');
+  });
+});
diff --git a/packages/client-common/src/logger/index.ts b/packages/client-common/src/logger/index.ts
@@ -1 +1,2 @@
 export * from './createNullLogger';
+export * from './logWarning';
diff --git a/packages/client-common/src/logger/logWarning.ts b/packages/client-common/src/logger/logWarning.ts
@@ -0,0 +1,13 @@
+import type { Logger } from '../types';
+
+/**
+ * Prefers the logger's optional `warn` method and falls back to `console.warn`, so warnings stay visible with the default no-op logger.
+ */
+export function logWarning(logger: Logger, message: string): void {
+  if (logger.warn) {
+    // a rejecting custom `warn` must not become a fatal unhandled rejection
+    void Promise.resolve(logger.warn(message)).catch(() => {});
+  } else {
+    console.warn(message);
+  }
+}
diff --git a/packages/client-common/src/types/logger.ts b/packages/client-common/src/types/logger.ts
@@ -17,6 +17,11 @@ export type Logger = {
    */
   info: (message: string, args?: any | undefined) => Promise<void>;
 
+  /**
+   * Logs warning messages. When not implemented, warnings fall back to `console.warn` so they stay visible with the default no-op logger.
+   */
+  warn?: (message: string, args?: any | undefined) => Promise<void>;
+
   /**
    * Logs error messages.
    */
diff --git a/packages/client-common/vitest.config.ts b/packages/client-common/vitest.config.ts
@@ -9,6 +9,7 @@ export default defineConfig({
             'src/__tests__/cache/null-cache.test.ts',
             'src/__tests__/cache/memory-cache.test.ts',
             'src/__tests__/create-iterable-promise.test.ts',
+            'src/__tests__/logger/logWarning.test.ts',
             'src/__tests__/logger/null-logger.test.ts',
             'src/__tests__/sse.test.ts',
             'src/__tests__/transporter/cache.test.ts',
@@ -25,6 +26,7 @@ export default defineConfig({
             'src/__tests__/cache/fallbackable-cache.test.ts',
             'src/__tests__/cache/null-cache.test.ts',
             'src/__tests__/create-iterable-promise.test.ts',
+            'src/__tests__/logger/logWarning.test.ts',
             'src/__tests__/logger/null-logger.test.ts',
             'src/__tests__/transporter/cache.test.ts',
           ],
diff --git a/packages/client-search/src/searchClient.ts b/packages/client-search/src/searchClient.ts
@@ -17,6 +17,7 @@ import {
   createIterablePromise,
   createTransporter,
   getAlgoliaAgent,
+  logWarning,
   shuffle,
   validateRequired,
 } from '@algolia/client-common';
@@ -634,6 +635,8 @@ export 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.
@@ -653,6 +656,13 @@ export function createSearchClient({
       }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions | undefined,
     ): Promise<ReplaceAllObjectsResponse> {
+      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() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
diff --git a/packages/logger-console/src/__tests__/logger-console.test.ts b/packages/logger-console/src/__tests__/logger-console.test.ts
diff --git a/packages/logger-console/src/logger.ts b/packages/logger-console/src/logger.ts

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`},`
`64`	`64`	`{`
`65`	`65`	`"path": "packages/client-search/dist/builds/browser.umd.js",`
`66`		`- "maxSize": "10KB"`
	`66`	`+ "maxSize": "11KB"`
`67`	`67`	`},`
`68`	`68`	`{`
`69`	`69`	`"path": "packages/ingestion/dist/builds/browser.umd.js",`