refactor: Region handling and utilizing utility functions for endpoint retrieval

Author: nadeem-cs

packages/contentstack-config/src/utils/region-handler.ts

@@ -16,100 +16,6 @@ function validURL(str) {
   return pattern.test(str);
 }
 
-// Available region list
-const regions = {
-  NA: {
-    name: 'NA',
-    cma: 'https://api.contentstack.io',
-    cda: 'https://cdn.contentstack.io',
-    uiHost: 'https://app.contentstack.com',
-    developerHubUrl: 'https://developerhub-api.contentstack.com',
-    launchHubUrl: 'https://launch-api.contentstack.com',
-    personalizeUrl: 'https://personalize-api.contentstack.com',
-  },
-  'AWS-NA': {
-    name: 'AWS-NA',
-    cma: 'https://api.contentstack.io',
-    cda: 'https://cdn.contentstack.io',
-    uiHost: 'https://app.contentstack.com',
-    developerHubUrl: 'https://developerhub-api.contentstack.com',
-    launchHubUrl: 'https://launch-api.contentstack.com',
-    personalizeUrl: 'https://personalize-api.contentstack.com',
-  },
-  EU: {
-    name: 'EU',
-    cma: 'https://eu-api.contentstack.com',
-    cda: 'https://eu-cdn.contentstack.com',
-    uiHost: 'https://eu-app.contentstack.com',
-    developerHubUrl: 'https://eu-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://eu-launch-api.contentstack.com',
-    personalizeUrl: 'https://eu-personalize-api.contentstack.com',
-  },
-  'AWS-EU': {
-    name: 'AWS-EU',
-    cma: 'https://eu-api.contentstack.com',
-    cda: 'https://eu-cdn.contentstack.com',
-    uiHost: 'https://eu-app.contentstack.com',
-    developerHubUrl: 'https://eu-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://eu-launch-api.contentstack.com',
-    personalizeUrl: 'https://eu-personalize-api.contentstack.com',
-  },
-  AU: {
-    name: 'AU',
-    cma: 'https://au-api.contentstack.com',
-    cda: 'https://au-cdn.contentstack.com',
-    uiHost: 'https://au-app.contentstack.com',
-    developerHubUrl: 'https://au-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://au-launch-api.contentstack.com',
-    personalizeUrl: 'https://au-personalize-api.contentstack.com',
-  },
-  'AWS-AU': {
-    name: 'AWS-AU',
-    cma: 'https://au-api.contentstack.com',
-    cda: 'https://au-cdn.contentstack.com',
-    uiHost: 'https://au-app.contentstack.com',
-    developerHubUrl: 'https://au-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://au-launch-api.contentstack.com',
-    personalizeUrl: 'https://au-personalize-api.contentstack.com',
-  },
-  'AZURE-NA': {
-    name: 'AZURE-NA',
-    cma: 'https://azure-na-api.contentstack.com',
-    cda: 'https://azure-na-cdn.contentstack.com',
-    uiHost: 'https://azure-na-app.contentstack.com',
-    developerHubUrl: 'https://azure-na-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://azure-na-launch-api.contentstack.com',
-    personalizeUrl: 'https://azure-na-personalize-api.contentstack.com',
-  },
-  'AZURE-EU': {
-    name: 'AZURE-EU',
-    cma: 'https://azure-eu-api.contentstack.com',
-    cda: 'https://azure-eu-cdn.contentstack.com',
-    uiHost: 'https://azure-eu-app.contentstack.com',
-    developerHubUrl: 'https://azure-eu-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://azure-eu-launch-api.contentstack.com',
-    personalizeUrl: 'https://azure-eu-personalize-api.contentstack.com',
-  },
-  'GCP-NA': {
-    name: 'GCP-NA',
-    cma: 'https://gcp-na-api.contentstack.com',
-    cda: 'https://gcp-na-cdn.contentstack.com',
-    uiHost: 'https://gcp-na-app.contentstack.com',
-    developerHubUrl: 'https://gcp-na-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://gcp-na-launch-api.contentstack.com',
-    personalizeUrl: 'https://gcp-na-personalize-api.contentstack.com',
-  },
-  'GCP-EU': {
-    name: 'GCP-EU',
-    cma: 'https://gcp-eu-api.contentstack.com',
-    cda: 'https://gcp-eu-cdn.contentstack.com',
-    uiHost: 'https://gcp-eu-app.contentstack.com',
-    developerHubUrl: 'https://gcp-eu-developerhub-api.contentstack.com',
-    launchHubUrl: 'https://gcp-eu-launch-api.contentstack.com',
-    personalizeUrl: 'https://gcp-eu-personalize-api.contentstack.com',
-  },
-};
-
 class UserConfig {
   /**
    *
@@ -118,19 +24,24 @@ class UserConfig {
    * @returns {object} region object with cma, cda, region property
    */
   setRegion(region) {
-    const endpointsObj = Utils.getEndpointsByRegion(region);
-    if (endpointsObj) {
-      const regionObj = {
-        name: region.toUpperCase(),
-        cma: endpointsObj.contentManagement,
-        cda: endpointsObj.contentDelivery,
-        uiHost: endpointsObj.application,
-        developerHubUrl: endpointsObj.developerHub,
-        launchHubUrl: endpointsObj.launch,
-        personalizeUrl: endpointsObj.personalizeManagement,
+    try {
+      const endpointsObj = Utils.getContentstackEndpoint(region);
+      if (endpointsObj) {
+        const regionObj = {
+          name: region.toUpperCase(),
+          cma: endpointsObj.contentManagement,
+          cda: endpointsObj.contentDelivery,
+          uiHost: endpointsObj.application,
+          developerHubUrl: endpointsObj.developerHub,
+          launchHubUrl: endpointsObj.launch,
+          personalizeUrl: endpointsObj.personalizeManagement,
+        }
+        configHandler.set('region', regionObj);
+        return regionObj;
       }
-      configHandler.set('region', regionObj);
-      return regionObj;
+    } catch (error) {
+      // Return undefined for invalid regions
+      return undefined;
     }
   }
 
@@ -144,7 +55,19 @@ class UserConfig {
     if (regionDetails) return regionDetails;
 
     // returns AWS-NA region if not found in config
-    return regions['AWS-NA'];
+    const defaultEndpoints = Utils.getContentstackEndpoint('AWS-NA');
+    if (defaultEndpoints) {
+      return {
+        name: 'AWS-NA',
+        cma: defaultEndpoints.contentManagement,
+        cda: defaultEndpoints.contentDelivery,
+        uiHost: defaultEndpoints.application,
+        developerHubUrl: defaultEndpoints.developerHub,
+        launchHubUrl: defaultEndpoints.launch,
+        personalizeUrl: defaultEndpoints.personalizeManagement,
+      };
+    }
+    throw new TypeError('Region is not set yet, Please set the region first');
   }
 
   /**
@@ -211,7 +134,4 @@ class UserConfig {
   }
 }
 
-// Export the regions object for use in other packages
-export { regions };
-
 export default new UserConfig();

packages/contentstack-config/test/run.test.ts

@@ -1,13 +1,8 @@
 import { join, resolve } from "path";
 import { existsSync, readdirSync } from "fs";
-import filter from "lodash/filter.js";
-import forEach from "lodash/forEach.js";
-import isEmpty from "lodash/isEmpty.js";
-import isArray from "lodash/isArray.js";
-import includes from "lodash/includes.js";
-// @ts-ignore
-import config from "./config.json" with { type: "json" };
+import { filter, forEach, isEmpty, isArray, includes } from "lodash";
 
+const config = require("./config.json");
 const { IS_TS, UNIT_EXECUTION_ORDER, INTEGRATION_EXECUTION_ORDER } = config;
 
 const testFileExtension = IS_TS ? ".ts" : ".js";