Fixes #26861: Migration from Box to ZIO : Refactor XmlUnserialisation #6357
Conversation
This file contains hidden or 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
clarktsiory
reviewed
May 6, 2025
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
Contributor
Author
|
PR updated with a new commit |
Contributor
Author
|
Commit modified |
5d5d85c to
c47cc2c
Compare
Contributor
Author
|
PR updated with a new commit |
clarktsiory
reviewed
May 7, 2025
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
Contributor
Author
|
PR updated with a new commit |
1 similar comment
Contributor
Author
|
PR updated with a new commit |
skaerg
commented
May 9, 2025
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
2234554 to
8a0f048
Compare
clarktsiory
reviewed
May 14, 2025
...main/scala/com/normation/rudder/services/workflows/CommitAndDeployChangeRequestService.scala
Outdated
Show resolved
Hide resolved
clarktsiory
reviewed
May 15, 2025
...r-core/src/test/scala/com/normation/rudder/services/marshalling/TestXmlUnserialisation.scala
Outdated
Show resolved
Hide resolved
clarktsiory
requested changes
May 15, 2025
Contributor
clarktsiory
left a comment
There was a problem hiding this comment.
It is great having such a migration, it covers already a lot.
There were some other methods in CommitAndDeployChangeRequestServiceImpl that still could be migrated, as propagated changes (to avoid toBox).
Also the XmlUtils API is nice, I have some suggestions to make it easier to use.
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
Contributor
Author
|
PR updated with a new commit |
clarktsiory
reviewed
May 16, 2025
...main/scala/com/normation/rudder/services/workflows/CommitAndDeployChangeRequestService.scala
Outdated
Show resolved
Hide resolved
clarktsiory
reviewed
May 16, 2025
...main/scala/com/normation/rudder/services/workflows/CommitAndDeployChangeRequestService.scala
Outdated
Show resolved
Hide resolved
clarktsiory
requested changes
May 19, 2025
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
Contributor
Author
|
PR updated with a new commit |
clarktsiory
reviewed
May 19, 2025
...r-core/src/main/scala/com/normation/rudder/services/marshalling/XmlUnserialisationImpl.scala
Outdated
Show resolved
Hide resolved
Contributor
Author
|
PR updated with a new commit |
clarktsiory
reviewed
May 20, 2025
Comment on lines
130
to
133
| (config, trigger) <- changeRequest match { | ||
| case config: ConfigurationChangeRequest => | ||
| if (!isMergeableConfigurationChangeRequest(config)) { | ||
| ChangeRequestLogger.info( | ||
| logger.info( |
Contributor
There was a problem hiding this comment.
right above this, there is some code that can be put in the for-comprehension instead :
workflowEnabled().either.runNow match {
case Right(b) => if (b) logger.info(s"Saving and deploying change request ${changeRequest.id.value}")
case _ => ()
}
Contributor
Author
|
PR updated with a new commit |
clarktsiory
requested changes
May 21, 2025
|
|
||
| for { | ||
| workflowEnabled <- workflowEnabled().toBox | ||
| _ = if (workflowEnabled) logger.info(s"Saving and deploying change request ${changeRequest.id.value}") |
Contributor
There was a problem hiding this comment.
the logger is pure, so this will just skip the log. It needs to be <-
Contributor
There was a problem hiding this comment.
the for-comprehension likely needs to be for IOResult, and not Box, the toIO at the end should be avoided
Contributor
Author
|
PR updated with a new commit |
clarktsiory
requested changes
May 21, 2025
Comment on lines
125
to
127
| _ <- workflowEnabled().toBox.map(workflowEnabled => { | ||
| if (workflowEnabled) logger.info(s"Saving and deploying change request ${changeRequest.id.value}") | ||
| }) |
Contributor
There was a problem hiding this comment.
This will still not do the log, the pure logger needs to be evaluated (the result of this expression is Box[IOResult[Unit]]).
The whole for-comprehension needs to be a IOResult one, there are nested toBox and toIO and we don't want that. In fact the toIO and the end needs to be removed (you will likely need to do saveConfigurationChangeRequest(...).toIO)
Contributor
Author
|
PR updated with a new commit |
clarktsiory
approved these changes
May 21, 2025
Contributor
|
OK, squash merging this PR |
#XmlUnserialisationImpl: chain additional error if unserialisation fails ; CmdbQueryParser pure implementation
88fd787 to
e371c1b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
https://issues.rudder.io/issues/26861
This is part of the plan to remove the dependency to the lift library from Rudder and Rudder plugins.
This PR migrates the following classes in XmlUnserialisation :
This change also includes a new
XmlUtilsobject, which offers methods to look up a specific child node or attribute of a given XML node, and the error handling that comes with it. XmlUtils may be used in order to migrate the remaining classes in XmlUnserialisationThis PR is part of the migration from Box to ZIO in change-validation, and is linked to the following PR in the Rudder plugins repository : Normation/rudder-plugins#828