chore: add tests for WithTransformation methods

Author: shortcuts

generators/src/main/java/com/algolia/codegen/cts/tests/TestsClient.java

@@ -95,6 +95,13 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
                 stepOut.put("customHosts", step.parameters.get("customHosts"));
               }
 
+              boolean hasTransformationRegion = step.parameters != null && step.parameters.containsKey("transformationRegion");
+              if (hasTransformationRegion) testOut.put("useEchoRequester", false);
+              stepOut.put("hasTransformationRegion", hasTransformationRegion);
+              if (hasTransformationRegion) {
+                stepOut.put("transformationRegion", step.parameters.get("transformationRegion"));
+              }
+
               boolean gzipEncoding = step.parameters != null && step.parameters.getOrDefault("gzip", false).equals(true);
               // many languages don't support gzip yet
               if (

scripts/cts/testServer/index.ts

@@ -13,6 +13,7 @@ import { apiKeyServer } from './apiKey.ts';
 import { benchmarkServer } from './benchmark.ts';
 import { chunkWrapperServer } from './chunkWrapper.ts';
 import { gzipServer } from './gzip.ts';
+import { pushMockServer } from './pushMock.ts';
 import { replaceAllObjectsServer } from './replaceAllObjects.ts';
 import { replaceAllObjectsServerFailed } from './replaceAllObjectsFailed.ts';
 import { replaceAllObjectsScopesServer } from './replaceAllObjectsScopes.ts';
@@ -35,6 +36,7 @@ export async function startTestServer(suites: Record<CTSType, boolean>): Promise
       waitForApiKeyServer(),
       apiKeyServer(),
       algoliaMockServer(),
+      pushMockServer(),
     );
   }
   if (suites.benchmark) {

scripts/cts/testServer/pushMock.ts

@@ -0,0 +1,87 @@
+import type { Server } from 'http';
+
+import { expect } from 'chai';
+import type { Express } from 'express';
+import express from 'express';
+
+import { setupServer } from './index.ts';
+
+const pushMockState: Record<string, any> = {};
+
+export function assertPushMockValid(expectedCount: number): void {
+  if (Object.values(pushMockState).length !== expectedCount) {
+    throw new Error('unexpected number of call to pushMock');
+  }
+  for (const [lang, state] of Object.entries(pushMockState)) {
+    let numberOfTestSuites = 1;
+
+    if (lang === 'python') {
+      numberOfTestSuites = 2;
+    }
+
+    expect(state).to.deep.equal({
+      saveObjectsWithTransformation: Number(numberOfTestSuites),
+      partialUpdateObjectsWithTransformation: Number(numberOfTestSuites),
+    });
+  }
+}
+
+function addRoutes(app: Express): void {
+  app.use(express.urlencoded({ extended: true }));
+  app.use(
+    express.json({
+      type: ['application/json', 'text/plain'], // the js client sends the body as text/plain
+    }),
+  );
+
+  app.post('/1/push/:indexName', (req, res) => {
+    const match = req.params.indexName.match(/^cts_e2e_(\w+)_(.*)$/);
+    const helper = match?.[1] as string;
+    const lang = match?.[2] as string;
+
+    if (!pushMockState[lang]) {
+      pushMockState[lang] = {};
+    }
+
+    pushMockState[lang][helper] = (pushMockState[lang][helper] ?? 0) + 1;
+    switch (helper) {
+      case 'saveObjectsWithTransformation':
+        expect(req.body).to.deep.equal({
+          requests: [
+            { action: 'addObject', body: { objectID: '1', name: 'Adam' } },
+            { action: 'addObject', body: { objectID: '2', name: 'Benoit' } },
+          ],
+        });
+
+        res.json({
+          runID: 'b1b7a982-524c-40d2-bb7f-48aab075abda',
+          eventID: '113b2068-6337-4c85-b5c2-e7b213d82925',
+          message: 'OK',
+          createdAt: '2022-05-12T06:24:30.049Z',
+        });
+
+        break;
+      case 'partialUpdateObjectsWithTransformation':
+        expect(req.body).to.deep.equal({
+          requests: [
+            { action: 'partialUpdateObject', body: { objectID: '1', name: 'Adam' } },
+            { action: 'partialUpdateObject', body: { objectID: '2', name: 'Benoit' } },
+          ],
+        });
+
+        res.json({
+          runID: 'b1b7a982-524c-40d2-bb7f-48aab075abda',
+          eventID: '113b2068-6337-4c85-b5c2-e7b213d82925',
+          message: 'OK',
+          createdAt: '2022-05-12T06:24:30.049Z',
+        });
+        break;
+      default:
+        throw new Error('unknown helper');
+    }
+  });
+}
+
+export function pushMockServer(): Promise<Server> {
+  return setupServer('pushMock', 6689, addRoutes);
+}

templates/javascript/tests/client/createClient.mustache

@@ -17,8 +17,11 @@
       protocol: 'http'
     },
     {{/customHosts}}
-    ]
+    ],
     {{/hasCustomHosts}} 
+    {{#hasTransformationRegion}}
+    transformation: { region : "{{{transformationRegion}}}" },
+    {{/hasTransformationRegion}} 
   }
   {{/isStandaloneClient}}
 ){{^isStandaloneClient}}.{{{initMethod}}}(

tests/CTS/client/search/partialUpdateObjectsWithTransformation.json

@@ -0,0 +1,50 @@
+[
+  {
+    "testName": "call partialUpdateObjectsWithTransformation with createIfNotExists=true",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "customHosts": [
+            {
+              "port": 6689
+            }
+          ],
+          "transformationRegion": "us"
+        }
+      },
+      {
+        "type": "method",
+        "method": "partialUpdateObjectsWithTransformation",
+        "parameters": {
+          "indexName": "cts_e2e_partialUpdateObjectsWithTransformation_${{language}}",
+          "objects": [
+            {
+              "objectID": "1",
+              "name": "Adam"
+            },
+            {
+              "objectID": "2",
+              "name": "Benoit"
+            }
+          ],
+          "createIfNotExists": true
+        },
+        "expected": {
+          "type": "response",
+          "match": [
+            {
+              "runID": "b1b7a982-524c-40d2-bb7f-48aab075abda",
+              "eventID": "113b2068-6337-4c85-b5c2-e7b213d82925",
+              "message": "OK",
+              "createdAt": "2022-05-12T06:24:30.049Z"
+            }
+          ]
+        }
+      }
+    ]
+  }
+]

tests/CTS/client/search/saveObjectsWithTransformation.json

@@ -0,0 +1,49 @@
+[
+  {
+    "testName": "call saveObjectsWithTransformation without error",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "customHosts": [
+            {
+              "port": 6689
+            }
+          ],
+          "transformationRegion": "us"
+        }
+      },
+      {
+        "type": "method",
+        "method": "saveObjectsWithTransformation",
+        "parameters": {
+          "indexName": "cts_e2e_saveObjectsWithTransformation_${{language}}",
+          "objects": [
+            {
+              "objectID": "1",
+              "name": "Adam"
+            },
+            {
+              "objectID": "2",
+              "name": "Benoit"
+            }
+          ]
+        },
+        "expected": {
+          "type": "response",
+          "match": [
+            {
+              "runID": "b1b7a982-524c-40d2-bb7f-48aab075abda",
+              "eventID": "113b2068-6337-4c85-b5c2-e7b213d82925",
+              "message": "OK",
+              "createdAt": "2022-05-12T06:24:30.049Z"
+            }
+          ]
+        }
+      }
+    ]
+  }
+]