This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 16328d5 CAMEL-17585: Sage EIP - Options on Saga was not output in
json metadata. Update model to be aligned how other EIPs does that.
16328d5 is described below
commit 16328d5cc9466e368cba1dfb448a400dffbf1b2a
Author: Claus Ibsen <[email protected]>
AuthorDate: Sat Feb 5 18:41:45 2022 +0100
CAMEL-17585: Sage EIP - Options on Saga was not output in json metadata.
Update model to be aligned how other EIPs does that.
---
.../org/apache/camel/spring/processor/saga.xml | 8 ++--
.../org/apache/camel/spring/processor/sagaRef.xml | 8 ++--
.../services/org/apache/camel/model.properties | 1 +
.../resources/org/apache/camel/model/jaxb.index | 2 +-
.../resources/org/apache/camel/model/property.json | 2 +-
.../org/apache/camel/model/propertyExpression.json | 18 ++++++++
.../resources/org/apache/camel/model/saga.json | 2 +-
.../org/apache/camel/model/sagaOption.json | 2 +-
.../org/apache/camel/model/PropertyDefinition.java | 4 +-
...tion.java => PropertyExpressionDefinition.java} | 53 +++++++++-------------
.../org/apache/camel/model/SagaDefinition.java | 10 ++--
.../java/org/apache/camel/reifier/SagaReifier.java | 8 ++--
.../apache/camel/processor/SagaOptionsTest.java | 14 ------
.../java/org/apache/camel/xml/in/ModelParser.java | 28 +++++++-----
.../ROOT/pages/camel-3x-upgrade-guide-3_16.adoc | 10 ++--
15 files changed, 87 insertions(+), 83 deletions(-)
diff --git
a/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
b/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
index 6a70c04..9f575e8 100644
---
a/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
+++
b/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/saga.xml
@@ -33,12 +33,12 @@
<saga>
<compensation uri="mock:compensation" />
<completion uri="mock:completion" />
- <sagaOption name="myOptionKey">
+ <option key="myOptionKey">
<constant>myOptionValue</constant>
- </sagaOption>
- <sagaOption name="myOptionKey2">
+ </option>
+ <option key="myOptionKey2">
<constant>myOptionValue2</constant>
- </sagaOption>
+ </option>
</saga>
<choice>
<when>
diff --git
a/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
b/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
index 098a793..c2473ca 100644
---
a/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
+++
b/components/camel-spring-xml/src/test/resources/org/apache/camel/spring/processor/sagaRef.xml
@@ -34,12 +34,12 @@
<saga sagaServiceRef="mySagaService">
<compensation uri="mock:compensation"/>
<completion uri="mock:completion"/>
- <sagaOption name="myOptionKey">
+ <option key="myOptionKey">
<constant>myOptionValue</constant>
- </sagaOption>
- <sagaOption name="myOptionKey2">
+ </option>
+ <option key="myOptionKey2">
<constant>myOptionValue2</constant>
- </sagaOption>
+ </option>
</saga>
<choice>
<when>
diff --git
a/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
b/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
index c50cf9d..86de2b4 100644
---
a/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
+++
b/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
@@ -113,6 +113,7 @@ pollEnrich
post
process
property
+propertyExpression
protobuf
put
random
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
index c14b73c..b71d046 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
@@ -52,6 +52,7 @@ PollEnrichDefinition
ProcessDefinition
PropertyDefinition
PropertyDefinitions
+PropertyExpressionDefinition
RecipientListDefinition
RedeliveryPolicyDefinition
RemoveHeaderDefinition
@@ -78,7 +79,6 @@ RoutesDefinition
RoutingSlipDefinition
SagaCompletionMode
SagaDefinition
-SagaOptionDefinition
SagaPropagation
SamplingDefinition
ScriptDefinition
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
index 0c270fd..a20cf40 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/property.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "property",
"title": "Property",
- "description": "A key value pair",
+ "description": "A key value pair where the value is a literal value",
"deprecated": false,
"label": "configuration",
"javaType": "org.apache.camel.model.PropertyDefinition",
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/propertyExpression.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/propertyExpression.json
new file mode 100644
index 0000000..41f68d8
--- /dev/null
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/propertyExpression.json
@@ -0,0 +1,18 @@
+{
+ "model": {
+ "kind": "model",
+ "name": "propertyExpression",
+ "title": "Property Expression",
+ "description": "A key value pair where the value is an expression.",
+ "deprecated": false,
+ "label": "configuration",
+ "javaType": "org.apache.camel.model.PropertyExpressionDefinition",
+ "abstract": false,
+ "input": false,
+ "output": false
+ },
+ "properties": {
+ "expression": { "kind": "expression", "displayName": "Expression",
"required": true, "type": "object", "javaType":
"org.apache.camel.model.language.ExpressionDefinition", "oneOf": [ "constant",
"csimple", "datasonnet", "exchangeProperty", "groovy", "header", "hl7terser",
"joor", "jsonpath", "language", "method", "mvel", "ognl", "ref", "simple",
"spel", "tokenize", "xpath", "xquery", "xtokenize" ], "deprecated": false,
"autowired": false, "secret": false },
+ "key": { "kind": "attribute", "displayName": "Key", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Property key" }
+ }
+}
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/saga.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/saga.json
index cae9146..f575885 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/saga.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/saga.json
@@ -17,7 +17,7 @@
"timeout": { "kind": "attribute", "displayName": "Timeout", "required":
false, "type": "duration", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Set the maximum amount of
time for the Saga. After the timeout is expired, the saga will be compensated
automatically (unless a different decision has been taken in the meantime)." },
"compensation": { "kind": "element", "displayName": "Compensation",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.SagaActionUriDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "The compensation endpoint
URI that must be called to compensate all changes done in the route. The route
corresponding to the compensation URI must perform compensation and complete
without error. If errors occur during compensation, the saga serv [...]
"completion": { "kind": "element", "displayName": "Completion",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.SagaActionUriDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "The completion endpoint
URI that will be called when the Saga is completed successfully. The route
corresponding to the completion URI must perform completion tasks and terminate
without error. If errors occur during completion, the saga service may c [...]
- "sagaOption": { "kind": "element", "displayName": "Saga Option",
"required": false, "type": "array", "javaType":
"java.util.List<org.apache.camel.model.SagaOptionDefinition>", "deprecated":
false, "autowired": false, "secret": false, "description": "Allows to save
properties of the current exchange in order to re-use them in a
compensation\/completion callback route. Options are usually helpful e.g. to
store and retrieve identifiers of objects that should be deleted in
compensating a [...]
+ "option": { "kind": "element", "displayName": "Option", "required": false,
"type": "array", "javaType":
"java.util.List<org.apache.camel.model.PropertyExpressionDefinition>",
"deprecated": false, "autowired": false, "secret": false, "description":
"Allows to save properties of the current exchange in order to re-use them in a
compensation\/completion callback route. Options are usually helpful e.g. to
store and retrieve identifiers of objects that should be deleted in
compensating ac [...]
"sagaServiceRef": { "kind": "attribute", "displayName": "Saga Service
Ref", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description":
"Refers to the id to lookup in the registry for the specific CamelSagaService
to use." },
"id": { "kind": "attribute", "displayName": "Id", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the id of this node"
},
"description": { "kind": "element", "displayName": "Description",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.DescriptionDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the description of
this node" }
diff --git
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/sagaOption.json
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/sagaOption.json
index ecd347d..1396147 100644
---
a/core/camel-core-model/src/generated/resources/org/apache/camel/model/sagaOption.json
+++
b/core/camel-core-model/src/generated/resources/org/apache/camel/model/sagaOption.json
@@ -4,7 +4,7 @@
"name": "sagaOption",
"title": "Saga Option",
"description": "Allows declaring options on Sagas",
- "deprecated": false,
+ "deprecated": true,
"label": "configuration",
"javaType": "org.apache.camel.model.SagaOptionDefinition",
"abstract": false,
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
index ad83f1d..445124d 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyDefinition.java
@@ -24,7 +24,9 @@ import javax.xml.bind.annotation.XmlRootElement;
import org.apache.camel.spi.Metadata;
/**
- * A key value pair
+ * A key value pair where the value is a literal value
+ *
+ * @see PropertyExpressionDefinition
*/
@Metadata(label = "configuration")
@XmlRootElement(name = "property")
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaOptionDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyExpressionDefinition.java
similarity index 55%
rename from
core/camel-core-model/src/main/java/org/apache/camel/model/SagaOptionDefinition.java
rename to
core/camel-core-model/src/main/java/org/apache/camel/model/PropertyExpressionDefinition.java
index 6cc71cc..b5508e3 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaOptionDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/PropertyExpressionDefinition.java
@@ -19,6 +19,7 @@ package org.apache.camel.model;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlElementRef;
import javax.xml.bind.annotation.XmlRootElement;
import org.apache.camel.Expression;
@@ -26,53 +27,43 @@ import org.apache.camel.model.language.ExpressionDefinition;
import org.apache.camel.spi.Metadata;
/**
- * Allows declaring options on Sagas
+ * A key value pair where the value is an expression.
+ *
+ * @see PropertyDefinition
*/
@Metadata(label = "configuration")
-@XmlRootElement(name = "sagaOption")
+@XmlRootElement(name = "propertyExpression")
@XmlAccessorType(XmlAccessType.FIELD)
-public class SagaOptionDefinition extends ExpressionNode {
-
+public class PropertyExpressionDefinition {
@XmlAttribute(required = true)
- private String name;
-
- public SagaOptionDefinition() {
- }
+ private String key;
+ @XmlElementRef
+ private ExpressionDefinition expression;
- public SagaOptionDefinition(String name, Expression expression) {
- setName(name);
- setExpression(ExpressionNodeHelper.toExpressionDefinition(expression));
+ public PropertyExpressionDefinition() {
}
- @Override
- public String toString() {
- return "option:" + getName() + "=" + getExpression();
+ public PropertyExpressionDefinition(String key, Expression expression) {
+ this.key = key;
+ this.expression = new ExpressionDefinition(expression);
}
/**
- * Name of the option. It identifies the name of the header where the
value of the expression will be stored when
- * the compensation or completion routes will be called.
+ * Property key
*/
- public void setName(String name) {
- this.name = name;
- }
-
- public String getName() {
- return name;
+ public void setKey(String key) {
+ this.key = key;
}
- @Override
- public ExpressionDefinition getExpressionType() {
- return getExpression();
+ public String getKey() {
+ return key;
}
- @Override
- public void setExpressionType(ExpressionDefinition expressionType) {
- setExpression(expressionType);
+ public ExpressionDefinition getExpression() {
+ return expression;
}
- @Override
- public String getShortName() {
- return "sagaOption";
+ public void setExpression(ExpressionDefinition expression) {
+ this.expression = expression;
}
}
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
index d871ae9..89522fc 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/SagaDefinition.java
@@ -62,8 +62,8 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
@XmlElement
private SagaActionUriDefinition completion;
- @XmlElement(name = "sagaOption")
- private List<SagaOptionDefinition> options;
+ @XmlElement(name = "option")
+ private List<PropertyExpressionDefinition> options;
@XmlAttribute
private String sagaServiceRef;
@@ -185,7 +185,7 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
this.sagaServiceRef = sagaServiceRef;
}
- public List<SagaOptionDefinition> getOptions() {
+ public List<PropertyExpressionDefinition> getOptions() {
return options;
}
@@ -195,7 +195,7 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
* compensating actions. Option values will be transformed into input
headers of the compensation/completion
* exchange.
*/
- public void setOptions(List<SagaOptionDefinition> options) {
+ public void setOptions(List<PropertyExpressionDefinition> options) {
this.options = options;
}
@@ -215,7 +215,7 @@ public class SagaDefinition extends
OutputDefinition<SagaDefinition> {
if (this.options == null) {
this.options = new ArrayList<>();
}
- this.options.add(new SagaOptionDefinition(option, expression));
+ this.options.add(new PropertyExpressionDefinition(option, expression));
}
// Builders
diff --git
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
index 32d3c64..114798a 100644
---
a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
+++
b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/SagaReifier.java
@@ -26,9 +26,9 @@ import org.apache.camel.Processor;
import org.apache.camel.Route;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.model.ProcessorDefinition;
+import org.apache.camel.model.PropertyExpressionDefinition;
import org.apache.camel.model.SagaActionUriDefinition;
import org.apache.camel.model.SagaDefinition;
-import org.apache.camel.model.SagaOptionDefinition;
import org.apache.camel.processor.saga.SagaCompletionMode;
import org.apache.camel.processor.saga.SagaProcessorBuilder;
import org.apache.camel.processor.saga.SagaPropagation;
@@ -53,9 +53,9 @@ public class SagaReifier extends
ProcessorReifier<SagaDefinition> {
Map<String, Expression> optionsMap = new TreeMap<>();
if (definition.getOptions() != null) {
- for (SagaOptionDefinition optionDef : definition.getOptions()) {
- String optionName = optionDef.getName();
- Expression expr = optionDef.getExpression();
+ for (PropertyExpressionDefinition def : definition.getOptions()) {
+ String optionName = def.getKey();
+ Expression expr = createExpression(def.getExpression());
optionsMap.put(optionName, expr);
}
}
diff --git
a/core/camel-core/src/test/java/org/apache/camel/processor/SagaOptionsTest.java
b/core/camel-core/src/test/java/org/apache/camel/processor/SagaOptionsTest.java
index 723787d..7b47b7a 100644
---
a/core/camel-core/src/test/java/org/apache/camel/processor/SagaOptionsTest.java
+++
b/core/camel-core/src/test/java/org/apache/camel/processor/SagaOptionsTest.java
@@ -18,7 +18,6 @@ package org.apache.camel.processor;
import org.apache.camel.ContextTestSupport;
import org.apache.camel.Exchange;
-import org.apache.camel.RuntimeCamelException;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.component.mock.MockEndpoint;
import org.apache.camel.saga.InMemorySagaService;
@@ -61,16 +60,6 @@ public class SagaOptionsTest extends ContextTestSupport {
compensate.assertIsSatisfied();
}
- @Test
- public void testRouteDoesNotHangOnOptionError() throws Exception {
- try {
- template.sendBody("direct:wrong-expression", "Hello");
- fail("Should throw an exception");
- } catch (RuntimeCamelException ex) {
- // OK
- }
- }
-
@Override
protected RouteBuilder createRouteBuilder() throws Exception {
@@ -86,9 +75,6 @@ public class SagaOptionsTest extends ContextTestSupport {
throw new RuntimeException("forced compensate");
}).end().setHeader("myname",
constant("TryToOverride")).setHeader("name", constant("TryToOverride"))
.to("mock:endpoint");
-
- from("direct:wrong-expression").saga().option("id",
simple("${10 / 0}")).to("log:info");
-
}
};
}
diff --git
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
index 592da53..34a401c 100644
---
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
+++
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
@@ -811,6 +811,22 @@ public class ModelParser extends BaseParser {
return false;
}, noValueHandler());
}
+ protected PropertyExpressionDefinition
doParsePropertyExpressionDefinition() throws IOException,
XmlPullParserException {
+ return doParse(new PropertyExpressionDefinition(), (def, key, val) -> {
+ if ("key".equals(key)) {
+ def.setKey(val);
+ return true;
+ }
+ return false;
+ }, (def, key) -> {
+ ExpressionDefinition v = doParseExpressionDefinitionRef(key);
+ if (v != null) {
+ def.setExpression(v);
+ return true;
+ }
+ return false;
+ }, noValueHandler());
+ }
protected RecipientListDefinition doParseRecipientListDefinition() throws
IOException, XmlPullParserException {
return doParse(new RecipientListDefinition(), (def, key, val) -> {
switch (key) {
@@ -1247,7 +1263,7 @@ public class ModelParser extends BaseParser {
switch (key) {
case "compensation":
def.setCompensation(doParseSagaActionUriDefinition()); break;
case "completion":
def.setCompletion(doParseSagaActionUriDefinition()); break;
- case "sagaOption": doAdd(doParseSagaOptionDefinition(),
def.getOptions(), def::setOptions); break;
+ case "option": doAdd(doParsePropertyExpressionDefinition(),
def.getOptions(), def::setOptions); break;
default: return outputDefinitionElementHandler().accept(def,
key);
}
return true;
@@ -1257,15 +1273,6 @@ public class ModelParser extends BaseParser {
return doParse(new SagaActionUriDefinition(),
sendDefinitionAttributeHandler(),
optionalIdentifiedDefinitionElementHandler(), noValueHandler());
}
- protected SagaOptionDefinition doParseSagaOptionDefinition() throws
IOException, XmlPullParserException {
- return doParse(new SagaOptionDefinition(), (def, key, val) -> {
- if ("name".equals(key)) {
- def.setName(val);
- return true;
- }
- return processorDefinitionAttributeHandler().accept(def, key, val);
- }, expressionNodeElementHandler(), noValueHandler());
- }
protected SamplingDefinition doParseSamplingDefinition() throws
IOException, XmlPullParserException {
return doParse(new SamplingDefinition(), (def, key, val) -> {
switch (key) {
@@ -3203,7 +3210,6 @@ public class ModelParser extends BaseParser {
case "route": return doParseRouteDefinition();
case "routingSlip": return doParseRoutingSlipDefinition();
case "saga": return doParseSagaDefinition();
- case "sagaOption": return doParseSagaOptionDefinition();
case "sample": return doParseSamplingDefinition();
case "script": return doParseScriptDefinition();
case "setBody": return doParseSetBodyDefinition();
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_16.adoc
b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_16.adoc
index ddea207..66f0728 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_16.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_16.adoc
@@ -26,7 +26,7 @@ to keep the existing and ignore the duplicate.
Removed the deprecated `timeoutInMilliseconds` option, use `timeout` instead.
-Renamed `<option>` to `<sagaOption>` and `optionName` to `name`. When using
XML DSL then this is affected as follows:
+In the `<option>` the `optionName` is renamed to `key`. When using XML DSL
then this is affected as follows:
[source,xml]
----
@@ -49,12 +49,12 @@ To:
<saga sagaServiceRef="mySagaService">
<compensation uri="mock:compensation"/>
<completion uri="mock:completion"/>
- <sagaOption name="myOptionKey">
+ <option key="myOptionKey">
<constant>myOptionValue</constant>
- </sagaOption>
- <sagaOption name="myOptionKey2">
+ </option>
+ <option key="myOptionKey2">
<constant>myOptionValue2</constant>
- </sagaOption>
+ </option>
</saga>
----