reflect PR comments

packages/ui/src/hooks/entities.test.tsx

@@ -59,12 +59,14 @@ describe('useEntities', () => {
     expect(notifierSpy).toHaveBeenCalledWith('entities:updated', camelRouteYaml_1_1_updated);
   });
 
-  it('should notifiy subscribers when the entities are updated', () => {
+  it('should notify subscribers when the entities are updated', () => {
     const notifierSpy = jest.spyOn(eventNotifier, 'next');
     const { result } = renderHook(() => useEntities());
 
     act(() => {
+      console.log('result.current.camelResource:', result.current.camelResource);
       result.current.camelResource.addNewEntity();
+      console.log('result.current.camelResource:', result.current.camelResource);
       result.current.updateSourceCodeFromEntities();
     });
 
@@ -162,69 +164,4 @@ describe('useEntities', () => {
 `,
     );
   });
-
-  describe('comments', () => {
-    it(`should store code's comments`, () => {
-      const code = `# This is a comment
-      # An indented comment
-
-- route:
-    id: route-1234
-    from:
-      id: from-1234
-      uri: timer
-      parameters:
-        period: "1000"
-        timerName: template
-      # This comment won't be stored
-      steps:
-        - log:
-            id: log-1234
-            message: \${body}
-`;
-
-      const { result } = renderHook(() => useEntities());
-
-      act(() => {
-        eventNotifier.next('code:updated', code);
-      });
-
-      expect(result.current.camelResource.getComments()).toEqual([
-        '# This is a comment',
-        '      # An indented comment',
-        '',
-      ]);
-    });
-
-    it('should add comments to the source code', () => {
-      const notifierSpy = jest.spyOn(eventNotifier, 'next');
-      const { result } = renderHook(() => useEntities());
-
-      act(() => {
-        result.current.camelResource.setComments(['# This is a comment', '      # An indented comment', '']);
-        result.current.camelResource.addNewEntity();
-        result.current.updateSourceCodeFromEntities();
-      });
-
-      expect(notifierSpy).toHaveBeenCalledWith(
-        'entities:updated',
-        `# This is a comment
-      # An indented comment
-
-- route:
-    id: route-1234
-    from:
-      id: from-1234
-      uri: timer
-      parameters:
-        period: "1000"
-        timerName: template
-      steps:
-        - log:
-            id: log-1234
-            message: \${body}
-`,
-      );
-    });
-  });
 });

packages/ui/src/hooks/entities.ts

@@ -6,17 +6,6 @@ import { BaseVisualCamelEntity } from '../models/visualization/base-visual-entit
 import { EventNotifier } from '../utils';
 import { CamelResourceFactory } from '../models/camel/camel-resource-factory';
 
