fix(cts): use node test runner instead of jest

millotp · millotp · commit 68dc734a6a91 · 2024-09-17T09:11:31.000+02:00
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -289,7 +289,7 @@ jobs:
           path: clients-javascript.zip
 
   client_gen:
-    timeout-minutes: 10
+    timeout-minutes: 15
     runs-on: ubuntu-22.04
     needs:
       - setup
@@ -400,7 +400,7 @@ jobs:
           path: clients-${{matrix.client.language }}.zip
 
   kotlin_build_macos:
-    timeout-minutes: 10
+    timeout-minutes: 15
     runs-on: macos-latest
     needs:
       - setup
diff --git a/playground/javascript/node/abtesting.ts b/playground/javascript/node/abtesting.ts
@@ -1,8 +1,5 @@
 import { abtestingClient } from '@algolia/client-abtesting';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/algoliasearch.ts b/playground/javascript/node/algoliasearch.ts
@@ -1,12 +1,9 @@
 import { algoliasearch, SearchClient } from 'algoliasearch';
 import { liteClient } from 'algoliasearch/lite';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
 
 import type { SearchResponses } from 'algoliasearch';
 
-dotenv.config({ path: '../../.env' });
-
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey = process.env.ALGOLIA_SEARCH_KEY || '**** SEARCH_API_KEY *****';
 
diff --git a/playground/javascript/node/analytics.ts b/playground/javascript/node/analytics.ts
@@ -1,8 +1,5 @@
 import { analyticsClient } from '@algolia/client-analytics';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/ingestion.ts b/playground/javascript/node/ingestion.ts
@@ -1,8 +1,5 @@
 import { ingestionClient } from '@algolia/ingestion';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/insights.ts b/playground/javascript/node/insights.ts
@@ -1,8 +1,5 @@
 import { insightsClient } from '@algolia/client-insights';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/package.json b/playground/javascript/node/package.json
@@ -4,15 +4,7 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "start:algoliasearch": "tsc && node dist/algoliasearch.js",
-    "start:abtesting": "tsc && node dist/abtesting.js",
-    "start:analytics": "tsc && node dist/analytics.js",
-    "start:insights": "tsc && node dist/insights.js",
-    "start:personalization": "tsc && node dist/personalization.js",
-    "start:query-suggestions": "tsc && node dist/query-suggestions.js",
-    "start:recommend": "tsc && node dist/recommend.js",
-    "start:search": "tsc && node dist/search.js",
-    "start:sources": "tsc && node dist/sources.js",
+    "start": "tsc && node --env-file=../../.env dist/$0.js",
     "build": "tsc"
   },
   "dependencies": {
@@ -29,11 +21,10 @@
     "algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch"
   },
   "devDependencies": {
-    "dotenv": "16.4.5",
     "typescript": "5.6.2"
   },
   "engines": {
-    "node": ">= 14.0.0",
+    "node": ">= 20.0.0",
     "yarn": "^4.0.0"
   }
 }
diff --git a/playground/javascript/node/personalization.ts b/playground/javascript/node/personalization.ts
@@ -1,8 +1,5 @@
 import { personalizationClient } from '@algolia/client-personalization';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/query-suggestions.ts b/playground/javascript/node/query-suggestions.ts
@@ -1,8 +1,5 @@
 import { querySuggestionsClient } from '@algolia/client-query-suggestions';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey =
diff --git a/playground/javascript/node/recommend.ts b/playground/javascript/node/recommend.ts
@@ -1,8 +1,5 @@
 import { recommendClient } from '@algolia/recommend';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey = process.env.ALGOLIA_SEARCH_KEY || '**** SEARCH_API_KEY *****';
diff --git a/playground/javascript/node/search.ts b/playground/javascript/node/search.ts
@@ -1,9 +1,6 @@
 import { searchClient, apiClientVersion } from '@algolia/client-search';
 import { SearchQuery } from '@algolia/client-search/model';
 import { ApiError } from '@algolia/client-common';
-import dotenv from 'dotenv';
-
-dotenv.config({ path: '../../.env' });
 
 const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
 const apiKey = process.env.ALGOLIA_ADMIN_KEY || '**** SEARCH_API_KEY *****';
diff --git a/scripts/cts/runCts.ts b/scripts/cts/runCts.ts
@@ -68,7 +68,7 @@ async function runCtsOne(language: Language, suites: Record<CTSType, boolean>):
       });
       break;
     case 'javascript':
