feat(commons): environment variable helpers (#3945)

Author: dreamorosi

packages/commons/package.json

@@ -53,6 +53,10 @@
       "import": "./lib/esm/unmarshallDynamoDB.js",
       "require": "./lib/cjs/unmarshallDynamoDB.js"
     },
+    "./utils/env": {
+      "import": "./lib/esm/envUtils.js",
+      "require": "./lib/cjs/envUtils.js"
+    },
     "./types": {
       "import": "./lib/esm/types/index.js",
       "require": "./lib/cjs/types/index.js"
@@ -76,6 +80,10 @@
         "lib/cjs/unmarshallDynamoDB.d.ts",
         "lib/esm/unmarshallDynamoDB.d.ts"
       ],
+      "utils/env": [
+        "lib/cjs/envUtils.d.ts",
+        "lib/esm/envUtils.d.ts"
+      ],
       "types": [
         "lib/cjs/types/index.d.ts",
         "lib/esm/types/index.d.ts"

packages/commons/src/config/EnvironmentVariablesService.ts

@@ -1,3 +1,9 @@
+import {
+  getServiceName,
+  getXRayTraceIdFromEnv,
+  isDevMode,
+  isRequestXRaySampled,
+} from '../envUtils.js';
 import type { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 
 /**
@@ -46,7 +52,7 @@ class EnvironmentVariablesService implements ConfigServiceInterface {
    * Get the value of the `POWERTOOLS_SERVICE_NAME` environment variable.
    */
   public getServiceName(): string {
-    return this.get(this.serviceNameVariable);
+    return getServiceName();
   }
 
   /**
@@ -58,9 +64,7 @@ class EnvironmentVariablesService implements ConfigServiceInterface {
    * The actual Trace ID is: `1-5759e988-bd862e3fe1be46a994272793`.
    */
   public getXrayTraceId(): string | undefined {
-    const xRayTraceData = this.getXrayTraceData();
-
-    return xRayTraceData?.Root;
+    return getXRayTraceIdFromEnv();
   }
 
   /**
@@ -70,16 +74,14 @@ class EnvironmentVariablesService implements ConfigServiceInterface {
    * `Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1`,
    */
   public getXrayTraceSampled(): boolean {
-    const xRayTraceData = this.getXrayTraceData();
-
-    return xRayTraceData?.Sampled === '1';
+    return isRequestXRaySampled();
   }
 
   /**
    * Determine if the current invocation is running in a development environment.
    */
   public isDevMode(): boolean {
-    return this.isValueTrue(this.get(this.devModeVariable));
+    return isDevMode();
   }
 
   /**
@@ -103,29 +105,6 @@ class EnvironmentVariablesService implements ConfigServiceInterface {
 
     return falsyValues.includes(value.toLowerCase());
   }
-
-  /**
-   * Get the AWS X-Ray Trace data from the environment variable.
-   *
-   * The method parses the environment variable `_X_AMZN_TRACE_ID` and returns an object with the key-value pairs.
-   */
-  private getXrayTraceData(): Record<string, string> | undefined {
-    const xRayTraceEnv = this.get(this.xRayTraceIdVariable);
-
-    if (xRayTraceEnv === '') return undefined;
-
-    if (!xRayTraceEnv.includes('=')) return { Root: xRayTraceEnv };
-
-    const xRayTraceData: Record<string, string> = {};
-
-    for (const field of xRayTraceEnv.split(';')) {
-      const [key, value] = field.split('=');
-
-      xRayTraceData[key] = value;
-    }
-
-    return xRayTraceData;
-  }
 }
 
 export { EnvironmentVariablesService };

packages/commons/src/constants.ts

@@ -0,0 +1,9 @@
+const POWERTOOLS_DEV_ENV_VAR = 'POWERTOOLS_DEV' as const;
+const POWERTOOLS_SERVICE_NAME_ENV_VAR = 'POWERTOOLS_SERVICE_NAME' as const;
+const XRAY_TRACE_ID_ENV_VAR = '_X_AMZN_TRACE_ID' as const;
+
+export {
+  POWERTOOLS_DEV_ENV_VAR,
+  POWERTOOLS_SERVICE_NAME_ENV_VAR,
+  XRAY_TRACE_ID_ENV_VAR,
+};