fix(javascript): check that appId, apiKey and region are valid parameters (#622)

Author: millotp

templates/javascript/api-single.mustache

@@ -34,7 +34,8 @@ export const apiClientVersion = '{{packageVersion}}';
 {{/description}}
 
 {{#hasRegionalHost}}
-export type Region = {{#allowedRegions}}'{{.}}'{{^-last}}|{{/-last}}{{/allowedRegions}};
+export const REGIONS = [{{#allowedRegions}}'{{.}}'{{^-last}},{{/-last}}{{/allowedRegions}}] as const;
+export type Region = typeof REGIONS[number];
 {{/hasRegionalHost}}
 
 {{^hasRegionalHost}}

templates/javascript/browser.mustache

@@ -6,7 +6,7 @@ import { create{{capitalizedApiName}}, apiClientVersion } from '../src/{{apiName
 import type { {{capitalizedApiName}} } from '../src/{{apiName}}';
 
 {{#hasRegionalHost}}
-import type { Region } from '../src/{{apiName}}';
+import { Region, REGIONS } from '../src/{{apiName}}';
 {{/hasRegionalHost}}
 
 export * from '../src/{{apiName}}';
@@ -16,11 +16,11 @@ export function {{apiName}}(
   apiKey: string,{{#hasRegionalHost}}region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region,{{/hasRegionalHost}}
   options?: InitClientOptions
 ): {{capitalizedApiName}} {
-  if (!appId) {
+  if (!appId || typeof appId !== 'string') {
     throw new Error("`appId` is missing.");
   }
 
-  if (!apiKey) {
+  if (!apiKey || typeof apiKey !== 'string') {
     throw new Error("`apiKey` is missing.");
   }
 
@@ -29,6 +29,9 @@ export function {{apiName}}(
   if (!region) {
     throw new Error("`region` is missing.");
   }
+  if (typeof region !== 'string' || !REGIONS.includes(region)) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
   {{/fallbackToAliasHost}}
   {{/hasRegionalHost}}
 

templates/javascript/node.mustache

@@ -6,7 +6,7 @@ import { create{{capitalizedApiName}} } from '../src/{{apiName}}';
 import type { {{capitalizedApiName}} } from '../src/{{apiName}}';
 
 {{#hasRegionalHost}}
-import type { Region } from '../src/{{apiName}}';
+import { Region, REGIONS } from '../src/{{apiName}}';
 {{/hasRegionalHost}}
 
 export * from '../src/{{apiName}}';
@@ -16,11 +16,11 @@ export function {{apiName}}(
   apiKey: string,{{#hasRegionalHost}}region{{#fallbackToAliasHost}}?{{/fallbackToAliasHost}}: Region,{{/hasRegionalHost}}
   options?: InitClientOptions
 ): {{capitalizedApiName}} {
-  if (!appId) {
+  if (!appId || typeof appId !== 'string') {
     throw new Error("`appId` is missing.");
   }
 
-  if (!apiKey) {
+  if (!apiKey || typeof apiKey !== 'string') {
     throw new Error("`apiKey` is missing.");
   }
 
@@ -29,6 +29,9 @@ export function {{apiName}}(
   if (!region) {
     throw new Error("`region` is missing.");
   }
+  if (typeof region !== 'string' || !REGIONS.includes(region)) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
   {{/fallbackToAliasHost}}
   {{/hasRegionalHost}}
 

tests/CTS/client/personalization/parameters.json

@@ -16,6 +16,23 @@
       }
     ]
   },
+  {
+    "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: eu, us"
+        }
+      }
+    ]
+  },
   {
     "testName": "does not throw when region is given",
     "autoCreateClient": false,

tests/CTS/client/predict/parameters.json

@@ -16,6 +16,23 @@
       }
     ]
   },
+  {
+    "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: ue, ew"
+        }
+      }
+    ]
+  },
   {
     "testName": "does not throw when region is given",
     "autoCreateClient": false,

tests/CTS/client/query-suggestions/parameters.json

@@ -16,6 +16,23 @@
       }
     ]
   },
+  {
+    "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: eu, us"
+        }
+      }
+    ]
+  },
   {
     "testName": "does not throw when region is given",
     "autoCreateClient": false,

tests/CTS/client/sources/parameters.json

@@ -16,6 +16,23 @@
       }
     ]
   },
+  {
+    "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": "does not throw when region is given",
     "autoCreateClient": false,