feat(xml-support): implement parsing and serialisation from/to Camel XML IO files #2009

mmelko · 2025-02-13T18:26:08Z

This PR enables parsing From XML IO files to the Kaoto model and back
- All the functionality is in src/serializers/xml
XML format is enabled in the Code view when XML is pasted.
When XML is detected, XMLCamelResourceSerializer is created in the CamelResource.
Parsing and processing relies on the provided Camel Catalog. Due to differences between catalogs, or missing features manual handling of some cases was necessary.
All Entities Camel Yaml Dsl entities currently supported in Kaoto can be parsed and serialized
Serializer Selector is added in the Web UI:
- the selector is NOT added into VS Code

Fixed issues:

codecov · 2025-02-13T22:19:11Z

Codecov Report

Attention: Patch coverage is 78.49315% with 157 lines in your changes missing coverage. Please review.

Project coverage is 78.66%. Comparing base (c04c425) to head (010d834).

Files with missing lines	Patch %	Lines
packages/ui/src/utils/camel-uri-helper.ts	2.12%	46 Missing ⚠️
...i/src/serializers/xml-camel-resource-serializer.ts	20.51%	31 Missing ⚠️
...tToolbar/SerializerSelector/SerializerSelector.tsx	0.00%	19 Missing ⚠️
...serializers/xml/serializers/step-xml-serializer.ts	86.77%	16 Missing ⚠️
...erializers/xml/serializers/kaoto-xml-serializer.ts	68.75%	15 Missing ⚠️
packages/ui/src/serializers/xml/xml-utils.ts	85.00%	6 Missing ⚠️
...ckages/ui/src/models/camel/camel-route-resource.ts	42.85%	4 Missing ⚠️
.../src/serializers/yaml-camel-resource-serializer.ts	66.66%	4 Missing ⚠️
...ts/Visualization/ContextToolbar/ContextToolbar.tsx	0.00%	3 Missing ⚠️
packages/ui/src/models/camel/camel-k-resource.ts	25.00%	3 Missing ⚠️
... and 7 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2009      +/-   ##
============================================
+ Coverage     78.60%   78.66%   +0.06%     
  Complexity      367      367              
============================================
  Files           471      486      +15     
  Lines         14848    15552     +704     
  Branches       2758     2926     +168     
============================================
+ Hits          11671    12234     +563     
- Misses         3089     3230     +141     
  Partials         88       88

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lordrip · 2025-02-14T09:25:51Z

packages/ui/src/components/SourceCode/SourceCode.tsx

