test(clients): test more region param and timeouts (#663)

algolia · Jun 10, 2022 · ad27abc · ad27abc
1 parent ed97787
commit ad27abc
Show file tree

Hide file tree

Showing 9 changed files with 218 additions and 10 deletions.
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "build:eslint": "yarn workspace eslint-plugin-automation-custom build && yarn install",
-    "clean": "rm -rf **/dist **/build **/node_modules **/.gradle || true",
+    "clean": "rm -rf **/dist **/build **/node_modules **/.gradle **/vendor || true",
     "cli": "yarn workspace scripts ts-node --transpile-only ./index.ts",
     "docker": "docker exec -it dev yarn cli $*",
     "docker:build": "./scripts/docker/build.sh",

diff --git a/templates/javascript/browser.mustache b/templates/javascript/browser.mustache
@@ -30,15 +30,17 @@ export function {{apiName}}(
     throw new Error("`apiKey` is missing.");
   }
 
-  {{#hasRegionalHost}}{{^fallbackToAliasHost}}
+  {{#hasRegionalHost}}
+  {{^fallbackToAliasHost}}
   if (!region) {
     throw new Error("`region` is missing.");
   }
-
-  if (typeof region !== 'string' || !REGIONS.includes(region)) {
+  {{/fallbackToAliasHost}}
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
     throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
   }
-  {{/fallbackToAliasHost}}{{/hasRegionalHost}}
+  {{/hasRegionalHost}}
 
   return create{{capitalizedApiName}}({
     appId,

diff --git a/templates/javascript/node.mustache b/templates/javascript/node.mustache
@@ -30,15 +30,17 @@ export function {{apiName}}(
     throw new Error("`apiKey` is missing.");
   }
 
-  {{#hasRegionalHost}}{{^fallbackToAliasHost}}
+  {{#hasRegionalHost}}
+  {{^fallbackToAliasHost}}
   if (!region) {
     throw new Error("`region` is missing.");
   }
-
-  if (typeof region !== 'string' || !REGIONS.includes(region)) {
+  {{/fallbackToAliasHost}}
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
     throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
   }
-  {{/fallbackToAliasHost}}{{/hasRegionalHost}}
+  {{/hasRegionalHost}}
 
   return create{{capitalizedApiName}}({
     appId,

diff --git a/tests/CTS/client/abtesting/parameters.json b/tests/CTS/client/abtesting/parameters.json
@@ -24,5 +24,49 @@
         }
       }
     ]
+  },
+  {
+    "testName": "uses the correct region",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "us"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "getABTest",
+        "parameters": {
+          "id": 123
+        },
+        "expected": {
+          "type": "host",
+          "match": "analytics.us.algolia.com"
+        }
+      }
+    ]
+  },
+  {
+    "testName": "throws when incorrect region is given",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "not_a_region"
+        },
+        "expected": {
+          "error": "`region` must be one of the following: de, us"
+        }
+      }
+    ]
   }
 ]
diff --git a/tests/CTS/client/analytics/parameters.json b/tests/CTS/client/analytics/parameters.json
@@ -25,6 +25,50 @@
       }
     ]
   },
+  {
+    "testName": "uses the correct region",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "de"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "post",
+        "parameters": {
+          "path": "/test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "analytics.de.algolia.com"
+        }
+      }
+    ]
+  },
+  {
+    "testName": "throws when incorrect region is given",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "not_a_region"
+        },
+        "expected": {
+          "error": "`region` must be one of the following: de, us"
+        }
+      }
+    ]
+  },
   {
     "testName": "getAverageClickPosition throws without index",
     "steps": [

diff --git a/tests/CTS/client/common/commonApi.json b/tests/CTS/client/common/commonApi.json
@@ -17,7 +17,27 @@
     ]
   },
   {
-    "testName": "calls api with correct timeouts",
+    "testName": "calls api with default read timeouts",
+    "steps": [
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "get",
+        "parameters": {
+          "path": "/test"
+        },
+        "expected": {
+          "type": "timeouts",
+          "match": {
+            "connectTimeout": 2000,
+            "responseTimeout": 5000
+          }
+        }
+      }
+    ]
+  },
+  {
+    "testName": "calls api with default write timeouts",
     "steps": [
       {
         "type": "method",

diff --git a/tests/CTS/client/insights/parameters.json b/tests/CTS/client/insights/parameters.json
@@ -24,5 +24,49 @@
         }
       }
     ]
+  },
+  {
+    "testName": "uses the correct region",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "us"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "del",
+        "parameters": {
+          "path": "/test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "insights.us.algolia.io"
+        }
+      }
+    ]
+  },
+  {
+    "testName": "throws when incorrect region is given",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "my-app-id",
+          "apiKey": "my-api-key",
+          "region": "not_a_region"
+        },
+        "expected": {
+          "error": "`region` must be one of the following: de, us"
+        }
+      }
+    ]
   }
 ]
diff --git a/tests/CTS/client/recommend/api.json b/tests/CTS/client/recommend/api.json
@@ -24,5 +24,31 @@
         }
       }
     ]
+  },
+  {
+    "testName": "calls api with correct write host",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "post",
+        "parameters": {
+          "path": "/test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "test-app-id.algolia.net"
+        }
+      }
+    ]
   }
 ]
diff --git a/tests/CTS/client/search/api.json b/tests/CTS/client/search/api.json
@@ -24,5 +24,31 @@
         }
       }
     ]
+  },
+  {
+    "testName": "calls api with correct write host",
+    "autoCreateClient": false,
+    "steps": [
+      {
+        "type": "createClient",
+        "parameters": {
+          "appId": "test-app-id",
+          "apiKey": "test-api-key"
+        },
+        "expected": {}
+      },
+      {
+        "type": "method",
+        "object": "$client",
+        "path": "post",
+        "parameters": {
+          "path": "/test"
+        },
+        "expected": {
+          "type": "host",
+          "match": "test-app-id.algolia.net"
+        }
+      }
+    ]
   }
 ]