KMS-565: Add LocalStack and Offline Lambda Support for Local Development #74

htranho · 2025-08-27T18:10:40Z

Overview

What is the feature?

Add LocalStack and Offline Lambda Support for Local Development

What is the Solution?

Add LocalStack and Offline Lambda Support for Local Development

What areas of the application does this impact?

Application run in local mode.

Testing

To startup rdf4j, cdk synth and sam client: 'npm run start-local'
Test all interfaces listed (http://localhost:3013/), specially the write interfaces, for example create a new scheme. Local mode should not required token.

Attachments

N/A

Checklist

I have added automated tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings

codecov-commenter · 2025-08-27T19:11:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (KMS-570@956a3fe). Learn more about missing BASE report.

Additional details and impacted files

@@            Coverage Diff             @@
##             KMS-570      #74   +/-   ##
==========================================
  Coverage           ?   99.57%           
==========================================
  Files              ?      139           
  Lines              ?     2333           
  Branches           ?      571           
==========================================
  Hits               ?     2323           
  Misses             ?        9           
  Partials           ?        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

cgokey · 2025-08-27T19:30:39Z

README.md

+To run cdk synth:
 ```
-CMR_BASE_URL=https://cmr.earthdata.nasa.gov RDF4J_SERVICE_URL=http://localhost:8080 npm run offline
+npm run run-synth


is this needed if you are doing it below: cdk synth --context useLocalstack=true --output ./cdk.out > /dev/null 2>&1

right, that is not needed because included in 'npm run start-local'. Is there a use case for just run 'cdk synth'?

Done, removed that instruction.

cgokey · 2025-08-27T19:31:53Z

bin/start-local.sh

+npm run rdf4j:start
+# Wait for rdf4j server to start
+sleep 10
+npm run rdf4j:setup


I don't think starting the db should be part of start-local. You might want to start-local multiple times and keep the data in the rdfdb.

Done, removed steps to startup and setup rdf4j.

cgokey · 2025-08-27T19:46:10Z

cdk/app/lib/helper/KmsLambdaFunctions.ts

 import * as iam from 'aws-cdk-lib/aws-iam'
 import * as lambda from 'aws-cdk-lib/aws-lambda'
-import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs'
+import * as nodejsLambda from 'aws-cdk-lib/aws-lambda-nodejs'


I think you can also do:
import { NodejsFunction, NodejsFunctionProps } from 'aws-cdk-lib/aws-lambda-nodejs'
which I think it preferred way of doing it.

cgokey · 2025-08-27T19:47:22Z

cdk/app/lib/helper/KmsLambdaFunctions.ts

-      })
+        environment: this.props.environment,
+        // Conditionally add VPC configuration
+        ...(this.props.useLocalstack ? {} : {


destructure useLocalstack from props

cgokey · 2025-08-27T19:47:36Z

cdk/app/lib/helper/KmsLambdaFunctions.ts

    scope: Construct,
    authorizerLambda: lambda.Function
  ): apigateway.IAuthorizer {
+    if (this.props.useLocalstack) {


destructure

mandyparson · 2025-08-28T16:23:17Z

cdk/bin/main.ts

-    account: process.env.CDK_DEFAULT_ACCOUNT,
-    region: process.env.CDK_DEFAULT_REGION
-  }
+  const useLocalstack = app.node.tryGetContext('useLocalstack') === 'true'


const useLocalstack = app.node.tryGetContext('useLocalstack')

That would not work in case user wanted useLocalstack to be false. So I fix this way and checked in:
keep 'const useLocalstack = app.node.tryGetContext('useLocalstack') === 'true' '
but in the start-local.sh change to 'cdk synth --context useLocalstack='true' --output ./cdk.out > /dev/null 2>&1'

it was 'cdk synth --context useLocalstack=true --output ./cdk.out > /dev/null 2>&1'

eudoroolivares2016 · 2025-08-28T17:13:22Z

So we'll want npm install aws-cdk --save-dev that will add the cdk lib to the dev dependencies which will allow us to build the template file/cdk.out directory

htranho · 2025-08-28T18:37:25Z

So we'll want npm install aws-cdk --save-dev that will add the cdk lib to the dev dependencies which will allow us to build the template file/cdk.out directory

Done.

htranho added 3 commits August 26, 2025 19:13

KMS-565: Initial checkin

e730a2b

KMS-565: Add authorization case for local stack

624c4e4

KMS-565: Remove un-used file

50a01a9

htranho marked this pull request as draft August 27, 2025 18:11

htranho added 2 commits August 27, 2025 14:23

KMS-565: Fix some variable declarations

541830b

KMS-565: Fix lint issues found

65ff3cb

cgokey reviewed Aug 27, 2025

View reviewed changes

htranho added 2 commits August 27, 2025 15:39

KMS-565: Remove step 'cdk synth' from readme file

f565f86

KMS-565: Remove steps to start and setup rdf4j

e859e38

cgokey reviewed Aug 27, 2025

View reviewed changes

htranho added 2 commits August 27, 2025 16:02

KMS-565: Use of import, destruct useLocalstack

04f4203

KMS-565: Fix lint

77156c5

cgokey approved these changes Aug 27, 2025

View reviewed changes

htranho marked this pull request as ready for review August 27, 2025 20:12

htranho requested review from dpesall, eudoroolivares2016, macrouch and mandyparson August 27, 2025 20:13

mandyparson reviewed Aug 28, 2025

View reviewed changes

htranho added 2 commits August 28, 2025 13:31

KMS-565: Fix value of variable useLocalstack

e252b6d

KMS-565: Install aws-cdk into dev dependency

49454aa

htranho added 2 commits August 28, 2025 16:33

KMS-565: Use double quotes for useLocalstack value

fa174e7

KMS-565: Use docker network name

7c77db9

mandyparson approved these changes Sep 2, 2025

View reviewed changes

htranho merged commit 2001257 into KMS-570 Sep 2, 2025
6 checks passed

htranho deleted the KMS-565 branch September 2, 2025 21:39

KMS-565: Add LocalStack and Offline Lambda Support for Local Development #74

KMS-565: Add LocalStack and Offline Lambda Support for Local Development #74

Uh oh!

Conversation

htranho commented Aug 27, 2025

Overview

What is the feature?

What is the Solution?

What areas of the application does this impact?

Testing

Attachments

Checklist

Uh oh!

codecov-commenter commented Aug 27, 2025

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cgokey Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eudoroolivares2016 commented Aug 28, 2025

Uh oh!

htranho commented Aug 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cgokey Aug 27, 2025 •

edited

Loading