mcdev 4.2.1 → 4.3.0

package/lib/util/util.js

@@ -155,24 +155,46 @@ const Util = {
      * helper for {@link Mcdev.retrieve}, {@link Mcdev.retrieveAsTemplate} and {@link Mcdev.deploy}
      *
      * @param {TYPE.SupportedMetadataTypes} selectedType type or type-subtype
+     * @param {boolean} [handleOutside] if the API reponse is irregular this allows you to handle it outside of this generic method
      * @returns {boolean} type ok or not
      */
-    _isValidType(selectedType) {
-        const [type, subType] = selectedType ? selectedType.split('-') : [];
+    _isValidType(selectedType, handleOutside) {
+        const [type, subType] = Util.getTypeAndSubType(selectedType);
         if (type && !MetadataDefinitions[type]) {
-            Util.logger.error(`:: '${type}' is not a valid metadata type`);
-            return;
+            if (!handleOutside) {
+                Util.logger.error(`:: '${type}' is not a valid metadata type`);
+            }
+            return false;
         } else if (
             type &&
             subType &&
             (!MetadataDefinitions[type] || !MetadataDefinitions[type].subTypes.includes(subType))
         ) {
-            Util.logger.error(`:: '${selectedType}' is not a valid metadata type`);
-            return;
+            if (!handleOutside) {
+                Util.logger.error(`:: '${selectedType}' is not a valid metadata type`);
+            }
+            return false;
         }
         return true;
     },
 
+    /**
+     * helper that deals with extracting type and subtype
+     *
+     * @param {string} selectedType "type" or "type-subtype"
+     * @returns {string[]} first elem is type, second elem is subType
+     */
+    getTypeAndSubType(selectedType) {
+        if (selectedType) {
+            const temp = selectedType.split('-');
+            const type = temp.shift(); // remove first item which is the main typ
+            const subType = temp.join('-'); // subType can include "-"
+            return [type, subType];
+        } else {
+            return [];
+        }
+    },
+
     /**
      * helper for getDefaultProperties()
      *
@@ -293,7 +315,7 @@ const Util = {
      * Returns Order in which metadata needs to be retrieved/deployed
      *
      * @param {string[]} metadataTypes which should be retrieved/deployed
-     * @returns {string[]} retrieve/deploy order as array
+     * @returns {Object.<string, string[]>} retrieve/deploy order as array
      */
     getMetadataHierachy(metadataTypes) {
         const dependencies = [];
@@ -320,10 +342,11 @@ const Util = {
                 dependencies.push([undefined, metadataType]);
             }
         }
+        const allDeps = dependencies.map((dep) => dep[0]);
         // remove subtypes if main type is in the list
         for (const type of Object.keys(subTypeDeps)
-            // only look at subtype deps that are also supposed to be retrieved fully
-            .filter((type) => metadataTypes.includes(type))) {
+            // only look at subtype deps that are also supposed to be retrieved or cached fully
+            .filter((type) => metadataTypes.includes(type) || allDeps.includes(type))) {
             // convert set into array to walk its elements
             for (const subType of subTypeDeps[type]) {
                 for (const item of dependencies) {
@@ -336,7 +359,27 @@ const Util = {
         }
 
         // sort list & remove the undefined dependencies
-        return toposort(dependencies).filter((a) => !!a);
+        const flatList = toposort(dependencies).filter((a) => !!a);
+        const finalList = {};
+        // group subtypes per type
+        for (const type of flatList) {
+            if (type.includes('-')) {
+                const key = type.split('-')[0];
+                if (finalList[key]) {
+                    continue;
+                }
+                finalList[key] = subTypeDeps[key]
+                    ? [...subTypeDeps[key]].map((a) => {
+                          const temp = a.split('-');
+                          temp.shift(); // remove first item which is the main type
+                          return temp.join('-'); // subType can include "-"
+                      })
+                    : null;
+            } else {
+                finalList[type] = null;
+            }
+        }
+        return finalList;
     },
 
     /**
@@ -430,6 +473,78 @@ const Util = {
             Util.logger.debug('CLI logger set to: debug');
         }
     },
+    /**
+     * outputs a warning that the given type is still in beta
+     *
+     * @param {string} type api name of the type thats in beta
+     */
+    logBeta(type) {
+        Util.logger.warn(
+            ` - ${type} support is currently still in beta. Please report any issues here: https://github.com/Accenture/sfmc-devtools/issues/new/choose`
+        );
+    },
+    // defined colors for logging things in different colors
+    color: {
+        reset: '\x1B[0m',
+        dim: '\x1B[2m',
+    },
+    /**
+     * helper that wraps a message in the correct color codes to have them printed gray
+     *
+     * @param {string} msg log message that should be wrapped with color codes
+     * @returns {string} gray msg
+     */
+    getGrayMsg(msg) {
+        return `${Util.color.dim}${msg}${Util.color.reset}`;
+    },
+    /**
+     * helper to print the subtypes we filtered by
+     *
+     * @param {string[]} subTypeArr list of subtypes to be printed
+     * @returns {void}
+     */
+    logSubtypes(subTypeArr) {
+        if (subTypeArr && subTypeArr.length > 0) {
+            Util.logger.info(
+                Util.getGrayMsg(
+                    ` - Subtype${subTypeArr.length > 1 ? 's' : ''}: ${subTypeArr.join(', ')}`
+                )
+            );
+        }
+    },
+    /**
+     * helper to print the subtypes we filtered by
+     *
+     * @param {string[] | string} keyArr list of subtypes to be printed
+     * @param {boolean} [isId] optional flag to indicate if key is an id
+     * @returns {string} string to be appended to log message
+     */
+    getKeysString(keyArr, isId) {
+        if (!keyArr) {
+            return '';
+        }
+        if (!Array.isArray(keyArr)) {
+            // if only one key, make it an array
+            keyArr = [keyArr];
+        }
+        if (keyArr.length > 0) {
+            return Util.getGrayMsg(
+                ` - ${isId ? 'ID' : 'Key'}${keyArr.length > 1 ? 's' : ''}: ${keyArr.join(', ')}`
+            );
+        }
+        return '';
+    },
+    /**
+     * pause execution of code; useful when multiple server calls are dependent on each other and might not be executed right away
+     *
+     * @param {number} ms time in miliseconds to wait
+     * @returns {Promise.<void>} - promise to wait for
+     */
+    async sleep(ms) {
+        return new Promise((resolve) => {
+            setTimeout(resolve, ms);
+        });
+    },
 };
 /**
  * wrapper around our standard winston logging to console and logfile
@@ -508,7 +623,12 @@ function startLogger() {
             if (message) {
                 // ! this method only sets exitCode=1 if message-param was set
                 // if not, then this method purely outputs debug information and should not change the exitCode
-                winstonError(message + ': ' + ex.message);
+                winstonError(message + ':');
+                winstonError(`    ${ex.message} (${ex.code})`);
+                if (ex.endpoint) {
+                    // ex.endpoint is only available if 'ex' is of type RestError
+                    winstonError('    endpoint: ' + ex.endpoint);
+                }
                 Util.signalFatalError();
             }
             let stack;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "4.2.1",
+    "version": "4.3.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -17,6 +17,19 @@
         "type": "corporate",
         "url": "https://github.com/Accenture/sfmc-devtools"
     },
+    "keywords": [
+        "sfmc",
+        "ide",
+        "devops",
+        "developer",
+        "exacttarget",
+        "salesforce",
+        "marketing cloud",
+        "package manager",
+        "fuel",
+        "soap",
+        "rest"
+    ],
     "main": "./lib/index.js",
     "bin": {
         "mcdev": "./lib/cli.js"
@@ -55,11 +68,11 @@
         "json-to-table": "4.2.1",
         "mustache": "4.2.0",
         "p-limit": "3.1.0",
-        "prettier": "2.8.0",
+        "prettier": "2.8.3",
         "prettier-plugin-sql": "0.12.1",
         "semver": "7.3.8",
-        "sfmc-sdk": "0.6.1",
-        "simple-git": "3.15.1",
+        "sfmc-sdk": "0.6.3",
+        "simple-git": "3.16.0",
         "toposort": "2.0.2",
         "update-notifier": "5.1.0",
         "winston": "3.8.2",
@@ -70,17 +83,17 @@
         "axios-mock-adapter": "1.21.2",
         "chai": "4.3.7",
         "chai-files": "1.4.0",
-        "eslint": "8.29.0",
-        "eslint-config-prettier": "8.5.0",
+        "eslint": "8.32.0",
+        "eslint-config-prettier": "8.6.0",
         "eslint-config-ssjs": "1.1.11",
         "eslint-plugin-jsdoc": "39.6.4",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
-        "eslint-plugin-unicorn": "45.0.1",
-        "husky": "8.0.1",
+        "eslint-plugin-unicorn": "45.0.2",
+        "husky": "8.0.3",
         "jsdoc-to-markdown": "8.0.0",
         "lint-staged": "13.1.0",
-        "mocha": "10.1.0",
+        "mocha": "10.2.0",
         "mock-fs": "5.2.0",
         "npm-check": "6.0.1",
         "npm-run-all": "4.1.5",

package/test/dataExtension.test.js

@@ -29,9 +29,9 @@ describe('dataExtension', () => {
                 'returned metadata was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
-                6,
-                'Unexpected number of requests made'
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -65,9 +65,9 @@ describe('dataExtension', () => {
                 'returned metadata was not equal expected for update'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
-                12,
-                'Unexpected number of requests made'
+                testUtils.getAPIHistoryLength(),
+                11,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -112,9 +112,9 @@ describe('dataExtension', () => {
                 'returned deployment file was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 5,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -159,9 +159,9 @@ describe('dataExtension', () => {
                 'returned deployment file was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 5,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });

package/test/interaction.test.js

@@ -0,0 +1,123 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('interaction', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a interaction', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['interaction']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.interaction ? Object.keys(result.interaction).length : 0,
+                2,
+                'only 2 interactions expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_interaction', 'interaction'),
+                await testUtils.getExpectedJson('9999999', 'interaction', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                7,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a interaction', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['interaction']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.interaction ? Object.keys(result.interaction).length : 0,
+                3,
+                '3 interactions expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_interaction', 'interaction'),
+                await testUtils.getExpectedJson('9999999', 'interaction', 'post'),
+                'returned JSON was not equal expected for insert interaction'
+            );
+
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_interaction', 'interaction'),
+                await testUtils.getExpectedJson('9999999', 'interaction', 'put'), // watch out - interaction api wants put instead of patch for updates
+                'returned JSON was not equal expected for update interaction'
+            );
+
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                7,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        it('Should create a interaction template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['interaction']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'interaction',
+                ['testExisting_interaction'],
+                'testSourceMarket'
+            );
+            assert.equal(
+                result.interaction ? Object.keys(result.interaction).length : 0,
+                1,
+                'only one interaction expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_interaction', 'interaction'),
+                await testUtils.getExpectedJson('9999999', 'interaction', 'template'),
+                'returned template JSON was not equal expected'
+            );
+
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'interaction',
+                'testExisting_interaction',
+                'testTargetMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testExisting_interaction', 'interaction'),
+                await testUtils.getExpectedJson('9999999', 'interaction', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                7,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
+    });
+});

package/test/mockRoot/.mcdevrc.json

@@ -74,5 +74,5 @@
             "triggeredSendDefinition"
         ]
     },
-    "version": "4.2.0"
+    "version": "4.3.0"
 }