diff --git a/applications/processor/filter-processor/README.adoc b/applications/processor/filter-processor/README.adoc index ddbe62cd..db61e062 100644 --- a/applications/processor/filter-processor/README.adoc +++ b/applications/processor/filter-processor/README.adoc @@ -4,7 +4,7 @@ Filter processor enables an application to examine the incoming payload and then applies a predicate against it which decides if the record needs to be continued. For example, if the incoming payload is of type `String` and you want to filter out anything that has less than five characters, you can run the filter processor as below. -`java -jar filter-processor-kafka-.jar --spel.function.expression=payload.length() > 4` +`java -jar filter-processor-kafka-.jar --filter.function.expression=payload.length() > 4` Change kafka to rabbit if you want to run it against RabbitMQ. @@ -16,7 +16,7 @@ If the incoming type is `byte[]` and the content type is set to `text/plain` or == Options //tag::configuration-properties[] -$$spel.function.expression$$:: $$A SpEL expression to apply.$$ *($$String$$, default: `$$$$`)* +$$filter.function.expression$$:: $$A SpEL expression to apply.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/filter-processor/src/main/resources/META-INF/dataflow-configuration-metadata-whitelist.properties b/applications/processor/filter-processor/src/main/resources/META-INF/dataflow-configuration-metadata-whitelist.properties index b742b4cd..89497fc2 100644 --- a/applications/processor/filter-processor/src/main/resources/META-INF/dataflow-configuration-metadata-whitelist.properties +++ b/applications/processor/filter-processor/src/main/resources/META-INF/dataflow-configuration-metadata-whitelist.properties @@ -1,2 +1,2 @@ -configuration-properties.classes=org.springframework.cloud.fn.spel.SpelFunctionProperties +configuration-properties.classes=org.springframework.cloud.fn.filter.FilterFunctionProperties diff --git a/applications/source/time-source/src/test/java/org/springframework/cloud/stream/app/source/time/TimeSourceTests.java b/applications/source/time-source/src/test/java/org/springframework/cloud/stream/app/source/time/TimeSourceTests.java index 120fec97..1ccda3c6 100644 --- a/applications/source/time-source/src/test/java/org/springframework/cloud/stream/app/source/time/TimeSourceTests.java +++ b/applications/source/time-source/src/test/java/org/springframework/cloud/stream/app/source/time/TimeSourceTests.java @@ -66,18 +66,19 @@ public class TimeSourceTests { } @Test - public void testSourceComposedWithSpel() { + public void testSourceComposedWithSpelAndFilter() { try (ConfigurableApplicationContext context = new SpringApplicationBuilder( TestChannelBinderConfiguration .getCompleteConfiguration(TimeSourceTestApplication.class)) .web(WebApplicationType.NONE) - .run("--spring.cloud.function.definition=timeSupplier|spelFunction", - "--spel.function.expression=payload.length()")) { - + .run("--spring.cloud.function.definition=timeSupplier|headerEnricherFunction|filterFunction", + "--header.enricher.headers=seconds=T(java.lang.Integer).valueOf(payload.substring(payload.length() - 2))", + "--filter.function.expression=headers[seconds]%2==0")) { OutputDestination target = context.getBean(OutputDestination.class); Message sourceMessage = target.receive(10000); final String actual = new String(sourceMessage.getPayload()); - assertThat(Integer.valueOf(actual)).isEqualTo(17); + System.out.println(actual); + assertThat(((int) sourceMessage.getHeaders().get("seconds")) % 2).isZero(); } } diff --git a/functions/function/filter-function/README.adoc b/functions/function/filter-function/README.adoc index dc4e88f2..2c9917cf 100644 --- a/functions/function/filter-function/README.adoc +++ b/functions/function/filter-function/README.adoc @@ -14,11 +14,11 @@ Once injected, you can use the `apply` method of the `Function` to invoke it and ## Configuration Options -The filter function makes uses of link:../spel-function/README.adoc[SpEL function]. +All configuration properties are prefixed with `filter.function`. -For more information on the various options available, please see link:../spel-function/src/main/java/org/springframework/cloud/fn/spel/SpelFunctionProperties.java[SpelFunctionProperties.java] +For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/filter/FilterFunctionProperties.java[FilterFunctionProperties.java] -## Tests +## Examples See this link:src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java[test suite] for examples of how this function is used. diff --git a/functions/function/filter-function/pom.xml b/functions/function/filter-function/pom.xml index 92df009c..aa94ef67 100644 --- a/functions/function/filter-function/pom.xml +++ b/functions/function/filter-function/pom.xml @@ -17,8 +17,12 @@ org.springframework.cloud.fn - spel-function - 1.0.0-SNAPSHOT + payload-converter-function + ${project.version} + + + org.springframework.boot + spring-boot-starter-integration org.springframework.boot diff --git a/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionConfiguration.java b/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionConfiguration.java index 0fc5ebb6..a935ef9a 100644 --- a/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionConfiguration.java +++ b/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionConfiguration.java @@ -19,25 +19,36 @@ package org.springframework.cloud.fn.filter; import java.util.Optional; import java.util.function.Function; -import org.springframework.beans.factory.annotation.Qualifier; -import org.springframework.cloud.fn.spel.SpelFunctionConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Import; +import org.springframework.expression.spel.standard.SpelExpressionParser; +import org.springframework.integration.transformer.ExpressionEvaluatingTransformer; import org.springframework.messaging.Message; +/** + * @author Artem Bilan + * @author David Turanski + */ @Configuration -@Import(SpelFunctionConfiguration.class) +@EnableConfigurationProperties(FilterFunctionProperties.class) public class FilterFunctionConfiguration { @Bean public Function, Message> filterFunction( - @Qualifier("spelFunction") Function, Message> spelFunction) { + ExpressionEvaluatingTransformer filterExpressionEvaluatingTransformer) { - return message -> - Optional.of(message) - .filter(m -> (Boolean) spelFunction.apply(m).getPayload()) - .orElse(null); + return message -> Optional.of(message) + .filter(m -> (Boolean) filterExpressionEvaluatingTransformer.transform(m).getPayload()) + .orElse(null); + } + + @Bean + public ExpressionEvaluatingTransformer filterExpressionEvaluatingTransformer( + FilterFunctionProperties filterFunctionProperties) { + + return new ExpressionEvaluatingTransformer(new SpelExpressionParser() + .parseExpression(filterFunctionProperties.getExpression())); } } diff --git a/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionProperties.java b/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionProperties.java new file mode 100644 index 00000000..bde33f71 --- /dev/null +++ b/functions/function/filter-function/src/main/java/org/springframework/cloud/fn/filter/FilterFunctionProperties.java @@ -0,0 +1,47 @@ +/* + * Copyright 2020-2020 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 + * + * https://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.fn.filter; + +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.expression.Expression; +import org.springframework.expression.spel.standard.SpelExpressionParser; + +/** + * Configuration properties for the SpEL function. + * + * @author Gary Russell + * @author Artem Bilan + */ +@ConfigurationProperties("filter.function") +public class FilterFunctionProperties { + + private static final Expression DEFAULT_EXPRESSION = new SpelExpressionParser().parseExpression("payload"); + + /** + * A SpEL expression to apply. + */ + private String expression = DEFAULT_EXPRESSION.getExpressionString(); + + public String getExpression() { + return this.expression; + } + + public void setExpression(String expression) { + this.expression = expression; + } + +} diff --git a/functions/function/filter-function/src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java b/functions/function/filter-function/src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java index f17469f6..ed26dfef 100644 --- a/functions/function/filter-function/src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java +++ b/functions/function/filter-function/src/test/java/org/springframework/cloud/fn/filter/FilterFunctionApplicationTests.java @@ -30,7 +30,7 @@ import org.springframework.test.annotation.DirtiesContext; import static org.assertj.core.api.Assertions.assertThat; -@SpringBootTest(properties = "spel.function.expression=payload.length() > 5") +@SpringBootTest(properties = "filter.function.expression=payload.length() > 5") @DirtiesContext public class FilterFunctionApplicationTests {