Support for LocalStack

Author: ServerlessLife

.github/workflows/common-test.yml

@@ -53,3 +53,13 @@ jobs:
     with:
       mode: build
       testMonorepo: false
+      useLocalStack: false
+
+  test-localstack:
+    uses: ./.github/workflows/common-test.yml
+    secrets: inherit
+    needs: remove-old-layers
+    with:
+      mode: build
+      testMonorepo: false
+      useLocalStack: true

.github/workflows/pull-request.yml

@@ -19,6 +19,16 @@ jobs:
       mode: global
       testMonorepo: false
       version: ${{ inputs.version }}
+      useLocalStack: false
+    secrets: inherit
+
+  test-global-not-monorepo-localstack:
+    uses: ./.github/workflows/common-test.yml
+    with:
+      mode: global
+      testMonorepo: false
+      version: ${{ inputs.version }}
+      useLocalStack: true
     secrets: inherit
 
   test-local-not-monorepo:
@@ -28,6 +38,17 @@ jobs:
       mode: local
       testMonorepo: false
       version: ${{ inputs.version }}
+      useLocalStack: false
+    secrets: inherit
+
+  test-local-not-monorepo-localstack:
+    needs: test-global-not-monorepo
+    uses: ./.github/workflows/common-test.yml
+    with:
+      mode: local
+      testMonorepo: false
+      version: ${{ inputs.version }}
+      useLocalStack: true
     secrets: inherit
 
   test-global-monorepo:
@@ -37,6 +58,17 @@ jobs:
       mode: global
       testMonorepo: true
       version: ${{ inputs.version }}
+      useLocalStack: false
+    secrets: inherit
+
+  test-global-monorepo-localstack:
+    needs: test-local-not-monorepo
+    uses: ./.github/workflows/common-test.yml
+    with:
+      mode: global
+      testMonorepo: true
+      version: ${{ inputs.version }}
+      useLocalStack: true
     secrets: inherit
 
   test-local-monorepo:
@@ -46,4 +78,15 @@ jobs:
       mode: local
       testMonorepo: true
       version: ${{ inputs.version }}
+      useLocalStack: false
+    secrets: inherit
+
+  test-local-monorepo-localstack:
+    needs: test-global-monorepo
+    uses: ./.github/workflows/common-test.yml
+    with:
+      mode: local
+      testMonorepo: true
+      version: ${{ inputs.version }}
+      useLocalStack: true
     secrets: inherit

.github/workflows/test-with-real-npm-all.yml

@@ -16,6 +16,10 @@ on:
         description: 'Test monorepo by specifying folder in config'
         type: boolean
         default: false
+      useLocalStack:
+        description: 'Use LocalStack instead of AWS'
+        type: boolean
+        default: false
       version:
         description: 'Specify the version of the package'
         type: string
@@ -32,4 +36,5 @@ jobs:
       mode: ${{ inputs.mode }}
       testMonorepo: ${{ inputs.testMonorepo }}
       version: ${{ inputs.version }}
+      useLocalStack: ${{ inputs.useLocalStack }}
     secrets: inherit

.github/workflows/test-with-real-npm.yml

@@ -17,6 +17,50 @@ function getCredentialsProvider(
   });
 }
 
+/**
+ * Detects if LocalStack is being used by making a test request and checking for
+ * the 'x-localstack' header in the response.
+ * @see {@link https://github.com/localstack/localstack/pull/12769}
+ * @param awsConfiguration - AWS configuration to use for the test request
+ * @returns true if LocalStack is detected (x-localstack header present), false otherwise
+ */
+async function isLocalStackDetected(
+  awsConfiguration: AwsConfiguration,
+): Promise<boolean> {
+  // Enable LocalStack response header to detect LocalStack
+  process.env.LOCALSTACK_RESPONSE_HEADER_ENABLED = 'true';
+
+  const { STSClient, GetCallerIdentityCommand } = await import(
+    '@aws-sdk/client-sts'
+  );
+
+  const client = new STSClient({
+    region: awsConfiguration.region,
+    credentials: fromNodeProviderChain({
+      clientConfig: { region: awsConfiguration.region },
+      profile: awsConfiguration.profile,
+      roleArn: awsConfiguration.role,
+    }),
+  });
+
+  const command = new GetCallerIdentityCommand({});
+  const response = await client.send(command);
+
+  // Check for x-localstack header in response metadata
+  const headers = (response.$metadata as any)?.httpHeaders;
+  if (
+    headers &&
+    ('x-localstack' in headers ||
+      'X-Localstack' in headers ||
+      'X-LOCALSTACK' in headers)
+  ) {
+    return true;
+  }
+
+  return false;
+}
+
 export const AwsCredentials = {
   getCredentialsProvider,
+  isLocalStackDetected,
 };