@@ -101,7 +102,7 @@ export const SourceCode: FunctionComponent<SourceCodeProps> = (props) => {
      code={props.code}
      onCodeChange={props.onCodeChange}
      customControls={customControls}
-      language={Language.yaml}
+      language={isXML(props.code) ? Language.xml : Language.yaml}


[curious-question] Do we already know this information from the resource's serializer?

I don't think so. Serializers are considered at the resource level when CamelResources are being created, which happens in the useEntities hook

lordrip · 2025-02-14T09:30:14Z

...ges/ui/src/components/Visualization/ContextToolbar/SerializerSelector/SerializerSelector.tsx

+  const [isOpen, setIsOpen] = useState(false);
+  const [selected, setSelected] = useState<'XML' | 'YAML'>(camelResource.getSerializer().getLabel() as 'XML' | 'YAML');
+
+  function onSelect(serializer: string) {


Do we need to use function here? Couldn't we use an arrow function like the other components?

lordrip · 2025-02-14T09:39:30Z

...ges/ui/src/components/Visualization/ContextToolbar/SerializerSelector/SerializerSelector.tsx

+export const SerializerSelector: FunctionComponent = () => {
+  const { camelResource, updateSourceCodeFromEntities } = useContext(EntitiesContext)!;
+  const [isOpen, setIsOpen] = useState(false);
+  const [selected, setSelected] = useState<'XML' | 'YAML'>(camelResource.getSerializer().getLabel() as 'XML' | 'YAML');


It seems we're leaking this casting in many different places. What do you think starting from the very root? Meaning that at the top-most interface, we define a DSL property of type XML | YAML, and from that point, the serializer would have a method that returns one value statically. From there, we propagate that information up to this [selected, setSelected], and we won't need the <'XML' | 'YAML'> part as the type will be inferred from the serializer method.

Continuing on that path, I would leave it up to the camel resource how to instantiate the serializer, meaning that in the onSelect callback we would pass the serializer string and then the camel resource would change the serializer if finds it, otherwise it could throw an error.

In an ideal scenario, we would like to create new objects to the camel resource.

lordrip · 2025-02-14T09:39:55Z

...ges/ui/src/components/Visualization/ContextToolbar/SerializerSelector/SerializerSelector.tsx

+      onSelect={(_event, value) => onSelect(value as string)}
+      onOpenChange={(isOpen) => setIsOpen(isOpen)}
+      toggle={toggle}
+      style={{ width: '20rem' }}


Could we please move this to a dedicated SCSS file?

lordrip · 2025-02-14T09:40:30Z

...ges/ui/src/components/Visualization/ContextToolbar/SerializerSelector/SerializerSelector.tsx

+      onSelect={(_event, value) => onSelect(value as string)}
+      onOpenChange={(isOpen) => setIsOpen(isOpen)}


the onSelect attribute expects a void callback, but instead of providing one, we're passing a function that returns the output of the onSelect callback, could we write it in a void fashion, so it doesn't get decorated with return?

This:

() => doSomething();

get's transpiled to:

() => { return doSomething(); }

So for functions that don't need to return anything, is better to write them accordingly

Suggested change

onSelect={(_event, value) => onSelect(value as string)}

onOpenChange={(isOpen) => setIsOpen(isOpen)}

onSelect={(_event, value) => {

onSelect(value as string) }

}

onOpenChange={(isOpen) => {

setIsOpen(isOpen) }

}

lordrip · 2025-02-14T10:01:48Z

packages/ui/src/serializers/xml/parsers/beans-xml-parser.ts

@@ -0,0 +1,95 @@
+/*
+ * Copyright (C) 2023 Red Hat, Inc.


Suggested change

* Copyright (C) 2023 Red Hat, Inc.

* Copyright (C) 2025 Red Hat, Inc.

lordrip · 2025-02-14T10:03:00Z

packages/ui/src/serializers/xml/parsers/expression-parser.test.ts

+ * limitations under the License.
+ */
+
+import { describe } from 'node:test';


This seems suspicious 👀 , we're using jest, so this might break in older nodejs versions.

import { describe } from 'node:test';

lordrip · 2025-02-14T10:03:52Z

packages/ui/src/serializers/xml/parsers/rest-xml-parser.test.ts

+  });
+
+  it('should parse rest verbs correctly', () => {
+    const xml = `


is it possible to use an XML file instead? Even if it's not valid due to not having the <camel> tag, at least we would get a bit of autocompletion and coloring 😄 .

Coloring is important 😇

lordrip · 2025-02-14T12:21:57Z

packages/ui/src/serializers/xml/parsers/step-parser.test.ts

+  splitEntity,
+  throttleEntity,
+} from '../../../stubs/eip-entity-snippets';
+describe('parser basics', () => {


Suggested change

describe('parser basics', () => {

describe('parser basics', () => {

lordrip · 2025-02-14T12:24:06Z

packages/ui/src/serializers/xml/serializers/kaoto-xml-serializer.ts

+export type EntityDefinition =
+  | CamelRouteVisualEntity
+  | CamelErrorHandlerVisualEntity
+  | CamelRestVisualEntity
+  | BeansEntity
+  | CamelInterceptFromVisualEntity
+  | CamelInterceptSendToEndpointVisualEntity
+  | CamelInterceptVisualEntity
+  | CamelRouteConfigurationVisualEntity
+  | CamelOnCompletionVisualEntity
+  | CamelOnExceptionVisualEntity
+  | CamelRestConfigurationVisualEntity;


it might be better to move this type somewhere else, maybe a bit higher in the structure, as this might come handy for other code.

…urce files. (cherry picked from commit 3eb48b9)

…ntities to XML (cherry picked from commit f2618a4)

… with Kaoto (cherry picked from commit 7b03dd8)

…format (cherry picked from commit 8971aa5)

…YAML ones (cherry picked from commit 327b7c4)

(cherry picked from commit 5f8bb32)

(cherry picked from commit 37bd939)

(cherry picked from commit 279cbdf)

…efined

…ar and add it as a additionalControls component fix:add missing key to SerializerSelector

fixes KaotoIO#1997

fixes: KaotoIO#1999

sonarqubecloud · 2025-02-20T20:51:33Z

Quality Gate failed

Failed conditions
3 Security Hotspots

See analysis details on SonarQube Cloud

mmelko force-pushed the xml-support branch 3 times, most recently from c8dd60b to 5f8bb32 Compare February 13, 2025 22:10

lordrip reviewed Feb 14, 2025

View reviewed changes

mmelko force-pushed the xml-support branch 2 times, most recently from 7aabd4a to 279cbdf Compare February 18, 2025 14:52

mmelko added 9 commits February 19, 2025 18:30

feat(xml-support): Create xml-parser that enables Kaoto to use XML so…

7de4212

…urce files. (cherry picked from commit 3eb48b9)

feat(xml-support):Create xml-serializers that allow serialize camel e…

797aa2a

…ntities to XML (cherry picked from commit f2618a4)

feat(xml-support): Use XML parsers and serializers to allow using XML…

32ab491

… with Kaoto (cherry picked from commit 7b03dd8)

feat(ContextToolbar): Add Serializer selector to allow choose target …

899b7c8

…format (cherry picked from commit 8971aa5)

test(xml-support): Add test that compares files from XML folder with …

a878cea

…YAML ones (cherry picked from commit 327b7c4)

fix: Tests and sonar reports

fbb3156

(cherry picked from commit 5f8bb32)

fix(rest-xml-serializer): Check also {rest:RestDef} structure

3da15e8

(cherry picked from commit 37bd939)

refactor: Apply code review feedback

61974ee

(cherry picked from commit 279cbdf)

fix(xml-step-serializer):Add checking the steps being defined

9ddbfc9

mmelko force-pushed the xml-support branch 2 times, most recently from 862fe59 to 8849b16 Compare February 20, 2025 20:15

mmelko changed the title ~~[DRAFT] feat(xml-support): implement parsing and serialisation from/to Camel XML IO files~~ feat(xml-support): implement parsing and serialisation from/to Camel XML IO files Feb 20, 2025

mmelko added 4 commits February 20, 2025 21:48

fix(xml-serializer): Add aditional checks if the array elements are d…

9b76016

…efined

refactor(ContextToolbar): Move SerializerSelector out of ContextToolb…

388471d

…ar and add it as a additionalControls component fix:add missing key to SerializerSelector

fix(beans-xml-parser): Parse also beans defined outside of beans element

a5148a3

fixes KaotoIO#1997

fix(xml-beans): process script element

010d834

fixes: KaotoIO#1999

mmelko force-pushed the xml-support branch from 8849b16 to 010d834 Compare February 20, 2025 20:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(xml-support): implement parsing and serialisation from/to Camel XML IO files #2009

feat(xml-support): implement parsing and serialisation from/to Camel XML IO files #2009

mmelko commented Feb 13, 2025 •

edited

Loading

codecov bot commented Feb 13, 2025 •

edited

Loading

lordrip Feb 14, 2025

mmelko Feb 17, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

lordrip Feb 14, 2025

sonarqubecloud bot commented Feb 20, 2025

		onSelect={(_event, value) => onSelect(value as string)}
		onOpenChange={(isOpen) => setIsOpen(isOpen)}

-      onSelect={(_event, value) => onSelect(value as string)}
-      onOpenChange={(isOpen) => setIsOpen(isOpen)}
+      onSelect={(_event, value) => {
+        onSelect(value as string) }
+      }
+      onOpenChange={(isOpen) => {
+        setIsOpen(isOpen) }
+      }

	* Copyright (C) 2023 Red Hat, Inc.
	* Copyright (C) 2025 Red Hat, Inc.

	describe('parser basics', () => {

	describe('parser basics', () => {

feat(xml-support): implement parsing and serialisation from/to Camel XML IO files #2009

Are you sure you want to change the base?

feat(xml-support): implement parsing and serialisation from/to Camel XML IO files #2009

Conversation

mmelko commented Feb 13, 2025 • edited Loading

codecov bot commented Feb 13, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 20, 2025

Quality Gate failed

mmelko commented Feb 13, 2025 •

edited

Loading

codecov bot commented Feb 13, 2025 •

edited

Loading