Add dev config flag for fixing lambda invoke on macOS in host mode by joe4dev · Pull Request #7367 · localstack/localstack

joe4dev · 2022-12-20T14:06:31Z

Problem

The new lambda provider requires bi-directional communication (host <=> lambda container), which breaks host mode in macOS because the lambda container is not reachable via IPv4 in bridge mode.
Hence, invoking any lambda fails while the lambda container waits for an invocation (i.e., during "blocking the credentials service") after a connection timeout with the error Connection to 172.17.0.2 timed out.

Enable new lambda provider: PROVIDER_OVERRIDE_LAMBDA=asf

Relevant test case: tests.integration.awslambda.test_lambda.TestLambdaFeatures.test_invocation_type_request_response

Background

Docker Desktop can’t route traffic to Linux containers. However, if you’re a Windows user, you can ping the Windows containers. (Source: Docker I cannot ping my containers)

There is also a long discussion thread about this issue in the moby project.

LocalStack Workarounds

Start LS in a container with bind-mounted code and run tests against it using TEST_SKIP_LOCALSTACK_START=1
- ➖ Debugging doesn’t work
- ➖ Tests that monkey-patch stuff don’t work
Execute test in container TEST_PATH="tests/integration/awslambda/test_lambda_common.py" make test-docker-mount
- ➖ cannot install moto using pip install -e
  ⇒ delete -v $$PACKAGES_DIR/moto:/opt/code/localstack/.venv/lib/python3.10/site-packages/moto/ from test-docker-mount-code in the Makefile

Thanks, @dfangl for the hints 🙏

Potential macOS networking Workarounds (not tested)

Blogpost summarizing solutions: https://itecnote.com/tecnote/r-how-to-ping-the-docker-container-from-the-host/
- ➕ most comprehensive overview
Docker Toolbox/VirtualBox or Vagrant/Ansible-based setup: https://stackoverflow.com/a/39217691
- ➖ cumbersome to configure
- ➖ doesn't support host volume mapping
shim based fix: https://github.com/AlmirKadric-Published/docker-tuntap-osx
- ➖ depends on unmaintained TunTap

Suggested Changes

Introduce a dev config flag LAMBDA_DEV_PORT_EXPOSE and conditionally expose a free TCP port in the lambda container.

coveralls · 2022-12-20T14:48:25Z

Coverage decreased (-0.0008%) to 84.844% when pulling 2385ef2 on fix-lambda-invoke-dev-mode-macos into 9cd9c68 on master.

github-actions · 2022-12-20T15:58:40Z

LocalStack integration with Pro

      3 files ±0       3 suites ±0 1h 23m 8s ⏱️ - 11m 16s
1 576 tests +2 1 302 ✔️ +1 274 💤 +1 0 ❌ ±0
2 222 runs +4 1 670 ✔️ +1 552 💤 +3 0 ❌ ±0

Results for commit 2385ef2. ± Comparison against base commit 9cd9c68.

♻️ This comment has been updated with latest results.

dfangl

Just some minor nits!

dfangl · 2022-12-21T09:58:11Z

localstack/services/awslambda/invocation/docker_runtime_executor.py

        )
        executor_endpoint = ExecutorEndpoint(self.id, service_endpoint=service_endpoint)
+        if config.LAMBDA_ASF_DEV_PORT_EXPOSE:
+            executor_endpoint.container_address = "localhost"


It would be nice to set self.ip as well, so the contract for get_address is not broken.
We are not currently using it, but still.

good catch 👁️
I grouped the container_address assignment at the bottom for better readability.

dfangl · 2022-12-21T10:01:05Z

localstack/services/awslambda/invocation/docker_runtime_executor.py

            self.id,
        )
        executor_endpoint = ExecutorEndpoint(self.id, service_endpoint=service_endpoint)
+        if config.LAMBDA_ASF_DEV_PORT_EXPOSE:


Can we merge that whole if block with the first one in start? It seems unnecessary that this happens at object creation time. We set the executor endpoint IP in the not-port-expose path in start() as well.
Especially get_free_tcp_port can take some time, so I would rather have it in the start method.

Yes, that makes a lot of sense and reduces clutter because the constructor can stay generic this way

