feat(javascript): add requester-testing package (#3684) (generated) [skip ci]

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

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/algoliasearch/package.json

@@ -10,7 +10,7 @@
   "scripts": {
     "build": "yarn clean && yarn tsup && yarn rollup -c rollup.config.js",
     "clean": "rm -rf ./dist || true",
-    "test": "jest",
+    "test": "vitest --run",
     "test:bundle": "publint . && attw --pack ."
   },
   "name": "algoliasearch",
@@ -80,17 +80,16 @@
     "@algolia/requester-node-http": "5.3.2"
   },
   "devDependencies": {
+    "@algolia/requester-testing": "0.0.0",
     "@arethetypeswrong/cli": "0.15.4",
-    "@babel/preset-env": "7.25.4",
-    "@babel/preset-typescript": "7.24.7",
-    "@types/jest": "29.5.12",
     "@types/node": "22.5.1",
-    "jest": "29.7.0",
-    "jest-environment-miniflare": "2.14.3",
+    "jsdom": "25.0.0",
     "publint": "0.2.10",
     "rollup": "4.21.2",
     "tsup": "8.2.4",
-    "typescript": "5.5.4"
+    "typescript": "5.5.4",
+    "vitest": "2.0.5",
+    "vitest-environment-miniflare": "2.14.3"
   },
   "engines": {
     "node": ">= 14.0.0"

clients/algoliasearch-client-javascript/packages/algoliasearch/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "types": ["node", "jest"],
+    "types": ["node", "@cloudflare/workers-types", "vitest-environment-miniflare/globals", "vitest/globals"],
     "outDir": "dist"
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/algoliasearch/vitest.workspace.ts

@@ -5,35 +5,35 @@ export default defineWorkspace([
   {
     resolve: {
       alias: {
-        '@algolia/client-search': '../../client-search/builds/node'
-      }
+        '@algolia/client-search': '../../client-search/builds/node',
+      },
     },
     test: {
-      include: [ '__tests__/algoliasearch.node.test.ts' ],
+      include: ['__tests__/algoliasearch.node.test.ts'],
       name: 'node',
       environment: 'node',
     },
   },
   {
     resolve: {
       alias: {
-        '@algolia/client-search': '../../client-search/builds/browser'
-      }
+        '@algolia/client-search': '../../client-search/builds/browser',
+      },
     },
     test: {
-      include: [ '__tests__/algoliasearch.browser.test.ts', '__tests__/algoliasearch.common.test.ts' ],
+      include: ['__tests__/algoliasearch.browser.test.ts', '__tests__/algoliasearch.common.test.ts'],
       name: 'jsdom',
       environment: 'jsdom',
     },
   },
   {
     resolve: {
       alias: {
-        '@algolia/client-search': '../../client-search/builds/fetch'
-      }
+        '@algolia/client-search': '../../client-search/builds/fetch',
+      },
     },
     test: {
-      include: [ '__tests__/algoliasearch.fetch.test.ts' ],
+      include: ['__tests__/algoliasearch.fetch.test.ts'],
       name: 'miniflare',
       environment: 'miniflare',
     },

clients/algoliasearch-client-javascript/packages/client-abtesting/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-analytics/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-insights/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-personalization/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-query-suggestions/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-search/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/client-usage/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/ingestion/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/monitoring/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

clients/algoliasearch-client-javascript/packages/recommend/tsconfig.json

@@ -5,4 +5,4 @@
   },
   "include": ["src", "model", "builds"],
   "exclude": ["dist", "node_modules"]
-}
+}

tests/output/javascript/package.json

@@ -16,7 +16,7 @@
     "@algolia/ingestion": "link:../../../clients/algoliasearch-client-javascript/packages/ingestion",
     "@algolia/monitoring": "link:../../../clients/algoliasearch-client-javascript/packages/monitoring",
     "@algolia/recommend": "link:../../../clients/algoliasearch-client-javascript/packages/recommend",
