fix: Silence home directory warning in Lambda Extensions #1344
Conversation
This file contains 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 PR follows on to smithy-lang#893 which added LAMBDA_TASK_ROOT check. When running as a [Lambda Extension][ext] the environment variable for TASK_ROOT is redacted, so it is not reliable for testing whether you are in Lambda. Related commit: fbb4bc [ext]: https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html
jdisanti
reviewed
Apr 26, 2022
| environment.get("LAMBDA_TASK_ROOT").is_ok() | ||
| // AWS_LAMBDA_RUNTIME_API - Double-check because LAMBDA_TASK_ROOT is redacted to any code running in Extensions | ||
| // https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html | ||
| environment.get("LAMBDA_TASK_ROOT").is_ok() || environment.get("AWS_LAMBDA_RUNTIME_API").is_ok() |
There was a problem hiding this comment.
From what I can tell in the docs, AWS_LAMBDA_RUNTIME_API is only available when using a custom runtime. Perhaps we should check AWS_LAMBDA_FUNCTION_NAME instead of either of these values. Do you know if AWS_LAMBDA_FUNCTION_NAME is set for extensions also?
There was a problem hiding this comment.
AWS_LAMBDA_RUNTIME_API is always set in a Lambda extension process, it is required for the communication between the extension and the runtime.
I'll check on AWS_LAMBDA_FUNCTION_NAME and get back to you, if that works for both then we can reduce this back down to one check.
There was a problem hiding this comment.
Yep, AWS_LAMBDA_FUNCTION_NAME exists for both, so I've switched the check to use that.
jdisanti
approved these changes
Apr 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation and Context
Similar to aws-sdk-rust #307, suppress the home directory expansion warning when in Lambda. The fix #893 worked for Lambda functions, but not for Extensions.
Related commit: fbb4bc
Description
This PR follows on to #893 which added
LAMBDA_TASK_ROOTcheck. When running as a Lambda Extension the environment variable forLAMBDA_TASK_ROOTis redacted, so it is not reliable for testing whether you are in Lambda.To remedy this, I switched the check to use
AWS_LAMBDA_FUNCTION_NAMEso that the check returns correctly for both function handlers and extensions.Testing
Ran the full test suite, and validated that this suppresses the warning by rebuilding my local SDK and using it in a Lambda Extension.
Checklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesCHANGELOG.next.tomlif I made changes to the AWS SDK, generated SDK code, or SDK runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.