This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch CAMEL-27268 in repository https://gitbox.apache.org/repos/asf/camel.git
commit d7828ea602f31e6185676f2a21e438841375bf9b Author: Claus Ibsen <[email protected]> AuthorDate: Fri Nov 20 07:42:08 2026 +0100 CAMEL-27268: camel-yaml-dsl-validator - warn on parsed data before a text-plain data type, which sends it as its toString() The text-plain data type said its transformerIn is any, so the body type validator never warned when parsed data (a Map or a List) came before a Kamelet with a text in default, or before transformDataType: text-plain, although that body becomes its Java toString(), such as {status=ok}. Narrow transformerIn of text-plain to text, bytes, a stream, a file, a value or no body, and check the in data type of a Kamelet and transformDataType with a rule that also accepts a value, so parsed data before them is reported with the hint to marshal it first. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Claus Ibsen <[email protected]> --- .../camel/catalog/transformers/text-plain.json | 9 +++- .../org/apache/camel/transformer/text-plain.json | 9 +++- .../transformer/StringDataTypeTransformer.java | 8 +++- .../transformer/StringDataTypeTransformerTest.java | 5 ++- .../camel/dsl/yaml/validator/CatalogBodyTypes.java | 9 ++++ .../camel/dsl/yaml/validator/TextBodyFlow.java | 4 +- .../camel/dsl/yaml/validator/TextBodyFlowTest.java | 48 ++++++++++++++++++++-- 7 files changed, 78 insertions(+), 14 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/transformers/text-plain.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/transformers/text-plain.json index 35a266658010..44e16f27ed66 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/transformers/text-plain.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/transformers/text-plain.json @@ -12,9 +12,14 @@ "bodyTypes": { "transformerIn": { "carriers": [ - "any" + "text", + "bytes", + "stream", + "file", + "value", + "null" ], - "description": "A body Camel can convert to a String; a null body stays null" + "description": "Text, bytes, a stream, a file or a value such as a number, and a null body stays null; a Map, a List or an object would become its toString()" }, "transformerOut": { "carriers": [ diff --git a/core/camel-core-processor/src/generated/resources/META-INF/services/org/apache/camel/transformer/text-plain.json b/core/camel-core-processor/src/generated/resources/META-INF/services/org/apache/camel/transformer/text-plain.json index 35a266658010..44e16f27ed66 100644 --- a/core/camel-core-processor/src/generated/resources/META-INF/services/org/apache/camel/transformer/text-plain.json +++ b/core/camel-core-processor/src/generated/resources/META-INF/services/org/apache/camel/transformer/text-plain.json @@ -12,9 +12,14 @@ "bodyTypes": { "transformerIn": { "carriers": [ - "any" + "text", + "bytes", + "stream", + "file", + "value", + "null" ], - "description": "A body Camel can convert to a String; a null body stays null" + "description": "Text, bytes, a stream, a file or a value such as a number, and a null body stays null; a Map, a List or an object would become its toString()" }, "transformerOut": { "carriers": [ diff --git a/core/camel-core-processor/src/main/java/org/apache/camel/processor/transformer/StringDataTypeTransformer.java b/core/camel-core-processor/src/main/java/org/apache/camel/processor/transformer/StringDataTypeTransformer.java index 85e4140a3c3b..99b0b5d6403b 100644 --- a/core/camel-core-processor/src/main/java/org/apache/camel/processor/transformer/StringDataTypeTransformer.java +++ b/core/camel-core-processor/src/main/java/org/apache/camel/processor/transformer/StringDataTypeTransformer.java @@ -33,8 +33,12 @@ import org.apache.camel.spi.Transformer; * mechanism. By default, uses UTF-8 charset as encoding. */ @DataTypeTransformer(name = "text-plain") -@BodyTypes(transformerIn = @BodyType(value = Carrier.ANY, - description = "A body Camel can convert to a String; a null body stays null"), +@BodyTypes(transformerIn = @BodyType(value = { + Carrier.TEXT, Carrier.BYTES, Carrier.STREAM, Carrier.FILE, Carrier.VALUE, + Carrier.NULL }, + description = "Text, bytes, a stream, a file or a value such as a number, and a" + + " null body stays null; a Map, a List or an object would become" + + " its toString()"), transformerOut = @BodyType(value = { Carrier.TEXT, Carrier.NULL }, javaType = "java.lang.String", description = "A String, or null for a null body")) public class StringDataTypeTransformer extends Transformer { diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/transformer/StringDataTypeTransformerTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/transformer/StringDataTypeTransformerTest.java index 5deda58e7cba..ffadf15323dd 100644 --- a/core/camel-core/src/test/java/org/apache/camel/processor/transformer/StringDataTypeTransformerTest.java +++ b/core/camel-core/src/test/java/org/apache/camel/processor/transformer/StringDataTypeTransformerTest.java @@ -93,9 +93,10 @@ public class StringDataTypeTransformerTest { @Test void theBodyTypesSayTheBody() throws Exception { - // CAMEL-25928: any body Camel converts, as transformerIn says, and the body transformerOut says + // CAMEL-25928: a payload or a value, as transformerIn says, and the body transformerOut says BodyTypes bodyTypes = StringDataTypeTransformer.class.getAnnotation(BodyTypes.class); - assertEquals(Carrier.ANY, bodyTypes.transformerIn().value()[0]); + assertEquals(List.of(Carrier.TEXT, Carrier.BYTES, Carrier.STREAM, Carrier.FILE, Carrier.VALUE, Carrier.NULL), + List.of(bodyTypes.transformerIn().value())); assertEquals(List.of(Carrier.TEXT, Carrier.NULL), List.of(bodyTypes.transformerOut().value())); assertEquals(String.class.getCanonicalName(), bodyTypes.transformerOut().javaType()); for (Object body : List.of("Test", "Test".getBytes(StandardCharsets.UTF_8), diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java index 4e4a4429521d..752c3f0a8968 100644 --- a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java +++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java @@ -88,6 +88,15 @@ final class CatalogBodyTypes { return !carriers.isEmpty() && carriers.stream().allMatch(c -> PAYLOAD.contains(c) || "null".equals(c)); } + /** + * A payload, maybe a value or no body as well, as the text-plain data type takes: a Map or a List would be sent + * as its toString(). + */ + boolean onlyPayloadOrValue() { + return carriers.stream().anyMatch(PAYLOAD::contains) + && carriers.stream().allMatch(c -> PAYLOAD.contains(c) || "null".equals(c) || "value".equals(c)); + } + /** A Map or a List: an iterator is not one, as it is read once and has no index. */ boolean data() { return !carriers.isEmpty() && DATA.containsAll(carriers); diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/TextBodyFlow.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/TextBodyFlow.java index 914684b59469..b40180633ef7 100644 --- a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/TextBodyFlow.java +++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/TextBodyFlow.java @@ -1436,7 +1436,7 @@ final class TextBodyFlow { // what the transformer of the in data type of the Kamelet takes ProjectFacts.KameletDataTypes types = w.kamelets().get(kamelet); CatalogBodyTypes.Answer in = types != null && types.in() != null ? w.bodyTypes().transformerIn(types.in()) : null; - return in != null && in.onlyPayload() + return in != null && in.onlyPayloadOrValue() ? new Need( name + ": the Kamelet " + kamelet + " needs the body as " + in.inWords() + " (its in data type " + types.in() + ")", @@ -1445,7 +1445,7 @@ final class TextBodyFlow { } if ("transformDataType".equals(name)) { CatalogBodyTypes.Answer in = w.bodyTypes().transformerIn(value); - return in != null && in.onlyPayload() + return in != null && in.onlyPayloadOrValue() ? new Need( "transformDataType: " + toTypeOf(value) + " needs the body as " + in.inWords(), "before this step") diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java index b6b3e5ce0f54..e7704bdf79f3 100644 --- a/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java +++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java @@ -3000,7 +3000,7 @@ public class TextBodyFlowTest { @Test public void testTransformDataTypeLeavesWhatItsTransformerMakes() { - // text-plain makes the parsed data text again, as the body types of the transformer in the catalog say + // text-plain takes a payload or a value: parsed data would become its toString(), so it needs a marshal first String yaml = """ - route: from: @@ -3012,14 +3012,15 @@ public class TextBodyFlowTest { toType: text/plain - to: file:outbox """; - assertThat(lines(yaml)).isEmpty(); + assertThat(lines(yaml)).singleElement() + .satisfies(m -> assertThat(m).contains( + "transformDataType: text/plain needs the body as text, bytes, a stream, a file or a value")); + // text-plain makes text, as the body types of the transformer in the catalog say String text = """ - route: from: uri: file:inbox steps: - - unmarshal: - json: {} - transformDataType: toType: text-plain - setHeader: @@ -3081,6 +3082,7 @@ public class TextBodyFlowTest { Set.of(), Map.of(), null, Map.of(), Map.of(), Map.of("my-source", new ProjectFacts.KameletDataTypes(null, "application-octet-stream"), "my-sink", new ProjectFacts.KameletDataTypes("application-octet-stream", null), + "my-text-sink", new ProjectFacts.KameletDataTypes("text-plain", null), "my-action", new ProjectFacts.KameletDataTypes("application-x-struct", "text-plain"), "my-events", new ProjectFacts.KameletDataTypes(null, "aws2-s3:application-cloudevents"))); @@ -3120,6 +3122,44 @@ public class TextBodyFlowTest { + " application-octet-stream)")); } + @Test + public void testAKameletTextSinkNeedsText() { + // text-plain sends a Map as its toString(): parsed data needs a marshal first + String yaml = """ + - route: + from: + uri: file:inbox + steps: + - unmarshal: + json: {} + - to: + uri: kamelet:my-text-sink + """; + assertThat(lines(yaml, KAMELETS)).singleElement() + .satisfies(m -> assertThat(m).contains( + "to: the Kamelet my-text-sink needs the body as text, bytes, a stream, a file or a value (its in" + + " data type text-plain)")); + // text is what it takes + assertThat(lines(yaml.replace("unmarshal", "marshal"), KAMELETS)).isEmpty(); + } + + @Test + public void testTransformDataTypeTextPlainNeedsText() { + String yaml = """ + - route: + from: + uri: file:inbox + steps: + - unmarshal: + json: {} + - transformDataType: + toType: text-plain + """; + assertThat(lines(yaml)).singleElement() + .satisfies(m -> assertThat(m) + .contains("transformDataType: text-plain needs the body as text, bytes, a stream, a file or a value")); + } + @Test public void testAKameletStepLeavesItsOutDataType() { // text-plain makes the parsed data text again
