Skip to content

Commit 17ca1de

Browse files
matheusandre1matheusandre1
committed
feat: Implement correlation on event filter
- Add CorrelationPredicate for evaluating correlation expressions - Add correlate support in AbstractEventFilterBuilder and AbstractEventFilterSpec - Update TypeEventRegistration and TypeEventRegistrationBuilder with correlation predicates - Implement correlation matching in AbstractTypeConsumer - Add CorrelationTest and listen-correlate.yaml - Add correlate tests in WorkflowBuilderTest and DSLTest Signed-off-by: Matheus André <matheusandr2@gmail.com>
1 parent fcd26da commit 17ca1de

13 files changed

Lines changed: 415 additions & 20 deletions

File tree

‎fluent/spec/src/main/java/io/serverlessworkflow/fluent/spec/AbstractEventFilterBuilder.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,11 @@ public SELF with(Consumer<P> c) {
3737
}
3838

3939
public SELF correlate(String key, Consumer<ListenTaskBuilder.CorrelatePropertyBuilder> c) {
40-
throw new UnsupportedOperationException(
41-
"correlate is not supported in the engine level: https://github.com/serverlessworkflow/sdk-java/issues/1206");
40+
ListenTaskBuilder.CorrelatePropertyBuilder cb =
41+
new ListenTaskBuilder.CorrelatePropertyBuilder();
42+
c.accept(cb);
43+
correlate.setAdditionalProperty(key, cb.build());
44+
return self();
4245
}
4346

4447
public EventFilter build() {

‎fluent/spec/src/main/java/io/serverlessworkflow/fluent/spec/dsl/AbstractEventFilterSpec.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import io.serverlessworkflow.fluent.spec.AbstractEventFilterBuilder;
1919
import io.serverlessworkflow.fluent.spec.AbstractEventPropertiesBuilder;
20+
import io.serverlessworkflow.fluent.spec.AbstractListenTaskBuilder;
2021
import java.util.ArrayList;
2122
import java.util.List;
2223
import java.util.function.Consumer;
@@ -41,13 +42,11 @@ protected List<Consumer<EVENT_FILTER>> getFilterSteps() {
4142
return filterSteps;
4243
}
4344

44-
// TODO: "correlate is not supported in the engine level:
45-
// https://github.com/serverlessworkflow/sdk-java/issues/1206". Keeping the code for a future
46-
// reference.
47-
// public SELF correlate(String key, Consumer<ListenTaskBuilder.CorrelatePropertyBuilder> c) {
48-
// filterSteps.add(f -> f.correlate(key, c));
49-
// return self();
50-
// }
45+
public SELF correlate(
46+
String key, Consumer<AbstractListenTaskBuilder.CorrelatePropertyBuilder> c) {
47+
addFilterStep(f -> f.correlate(key, c));
48+
return self();
49+
}
5150

5251
@Override
5352
public void accept(EVENT_FILTER filterBuilder) {

‎fluent/spec/src/test/java/io/serverlessworkflow/fluent/spec/WorkflowBuilderTest.java‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import io.serverlessworkflow.api.types.AuthenticationPolicyUnion;
3838
import io.serverlessworkflow.api.types.CallHTTP;
3939
import io.serverlessworkflow.api.types.CatchErrors;
40+
import io.serverlessworkflow.api.types.CorrelateProperty;
4041
import io.serverlessworkflow.api.types.Document;
4142
import io.serverlessworkflow.api.types.EmitEventDefinition;
4243
import io.serverlessworkflow.api.types.EmitTask;
@@ -310,8 +311,12 @@ void testDoTaskListenOne() {
310311
to ->
311312
to.one(
312313
f ->
313-
f.with(
314-
p -> p.type("com.fake.pet").source("mySource"))))))
314+
f.with(p -> p.type("com.fake.pet").source("mySource"))
315+
.correlate(
316+
"orderId",
317+
c ->
318+
c.from("$.data.orderId")
319+
.expect("$.input.orderId"))))))
315320
.build();
316321

317322
List<TaskItem> items = wf.getDo();
@@ -327,6 +332,10 @@ void testDoTaskListenOne() {
327332
EventFilter filter = one.getOne();
328333
assertNotNull(filter, "EventFilter should be present");
329334
assertEquals("com.fake.pet", filter.getWith().getType(), "Filter type should match");
335+
CorrelateProperty correlate = filter.getCorrelate().getAdditionalProperties().get("orderId");
336+
assertNotNull(correlate, "Correlate property should be present");
337+
assertEquals("$.data.orderId", correlate.getFrom(), "Correlate from should match");
338+
assertEquals("$.input.orderId", correlate.getExpect(), "Correlate expect should match");
330339
}
331340

