Enabling local invoke debug mode for java8 and all nodejs runtimes #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,10 +25,13 @@ import ( | |
| "github.com/docker/docker/pkg/jsonmessage" | ||
| "github.com/docker/docker/pkg/stdcopy" | ||
| "github.com/docker/docker/pkg/term" | ||
| "github.com/docker/go-connections/nat" | ||
| "github.com/fatih/color" | ||
| "github.com/imdario/mergo" | ||
| "github.com/mattn/go-colorable" | ||
| "github.com/pkg/errors" | ||
| "os/signal" | ||
| "syscall" | ||
| ) | ||
|
|
||
| // Invoker is a simple interface to help with testing runtimes | ||
|
|
@@ -45,6 +48,7 @@ type Runtime struct { | |
| Cwd string | ||
| Function resources.AWSServerlessFunction | ||
| EnvVarOverrides map[string]string | ||
| DebugPort string | ||
| Context context.Context | ||
| Client *client.Client | ||
| TimeoutTimer *time.Timer | ||
|
|
@@ -59,20 +63,43 @@ var ( | |
| ErrRuntimeNotSupported = errors.New("unsupported runtime") | ||
| ) | ||
|
|
||
| var runtimeName = struct { | ||
| nodejs string | ||
| nodejs43 string | ||
| nodejs610 string | ||
| python27 string | ||
| python36 string | ||
| java8 string | ||
| }{ | ||
| nodejs: "nodejs", | ||
| nodejs43: "nodejs4.3", | ||
| nodejs610: "nodejs6.10", | ||
| python27: "python2.7", | ||
| python36: "python3.6", | ||
| java8: "java8", | ||
| } | ||
|
|
||
| var runtimeImageFor = map[string]string{ | ||
| runtimeName.nodejs: "lambci/lambda:nodejs", | ||
| runtimeName.nodejs43: "lambci/lambda:nodejs4.3", | ||
| runtimeName.nodejs610: "lambci/lambda:nodejs6.10", | ||
| runtimeName.python27: "lambci/lambda:python2.7", | ||
| runtimeName.python36: "lambci/lambda:python3.6", | ||
| runtimeName.java8: "lambci/lambda:java8", | ||
| } | ||
|
|
||
| // NewRuntimeOpt contains parameters that are passed to the NewRuntime method | ||
| type NewRuntimeOpt struct { | ||
| Function resources.AWSServerlessFunction | ||
| EnvVarsOverrides map[string]string | ||
| Basedir string | ||
| DebugPort string | ||
| } | ||
|
|
||
| // NewRuntime instantiates a Lambda runtime container | ||
| func NewRuntime(opt NewRuntimeOpt) (Invoker, error) { | ||
| // Determine which docker image to use for the provided runtime | ||
| image, found := runtimeImageFor[opt.Function.Runtime()] | ||
| if !found { | ||
| return nil, ErrRuntimeNotSupported | ||
| } | ||
|
|
@@ -82,17 +109,18 @@ func NewRuntime(basedir string, function resources.AWSServerlessFunction, envVar | |
| return nil, err | ||
| } | ||
|
|
||
| cwd, err := getWorkingDir(opt.Basedir, opt.Function.CodeURI().String()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| r := &Runtime{ | ||
| Name: opt.Function.Runtime(), | ||
| Cwd: cwd, | ||
| Image: image, | ||
| Function: opt.Function, | ||
| EnvVarOverrides: opt.EnvVarsOverrides, | ||
| DebugPort: opt.DebugPort, | ||
| Context: context.Background(), | ||
| Client: cli, | ||
| } | ||
|
|
@@ -107,7 +135,7 @@ func NewRuntime(basedir string, function resources.AWSServerlessFunction, envVar | |
| return nil, err | ||
| } | ||
|
|
||
| log.Printf("Fetching %s image for %s runtime...\n", r.Image, opt.Function.Runtime()) | ||
| progress, err := cli.ImagePull(r.Context, r.Image, types.ImagePullOptions{}) | ||
| if len(images) < 0 && err != nil { | ||
| log.Fatalf("Could not fetch %s Docker image\n%s", r.Image, err) | ||
|
|
@@ -176,6 +204,7 @@ func (r *Runtime) getHostConfig() (*container.HostConfig, error) { | |
| Binds: []string{ | ||
| fmt.Sprintf("%s:/var/task:ro", r.Cwd), | ||
| }, | ||
| PortBindings: r.getDebugPortBindings(), | ||
| } | ||
| if err := overrideHostConfig(host); err != nil { | ||
| log.Print(err) | ||
|
|
@@ -184,9 +213,9 @@ func (r *Runtime) getHostConfig() (*container.HostConfig, error) { | |
| return host, nil | ||
| } | ||
|
|
||
| // Invoke runs a Lambda function within the runtime with the provided event | ||
| // payload and returns a pair of io.Readers for it's stdout (callback results) | ||
| // and stderr (runtime logs). | ||
| func (r *Runtime) Invoke(event string) (io.Reader, io.Reader, error) { | ||
|
|
||
| log.Printf("Invoking %s (%s)\n", r.Function.Handler(), r.Name) | ||
|
|
@@ -195,10 +224,12 @@ func (r *Runtime) Invoke(event string) (io.Reader, io.Reader, error) { | |
|
|
||
| // Define the container options | ||
| config := &container.Config{ | ||
| WorkingDir: "/var/task", | ||
| Image: r.Image, | ||
| Tty: false, | ||
| ExposedPorts: r.getDebugExposedPorts(), | ||
| Entrypoint: r.getDebugEntrypoint(), | ||
| Cmd: []string{r.Function.Handler(), event}, | ||
| Env: func() []string { | ||
| result := []string{} | ||
| for k, v := range env { | ||
|
|
@@ -244,6 +275,17 @@ func (r *Runtime) Invoke(event string) (io.Reader, io.Reader, error) { | |
| return nil, nil, err | ||
| } | ||
|
|
||
| if len(r.DebugPort) == 0 { | ||
| r.setupTimeoutTimer(stdout, stderr) | ||
| } else { | ||
| r.setupInterruptHandler(stdout, stderr) | ||
| } | ||
|
|
||
| return stdout, stderr, nil | ||
|
|
||
| } | ||
|
|
||
| func (r *Runtime) setupTimeoutTimer(stdout, stderr io.ReadCloser) { | ||
| // Start a timer, we'll use this to abort the function if it runs beyond the specified timeout | ||
| timeout := time.Duration(3) * time.Second | ||
| if r.Function.Timeout() > 0 { | ||
|
|
@@ -257,13 +299,22 @@ func (r *Runtime) Invoke(event string) (io.Reader, io.Reader, error) { | |
| stdout.Close() | ||
| r.CleanUp() | ||
| }() | ||
| } | ||
|
|
||
| func (r *Runtime) setupInterruptHandler(stdout, stderr io.ReadCloser) { | ||
| iChan := make(chan os.Signal, 2) | ||
| signal.Notify(iChan, os.Interrupt, syscall.SIGTERM) | ||
| go func() { | ||
| <-iChan | ||
| log.Printf("Execution of function %q was interrupted", r.Function.Handler()) | ||
| stderr.Close() | ||
| stdout.Close() | ||
| r.CleanUp() | ||
| os.Exit(0) | ||
| }() | ||
| } | ||
|
|
||
| func getSessionOrDefaultCreds() map[string]string { | ||
| region := "us-east-1" | ||
| key := "defaultkey" | ||
| secret := "defaultsecret" | ||
|
|
@@ -289,7 +340,6 @@ func getSessionOrDefaultCreds() map[string]string { | |
| } | ||
|
|
||
| func getOsEnviron() map[string]string { | ||
| result := map[string]string{} | ||
| for _, value := range os.Environ() { | ||
| keyVal := strings.Split(value, "=") | ||
|
|
@@ -299,6 +349,80 @@ func getOsEnviron() map[string]string { | |
| return result | ||
| } | ||
|
|
||
| func (r *Runtime) getDebugPortBindings() nat.PortMap { | ||
| if len(r.DebugPort) == 0 { | ||
| return nil | ||
| } | ||
| return nat.PortMap{ | ||
| nat.Port(r.DebugPort): []nat.PortBinding{{HostPort: r.DebugPort}}, | ||
| } | ||
| } | ||
|
|
||
| func (r *Runtime) getDebugExposedPorts() nat.PortSet { | ||
| if len(r.DebugPort) == 0 { | ||
| return nil | ||
| } | ||
| return nat.PortSet{nat.Port(r.DebugPort): {}} | ||
| } | ||
|
|
||
| func (r *Runtime) getDebugEntrypoint() (overrides []string) { | ||
| if len(r.DebugPort) == 0 { | ||
| return | ||
| } | ||
| switch r.Name { | ||
| // configs from: https://github.com/lambci/docker-lambda | ||
| // to which we add the extra debug mode options | ||
| case runtimeName.java8: | ||
| overrides = []string{ | ||
| "/usr/bin/java", | ||
| "-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=" + r.DebugPort, | ||
|
||
| "-XX:MaxHeapSize=1336935k", | ||
| "-XX:MaxMetaspaceSize=157286k", | ||
| "-XX:ReservedCodeCacheSize=78643k", | ||
| "-XX:+UseSerialGC", | ||
| //"-Xshare:on", doesn't work in conjunction with the debug options | ||
| "-XX:-TieredCompilation", | ||
| "-jar", | ||
| "/var/runtime/lib/LambdaJavaRTEntry-1.0.jar", | ||
| } | ||
| case runtimeName.nodejs: | ||
| overrides = []string{ | ||
| "/usr/bin/node", | ||
| "--debug-brk=" + r.DebugPort, | ||
| "--nolazy", | ||
| "--max-old-space-size=1229", | ||
| "--max-new-space-size=153", | ||
| "--max-executable-size=153", | ||
| "--expose-gc", | ||
| "/var/runtime/node_modules/awslambda/bin/awslambda", | ||
| } | ||
| case runtimeName.nodejs43: | ||
| overrides = []string{ | ||
| "/usr/local/lib64/node-v4.3.x/bin/node", | ||
| "--debug-brk=" + r.DebugPort, | ||
| "--nolazy", | ||
| "--max-old-space-size=1229", | ||
| "--max-semi-space-size=76", | ||
| "--max-executable-size=153", | ||
| "--expose-gc", | ||
| "/var/runtime/node_modules/awslambda/index.js", | ||
| } | ||
| case runtimeName.nodejs610: | ||
| overrides = []string{ | ||
| "/var/lang/bin/node", | ||
| "--debug-brk=" + r.DebugPort, | ||
| "--nolazy", | ||
| "--max-old-space-size=1229", | ||
| "--max-semi-space-size=76", | ||
| "--max-executable-size=153", | ||
| "--expose-gc", | ||
| "/var/runtime/node_modules/awslambda/index.js", | ||
| } | ||
| // TODO: also add debug mode for Python runtimes | ||
| } | ||
| return | ||
| } | ||
|
|
||
| /** | ||
| The Environment Variable Saga.. | ||
|
|
||
|
|
@@ -386,7 +510,9 @@ func toStringMaybe(value interface{}) (string, bool) { | |
|
|
||
| // CleanUp removes the Docker container used by this runtime | ||
| func (r *Runtime) CleanUp() { | ||
| if r.TimeoutTimer != nil { | ||
| r.TimeoutTimer.Stop() | ||
| } | ||
| r.Client.ContainerKill(r.Context, r.ID, "SIGKILL") | ||
| r.Client.ContainerRemove(r.Context, r.ID, types.ContainerRemoveOptions{}) | ||
| } | ||
|
|
@@ -434,7 +560,7 @@ func getDockerVersion() (string, error) { | |
|
|
||
| func getWorkingDir(basedir string, codeuri string) (string, error) { | ||
|
|
||
| // Determine which directory to mount into the runtime container. | ||
| // If no CodeUri is specified for this function, then use the same | ||
| // directory as the SAM template (basedir), otherwise mount the | ||
| // directory specified in the CodeUri property. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the benefit of having this as an anon struct (and map), rather than just the map that was there before?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Paul. Thank you for having a look!
The reason why I altered the previous setup is the fact that I need to use the runtime names in the switch I added in the "getDebugEntrypoint" method. Previously, the runtime names were just keys in a map so they could not be used as const values to compare against.