DXCDT-421: Preserve identifier fields (#784)

* Initial work to preserve identifier fields

* Fixing test case

* Enabling more preservation if identifier field is updated

* Adding e2e test for preservation of identifier fields

* Adding e2e test for preservation of identifier fields

* Adding one more test case for custom domains

* Adding last test case

* Rerecording tests

* Simplifying change, updating comments

* Removing extraneous comment

---------

Co-authored-by: Will Vedder <[email protected]>

Author: willvedd

src/keywordPreservation.ts

@@ -10,7 +10,7 @@ import APIHandler from './tools/auth0/handlers/default';
   Original Github Issue: https://github.com/auth0/auth0-deploy-cli/issues/328
 */
 
-export const shouldFieldBePreserved = (
+export const doesHaveKeywordMarker = (
   string: string,
   keywordMappings: KeywordMappings
 ): boolean => {
@@ -29,7 +29,7 @@ export const getPreservableFieldsFromAssets = (
   address = ''
 ): string[] => {
   if (typeof asset === 'string') {
-    if (shouldFieldBePreserved(asset, keywordMappings)) {
+    if (doesHaveKeywordMarker(asset, keywordMappings)) {
       return [address];
     }
     return [];
@@ -91,7 +91,7 @@ export const getAssetsValueByAddress = (address: string, assets: any): any => {
 
   // It is easier to handle an address piece-by-piece by
   // splitting on the period into separate "directions"
-  const directions = address.split('.');
+  const directions = address.split(/\.(?![^\[]*\])/g);
 
   // If the the next directions are the proprietary array syntax (ex: `[name=foo]`)
   // then perform lookup against unique array-item property
@@ -123,7 +123,7 @@ export const convertAddressToDotNotation = (
   address: string,
   finalAddressTrail = ''
 ): string | null => {
-  const directions = address.split('.');
+  const directions = address.split(/\.(?![^\[]*\])/g);
 
   if (directions[0] === '') return finalAddressTrail;
 
@@ -213,7 +213,15 @@ export const preserveKeywords = ({
 
   addresses.forEach((address) => {
     const localValue = getAssetsValueByAddress(address, localAssets);
-    const remoteValue = getAssetsValueByAddress(address, remoteAssets);
+
+    const remoteAssetsAddress = (() => {
+      const doesAddressHaveKeyword = doesHaveKeywordMarker(address, keywordMappings);
+      if (doesAddressHaveKeyword) {
+        return keywordReplace(address, keywordMappings);
+      }
+      return address;
+    })();
+    const remoteValue = getAssetsValueByAddress(remoteAssetsAddress, remoteAssets);
 
     const localValueWithReplacement = keywordReplace(localValue, keywordMappings);
 
@@ -230,7 +238,22 @@ export const preserveKeywords = ({
       );
     }
 
-    updatedRemoteAssets = updateAssetsByAddress(updatedRemoteAssets, address, localValue);
+    // Two address possibilities are provided to account for cases when there is a keyword
+    // in the resources's identifier field. When the resource identifier's field is preserved
+    // on the remote assets tree, it loses its identify, so we'll need to try two addresses:
+    // one where the identifier field has a keyword and one where the identifier field has
+    // the literal replaced value.
+    // Example: `customDomains.[domain=##DOMAIN].domain` and `customDomains.[domain=travel0.com].domain`
+    updatedRemoteAssets = updateAssetsByAddress(
+      updatedRemoteAssets,
+      address, //Two possible addresses need to be passed, one with identifier field keyword replaced and one where it is not replaced. Ex: `customDomains.[domain=##DOMAIN].domain` and `customDomains.[domain=travel0.com].domain`
+      localValue
+    );
+    updatedRemoteAssets = updateAssetsByAddress(
+      updatedRemoteAssets,
+      remoteAssetsAddress, //Two possible addresses need to be passed, one with identifier field keyword replaced and one where it is not replaced. Ex: `customDomains.[domain=##DOMAIN].domain` and `customDomains.[domain=travel0.com].domain`
+      localValue
+    );
   });
 
   return updatedRemoteAssets;

test/e2e/e2e.test.ts

@@ -366,11 +366,12 @@ describe('keyword preservation', () => {
     AUTH0_CLIENT_SECRET,
     AUTH0_ACCESS_TOKEN,
     AUTH0_PRESERVE_KEYWORDS: true,
-    AUTH0_INCLUDED_ONLY: ['tenant', 'emailTemplates'] as AssetTypes[],
+    AUTH0_INCLUDED_ONLY: ['tenant', 'emailTemplates', 'clients'] as AssetTypes[],
     AUTH0_KEYWORD_REPLACE_MAPPINGS: {
       TENANT_NAME: 'This tenant name should be preserved',
       DOMAIN: 'travel0.com',
       LANGUAGES: ['en', 'es'],
+      ENV: 'dev',
     },
   };
 
@@ -431,6 +432,13 @@ describe('keyword preservation', () => {
       .toString();
     expect(emailTemplateHTML).to.contain('##TENANT_NAME##');
 
+    expect(
+      yaml.clients.some(
+        ({ name, logo_uri }) =>
+          name === 'Auth0 CLI - ##ENV##' && logo_uri === 'https://##ENV##.assets.com/photos/foo'
+      )
+    ).to.be.true;
+
     recordingDone();
   });
 
@@ -483,6 +491,16 @@ describe('keyword preservation', () => {
       fs.readFileSync(path.join(workDirectory, 'emails', 'welcome_email.html')).toString()
     ).to.contain(config.AUTH0_KEYWORD_REPLACE_MAPPINGS.TENANT_NAME);
 
+    const clientsJsonWithoutPreservation = JSON.parse(
+      fs.readFileSync(path.join(workDirectory, 'clients', 'Auth0 CLI - dev.json')).toString()
+    );
+    expect(clientsJsonWithoutPreservation.name).to.equal(
+      `Auth0 CLI - ${config.AUTH0_KEYWORD_REPLACE_MAPPINGS.ENV}`
+    );
+    expect(clientsJsonWithoutPreservation.logo_uri).to.equal(
+      `https://${config.AUTH0_KEYWORD_REPLACE_MAPPINGS.ENV}.assets.com/photos/foo`
+    );
+
     emptyDirSync(workDirectory);
     copySync(`${__dirname}/testdata/should-preserve-keywords/directory`, workDirectory); //It is necessary to copy directory contents to work directory to prevent overwriting of Git-committed files
 
@@ -512,6 +530,12 @@ describe('keyword preservation', () => {
       .toString();
     expect(emailTemplateHTML).to.contain('##TENANT_NAME##');
 
+    const clientsJSON = JSON.parse(
+      fs.readFileSync(path.join(workDirectory, 'clients', 'Auth0 CLI - dev.json')).toString()
+    );
+    expect(clientsJSON.name).to.equal('Auth0 CLI - ##ENV##');
+    expect(clientsJSON.logo_uri).to.equal('https://##ENV##.assets.com/photos/foo');
+
     recordingDone();
   });