332341
@Test

‎fluent/spec/src/test/java/io/serverlessworkflow/fluent/spec/dsl/DSLTest.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import static io.serverlessworkflow.fluent.spec.dsl.DSL.workflow;
3131
import static org.assertj.core.api.Assertions.assertThat;
3232

33+
import io.serverlessworkflow.api.types.CorrelateProperty;
3334
import io.serverlessworkflow.api.types.HTTPArguments;
3435
import io.serverlessworkflow.api.types.ListenTaskConfiguration;
3536
import io.serverlessworkflow.api.types.RunTaskConfiguration;
@@ -166,7 +167,15 @@ public void when_listen_any_with_until() {
166167
public void when_listen_one() {
167168
Workflow wf =
168169
WorkflowBuilder.workflow("f", "ns", "1")
169-
.tasks(t -> t.listen(to().one(event().type("only-once"))))
170+
.tasks(
171+
t ->
172+
t.listen(
173+
to().one(
174+
event()
175+
.type("only-once")
176+
.correlate(
177+
"workflowInstanceId",
178+
c -> c.from("$.metadata.instanceId")))))
170179
.build();
171180

172181
var to = wf.getDo().get(0).getTask().getListenTask().getListen().getTo();
@@ -178,6 +187,10 @@ public void when_listen_one() {
178187
var one = to.getOneEventConsumptionStrategy().getOne();
179188
assertThat(one.getWith()).isNotNull();
180189
assertThat(one.getWith().getType()).isEqualTo("only-once");
190+
CorrelateProperty correlate =
191+
one.getCorrelate().getAdditionalProperties().get("workflowInstanceId");
192+
assertThat(correlate).isNotNull();
193+
assertThat(correlate.getFrom()).isEqualTo("$.metadata.instanceId");
181194
}
182195

183196
@Test

‎impl/core/src/main/java/io/serverlessworkflow/impl/CompositeExpressionFactory.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ public WorkflowValueResolver<String> resolveString(ExpressionDescriptor desc) {
4949
return processFactories(desc, f -> f.resolveString(desc));
5050
}
5151

52+
@Override
53+
public WorkflowValueResolver<Object> resolveValue(ExpressionDescriptor desc) {
54+
return processFactories(desc, f -> f.resolveValue(desc));
55+
}
56+
5257
@Override
5358
public WorkflowValueResolver<OffsetDateTime> resolveDate(ExpressionDescriptor desc) {
5459
return processFactories(desc, f -> f.resolveDate(desc));

‎impl/core/src/main/java/io/serverlessworkflow/impl/events/AbstractTypeConsumer.java‎

Lines changed: 63 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,17 @@
1616
package io.serverlessworkflow.impl.events;
1717

1818
import io.cloudevents.CloudEvent;
19+
import io.serverlessworkflow.api.types.CorrelateProperty;
1920
import io.serverlessworkflow.api.types.EventFilter;
21+
import io.serverlessworkflow.api.types.EventFilterCorrelate;
2022
import io.serverlessworkflow.api.types.EventProperties;
2123
import io.serverlessworkflow.impl.TaskContext;
2224
import io.serverlessworkflow.impl.WorkflowApplication;
2325
import io.serverlessworkflow.impl.WorkflowContext;
26+
import io.serverlessworkflow.impl.WorkflowModel;
27+
import io.serverlessworkflow.impl.WorkflowModelFactory;
2428
import java.util.AbstractCollection;
29+
import java.util.ArrayList;
2530
import java.util.Collection;
2631
import java.util.Iterator;
2732
import java.util.List;
@@ -46,14 +51,34 @@ public abstract class AbstractTypeConsumer
4651
protected abstract void unregister(String topicName);
4752

4853
private Map<String, CloudEventConsumer> registrations = new ConcurrentHashMap<>();
54+
private WorkflowModelFactory modelFactory;
4955

5056
@Override
5157
public TypeEventRegistrationBuilder listen(
5258
EventFilter register, WorkflowApplication application) {
59+
this.modelFactory = application.modelFactory();
5360
EventProperties properties = register.getWith();
5461
String type = properties.getType();
55-
return new TypeEventRegistrationBuilder(
56-
type, application.cloudEventPredicateFactory().build(application, properties));
62+
CloudEventPredicate cePredicate =
63+
application.cloudEventPredicateFactory().build(application, properties);
64+
Collection<CorrelationPredicate> correlationPredicates =
65+
buildCorrelationPredicates(register.getCorrelate(), application);
66+
return correlationPredicates.isEmpty()
67+
? new TypeEventRegistrationBuilder(type, cePredicate)
68+
: new TypeEventRegistrationBuilder(type, cePredicate, correlationPredicates);
69+
}
70+
71+
private Collection<CorrelationPredicate> buildCorrelationPredicates(
72+
EventFilterCorrelate correlate, WorkflowApplication application) {
73+
if (correlate == null || correlate.getAdditionalProperties().isEmpty()) {
74+
return List.of();
75+
}
76+
Collection<CorrelationPredicate> predicates = new ArrayList<>();
77+
for (Map.Entry<String, CorrelateProperty> entry :
78+
correlate.getAdditionalProperties().entrySet()) {
79+
predicates.add(CorrelationPredicate.from(entry.getKey(), entry.getValue(), application));
80+
}
81+
return predicates;
5782
}
5883

5984
@Override
@@ -63,18 +88,45 @@ public Collection<TypeEventRegistrationBuilder> listenToAll(WorkflowApplication
6388

6489
private static class CloudEventConsumer extends AbstractCollection<TypeEventRegistration>
6590
implements Consumer<CloudEvent> {
91+
private final WorkflowModelFactory modelFactory;
6692
private Collection<TypeEventRegistration> registrations = new CopyOnWriteArrayList<>();
6793

94+
CloudEventConsumer(WorkflowModelFactory modelFactory) {
95+
this.modelFactory = modelFactory;
96+
}
97+
6898
@Override
6999
public void accept(CloudEvent ce) {
70-
logger.debug("Received cloud event {}", ce);
100+
WorkflowModel eventModel = null;
71101
for (TypeEventRegistration registration : registrations) {
72102
if (registration.predicate().test(ce, registration.workflow(), registration.task())) {
103+
Collection<CorrelationPredicate> predicates = registration.correlationPredicates();
104+
if (!predicates.isEmpty()) {
105+
if (eventModel == null) {
106+
eventModel = modelFactory.from(ce);
107+
}
108+
if (!testCorrelation(eventModel, registration)) {
109+
continue;
110+
}
111+
}
73112
registration.consumer().accept(ce);
74113
}
75114
}
76115
}
77116

117+
private boolean testCorrelation(WorkflowModel eventModel, TypeEventRegistration registration) {
118+
Collection<CorrelationPredicate> predicates = registration.correlationPredicates();
119+
if (predicates.isEmpty()) {
120+
return true;
121+
}
122+
for (CorrelationPredicate pred : predicates) {
123+
if (!pred.test(eventModel, registration.workflow(), registration.task())) {
124+
return false;
125+
}
126+
}
127+
return true;
128+
}
129+
78130
@Override
79131
public boolean add(TypeEventRegistration registration) {
80132
return registrations.add(registration);
@@ -107,12 +159,18 @@ public TypeEventRegistration register(
107159
return new TypeEventRegistration(null, ce, null, workflow, task);
108160
} else {
109161
TypeEventRegistration registration =
110-
new TypeEventRegistration(builder.type(), ce, builder.cePredicate(), workflow, task);
162+
new TypeEventRegistration(
163+
builder.type(),
164+
ce,
165+
builder.cePredicate(),
166+
builder.correlationPredicates(),
167+
workflow,
168+
task);
111169
registrations
112170
.computeIfAbsent(
113171
registration.type(),
114172
k -> {
115-
CloudEventConsumer consumer = new CloudEventConsumer();
173+
CloudEventConsumer consumer = new CloudEventConsumer(modelFactory);
116174
register(k, consumer);
117175
return consumer;
118176
})

‎impl/core/src/main/java/io/serverlessworkflow/impl/events/CorrelationPredicate.java‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/*
2+
* Copyright 2020-Present The Serverless Workflow Specification Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package io.serverlessworkflow.impl.events;
17+
18+
import io.serverlessworkflow.impl.TaskContext;
19+
import io.serverlessworkflow.impl.WorkflowApplication;
20+
import io.serverlessworkflow.impl.WorkflowContext;
21+
import io.serverlessworkflow.impl.WorkflowModel;
22+
import io.serverlessworkflow.impl.WorkflowValueResolver;
23+
import io.serverlessworkflow.impl.expressions.ExpressionDescriptor;
24+
import java.util.Objects;
25+
import org.slf4j.Logger;
26+
import org.slf4j.LoggerFactory;
27+
28+
public class CorrelationPredicate {
29+
30+
private static final Logger logger = LoggerFactory.getLogger(CorrelationPredicate.class);
31+
32+
private final String key;
33+
private final WorkflowValueResolver<Object> fromResolver;
34+
private final WorkflowValueResolver<Object> expectResolver;
35+
36+
private CorrelationPredicate(
37+
String key,
38+
WorkflowValueResolver<Object> fromResolver,
39+
WorkflowValueResolver<Object> expectResolver) {
40+
this.key = key;
41+
this.fromResolver = fromResolver;
42+
this.expectResolver = expectResolver;
43+
}
44+
45+
public static CorrelationPredicate from(
46+
String key, io.serverlessworkflow.api.types.CorrelateProperty prop, WorkflowApplication app) {
47+
WorkflowValueResolver<Object> fromResolver =
48+
app.expressionFactory().resolveValue(ExpressionDescriptor.from(prop.getFrom()));
49+
WorkflowValueResolver<Object> expectResolver =
50+
prop.getExpect() != null
51+
? app.expressionFactory().resolveValue(ExpressionDescriptor.from(prop.getExpect()))
52+
: null;
53+
return new CorrelationPredicate(key, fromResolver, expectResolver);
54+
}
55+
56+
public boolean test(WorkflowModel eventModel, WorkflowContext workflow, TaskContext task) {
57+
Object eventValue = fromResolver.apply(workflow, task, eventModel);
58+
if (eventValue == null) {
59+
logger.debug("Correlation key '{}': from expression returned null", key);
60+
return false;
61+
}
62+
63+
if (expectResolver == null) {
64+
logger.debug(
65+
"Correlation key '{}': no expect expression, accepting event value '{}'",
66+
key,
67+
eventValue);
68+
return true;
69+
}
70+
71+
Object expectedValue = expectResolver.apply(workflow, task, task.input());
72+
boolean result = Objects.equals(eventValue, expectedValue);
73+
logger.debug(
74+
"Correlation key '{}': eventValue='{}', expectedValue='{}', match={}",
75+
key,
76+
eventValue,
77+
expectedValue,
78+
result);
79+
return result;
80+
}
81+
82+
public String key() {
83+
return key;
84+
}
85+
}

‎impl/core/src/main/java/io/serverlessworkflow/impl/events/TypeEventRegistration.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,25 @@
1818
import io.cloudevents.CloudEvent;
1919
import io.serverlessworkflow.impl.TaskContext;
2020
import io.serverlessworkflow.impl.WorkflowContext;
21+
import java.util.Collection;
22+
import java.util.Collections;
2123
import java.util.function.Consumer;
2224

2325
public record TypeEventRegistration(
2426
String type,
2527
Consumer<CloudEvent> consumer,
2628
CloudEventPredicate predicate,
29+
Collection<CorrelationPredicate> correlationPredicates,
2730
WorkflowContext workflow,
2831
TaskContext task)
29-
implements EventRegistration {}
32+
implements EventRegistration {
33+
34+
public TypeEventRegistration(
35+
String type,
36+
Consumer<CloudEvent> consumer,
37+
CloudEventPredicate predicate,
38+
WorkflowContext workflow,
39+
TaskContext task) {
40+
this(type, consumer, predicate, Collections.emptyList(), workflow, task);
41+
}
42+
}

‎impl/core/src/main/java/io/serverlessworkflow/impl/events/TypeEventRegistrationBuilder.java‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,16 @@
1515
*/
1616
package io.serverlessworkflow.impl.events;
1717

18-
public record TypeEventRegistrationBuilder(String type, CloudEventPredicate cePredicate)
19-
implements EventRegistrationBuilder {}
18+
import java.util.Collection;
19+
import java.util.Collections;
20+
21+
public record TypeEventRegistrationBuilder(
22+
String type,
23+
CloudEventPredicate cePredicate,
24+
Collection<CorrelationPredicate> correlationPredicates)
25+
implements EventRegistrationBuilder {
26+
27+
public TypeEventRegistrationBuilder(String type, CloudEventPredicate cePredicate) {
28+
this(type, cePredicate, Collections.emptyList());
29+
}
30+
}

‎impl/core/src/main/java/io/serverlessworkflow/impl/expressions/AbstractExpressionFactory.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ public WorkflowValueResolver<String> resolveString(ExpressionDescriptor desc) {
4646
return (w, t, m) -> toString(expr.eval(w, t, m));
4747
}
4848

49+
@Override
50+
public WorkflowValueResolver<Object> resolveValue(ExpressionDescriptor desc) {
51+
ObjectExpression expr = buildExpression(desc);
52+
return (w, t, m) -> expr.eval(w, t, m);
53+
}
54+
4955
@Override
5056
public WorkflowValueResolver<Collection<?>> resolveCollection(ExpressionDescriptor desc) {
5157
ObjectExpression expr = buildExpression(desc);

0 commit comments

Comments
 (0)