src/awsCredentials.ts

@@ -9,6 +9,7 @@ import { getConfigTsFromConfigFile } from './configuration/getConfigFromTsConfig
 import { configFileDefaultName } from './constants.js';
 import { ResourceDiscovery } from './resourceDiscovery.js';
 import { Logger } from './logger.js';
+import { AwsCredentials } from './awsCredentials.js';
 
 let config: LldConfig;
 const lambdas: Record<string, LambdaResource> = {};
@@ -41,9 +42,15 @@ async function readConfig() {
     });
 
     const debuggerId = await generateDebuggerId(!!configFromWizard.observable);
+    const localStack = await AwsCredentials.isLocalStackDetected({
+      profile: configFromWizard.profile,
+      region: configFromWizard.region,
+      role: configFromWizard.role,
+    });
     setConfig({
       ...configFromWizard,
       debuggerId,
+      localStack,
       start: false, // don't start the debugger after the wizard
     });
   } else {
@@ -63,9 +70,15 @@ async function readConfig() {
           : configFromConfigFile?.context,
     };
     const debuggerId = await generateDebuggerId(!!configMerged.observable);
+    const localStack = await AwsCredentials.isLocalStackDetected({
+      profile: configMerged.profile,
+      region: configMerged.region,
+      role: configMerged.role,
+    });
     setConfig({
       ...configMerged,
       debuggerId,
+      localStack,
       start: true,
     });
   }

src/configuration.ts

@@ -1061,6 +1061,11 @@ function getEnvironmentVariablesForDebugger({
     env.LLD_VERBOSE = 'true';
   }
 
+  // Disable TLS verification for LocalStack
+  if (Configuration.config.localStack) {
+    env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+  }
+
   return env;
 }
 

src/infraDeploy.ts

@@ -122,12 +122,19 @@ async function connect(props?: {
     credentials,
   });
 
+  let region = props?.region;
+
+  if (!region && process.env.NODE_TLS_REJECT_UNAUTHORIZED === '0') {
+    // it is localstack
+    region = process.env.AWS_REGION ?? 'us-east-1';
+  }
+
   device = new iot.device({
     protocol: 'wss',
     host: endpoint,
     reconnectPeriod: 1,
     keepalive: 60,
-    region: props?.region,
+    region,
     accessKeyId: credentials?.accessKeyId,
     secretKey: credentials?.secretAccessKey,
     sessionToken: credentials?.sessionToken,

src/ioTService.ts

@@ -55,6 +55,11 @@ async function run() {
     return;
   }
 
+  if (Configuration.config.localStack) {
+    //https://github.com/localstack/localstack/issues/13308
+    process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+  }
+
   let message = `Starting the debugger ${
     Configuration.config.observable
       ? 'in Observability mode'

src/lldebugger.ts

@@ -91,4 +91,11 @@ export type LldConfigCliArgs = {
 
 export type LldConfigTs = Partial<LldConfigBase>;
 
-export type LldConfig = LldConfigCliArgs & LldConfigTs & { debuggerId: string };
+export type LldConfig = LldConfigCliArgs &
+  LldConfigTs & {
+    debuggerId: string;
+    /**
+     * Indicates whether LocalStack is being used instead of real AWS services.
+     */
+    localStack: boolean;
+  };