DXCDT-383: Integrate preserveKeywords function into export process
#751
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
willvedd
commented
Feb 22, 2023
src/context/yaml/index.ts
Outdated
Comment on lines
124
to
142
|
|
||
| const shouldPreserveKeywords = | ||
| //@ts-ignore because the string=>boolean conversion may not have happened if passed-in as env var | ||
| this.config.AUTH0_PRESERVE_KEYWORDS === 'true' || | ||
| this.config.AUTH0_PRESERVE_KEYWORDS === true; | ||
| if (shouldPreserveKeywords) { | ||
| await this.loadAssetsFromLocal({ disableKeywordReplacement: true }); | ||
| const localAssets = { ...this.assets }; | ||
| //@ts-ignore | ||
| delete this['assets']; | ||
|
|
||
| this.assets = preserveKeywords( | ||
| localAssets, | ||
| auth0.assets, | ||
| this.config.AUTH0_KEYWORD_REPLACE_MAPPINGS || {} | ||
| ); | ||
| } else { | ||
| this.assets = auth0.assets; | ||
| } |
There was a problem hiding this comment.
One of the integration points; into the yaml context handler.
willvedd
commented
Feb 22, 2023
src/context/directory/index.ts
Outdated
Comment on lines
80
to
98
| await this.loadAssetsFromLocal({ disableKeywordReplacement: true }); //Need to disable keyword replacement to retrieve the raw keyword markers (ex: ##KEYWORD##) | ||
|
|
||
| const shouldPreserveKeywords = | ||
| //@ts-ignore because the string=>boolean conversion may not have happened if passed-in as env var | ||
| this.config.AUTH0_PRESERVE_KEYWORDS === 'true' || | ||
| this.config.AUTH0_PRESERVE_KEYWORDS === true; | ||
| if (shouldPreserveKeywords) { | ||
| const localAssets = { ...this.assets }; | ||
| //@ts-ignore | ||
| delete this['assets']; | ||
|
|
||
| this.assets = preserveKeywords( | ||
| localAssets, | ||
| auth0.assets, | ||
| this.config.AUTH0_KEYWORD_REPLACE_MAPPINGS || {} | ||
| ); | ||
| } else { | ||
| this.assets = auth0.assets; | ||
| } |
There was a problem hiding this comment.
One of the integration points; into the directory context handler.
willvedd
commented
Feb 22, 2023
| @@ -205,6 +205,7 @@ export type Config = { | |||
| AUTH0_ALLOW_DELETE: boolean; | |||
| AUTH0_EXCLUDED?: AssetTypes[]; | |||
| AUTH0_INCLUDED_ONLY?: AssetTypes[]; | |||
| AUTH0_PRESERVE_KEYWORDS: boolean; | |||
There was a problem hiding this comment.
Introduction of the configuration to enable user opt-in behavior. Will be integrated as a flag in a later PR.
There was a problem hiding this comment.
💡 🤔 What if we keep it as a config key only?
willvedd
force-pushed
the
DXCDT-383-integrate-preserve-keywords-function-into-export
branch
from
a02e799 to
df66ab0
Compare
2 tasks
Codecov ReportBase: 83.93% // Head: 84.30% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #751 +/- ##
==========================================
+ Coverage 83.93% 84.30% +0.36%
==========================================
Files 115 115
Lines 3462 3486 +24
Branches 650 659 +9
==========================================
+ Hits 2906 2939 +33
+ Misses 324 311 -13
- Partials 232 236 +4
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
sergiught
approved these changes
Feb 23, 2023
willvedd
deleted the
DXCDT-383-integrate-preserve-keywords-function-into-export
branch
2 tasks
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
This PR takes the highest-order
preserveKeywordsfunction (#745) and introduces it into the export process. It does this by introducing aAUTH0_PRESERVE_KEYWORDSboolean configuration property that indicates wether to call that function, otherwise it will run as normal.The majority of these changes are to alter the existing export process to disable keyword replacement. Previously, there was never a need to retrieve the raw, unreplaced resource configuration files, but with keyword preservation there needs to be a mechanism to disable replacement to identify where the raw keyword markers exist in the asset tree.
📚 References
Related PR: #745
🔬 Testing
Introducing unit tests for both the directory and YAML context handlers.
📝 Checklist