Validate connection on Preprocess step #227
Merged
+2
−0
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
This *could* be fixed in the collectionspace-mapper (see below) but I am doing it here on the principle of saving the user time and effort. They shouldn't have to go through the preprocess step (which can take a few minutes) and click through to Processing and starting that step to find out their connection credentials will not let them complete a batch. The preprocessing step doesn't require a connection to the CollectionSpace instance, but it does make calls to methods on the collectionspace-mapper handler associated with the batch. On instantiation, the handler class attempts to set instance domain by calling client.domain, which fails if the client cannot authenticate. It probably shouldn't do that on instantiation, I will make a note to improve that later, but again, an unusable connection should be caught/reported to users ASAP by the importer, which means at the beginning of preprocessing (if not on batch creation).
mark-cooper
approved these changes
Feb 4, 2025
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.
Connection authentication check was added to all workflow steps in PR 200, but removed (kept in only the processing and transferring steps) as part of refactoring/cleanup in PR 204.
This PR adds this check back to the preprocessing step, on the principle of saving the user time and effort. They should find out about an unusable connection to CollectionSpace ASAP when starting on a batch. If that's not at batch creation time, then it should be in the preprocessing step.
Resolves #226