mirror of https://github.com/swift-server/swift-aws-lambda-runtime.git synced 2026-05-03 07:22:27 +00:00

Files

T

tomer doron e2ac820289 add an option to start the local debugging server based on an env variable (#87 )

motivation: make using the local debugging server easier to turn off/on without the need to change code when oyu are preparing to deploy

changes:
* add code to lambda so that in debug mode only, if the LOCAL_LAMBDA_SERVER_ENABLED env variable is set the local debugging server is started
* make withLocalServer internal
* update example code

2020-06-01 12:38:06 -07:00

Example.xcworkspace

improve debugging example (#84 )

2020-05-21 09:07:38 -07:00

MyApp

fix example correctness (#90 )

2020-05-28 09:59:56 -07:00

MyLambda

add an option to start the local debugging server based on an env variable (#87 )

2020-06-01 12:38:06 -07:00

Shared

improve debugging example (#84 )

2020-05-21 09:07:38 -07:00

README.md

add an option to start the local debugging server based on an env variable (#87 )

2020-06-01 12:38:06 -07:00

README.md

Local Debugging Example

This sample project demonstrates how to write a simple Lambda function in Swift, and how to use local debugging techniques that emulate how the Lambda function would be invoked by the AWS Lambda Runtime engine.

The example includes three modules:

MyApp is a SwiftUI iOS application that calls the Lambda function.
MyLambda is a SwiftPM executable package for the Lambda function.
Shared is a SwiftPM library package used for shared code between the iOS application and the Lambda function, such as the Request and Response model objects.

The local debugging experience is achieved by running the Lambda function in the context of the debug-only local lambda engine simulator which starts a local HTTP server enabling the communication between the iOS application and the Lambda function over HTTP.

To try out this example, open the workspace in Xcode and "run" the two targets, using the relevant MyLambda and MyApp Xcode schemas.

Start with running the MyLambda target.

Switch to the MyApp scheme and select the "My Mac" destination
Set the LOCAL_LAMBDA_SERVER_ENABLED environment variable to true by editing the MyLambda scheme under Run.
Hit Run
Once it is up you should see a log message in the Xcode console saying LocalLambdaServer started and listening on 127.0.0.1:7000, receiving payloads on /invoke which means the local emulator is up and receiving traffic on port 7000 and expecting payloads on the /invoke endpoint.

Continue to run the MyApp target

Switch to the MyApp scheme and select a simulator destination.
Hit Run
Once up, the application's UI should appear in the simulator allowing you to interact with it.

Once both targets are running, set up breakpoints in the iOS application or Lambda function to observe the system behavior.