feat(specs): add CustomFields to CT Source Input (#2742)

Co-authored-by: Pierre Millot <pierre.millot@algolia.com>

.github/workflows/check.yml

@@ -286,7 +286,7 @@ jobs:
           key: node-modules-tests-${{ env.CACHE_VERSION }}-${{ hashFiles('tests/output/javascript/yarn.lock') }}
 
       - name: Run CTS
-        run: yarn cli cts run javascript
+        run: yarn cli cts run javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
       - name: Generate code snippets for documentation
         run: yarn cli snippets javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
@@ -372,7 +372,7 @@ jobs:
         run: yarn cli cts generate ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
       - name: Run CTS
-        run: yarn cli cts run ${{ matrix.client.language }}
+        run: yarn cli cts run ${{ matrix.client.language }} ${{ matrix.client.toRun }}
 
       - name: Generate code snippets for documentation
         run: yarn cli snippets ${{ matrix.client.language }} ${{ matrix.client.toRun }}

scripts/cli/index.ts

@@ -124,16 +124,17 @@ ctsCommand
   .command('run')
   .description('Run the tests for the CTS')
   .addArgument(args.language)
+  .addArgument(args.clients)
   .option(flags.verbose.flag, flags.verbose.description)
-  .action(async (langArg: LangArg, { verbose }) => {
-    const { language } = transformSelection({
+  .action(async (langArg: LangArg, clientArg: string[], { verbose }) => {
+    const { language, clientList } = transformSelection({
       langArg,
-      clientArg: [ALL],
+      clientArg,
     });
 
     setVerbose(Boolean(verbose));
 
-    await runCts(language === ALL ? LANGUAGES : [language]);
+    await runCts(language === ALL ? LANGUAGES : [language], clientList);
   });
 
 ctsCommand

scripts/cts/runCts.ts

@@ -2,6 +2,7 @@ import * as fsp from 'fs/promises';
 
 import { run, runComposerInstall, toAbsolutePath } from '../common.js';
 import { createSpinner } from '../spinners.js';
+import type { Language } from '../types.js';
 
 import { getTimeoutCounter, startTestServer } from './testServer.js';
 
@@ -70,16 +71,24 @@ async function runCtsOne(language: string): Promise<void> {
   spinner.succeed();
 }
 
-export async function runCts(languages: string[]): Promise<void> {
-  const close = await startTestServer();
-
+// the clients option is only used to determine if we need to start the test server, it will run the tests for all clients anyway.
+export async function runCts(languages: Language[], clients: string[]): Promise<void> {
+  const useTestServer = clients.includes('search');
+  let close: () => Promise<void> = async () => {};
+  if (useTestServer) {
+    close = await startTestServer();
+  }
   for (const lang of languages) {
     await runCtsOne(lang);
   }
 
-  await close();
+  if (useTestServer) {
+    await close();
 
-  if (languages.length !== getTimeoutCounter()) {
-    throw new Error(`Expected ${languages.length} timeout(s), got ${getTimeoutCounter()} instead.`);
+    if (languages.length !== getTimeoutCounter()) {
+      throw new Error(
+        `Expected ${languages.length} timeout(s), got ${getTimeoutCounter()} instead.`
+      );
+    }
   }
 }

specs/ingestion/common/schemas/source.yml

@@ -120,12 +120,35 @@ SourceCommercetools:
       default: true
       description: >
         Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
+    customFields:
+      $ref: '#/CommercetoolsCustomFields'
   required:
     - url
     - projectKey
   x-discriminator-fields:
     - projectKey
 
+CommercetoolsCustomFields:
+  type: object
+  additionalProperties: false
+  description: Custom fields from Commercetools to index in the records (see https://docs.commercetools.com/tutorials/custom-types).
+  properties:
+    inventory:
+      type: array
+      items:
+        type: string
+      description: Inventory custom fields.
+    price:
+      type: array
+      items:
+        type: string
+      description: Price custom fields.
+    category:
+      type: array
+      items:
+        type: string
+      description: Category custom fields.
+
 SourceBigCommerce:
   type: object
   additionalProperties: false
@@ -347,6 +370,8 @@ SourceUpdateCommercetools:
         Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example ["fr-FR", "en"].
       items:
         type: string
+    customFields:
+      $ref: '#/CommercetoolsCustomFields'
 
 SourceUpdateInput:
   oneOf: