Add debugging setup & re-add release optimizations (#12)

Co-authored-by: Joel Scheuner <[email protected]>

Author: dominikschubert

.github/workflows/build.yml

@@ -20,6 +20,8 @@ jobs:
         go-version: '~1.18.2'
 
     - name: Build
+      env:
+        RELEASE_BUILD_LINKER_FLAGS: "-s -w"
       run: make compile-lambda-linux-all
 
     - uses: actions/upload-artifact@v3

Makefile

@@ -5,7 +5,6 @@
 # RELEASE_BUILD_LINKER_FLAGS disables DWARF and symbol table generation to reduce binary size
 #RELEASE_BUILD_LINKER_FLAGS=-s -w
 
-
 BINARY_NAME=aws-lambda-rie
 ARCH=x86_64
 GO_ARCH_x86_64 := amd64
@@ -25,7 +24,7 @@ compile-with-docker:
 	docker run --rm --env GOPROXY=direct -v $(shell pwd):/LambdaRuntimeLocal -w /LambdaRuntimeLocal golang:1.18 make ARCH=${ARCH} compile-lambda-linux
 
 compile-lambda-linux:
-	CGO_ENABLED=0 GOOS=linux GOARCH=${GO_ARCH_${ARCH}} go build -ldflags "${RELEASE_BUILD_LINKER_FLAGS}" -gcflags="all=-N -l" -o ${DESTINATION_${ARCH}} ./cmd/localstack
+	CGO_ENABLED=0 GOOS=linux GOARCH=${GO_ARCH_${ARCH}} go build -ldflags "${RELEASE_BUILD_LINKER_FLAGS}" -gcflags="${GC_FLAGS}" -o ${DESTINATION_${ARCH}} ./cmd/localstack
 
 tests:
 	go test ./...

custom-tests/.gitignore

@@ -0,0 +1,4 @@
+aws-lambda-rie
+build-delve/dlv
+init/var/rapid/init
+init/var/rapid/dlv

custom-tests/Makefile

@@ -0,0 +1,45 @@
+# Golang EOL overview: https://endoflife.date/go
+DOCKER_GOLANG_IMAGE ?= golang:1.18.2
+
+# On ARM hosts, use: make ARCH=arm64 build-init
+# Check host architecture: uname -m
+# x86_64 or arm64
+ARCH ?= x86_64
+
+ifeq ($(ARCH), arm64)
+ GOARCH=arm64
+else
+ GOARCH=amd64
+endif
+
+# Limitation: Debugging x86_64 lambdas does not work on ARM machines due to missing ptrace implementation in qemu used by Docker
+# The function aborts with "could not launch process: fork/exec /var/rapid/init: function not implemented"
+# * Discussion: https://github.com/aws/aws-sam-cli/discussions/4706
+# * Docker for Mac: https://github.com/docker/for-mac/issues/5191#issuecomment-834154431
+
+
+all: build
+
+# build & "package" necessary files for debugging
+build build-init: build-rapid build-delve/dlv
+	cp ../bin/aws-lambda-rie-$(ARCH) ./init/var/rapid/init
+	cp ./build-delve/dlv ./init/var/rapid/dlv
+
+build-rapid:
+	cd .. && GC_FLAGS="all=-N -l" make ARCH=$(ARCH) compile-lambda-linux
+
+build-delve/dlv:
+	docker run --rm -v $$(pwd)/build-delve/:/app/ $(DOCKER_GOLANG_IMAGE) \
+		bash -c "cd /app && export GOARCH=$(GOARCH) && ./build.sh"
+
+clean clean-init: clean-rapid clean-delve
+
+clean-rapid:
+	rm -rf ../bin/aws-lambda-rie-*
+	rm -rf ./init/var/rapid/init
+
+clean-delve:
+	rm -rf ./build-delve/dlv
+	rm -rf ./init/var/rapid/dlv
+
+.PHONY: build build-rapid clean clean-rapid clean-delve

custom-tests/README.md

@@ -0,0 +1,36 @@
+# Testing lambda-runtime-init
+
+## Testing in isolation
+Useful if you want more control over the API between the init and LocalStack (e.g. for error responses)
+
+
+## Debugging with LocalStack
+
+1. Build init via `make build`
+    * On ARM hosts, use `make ARCH=arm64 build`
+
+2. Start LocalStack with the following flags:
+
+    ```
+    LAMBDA_INIT_BIN_PATH=/Users/joe/Projects/LocalStack/lambda-runtime-init/custom-tests/init/var/rapid/init
+    LAMBDA_INIT_BOOTSTRAP_PATH=/Users/joe/Projects/LocalStack/lambda-runtime-init/custom-tests/init/var/rapid/entrypoint.sh
+    LAMBDA_INIT_DEBUG=1
+    LAMBDA_INIT_DELVE_PATH=/Users/joe/Projects/LocalStack/lambda-runtime-init/custom-tests/init/var/rapid/dlv
+    LAMBDA_INIT_DELVE_PORT=40000
+    LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT=3600
+    TEST_DISABLE_RETRIES_AND_TIMEOUTS=1
+    ```
+
+   * `LAMBDA_INIT_DEBUG=1|0` enables or disables RIE copying and debugging.
+   * `LAMBDA_REMOVE_CONTAINERS=0` keeps exited containers
+   * Adjust the path to `lambda-runtime-init` accordingly
+
+3. Start Delve debugger and connect to `localhost:40000`
+
+
+### Advice for function configuration
+
+Within `create_lambda_function`:
+
+* Increase the `timeout=3600`
+* On ARM hosts, use `Architectures=[Architecture.arm64]`

custom-tests/dlv

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+mkdir -p /tmp/build-delve
+cd /tmp/build-delve
+git clone https://github.com/go-delve/delve.git
+cd delve
+make build
+mv dlv /app/dlv

custom-tests/.dockerignore renamed to debugging/.dockerignore

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+LAMBDA_INIT_DELVE_PORT="${LAMBDA_INIT_DELVE_PORT:-40000}"
+
+# Run init without delve debugger
+#exec /var/rapid/init
+
+exec /var/rapid/dlv --listen=:${LAMBDA_INIT_DELVE_PORT} --headless=true --api-version=2 --accept-multiclient exec /var/rapid/init