-    "@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http",
+    "@algolia/requester-testing": "link:../../../clients/algoliasearch-client-javascript/packages/requester-testing",
     "algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch"
   },
   "devDependencies": {

tests/output/javascript/src/benchmark/search.test.ts

@@ -8,7 +8,7 @@ const appId = 'test-app-id';
 const apiKey = 'test-api-key';
 
 function createClient(): SearchClient {
-  return searchClient(appId, apiKey, { requester: echoRequester() });
+  return searchClient(appId, apiKey, { requester: nodeEchoRequester() });
 }
 
 describe('benchmark', () => {

tests/output/javascript/src/client/abtesting.test.ts

@@ -3,14 +3,14 @@
 // @ts-nocheck Failing tests will have type errors, but we cannot suppress them even with @ts-expect-error because it doesn't work for a block of lines.
 import type { AbtestingClient } from '@algolia/client-abtesting';
 import { abtestingClient } from '@algolia/client-abtesting';
-import { echoRequester } from '@algolia/requester-node-http';
-import type { EchoResponse } from '@algolia/requester-node-http';
+import { nodeEchoRequester } from '@algolia/requester-testing';
+import type { EchoResponse } from '@algolia/requester-testing';
 
 const appId = 'test-app-id';
 const apiKey = 'test-api-key';
 
 function createClient(): AbtestingClient {
-  return abtestingClient(appId, apiKey, 'us', { requester: echoRequester() });
+  return abtestingClient(appId, apiKey, 'us', { requester: nodeEchoRequester() });
 }
 
 describe('commonApi', () => {
@@ -51,15 +51,15 @@ describe('commonApi', () => {
 
 describe('parameters', () => {
   test('fallbacks to the alias when region is not given', async () => {
-    const client = abtestingClient('my-app-id', 'my-api-key', '', { requester: echoRequester() });
+    const client = abtestingClient('my-app-id', 'my-api-key', '', { requester: nodeEchoRequester() });
 
     const result = (await client.getABTest({ id: 123 })) as unknown as EchoResponse;
 
     expect(result.host).toEqual('analytics.algolia.com');
   }, 15000);
 
   test('uses the correct region', async () => {
-    const client = abtestingClient('my-app-id', 'my-api-key', 'us', { requester: echoRequester() });
+    const client = abtestingClient('my-app-id', 'my-api-key', 'us', { requester: nodeEchoRequester() });
 
     const result = (await client.getABTest({ id: 123 })) as unknown as EchoResponse;
 
@@ -68,7 +68,7 @@ describe('parameters', () => {
 
   test('throws when incorrect region is given', async () => {
     try {
-      const client = abtestingClient('my-app-id', 'my-api-key', 'not_a_region', { requester: echoRequester() });
+      const client = abtestingClient('my-app-id', 'my-api-key', 'not_a_region', { requester: nodeEchoRequester() });
       throw new Error('test is expected to throw error');
     } catch (e) {
       expect((e as Error).message).toMatch('`region` must be one of the following: de, us');
@@ -102,11 +102,11 @@ describe('init', () => {
   test('sets authMode', async () => {
     const qpClient = abtestingClient('foo', 'bar', 'us', {
       authMode: 'WithinQueryParameters',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
     const headerClient = abtestingClient('foo', 'bar', 'us', {
       authMode: 'WithinHeaders',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
 
     const qpResult = (await qpClient.customGet({

tests/output/javascript/src/client/analytics.test.ts

@@ -3,14 +3,14 @@
 // @ts-nocheck Failing tests will have type errors, but we cannot suppress them even with @ts-expect-error because it doesn't work for a block of lines.
 import type { AnalyticsClient } from '@algolia/client-analytics';
 import { analyticsClient } from '@algolia/client-analytics';
-import { echoRequester } from '@algolia/requester-node-http';
-import type { EchoResponse } from '@algolia/requester-node-http';
+import { nodeEchoRequester } from '@algolia/requester-testing';
+import type { EchoResponse } from '@algolia/requester-testing';
 
 const appId = 'test-app-id';
 const apiKey = 'test-api-key';
 
 function createClient(): AnalyticsClient {
-  return analyticsClient(appId, apiKey, 'us', { requester: echoRequester() });
+  return analyticsClient(appId, apiKey, 'us', { requester: nodeEchoRequester() });
 }
 
 describe('commonApi', () => {
@@ -51,15 +51,15 @@ describe('commonApi', () => {
 
 describe('parameters', () => {
   test('fallbacks to the alias when region is not given', async () => {
-    const client = analyticsClient('my-app-id', 'my-api-key', '', { requester: echoRequester() });
+    const client = analyticsClient('my-app-id', 'my-api-key', '', { requester: nodeEchoRequester() });
 
     const result = (await client.getAverageClickPosition({ index: 'my-index' })) as unknown as EchoResponse;
 
     expect(result.host).toEqual('analytics.algolia.com');
   }, 15000);
 
   test('uses the correct region', async () => {
-    const client = analyticsClient('my-app-id', 'my-api-key', 'de', { requester: echoRequester() });
+    const client = analyticsClient('my-app-id', 'my-api-key', 'de', { requester: nodeEchoRequester() });
 
     const result = (await client.customPost({ path: 'test' })) as unknown as EchoResponse;
 
@@ -68,7 +68,7 @@ describe('parameters', () => {
 
   test('throws when incorrect region is given', async () => {
     try {
-      const client = analyticsClient('my-app-id', 'my-api-key', 'not_a_region', { requester: echoRequester() });
+      const client = analyticsClient('my-app-id', 'my-api-key', 'not_a_region', { requester: nodeEchoRequester() });
       throw new Error('test is expected to throw error');
     } catch (e) {
       expect((e as Error).message).toMatch('`region` must be one of the following: de, us');
@@ -113,11 +113,11 @@ describe('init', () => {
   test('sets authMode', async () => {
     const qpClient = analyticsClient('foo', 'bar', 'us', {
       authMode: 'WithinQueryParameters',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
     const headerClient = analyticsClient('foo', 'bar', 'us', {
       authMode: 'WithinHeaders',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
 
     const qpResult = (await qpClient.customGet({

tests/output/javascript/src/client/ingestion.test.ts

@@ -3,14 +3,14 @@
 // @ts-nocheck Failing tests will have type errors, but we cannot suppress them even with @ts-expect-error because it doesn't work for a block of lines.
 import type { IngestionClient } from '@algolia/ingestion';
 import { ingestionClient } from '@algolia/ingestion';
-import { echoRequester } from '@algolia/requester-node-http';
-import type { EchoResponse } from '@algolia/requester-node-http';
+import { nodeEchoRequester } from '@algolia/requester-testing';
+import type { EchoResponse } from '@algolia/requester-testing';
 
 const appId = 'test-app-id';
 const apiKey = 'test-api-key';
 
 function createClient(): IngestionClient {
-  return ingestionClient(appId, apiKey, 'us', { requester: echoRequester() });
+  return ingestionClient(appId, apiKey, 'us', { requester: nodeEchoRequester() });
 }
 
 describe('commonApi', () => {
@@ -51,7 +51,7 @@ describe('commonApi', () => {
 
 describe('parameters', () => {
   test('uses the correct region', async () => {
-    const client = ingestionClient('my-app-id', 'my-api-key', 'us', { requester: echoRequester() });
+    const client = ingestionClient('my-app-id', 'my-api-key', 'us', { requester: nodeEchoRequester() });
 
     const result = (await client.getSource({
       sourceID: '6c02aeb1-775e-418e-870b-1faccd4b2c0f',
@@ -62,7 +62,7 @@ describe('parameters', () => {
 
   test('throws when incorrect region is given', async () => {
     try {
-      const client = ingestionClient('my-app-id', 'my-api-key', 'not_a_region', { requester: echoRequester() });
+      const client = ingestionClient('my-app-id', 'my-api-key', 'not_a_region', { requester: nodeEchoRequester() });
       throw new Error('test is expected to throw error');
     } catch (e) {
       expect((e as Error).message).toMatch('`region` is required and must be one of the following: eu, us');
@@ -96,11 +96,11 @@ describe('init', () => {
   test('sets authMode', async () => {
     const qpClient = ingestionClient('foo', 'bar', 'us', {
       authMode: 'WithinQueryParameters',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
     const headerClient = ingestionClient('foo', 'bar', 'us', {
       authMode: 'WithinHeaders',
-      requester: echoRequester(),
+      requester: nodeEchoRequester(),
     });
 
     const qpResult = (await qpClient.customGet({