fix(clients): retry strategy on error

Author: shortcuts

scripts/cts/runCts.ts

@@ -8,6 +8,7 @@ import type { Language } from '../types.ts';
 import { assertValidAccountCopyIndex } from './testServer/accountCopyIndex.ts';
 import { printBenchmarkReport } from './testServer/benchmark.ts';
 import { assertChunkWrapperValid } from './testServer/chunkWrapper.ts';
+import { assertValidErrors } from './testServer/error.ts';
 import { startTestServer } from './testServer/index.ts';
 import { assertPushMockValid } from './testServer/pushMock.ts';
 import { assertValidReplaceAllObjects } from './testServer/replaceAllObjects.ts';
@@ -152,6 +153,7 @@ export async function runCts(
     const skip = (lang: Language): number => (languages.includes(lang) ? 1 : 0);
     const only = skip;
 
+    assertValidErrors(languages.length);
     assertValidTimeouts(languages.length);
     assertChunkWrapperValid(languages.length - skip('dart'));
     assertValidReplaceAllObjects(languages.length - skip('dart'));

scripts/cts/testServer/error.ts

@@ -0,0 +1,59 @@
+import type { Server } from 'http';
+
+import { expect } from 'chai';
+import type express from 'express';
+
+import { setupServer } from './index.ts';
+
+const errorState: Record<string, { errorCount: number }> = {};
+
+export function assertValidErrors(expectedCount: number): void {
+  // assert that the retry strategy uses the correct timings, by checking the time between each request, and how long each request took before being timed out
+  // there should be no delay between requests, only an increase in error.
+  if (Object.keys(errorState).length !== expectedCount) {
+    throw new Error(`Expected ${expectedCount} error(s)`);
+  }
+
+  for (const [lang, state] of Object.entries(errorState)) {
+    let numberOfTestSuites = 1;
+
+    // python has sync and async tests
+    if (lang === 'python') {
+      numberOfTestSuites = 2;
+    }
+
+    expect(state.errorCount).to.equal(Number(numberOfTestSuites) * 3);
+  }
+}
+
+function addRoutes(app: express.Express): void {
+  app.post('/1/test/error/:lang', (req, res) => {
+    const lang = req.params.lang;
+    if (!errorState[lang]) {
+      errorState[lang] = {
+        errorCount: 0,
+      };
+    }
+
+    errorState[lang].errorCount++;
+
+    if (errorState[lang].errorCount < 3) {
+      res.status(500).json({ message: 'error test server response' });
+      return;
+    }
+
+    res.status(200).json({ status: 'ok' });
+  });
+}
+
+export function errorServer(): Promise<Server> {
+  return setupServer('error', 6671, addRoutes);
+}
+
+export function errorServerRetriedOnce(): Promise<Server> {
+  return setupServer('errorRetriedOnce', 6672, addRoutes);
+}
+
+export function errorServerRetriedTwice(): Promise<Server> {
+  return setupServer('errorRetriedTwice', 6673, addRoutes);
+}

scripts/cts/testServer/index.ts

@@ -12,6 +12,7 @@ import { algoliaMockServer } from './algoliaMock.ts';
 import { apiKeyServer } from './apiKey.ts';
 import { benchmarkServer } from './benchmark.ts';
 import { chunkWrapperServer } from './chunkWrapper.ts';
+import { errorServer, errorServerRetriedOnce, errorServerRetriedTwice } from './error.ts';
 import { gzipServer } from './gzip.ts';
 import { pushMockServer } from './pushMock.ts';
 import { replaceAllObjectsServer } from './replaceAllObjects.ts';
@@ -27,6 +28,9 @@ export async function startTestServer(suites: Record<CTSType, boolean>): Promise
   if (suites.client) {
     toStart.push(
       timeoutServer(),
+      errorServer(),
+      errorServerRetriedOnce(),
+      errorServerRetriedTwice(),
       gzipServer(),
       timeoutServerBis(),
       accountCopyIndexServer(),

scripts/cts/testServer/replaceAllObjectsWithTransformation.ts

@@ -88,7 +88,6 @@ function addRoutes(app: Express): void {
       case 'move': {
         const lang = req.body.destination.replace('cts_e2e_replace_all_objects_with_transformation_', '');
         expect(raowtState).to.include.keys(lang);
-        console.log(raowtState[lang]);
         expect(raowtState[lang]).to.deep.equal({
           copyCount: 2,
           pushCount: 4,

tests/CTS/client/search/api.json

@@ -109,7 +109,7 @@
     ]
   },
   {
-    "testName": "tests the retry strategy error",
+    "testName": "tests the retry strategy on timeout",
     "autoCreateClient": false,
     "steps": [
       {
@@ -148,6 +148,43 @@
       }
     ]
   },
+  {
+    "testName": "tests the retry strategy on 5xx",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key",
+          "customHosts": [
+            {
+              "port": 6671
+            },
+            {
+              "port": 6672
+            },
+            {
+              "port": 6673
+            }
+          ]
+        }
+      },
+      {
+        "type": "method",
+        "method": "customPost",
+        "parameters": {
+          "path": "1/test/error/${{language}}"
+        },
+        "expected": {
+          "type": "response",
+          "match": {
+            "status": "ok"
+          }
+        }
+      }
+    ]
+  },
   {
     "testName": "test the compression strategy",
     "autoCreateClient": false,