Merge pull request #73 from ServerlessLife/additional-node-options

fix: Use NODE_OPTIONS=--enable-source-maps only localy

Author: ServerlessLife

.github/workflows/pull-request.yml

@@ -5,7 +5,7 @@ on:
   # pull_request:
   #   branches:
   #     - main
-  pull_request_target:
+  pull_request_review:
     branches:
       - main
 

.vitepress/config.mts

@@ -74,10 +74,10 @@ export default defineConfig({
           { text: 'CLI Parameters', link: '#cli-parameters' },
           { text: 'Configuration file', link: '#configuration-file' },
           { text: 'Debugging', link: '#debugging' },
+          { text: 'Removing', link: '#removing' },
           { text: 'Development Process', link: '#development-process' },
           { text: 'Observability Mode', link: '#observability-mode' },
           { text: 'Monorepo', link: '#monorepo-setup' },
-          { text: 'Removing', link: '#removing' },
         ],
       },
       {

README.md

@@ -167,21 +167,9 @@ Now, you have to press F5 or press Run -> Start Debugging, and you can set break
 
 For other tools, please send documentation to include here. WebStorm instructions are especially needed.
 
-## Development Process
-
-Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personal environment or an environment created for a feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
-
-## Observability Mode
-
-In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in the development, testing, or even, if you are adventurous, production environment. It samples requests every 3 seconds by default (configurable with an `interval` setting) to avoid overloading the system.
-
-## Monorepo Setup
-
-Set the `subfolder` parameter if your framework is in a subfolder.
-
 ## Removing
 
-To remove Lambda Live Debugger from your AWS account
+When you no longer want to debug and want Lambda to execute the code deployed to the cloud, you need to remove the Lambda Live Debugger:
 
 ```
 lld -r
@@ -195,6 +183,18 @@ To also remove the Layer:
 lld -r=all
 ```
 
+## Development Process
+
+Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personal environment or an environment created for a feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
+
+## Observability Mode
+
+In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in the development, testing, or even, if you are adventurous, production environment. It samples requests every 3 seconds by default (configurable with an `interval` setting) to avoid overloading the system.
+
+## Monorepo Setup
+
+Set the `subfolder` parameter if your framework is in a subfolder.
+
 ## Frameworks
 
 ### AWS CDK v2

package.json

@@ -41,7 +41,7 @@
     "lint": "eslint . --fix",
     "prettier": "prettier . --write",
     "prepare": "husky",
-    "add-bang": "sed -i '1s|^|#!/usr/bin/env node\\n|' ./dist/lldebugger.mjs",
+    "add-bang": "printf '#!/usr/bin/env node\\n%s' \"$(cat ./dist/lldebugger.mjs)\" > ./dist/lldebugger.mjs.tmp && mv ./dist/lldebugger.mjs.tmp ./dist/lldebugger.mjs",
     "build": "tsc -p tsconfig.build.json && cp src/nodeWorkerRunner.mjs dist && cp src/frameworks/cdkFrameworkWorker.mjs dist/frameworks && node fix-imports.js && npm run add-bang && npm run bundle-extension",
     "bundle-extension": "cd src/extension && npm run build && cd ../../",
     "deploy-github-role": "aws cloudformation deploy --stack-name lld-deploy-role --template-file cloudformation/gitHubDeployRole.yaml --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM --profile lldebugger",

src/infraDeploy.ts

@@ -562,7 +562,6 @@ function getEnvironmentVarablesForDebugger(
   return {
     LLD_FUNCTION_ID: functionId,
     AWS_LAMBDA_EXEC_WRAPPER: '/opt/lld-wrapper',
-    NODE_OPTIONS: '--enable-source-maps',
     LLD_DEBUGGER_ID: Configuration.config.debuggerId,
     LLD_INITIAL_TIMEOUT: timeout ? timeout.toString() : '-1', // should never be negative
     LLD_OBSERVABLE_MODE: Configuration.config.observable ? 'true' : 'false',

src/nodeWorker.ts

@@ -34,12 +34,15 @@ async function runInWorker(input: {
     );
 
     if (!worker) {
+      const environment = input.environment;
+      addEnableSourceMapsToEnv(environment);
+
       worker = startWorker({
         handler: func.handler ?? 'handler',
         artifactFile: input.artifactFile,
         workerId: input.fuctionRequest.workerId,
         functionId: input.fuctionRequest.functionId,
-        environment: input.environment,
+        environment,
         verbose: Configuration.config.verbose,
       });
       worker.used = false;
@@ -85,6 +88,20 @@ async function runInWorker(input: {
   });
 }
 
+/**
+ * Add NODE_OPTIONS: --enable-source-maps to the environment variables
+ * @param environment
+ */
+function addEnableSourceMapsToEnv(environment: {
+  [key: string]: string | undefined;
+}) {
+  const nodeOptions = environment.NODE_OPTIONS || '';
+  if (!nodeOptions.includes('--enable-source-maps')) {
+    environment.NODE_OPTIONS =
+      nodeOptions + (nodeOptions ? ' ' : '') + '--enable-source-maps';
+  }
+}
+
 type WorkerRequest = {
   handler: string;
   artifactFile: string;

test/utils/expectInfraDeployed.ts

@@ -15,7 +15,6 @@ export async function expectInfraDeployed(lambdaName: any) {
       LLD_DEBUGGER_ID: expect.any(String),
       LLD_FUNCTION_ID: expect.any(String),
       LLD_INITIAL_TIMEOUT: expect.any(String),
-      NODE_OPTIONS: '--enable-source-maps',
     });
 
     const initialTimeout = parseInt(