-      await run(`YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install && yarn test ${filter((f) => `dist/${f}`)}`, {
+      await run(`YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install && yarn test ${filter((f) => `dist/${f}/*.js`)}`, {
         cwd,
       });
       break;
diff --git a/scripts/playground.ts b/scripts/playground.ts
@@ -13,7 +13,7 @@ export async function playground({ language, client }: { language: AllLanguage;
       });
       break;
     case 'javascript':
-      await run(`yarn workspace javascript-playground start:${client}`);
+      await run(`yarn workspace javascript-playground start ${client}`);
       break;
     case 'java':
       await run(
diff --git a/templates/javascript/tests/client/client.mustache b/templates/javascript/tests/client/client.mustache
@@ -1,6 +1,9 @@
 // {{generationBanner}}
 /* eslint-disable @typescript-eslint/no-unused-vars, require-await, no-lone-blocks */
 // @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 assert from 'node:assert';
+import test, { describe } from 'node:test';
+
 import { {{client}}, {{#lambda.titlecase}}{{client}}{{/lambda.titlecase}} } from '{{{import}}}';
 import { nodeEchoRequester } from '@algolia/requester-testing';
 import type { EchoResponse } from '@algolia/requester-testing';
@@ -30,15 +33,15 @@ describe('init', () => {
     const qpResult = (await qpClient.customGet({
       path: '1/foo',
     })) as unknown as EchoResponse;
-    expect(qpResult.searchParams).toEqual({
+    assert.deepStrictEqual(qpResult.searchParams, {
       'x-algolia-api-key': 'bar',
       'x-algolia-application-id': 'foo',
     });
 
     const headerResult = (await headerClient.customGet({
       path: '1/bar',
     })) as unknown as EchoResponse;
-    expect(headerResult.headers).toEqual({
+    assert.deepStrictEqual(headerResult.headers, {
       accept: 'application/json',
       'content-type': 'text/plain',
       'x-algolia-api-key': 'bar',
diff --git a/templates/javascript/tests/client/tests.mustache b/templates/javascript/tests/client/tests.mustache
@@ -15,7 +15,7 @@ describe('{{testType}}', () => {
           {{#dynamicTemplate}}{{/dynamicTemplate}}
           throw new Error('test is expected to throw error');
         } catch(e) {
-          expect((e as Error).message).toMatch("{{{expectedError}}}");
+          assert.strictEqual((e as Error).message, "{{{expectedError}}}");
         }
       {{/isError}}
       {{^isError}}
@@ -25,25 +25,31 @@ describe('{{testType}}', () => {
         {{#dynamicTemplate}}{{/dynamicTemplate}}
 
         {{#testUserAgent}}
-          expect(decodeURIComponent(result.algoliaAgent)).toMatch(/{{{match.value}}}/);
+          assert.match(decodeURIComponent(result.algoliaAgent), /{{{match.value}}}/);
         {{/testUserAgent}}
         {{#testTimeouts}}
-          expect(result).toEqual(expect.objectContaining({{{match.value}}}));
+          assert.strictEqual(result.connectTimeout, {{{matchConnectTimeout}}});
+          assert.strictEqual(result.responseTimeout, {{{matchResponseTimeout}}});
         {{/testTimeouts}}
         {{#testHost}}
-          expect(result.host).toEqual("{{{match.value}}}");
+          assert.strictEqual(result.host, "{{{match.value}}}");
         {{/testHost}}
         {{#testResponse}}
           {{#match.isPrimitive}}
             {{#match.isString}}
-              expect(result).toEqual("{{{match.value}}}");
+              assert.strictEqual(result, "{{{match.value}}}");
             {{/match.isString}}
             {{^match.isString}}
-              expect(result).toEqual({{{match.value}}});
+              {{#match.isNull}}
+                assert.strictEqual(result, undefined);
+              {{/match.isNull}}
+              {{^match.isNull}}
+                assert.deepStrictEqual(result, {{{match.value}}});
+              {{/match.isNull}}
             {{/match.isString}}
           {{/match.isPrimitive}}
           {{^match.isPrimitive}}
-            expect(result).toEqual({{{match.value}}});
+            assert.deepStrictEqual(result, {{{match.value}}});
           {{/match.isPrimitive}}
         {{/testResponse}}
         {{#shouldScope}} 
diff --git a/templates/javascript/tests/e2e/e2e.mustache b/templates/javascript/tests/e2e/e2e.mustache
@@ -1,9 +1,9 @@
 // {{generationBanner}}
-import { union } from '../helpers';
+import assert from 'node:assert';
+import test, { describe } from 'node:test';
 
-import * as dotenv from 'dotenv';
+import { union } from '../helpers';
 
-dotenv.config({path:'../../.env'});
 import { {{client}} } from '{{{import}}}';
 import type { RequestOptions } from '@algolia/client-common';
 
@@ -28,7 +28,7 @@ describe('{{operationId}}', () => {
     {{#body}}
     const expectedBody = {{{.}}};
 
-    expect(expectedBody).toEqual(union(expectedBody, resp));
+    assert.deepStrictEqual(expectedBody, union(expectedBody, resp));
     {{/body}}
     {{/response}}
   });
diff --git a/templates/javascript/tests/package.mustache b/templates/javascript/tests/package.mustache
@@ -2,7 +2,7 @@
   "name": "javascript-tests",
   "version": "1.0.0",
   "scripts": {
-    "test": "rm -rf dist || true && tsc && jest --passWithNoTests"
+    "test": "rm -rf dist || true && tsc && node --env-file ../../.env --test"
   },
   "dependencies": {
     {{#packageDependencies}}
@@ -13,9 +13,7 @@
   },
   "devDependencies": {
     "@types/jest": "29.5.13",
-    "@types/node": "22.5.1",
-    "jest": "29.7.0",
-    "typescript": "5.5.4",
-    "dotenv": "16.4.5"
+    "@types/node": "22.5.5",
+    "typescript": "5.6.2"
   }
 }
diff --git a/templates/javascript/tests/requests/helpers.mustache b/templates/javascript/tests/requests/helpers.mustache
diff --git a/templates/javascript/tests/requests/requests.mustache b/templates/javascript/tests/requests/requests.mustache
@@ -1,4 +1,9 @@
 // {{generationBanner}}
+import assert from 'node:assert';
+import test, { describe } from 'node:test';
+
+import { union } from '../helpers';
+
 import { {{client}} } from '{{{import}}}';
 import { nodeEchoRequester } from '@algolia/requester-testing';
 import type { EchoResponse } from '@algolia/requester-testing';
@@ -15,22 +20,17 @@ describe('{{operationId}}', () => {
   test('{{{testName}}}', async () => {
     const req = ({{> tests/method}}) as unknown as EchoResponse;
 
-    expect(req.path).toEqual('{{{request.path}}}');
-    expect(req.method).toEqual('{{{request.method}}}');
-    expect(req.data).toEqual({{#request.body}}{{{.}}}{{/request.body}}{{^request.body}}undefined{{/request.body}});
-    expect(req.searchParams).toStrictEqual({{#request.queryParameters}}{{{.}}}{{/request.queryParameters}}{{^request.queryParameters}}undefined{{/request.queryParameters}});
+    assert.strictEqual(req.path, '{{{request.path}}}');
+    assert.strictEqual(req.method, '{{{request.method}}}');
+    assert.deepStrictEqual(req.data, {{#request.body}}{{{.}}}{{/request.body}}{{^request.body}}undefined{{/request.body}});
+    assert.deepStrictEqual(req.searchParams, {{#request.queryParameters}}{{{.}}}{{/request.queryParameters}}{{^request.queryParameters}}undefined{{/request.queryParameters}});
     {{#request.headers}}
-    expect(req.headers).toEqual(
-      expect.objectContaining({{{request.headers}}})
-    );
+    const expectedHeaders = {{{request.headers}}};
+    assert.deepStrictEqual(expectedHeaders, union(expectedHeaders, req.headers));
     {{/request.headers}}
   });
 
   {{/tests}}
 })
 
-{{/blocksRequests}}
-
-{{#isSearchClient}}
-{{> tests/requests/helpers}}
-{{/isSearchClient}}
+{{/blocksRequests}}
diff --git a/tests/output/javascript/tsconfig.json b/tests/output/javascript/tsconfig.json
@@ -2,7 +2,7 @@
   "extends": "../../../config/base.tsconfig.json",
   "compilerOptions": {
     "typeRoots": ["../../../node_modules/@types"],
-    "types": ["node", "jest"],
+    "types": ["node"],
     "lib": ["dom", "esnext"],
     "outDir": "dist"
   },
diff --git a/tests/output/javascript/yarn.lock b/tests/output/javascript/yarn.lock
diff --git a/yarn.lock b/yarn.lock
