DXCDT-370: Check prerequisites for keyword preservation #754
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
…T-375-rename-load-to-loadAssetsFromAuth0
…ort' into fix-make-keyword-preservation-more-flexible
willvedd
commented
Feb 23, 2023
| export const setupContext = async (config: Config): Promise<DirectoryContext | YAMLContext> => { | ||
| export const setupContext = async ( | ||
| config: Config, | ||
| command: 'import' | 'export' |
There was a problem hiding this comment.
It was necessary for me to introduce this command argument to exclude the prerequisite checks if an import was being run.
sergiught
approved these changes
Feb 27, 2023
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.
🔧 Changes
In order for keyword preservation to work, there are two key prerequisites that must be met:
If the above criteria are not met, it suggests an erroneous condition and that data loss could occur. This PR introduces checks to ensure that these prerequisites are met before attempting to preserve keywords. Otherwise, an exception will be thrown. It is debatable wether or not an exception is a bit harsh, but for this first iteration I'm proposing to stay on the safer side and stop the usage of keyword preservation if it is doomed to work.
🔬 Testing
Added E2E tests for both checks.
📝 Checklist