Feature/630 refresh emails in active triggeredsends journeys

lib/cli.js

@@ -221,9 +221,7 @@ yargs
         handler: (argv) => {
             Mcdev.setSkipInteraction(argv.skipInteraction);
             Mcdev.setLoggingLevel(argv);
-            const keyArr = csvToArray(argv.KEY);
-
-            Mcdev.buildTemplate(argv.BU, argv.TYPE, keyArr, argv.MARKET);
+            Mcdev.buildTemplate(argv.BU, argv.TYPE, csvToArray(argv.KEY), argv.MARKET);
         },
     })
     .command({
@@ -345,9 +343,32 @@ yargs
         handler: (argv) => {
             Mcdev.setSkipInteraction(argv.skipInteraction);
             Mcdev.setLoggingLevel(argv);
-            const keyArr = csvToArray(argv.KEY);
-
-            Mcdev.getFilesToCommit(argv.BU, argv.TYPE, keyArr);
+            Mcdev.getFilesToCommit(argv.BU, argv.TYPE, csvToArray(argv.KEY));
+        },
+    })
+    .command({
+        command: 'refresh <BU> [TYPE] [KEY]',
+        aliases: ['re'],
+        desc: 'ensures that updates are properly published',
+        builder: (yargs) => {
+            yargs
+                .positional('BU', {
+                    type: 'string',
+                    describe: 'the business unit to execute the refresh on',
+                })
+                .positional('TYPE', {
+                    type: 'string',
+                    describe: 'metadata type',
+                })
+                .positional('KEY', {
+                    type: 'string',
+                    describe: 'key(s) of the metadata component(s)',
+                });
+        },
+        handler: (argv) => {
+            Mcdev.setSkipInteraction(argv.skipInteraction);
+            Mcdev.setLoggingLevel(argv);
+            Mcdev.refresh(argv.BU, argv.TYPE, csvToArray(argv.KEY));
         },
     })
     .command({

lib/index.js

@@ -350,7 +350,7 @@ class Mcdev {
     }
 
     /**
-     * Creates docs for supported metadata types in Markdown and/or HTML format
+     * deletes metadata from MC instance by key
      *
      * @param {string} businessUnit references credentials from properties.json
      * @param {string} type supported metadata type
@@ -359,27 +359,63 @@ class Mcdev {
      */
     static async deleteByKey(businessUnit, type, customerKey) {
         Util.logger.info('mcdev:: delete');
+        if (!Util._isValidType(type)) {
+            return;
+        }
         const properties = await config.getProperties();
         if (!(await config.checkProperties(properties))) {
             return null;
         }
         const buObject = await Cli.getCredentialObject(properties, businessUnit);
         if (buObject !== null) {
-            if ('string' !== typeof type) {
-                Util.logger.error('mcdev.delete failed: Bad metadata type passed in');
+            try {
+                MetadataTypeInfo[type].client = auth.getSDK(buObject);
+            } catch (ex) {
+                Util.logger.error(ex.message);
                 return;
             }
+            try {
+                MetadataTypeInfo[type].properties = properties;
+                MetadataTypeInfo[type].buObject = buObject;
+                await MetadataTypeInfo[type].deleteByKey(customerKey);
+            } catch (ex) {
+                Util.logger.errorStack(ex, ` - Deleting ${type} failed`);
+            }
+        }
+    }
+    /**
+     * ensures triggered sends are restarted to ensure they pick up on changes of the underlying emails
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} type references credentials from properties.json
+     * @param {string[]} [keyArr] metadata keys
+     * @returns {Promise.<void>} -
+     */
+    static async refresh(businessUnit, type, keyArr) {
+        Util.logger.info('mcdev:: refresh');
+        if (!type || !Util._isValidType(type, true)) {
+            type = 'triggeredSendDefinition';
+            Util.logger.info(' - setting type to ' + type);
+        }
+        const properties = await config.getProperties();
+        if (!(await config.checkProperties(properties))) {
+            return null;
+        }
+        const buObject = await Cli.getCredentialObject(properties, businessUnit);
+        if (buObject !== null) {
             try {
                 MetadataTypeInfo[type].client = auth.getSDK(buObject);
             } catch (ex) {
                 Util.logger.error(ex.message);
                 return;
             }
             try {
+                cache.initCache(buObject);
                 MetadataTypeInfo[type].properties = properties;
-                await MetadataTypeInfo[type].deleteByKey(buObject, customerKey);
+                MetadataTypeInfo[type].buObject = buObject;
+                await MetadataTypeInfo[type].refresh(keyArr);
             } catch (ex) {
-                Util.logger.errorStack(ex, ` - Deleting ${type} failed`);
+                Util.logger.errorStack(ex, 'mcdev.refresh ' + ex.message);
             }
         }
     }

lib/metadataTypes/DataExtension.js

@@ -839,27 +839,25 @@ class DataExtension extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, customerKey) {
-        return super.deleteByKeySOAP(buObject, customerKey, false);
+    static deleteByKey(customerKey) {
+        return super.deleteByKeySOAP(customerKey, false);
     }
 
     /**
      * clean up after deleting a metadata item
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of metadata item
      * @returns {void}
      */
-    static async postDeleteTasks(buObject, customerKey) {
+    static async postDeleteTasks(customerKey) {
         // delete local copy: retrieve/cred/bu/dataExtension/...json
         const jsonFile = File.normalizePath([
             this.properties.directories.retrieve,
-            buObject.credential,
-            buObject.businessUnit,
+            this.buObject.credential,
+            this.buObject.businessUnit,
             this.definition.type,
             `${customerKey}.${this.definition.type}-meta.json`,
         ]);
@@ -868,8 +866,8 @@ class DataExtension extends MetadataType {
         const mdFile = File.normalizePath([
             this.properties.directories.docs,
             'dataExtension',
-            buObject.credential,
-            buObject.businessUnit,
+            this.buObject.credential,
+            this.buObject.businessUnit,
             `${customerKey}.${this.definition.type}.md`,
         ]);
         await File.remove(mdFile);

lib/metadataTypes/DataExtensionField.js

@@ -253,23 +253,21 @@ class DataExtensionField extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, customerKey) {
-        return this.deleteByKeySOAP(buObject, customerKey, false);
+    static deleteByKey(customerKey) {
+        return this.deleteByKeySOAP(customerKey, false);
     }
 
     /**
      * Delete a data extension from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of metadata
      * @param {boolean} [handleOutside] if the API reponse is irregular this allows you to handle it outside of this generic method
      * @returns {boolean} deletion success flag
      */
-    static async deleteByKeySOAP(buObject, customerKey, handleOutside) {
+    static async deleteByKeySOAP(customerKey, handleOutside) {
         const [deKey, fieldKey] = customerKey.split('.');
         customerKey = `[${deKey}].[${fieldKey}]`;
 
@@ -309,7 +307,7 @@ class DataExtensionField extends MetadataType {
             if (!handleOutside) {
                 Util.logger.info(`- deleted ${this.definition.type}: ${customerKey}`);
             }
-            this.postDeleteTasks(buObject, customerKey);
+            this.postDeleteTasks(customerKey);
             return true;
         } catch (ex) {
             if (handleOutside) {

lib/metadataTypes/EmailSendDefinition.js

@@ -79,12 +79,11 @@ class EmailSendDefinition extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, customerKey) {
-        return super.deleteByKeySOAP(buObject, customerKey, false);
+    static deleteByKey(customerKey) {
+        return super.deleteByKeySOAP(customerKey, false);
     }
 
     /**

lib/metadataTypes/EventDefinition.js

@@ -119,13 +119,11 @@ class EventDefinition extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} key Identifier of item
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, key) {
+    static deleteByKey(key) {
         return super.deleteByKeyREST(
-            buObject,
             '/interaction/v1/eventDefinitions/key:' + encodeURIComponent(key),
             key,
             false

lib/metadataTypes/Interaction.js

@@ -85,11 +85,10 @@ class Interaction extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} key Identifier of item
      * @returns {Promise.<boolean>} deletion success status
      */
-    static async deleteByKey(buObject, key) {
+    static async deleteByKey(key) {
         let version;
         let singleKey = '';
         /* eslint-disable unicorn/prefer-ternary */
@@ -134,7 +133,6 @@ class Interaction extends MetadataType {
         );
         /* eslint-enable unicorn/prefer-ternary */
         return super.deleteByKeyREST(
-            buObject,
             '/interaction/v1/interactions/' + singleKey + `?versionNumber=${version}`,
             key,
             false

lib/metadataTypes/List.js

@@ -158,12 +158,11 @@ class List extends MetadataType {
     /**
      * Delete a metadata item from the specified business unit
      *
-     * @param {TYPE.BuObject} buObject references credentials
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(buObject, customerKey) {
-        return super.deleteByKeySOAP(buObject, customerKey, false);
+    static deleteByKey(customerKey) {
+        return super.deleteByKeySOAP(customerKey, false);
     }
 
     /**