refactor(xmlupload): refactor resource creation #917
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
jnussbaum
commented
Apr 30, 2024
jnussbaum
commented
Apr 30, 2024
jnussbaum
commented
Apr 30, 2024
Nora-Olivia-Ammann
approved these changes
May 8, 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.
Problem statement
The processes of xmlupload during resource creation are not tested, because they are not testable. It is unclear if the error handling, the preservation of the current state, and the user communication are correct.
Approach
Make the
UploadStatemutable, and create it at the very beginning at a high level. Then, modify it in the lower level functions. This allows testing the higher level functions, using mocking.Challenges
The things stored in
UploadStatemust be slightly rearranged. So the new DSP-TOOLS version won't be able to continue an xmlupload aborted with an older version. -> Don't forget to inform RDU.Because of logging/printing,
_tidy_up_resource_creation_idempotent()is not really idempotent any more.