fix(kamelets): Edit Kamelets' nodes properties #651
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lordrip
force-pushed
the
fix/edit-kamelets
branch
from
6e03ccc to
e83c97f
Compare
4 tasks
lhein
approved these changes
Jan 17, 2024
tplevko
reviewed
Jan 17, 2024
Currently, Kamelets' nodes can't be edited using the Canvas Form, causing the changes made by the user, are not serialized into the source code. This bug was caused due to a problem in the serialization of the `KameletResource`, because despite the `Canvas Form` editing the `KameletVisualEntity` correctly, what ultimately was serialized was the original `Kamelet` without changes. The fix is to ensure that we're serializing the `KameletVisualEntity.from` as part of the resulting `KameletResource.toJSON()` method. This change opens up a more broad topic about `Kamelets`, at this moment, the `KameletVisualEntity` class knows about the underlying flow (`kamelet.spec.template.from`) and its metadata (`kamelet.metadata`), and this shouldn't be the case. Ideally, `KameletVisualEntity` would have knowledge about the flow only but the issue with this is that it will close the possibility of renaming the flow, as the `setId` method is defined in the `KameletVisualEntity` class. A solution for this could be to create an intermediate `setId` functionality in the `CamelResource` interface itself which will later on delegate the change to the underlying `VisualEntities.setId()` method if necessary, this way, in case of `Kamelets` and `Pipes`, we have the chance to update its metadata and also the underlying flow. In addition to that, it would be convenient to offer a mechanism to sort the properties of the underlying `VisualEntities`, this way we could sort the entire `Kamelet` in a `kubernetes` friendly way and also keeping the underlying `Camel Route` sorted differently. fix: KaotoIO#594
lordrip
force-pushed
the
fix/edit-kamelets
branch
from
e83c97f to
7b65062
Compare
tplevko
approved these changes
Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Currently, Kamelets' nodes can't be edited using the Canvas Form, causing the changes made by the user, are not serialized into the source code.
This bug was caused due to a problem in the serialization of the
KameletResource, because despite theCanvas Formediting theKameletVisualEntitycorrectly, what ultimately was serialized was the originalKameletwithout changes.Changes
The fix is to ensure that we're serializing the
KameletVisualEntity.fromas part of the resultingKameletResource.toJSON()method.Notes
This change opens up a more broad topic about
Kamelets, at this moment, theKameletVisualEntityclass has knowledge about the underlying flow (kamelet.spec.template.from) and its metadata (kamelet.metadata), and this shouldn't be the case.Ideally,
KameletVisualEntitywould have knowledge about the flow only but the issue with this is that it will close the possibility of renaming the flow, as thesetIdmethod is defined in theKameletVisualEntityclass. A solution for this could be to create an intermediatesetIdfunctionality in theCamelResourceinterface itself which will later on delegate the change to the underlyingVisualEntities.setId()method if necessary, this way, in case ofKameletsandPipes, we have the chance to update its metadata and also the underlying flow.In addition to that, it would be convenient to offer a mechanism to sort the properties of the underlying
VisualEntities, this way we could sort the entireKameletin akubernetesfriendly way and also keep the underlyingCamel Routesorted differently. This will be discussed in: #652fix: #594