dfangl

One minor thing again (to set self.ip correctly), then its good to go from my side!

localstack/services/awslambda/invocation/docker_runtime_executor.py

Co-authored-by: Daniel Fangl <daniel.fangl@localstack.cloud>

dfangl

LGTM! Great work tackling this!

joe4dev · 2022-12-22T13:57:25Z

Updated naming as discussed:

Omit ASF as the new lambda provider becomes default in the next major release
Keep DEV to emphasize that its a feature flag for LS developers only
Keep EXPOSE to clarify its meaning as a boolean flag (rather than indicate a manual port setting)

whummer · 2022-12-27T10:20:51Z

Just gave this a try on my Mac in host mode - works like a charm, great job @joe4dev 🚀

joe4dev · 2022-12-27T18:35:20Z

Glad to hear it works 👍
Thanks 🙏

Add dev config flag for fixing lambda invoke on macOS

473055f

joe4dev requested a review from dfangl December 20, 2022 14:06

joe4dev requested review from dominikschubert and thrau as code owners December 20, 2022 14:06

joe4dev temporarily deployed to localstack-ext-tests December 20, 2022 14:06 — with GitHub Actions Inactive

joe4dev marked this pull request as draft December 20, 2022 14:06

joe4dev added aws:lambda AWS Lambda platform: arm64/aarch64 Issues related to Apple Silicon labels Dec 20, 2022

joe4dev changed the title ~~Add dev config flag for fixing lambda invoke on macOS~~ Add dev config flag for fixing lambda invoke on macOS in host mode Dec 20, 2022

joe4dev marked this pull request as ready for review December 21, 2022 08:11

dfangl suggested changes Dec 21, 2022

View reviewed changes

joe4dev removed aws:lambda AWS Lambda platform: arm64/aarch64 Issues related to Apple Silicon labels Dec 21, 2022

Move port detection into start and set ip in dev mode

c9eb2b9

joe4dev temporarily deployed to localstack-ext-tests December 22, 2022 10:22 — with GitHub Actions Inactive

dfangl suggested changes Dec 22, 2022

View reviewed changes

localstack/services/awslambda/invocation/docker_runtime_executor.py Outdated Show resolved Hide resolved

Set docker runtime executor IP to localhost in dev mode

7de60dd

Co-authored-by: Daniel Fangl <daniel.fangl@localstack.cloud>

joe4dev temporarily deployed to localstack-ext-tests December 22, 2022 10:41 — with GitHub Actions Inactive

dfangl approved these changes Dec 22, 2022

View reviewed changes

Omit ASF in config flag name

2385ef2

joe4dev temporarily deployed to localstack-ext-tests December 22, 2022 13:53 — with GitHub Actions Inactive

joe4dev merged commit 6c92dd6 into master Dec 23, 2022

joe4dev deleted the fix-lambda-invoke-dev-mode-macos branch December 23, 2022 08:22

joe4dev mentioned this pull request Jul 29, 2024

Change default for LAMBDA_DEV_PORT_EXPOSE on macOS in host mode #11280

Merged

Uh oh!

Conversation

joe4dev commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Background

LocalStack Workarounds

Potential macOS networking Workarounds (not tested)

Suggested Changes

Uh oh!

coveralls commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

LocalStack integration with Pro

Uh oh!

dfangl left a comment

Choose a reason for hiding this comment

Uh oh!

dfangl Dec 21, 2022

Choose a reason for hiding this comment

Uh oh!

joe4dev Dec 22, 2022

Choose a reason for hiding this comment

Uh oh!

dfangl Dec 21, 2022

Choose a reason for hiding this comment

Uh oh!

joe4dev Dec 22, 2022

Choose a reason for hiding this comment

Uh oh!

dfangl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dfangl left a comment

Choose a reason for hiding this comment

Uh oh!

joe4dev commented Dec 22, 2022

Uh oh!

whummer commented Dec 27, 2022

Uh oh!

joe4dev commented Dec 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joe4dev commented Dec 20, 2022 •

edited

Loading

coveralls commented Dec 20, 2022 •

edited

Loading

github-actions bot commented Dec 20, 2022 •

edited

Loading