-/**
- * Regular expression to match commented lines, regardless of indentation
- * Given the following examples, the regular expression should match the comments:
- * ```
- * # This is a comment
- *     # This is an indented comment
- *# This is an indented comment
- * ```
- * The regular expression should match the first three lines
- */
-
 export interface EntitiesContextResult {
   entities: BaseCamelEntity[];
   currentSchemaType: SourceSchemaType;

packages/ui/src/models/camel/__snapshots__/camel-resource.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`createCamelResource should create an empty KameletResource if no args is specified 1`] = `
+exports[`CamelResourceFactory.createCamelResource should create an empty KameletResource if no args is specified 1`] = `
 [
   {
     "from": {

packages/ui/src/models/camel/camel-k-resource-factory.ts

@@ -13,7 +13,8 @@ import {
 
 export class CamelKResourceFactory {
   static getCamelKResource(json?: unknown, type?: SourceSchemaType): CamelResource | undefined {
-    const jsonRecord = json as Record<string, unknown>;
+    const jsonRecord = json ? (json as Record<string, unknown>) : {};
+
     if ((jsonRecord && typeof json === 'object' && 'kind' in jsonRecord) || type) {
       switch (jsonRecord['kind'] || type) {
         case SourceSchemaType.Integration:
@@ -24,8 +25,6 @@ export class CamelKResourceFactory {
           return new KameletBindingResource(json as KameletBindingType);
         case SourceSchemaType.Pipe:
           return new PipeResource(json as PipeType);
-        default:
-          return undefined;
       }
     }
     return undefined;

packages/ui/src/models/camel/camel-k-resource.ts

@@ -35,8 +35,6 @@ export abstract class CamelKResource implements CamelResource {
     parsedResource: unknown,
     private readonly serializer: CamelResourceSerializer = new YamlCamelResourceSerializer(),
   ) {
-    this.serializer = serializer;
-
     if (parsedResource) {
       this.resource = parsedResource as CamelKType;
     } else {

packages/ui/src/models/camel/camel-resource-factory.ts

@@ -1,6 +1,6 @@
 import { SourceSchemaType } from './source-schema-type';
 import { CamelResource } from './camel-resource';
-import { XmlCamelResourceSerializer, YamlCamelResourceSerializer } from '../../serializers';
+import { CamelResourceSerializer, XmlCamelResourceSerializer, YamlCamelResourceSerializer } from '../../serializers';
 import { CamelRouteResource } from './camel-route-resource';
 import { CamelKResourceFactory } from './camel-k-resource-factory';
 
@@ -14,14 +14,14 @@ export class CamelResourceFactory {
    * @param source
    */
   static createCamelResource(source?: string, type?: SourceSchemaType): CamelResource {
-    if (XmlCamelResourceSerializer.isApplicable(source)) {
-      return new CamelRouteResource(source, new XmlCamelResourceSerializer());
-    }
+    const serializer: CamelResourceSerializer = XmlCamelResourceSerializer.isApplicable(source)
+      ? new XmlCamelResourceSerializer()
+      : new YamlCamelResourceSerializer();
 
-    const serializer = new YamlCamelResourceSerializer();
-    const resource = CamelKResourceFactory.getCamelKResource(serializer.parse(source ?? ''), type);
+    const parsedCode = source ? serializer.parse(source) : source;
+    const resource = CamelKResourceFactory.getCamelKResource(parsedCode, type);
 
     if (resource) return resource;
-    return new CamelRouteResource(source, serializer);
+    return new CamelRouteResource(parsedCode, serializer);
   }
 }

packages/ui/src/models/camel/camel-resource.test.ts

@@ -70,7 +70,7 @@ describe('CamelResourceFactory.createCamelResource', () => {
   });
 
   it('should create a Kamelet', () => {
-    const resource = CamelResourceFactory.createCamelResource(kameletJson);
+    const resource = CamelResourceFactory.createCamelResource(JSON.stringify(kameletJson));
     expect(resource.getType()).toEqual(SourceSchemaType.Kamelet);
     expect(resource.getVisualEntities().length).toEqual(1);
   });

packages/ui/src/models/camel/camel-route-resource.test.ts

@@ -13,7 +13,7 @@ import { CamelResourceFactory } from './camel-resource-factory';
 
 describe('CamelRouteResource', () => {
   it('should create CamelRouteResource', () => {
-    const resource = new CamelRouteResource(camelRouteYaml);
+    const resource = new CamelRouteResource(camelRouteJson);
     expect(resource.getType()).toEqual(SourceSchemaType.Route);
     expect(resource.getVisualEntities().length).toEqual(1);
     expect(resource.getEntities().length).toEqual(0);
@@ -39,7 +39,7 @@ describe('CamelRouteResource', () => {
       [null, undefined],
       [[], undefined],
     ])('should return the appropriate entity for: %s', (json, expected) => {
-      const resource = new CamelRouteResource(JSON.stringify(json));
+      const resource = new CamelRouteResource(json);
       const firstEntity = resource.getVisualEntities()[0] ?? resource.getEntities()[0];
 
       if (typeof expected === 'function') {
@@ -98,22 +98,22 @@ describe('CamelRouteResource', () => {
   });
 
   it('should return visual entities', () => {
-    const resource = new CamelRouteResource(camelRouteYaml);
+    const resource = new CamelRouteResource(camelRouteJson);
     expect(resource.getVisualEntities()).toHaveLength(1);
     expect(resource.getVisualEntities()[0]).toBeInstanceOf(CamelRouteVisualEntity);
     expect(resource.getEntities()).toHaveLength(0);
   });
 
   it('should return entities', () => {
-    const resource = new CamelRouteResource(JSON.stringify(beansJson));
+    const resource = new CamelRouteResource(beansJson);
     expect(resource.getEntities()).toHaveLength(1);
     expect(resource.getEntities()[0]).toBeInstanceOf(BeansEntity);
     expect(resource.getVisualEntities()).toHaveLength(0);
   });
 
   describe('toJSON', () => {
     it('should return JSON', () => {
-      const resource = new CamelRouteResource(camelRouteYaml);
+      const resource = new CamelRouteResource(camelRouteJson);
       expect(resource.toJSON()).toMatchSnapshot();
     });
 
@@ -141,23 +141,23 @@ describe('CamelRouteResource', () => {
 
   describe('removeEntity', () => {
     it('should not do anything if the ID is not provided', () => {
-      const resource = new CamelRouteResource(camelRouteYaml);
+      const resource = new CamelRouteResource(camelRouteJson);
 
       resource.removeEntity();
 
       expect(resource.getVisualEntities()).toHaveLength(1);
     });
 
     it('should not do anything when providing a non existing ID', () => {
-      const resource = new CamelRouteResource(camelRouteYaml);
+      const resource = new CamelRouteResource(camelRouteJson);
 
       resource.removeEntity('non-existing-id');
 
       expect(resource.getVisualEntities()).toHaveLength(1);
     });
 
     it('should allow to remove an entity', () => {
-      const resource = new CamelRouteResource(JSON.stringify([camelRouteJson, camelFromJson]));
+      const resource = new CamelRouteResource([camelRouteJson, camelFromJson]);
       const camelRouteEntity = resource.getVisualEntities()[0];
 
       resource.removeEntity(camelRouteEntity.id);
@@ -166,7 +166,7 @@ describe('CamelRouteResource', () => {
     });
 
     it('should NOT create a new entity after deleting them all', () => {
-      const resource = new CamelRouteResource(camelRouteYaml);
+      const resource = new CamelRouteResource(camelRouteJson);
       const camelRouteEntity = resource.getVisualEntities()[0];
 
       resource.removeEntity(camelRouteEntity.id);
@@ -209,7 +209,7 @@ describe('CamelRouteResource', () => {
       [{ anotherUnknownContent: {} }],
       [{}],
     ])('should not throw error when calling: %s', (json) => {
-      const resource = new CamelRouteResource(JSON.stringify(json));
+      const resource = new CamelRouteResource(json);
       const firstEntity = resource.getVisualEntities()[0] ?? resource.getEntities()[0];
       expect(firstEntity.toJSON()).not.toBeUndefined();
     });

packages/ui/src/models/camel/camel-route-resource.ts

@@ -50,12 +50,11 @@ export class CamelRouteResource implements CamelResource, BeansAwareResource {
   private resolvedEntities: BaseVisualCamelEntityDefinition | undefined;
   private serializer: CamelResourceSerializer;
 
-  constructor(code?: string, serializer?: CamelResourceSerializer) {
+  constructor(code?: unknown, serializer?: CamelResourceSerializer) {
     this.serializer = serializer ?? new YamlCamelResourceSerializer();
     if (!code) return;
 
-    const parsedCode = this.serializer.parse(code);
-    const entities = Array.isArray(parsedCode) ? parsedCode : [parsedCode];
+    const entities = Array.isArray(code) ? code : [code];
     this.entities = entities.reduce((acc, rawItem) => {
       const entity = this.getEntity(rawItem);
       if (isDefined(entity) && typeof entity === 'object') {

packages/ui/src/models/camel/kamelet-resource.test.ts

@@ -1,10 +1,10 @@
 import { kameletJson } from '../../stubs/kamelet-route';
 import { AddStepMode } from '../visualization/base-visual-entity';
 import { CamelComponentFilterService } from '../visualization/flows/support/camel-component-filter.service';
-import { createCamelResource } from './camel-resource';
 import { KameletResource } from './kamelet-resource';
 import { SourceSchemaType } from './source-schema-type';
-import { cloneDeep } from 'lodash';
+import { CamelKResourceFactory } from './camel-k-resource-factory';
+import cloneDeep from 'lodash/cloneDeep';
 
 describe('KameletResource', () => {
   it('should create a new KameletResource', () => {
@@ -78,7 +78,7 @@ describe('KameletResource', () => {
     it('should delegate to the CamelComponentFilterService', () => {
       const filterSpy = jest.spyOn(CamelComponentFilterService, 'getKameletCompatibleComponents');
 
-      const resource = createCamelResource(kameletJson);
+      const resource = CamelKResourceFactory.getCamelKResource(kameletJson)!;
       resource.getCompatibleComponents(AddStepMode.ReplaceStep, { path: 'from', label: 'timer' });
 
       expect(filterSpy).toHaveBeenCalledWith(AddStepMode.ReplaceStep, { path: 'from', label: 'timer' }, undefined);

packages/ui/src/models/camel/kamelet-resource.ts

@@ -62,7 +62,7 @@ export class KameletResource extends CamelKResource implements RouteTemplateBean
      * the CamelRouteVisualEntity.
      */
     set(this.resource, 'metadata.name', this.flow.getId());
-    set(this.resource, 'spec.template.from', this.flow.route.from);
+    set(this.resource, 'spec.template.from', this.flow.entityDef.template.from);
     set(this.resource, 'spec.template.beans', this.beans?.parent.beans);
     return this.resource as IKameletDefinition;
   }

packages/ui/src/serializers/yaml-camel-resource-serializer.test.ts

@@ -0,0 +1,32 @@
+import { YamlCamelResourceSerializer } from './yaml-camel-resource-serializer';
+import { camelRouteJson, camelRouteYaml } from '../stubs';
+import { CamelRouteResource } from '../models/camel';
+
+describe('YamlCamelResourceSerializer', () => {
+  let serializer: YamlCamelResourceSerializer;
+
+  beforeEach(() => {
+    serializer = new YamlCamelResourceSerializer();
+  });
+
+  it('parses YAML code into JSON object', () => {
+    const result = serializer.parse(camelRouteYaml);
+    expect(result).toEqual([camelRouteJson]);
+  });
+
+  it('returns empty array for empty or non-string input in parse', () => {
+    expect(serializer.parse('')).toEqual([]);
+    expect(serializer.parse(null as unknown as string)).toEqual([]);
+    expect(serializer.parse(123 as unknown as string)).toEqual([]);
+  });
+
+  it('includes comments in serialized YAML string', () => {
+    const entities = serializer.parse('# comment1\n' + camelRouteYaml);
+    console.log(serializer.comments);
+    expect(serializer.comments.includes('# comment1')).toBeTruthy();
+
+    serializer.comments.push('# Comment2');
+    const result = serializer.serialize(new CamelRouteResource(entities));
+    expect(result).toContain('# Comment2');
+  });
+});

packages/ui/src/serializers/yaml-camel-resource-serializer.ts

@@ -3,18 +3,28 @@ import { parse, stringify } from 'yaml';
 import { CamelResourceSerializer } from './camel-resource-serializer';
 
 export class YamlCamelResourceSerializer implements CamelResourceSerializer {
+  /**
+   * Regular expression to match commented lines, regardless of indentation
+   * Given the following examples, the regular expression should match the comments:
+   * ```
+   * # This is a comment
+   *     # This is an indented comment
+   *# This is an indented comment
+   * ```
+   * The regular expression should match the first three lines
+   */
   COMMENTED_LINES_REGEXP = /^\s*#.*$/;
   comments: string[] = [];
 
-  static isApplicable(code: unknown): boolean {
+  static isApplicable(_code: unknown): boolean {
     //TODO
     // return !isXML(code);
 
     return true;
   }
 
   parse(code: string): unknown {
-    if (!code || typeof code !== 'string') return {};
+    if (!code || typeof code !== 'string') return [];
 
     this.comments = this.parseComments(code);
     const json = parse(code);