Deeper support for custom AWS Lambda runtime

Adds an EnvironmentPostProcessor so the user ony has to set one
property (spring.cloud.function.web.export.enabled=true).
This commit is contained in:
Dave Syer
2019-02-28 09:56:17 -05:00
parent 8d834a7483
commit 138e1cf3c2
5 changed files with 73 additions and 15 deletions

View File

@@ -58,9 +58,6 @@ An https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html[AWS Lambda
```
spring.cloud.function.web.export.enabled=true
spring.cloud.function.web.export.source.url=http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/next
spring.cloud.function.web.export.sink.url=http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/{{destination}}/response
spring.cloud.function.web.export.sink.name=origin|uppercase
```
where "uppercase" is the name of your function ("origin" is the name of the `Supplier` that is provided by Spring Cloud Function Web). Then provide a `bootstrap` script in the root of your zip/jar that runs the Spring Boot application. The functional bean definition style works for custom runtimes too, and is faster than the `@Bean` style, so the example `FuncApplication` above would work. A custom runtime can start up much quicker even than a functional bean implementation of a Java lambda - it depends mostly on the number of classes you need to load at runtime. Spring doesn't do very much here, so you can reduce the cold start time by only using primitive types in your function, for instance, and not doing any work in custom `@PostConstruct` initializers.
Set the handler name in AWS to the name of your function. Then provide a `bootstrap` script in the root of your zip/jar that runs the Spring Boot application. The functional bean definition style works for custom runtimes too, and is faster than the `@Bean` style, so the example `FuncApplication` above would work. A custom runtime can start up much quicker even than a functional bean implementation of a Java lambda - it depends mostly on the number of classes you need to load at runtime. Spring doesn't do very much here, so you can reduce the cold start time by only using primitive types in your function, for instance, and not doing any work in custom `@PostConstruct` initializers.

View File

@@ -0,0 +1,64 @@
/*
* Copyright 2019-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.cloud.function.adapter.aws;
import java.util.HashMap;
import java.util.Map;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
/**
* Adds default properties to the environment for running a custom runtime in AWS.
*
* @author Dave Syer
*/
public class CustomRuntimeEnvironmentPostProcessor implements EnvironmentPostProcessor {
private static final String CUSTOM_RUNTIME = "spring.cloud.function.aws.custom";
@Override
public void postProcessEnvironment(ConfigurableEnvironment environment,
SpringApplication application) {
if (!environment.containsProperty(CUSTOM_RUNTIME)) {
Map<String, Object> defaults = getDefaultProperties(environment);
defaults.putIfAbsent("spring.cloud.function.web.export.source.url",
"http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/next");
defaults.putIfAbsent("spring.cloud.function.web.export.sink.url",
"http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/{{destination}}/response");
defaults.put("spring.cloud.function.web.export.sink.name",
"origin|${_HANDLER:}");
defaults.put(CUSTOM_RUNTIME, true);
}
}
private Map<String, Object> getDefaultProperties(
ConfigurableEnvironment environment) {
if (environment.getPropertySources().contains("defaultProperties")) {
MapPropertySource source = (MapPropertySource) environment
.getPropertySources().get("defaultProperties");
return source.getSource();
}
HashMap<String, Object> map = new HashMap<String, Object>();
environment.getPropertySources()
.addLast(new MapPropertySource("defaultProperties", map));
return map;
}
}

View File

@@ -2,3 +2,5 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.function.adapter.aws.CustomRuntimeAutoConfiguration
org.springframework.context.ApplicationContextInitializer=\
org.springframework.cloud.function.adapter.aws.CustomRuntimeInitializer
org.springframework.boot.env.EnvironmentPostProcessor=\
org.springframework.cloud.function.adapter.aws.CustomRuntimeEnvironmentPostProcessor

View File

@@ -1,5 +1 @@
spring.cloud.function.web.export.enabled=true
spring.cloud.function.web.export.source.url=http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/next
spring.cloud.function.web.export.sink.url=http://${AWS_LAMBDA_RUNTIME_API:localhost}/2018-06-01/runtime/invocation/{{destination}}/response
spring.cloud.function.web.export.sink.name=origin|uppercase
# spring.cloud.function.web.supplier.debug=true

View File

@@ -53,13 +53,12 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = { RestConfiguration.class,
ApplicationConfiguration.class },
webEnvironment = WebEnvironment.DEFINED_PORT, properties = {
"spring.cloud.function.web.export.sink.url=http://localhost:${server.port}",
"spring.cloud.function.web.export.source.url=http://localhost:${server.port}",
"spring.cloud.function.web.export.sink.name=origin|uppercase",
"spring.cloud.function.web.export.debug=true",
"spring.cloud.function.web.export.enabled=true" })
ApplicationConfiguration.class }, webEnvironment = WebEnvironment.DEFINED_PORT, properties = {
"spring.cloud.function.web.export.sink.url=http://localhost:${server.port}",
"spring.cloud.function.web.export.source.url=http://localhost:${server.port}",
"spring.cloud.function.web.export.sink.name=origin|uppercase",
// "spring.cloud.function.web.export.debug=true",
"spring.cloud.function.web.export.enabled=true" })
public class FunctionAutoConfigurationIntegrationTests {
@Autowired