release/2026-04-03 - Clean up localstack endpoints / env check

server/utils/instanceMgr.js

@@ -7,14 +7,24 @@
  * @property { string | object | function } promanager Return this prop if Rome.
  * @property { string | object | function } imex  Return this prop if Rome.
  */
+const { isString, isEmpty } = require("lodash");
 
-function InstanceManager({ args, instance, debug, executeFunction, rome, promanager, imex }) {
+/**
+ * InstanceManager is a utility function that determines which property to return based on the current instance type.
+ * @param param0
+ * @param param0.args
+ * @param param0.instance
+ * @param param0.debug
+ * @param param0.executeFunction
+ * @param param0.rome
+ * @param param0.promanager
+ * @param param0.imex
+ * @returns {*|null}
+ * @constructor
+ */
+const InstanceManager = ({ args, instance, debug, executeFunction, rome, promanager, imex }) => {
   let propToReturn = null;
 
-  //TODO: Remove after debugging.
-  if (promanager) {
-    console.trace("ProManager Prop was used");
-  }
   switch (instance || process.env.INSTANCE) {
     case "IMEX":
       propToReturn = imex;
@@ -50,15 +60,42 @@ function InstanceManager({ args, instance, debug, executeFunction, rome, promana
   }
   if (executeFunction && typeof propToReturn === "function") return propToReturn(...args);
   return propToReturn === undefined ? null : propToReturn;
-}
+};
 
-exports.InstanceRegion = () =>
+/**
+ * Returns the AWS region to be used for the current instance, which is determined by the INSTANCE environment variable.
+ * @returns {*}
+ * @constructor
+ */
+const InstanceRegion = () =>
   InstanceManager({
     imex: "ca-central-1",
     rome: "us-east-2"
   });
 
-exports.InstanceEndpoints = () =>
+/**
+ * Checks if the instance is configured to use LocalStack by verifying the presence of the LOCALSTACK_HOSTNAME
+ * environment variable.
+ * @returns {boolean}
+ * @constructor
+ */
+const InstanceIsLocalStackEnabled = () =>
+  isString(process.env?.LOCALSTACK_HOSTNAME) && !isEmpty(process.env?.LOCALSTACK_HOSTNAME);
+
+/**
+ * Returns the LocalStack endpoint URL based on the LOCALSTACK_HOSTNAME environment variable.
+ * @returns {`http://${*}:4566`}
+ * @constructor
+ */
+const InstanceLocalStackEndpoint = () => `http://${process.env.LOCALSTACK_HOSTNAME}:4566`;
+
+/**
+ * Returns the appropriate endpoints for the current instance, which can be used for making API calls or other network
+ * requests.
+ * @returns {*|null}
+ * @constructor
+ */
+const InstanceEndpoints = () =>
   InstanceManager({
     imex:
       process.env?.NODE_ENV === "development"
@@ -74,4 +111,11 @@ exports.InstanceEndpoints = () =>
           : "https://romeonline.io"
   });
 
-exports.default = InstanceManager;
+module.exports = {
+  InstanceManager,
+  InstanceRegion,
+  InstanceIsLocalStackEnabled,
+  InstanceLocalStackEndpoint,
+  InstanceEndpoints,
+  default: InstanceManager
+};