mcdev 3.0.0 → 3.1.0

package/lib/retrieveChangelog.js

@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * sample file on how to retrieve a simple changelog to use in GUIs or automated processing of any kind
+ * @example
+ [{
+    name: 'deName',
+    key: 'deKey',
+    t: 'dataExtension',
+    cd: '2020-05-06T00:16:00.737',
+    cb: 'name of creator',
+    ld: '2020-05-06T00:16:00.737',
+    lb: 'name of lastmodified'
+  }]
+ */
+
+const mcdev = require('./index');
+const Definition = require('./MetadataTypeDefinitions');
+const MetadataType = require('./MetadataTypeInfo');
+
+// disable cli logs
+// mcdev._setLoggingLevel({ silent: true });
+
+const customDefinition = {
+    automation: {
+        keyField: 'CustomerKey',
+        nameField: 'Name',
+        createdDateField: 'CreatedDate',
+        createdNameField: 'CreatedBy',
+        lastmodDateField: 'LastSaveDate',
+        lastmodNameField: 'LastSavedBy',
+    },
+    dataExtension: {
+        keyField: 'CustomerKey',
+        nameField: 'Name',
+        createdDateField: 'CreatedDate',
+        createdNameField: null,
+        lastmodDateField: 'ModifiedDate',
+        lastmodNameField: null,
+    },
+};
+(async function () {
+    // get userid>name mapping
+    const userList = (await mcdev.retrieve('ACN-Learning/_ParentBU_', 'accountUser', true))
+        .accountUser;
+    // reduce userList to simple id-name map
+    Object.keys(userList).forEach((key) => {
+        userList[userList[key].ID] = userList[key].Name;
+        delete userList[key];
+    });
+
+    // get changed metadata
+    const changelogList = await mcdev.retrieve('ACN-Learning/MCDEV_Training_Source', null, true);
+    const allMetadata = [];
+    Object.keys(changelogList).map((type) => {
+        if (changelogList[type]) {
+            const def = customDefinition[type] || Definition[type];
+            allMetadata.push(
+                ...Object.keys(changelogList[type]).map((key) => {
+                    const item = changelogList[type][key];
+                    if (
+                        MetadataType[type].isFiltered(item, true) ||
+                        MetadataType[type].isFiltered(item, false)
+                    ) {
+                        return;
+                    }
+
+                    const listEntry = {
+                        name: item[def.nameField],
+                        key: item[def.keyField],
+                        t: type,
+                        cd: item[def.createdDateField],
+                        cb: getUserName(userList, item, def.createdNameField),
+                        ld: item[def.lastmodDateField],
+                        lb: getUserName(userList, item, def.lastmodNameField),
+                    };
+                    return listEntry;
+                })
+            );
+        }
+    });
+    const finalResult = allMetadata.filter((item) => undefined !== item);
+    console.log('finalResult', finalResult);
+})();
+
+/**
+ *
+ * @param {object<string,string>} userList user-id > user-name map
+ * @param {object<string,string>} item single metadata item
+ * @param {string} fieldname name of field containing the info
+ * @returns {string} username or user id or 'n/a'
+ */
+function getUserName(userList, item, fieldname) {
+    return userList[item[fieldname]] || item[fieldname] || 'n/a';
+}

package/lib/util/cli.js

@@ -427,9 +427,8 @@ const Cli = {
                                 subtype,
                             type: MetadataDefinitions[el].type + '-' + subtype,
                             mainType: MetadataDefinitions[el].type,
-                            typeRetrieveByDefault: MetadataDefinitions[
-                                el
-                            ].typeRetrieveByDefault.includes(subtype),
+                            typeRetrieveByDefault:
+                                MetadataDefinitions[el].typeRetrieveByDefault.includes(subtype),
                         });
                     }
                 }
@@ -560,9 +559,8 @@ const Cli = {
                 let lastCountdown = MetadataDefinitions[el].subTypes.length;
                 for (const subtype of MetadataDefinitions[el].subTypes) {
                     lastCountdown--;
-                    const subTypeRetrieveByDefault = MetadataDefinitions[
-                        el
-                    ].typeRetrieveByDefault.includes(subtype);
+                    const subTypeRetrieveByDefault =
+                        MetadataDefinitions[el].typeRetrieveByDefault.includes(subtype);
                     const definition =
                         '  ' + MetadataDefinitions[el].extendedSubTypes[subtype].join(', ');
                     typeChoices.push({

package/lib/util/init.config.js

@@ -90,6 +90,9 @@ const Init = {
                         break;
                     case 'version':
                         // do nothing other than ensure we re-save the config (with the new version)
+                        delete properties.catalystFullVersion;
+                        delete properties.catalystVersion;
+
                         upgradeMsgs.push(`- ✔️  version updated`);
                         break;
                     default:

package/lib/util/init.git.js

@@ -229,7 +229,8 @@ const Init = {
                     // eslint-disable-next-line require-jsdoc
                     validate: function (value) {
                         value = value.trim();
-                        const regex = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+                        const regex =
+                            /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
                         if (!value || !regex.test(String(value).toLowerCase())) {
                             return 'Please enter valid email';
                         }

package/lib/util/util.js

@@ -110,6 +110,23 @@ const Util = {
         'workflows_read',
         'workflows_write',
     ],
+    /**
+     * SFMC accepts multiple true values for Boolean attributes for which we are checking here
+     * @param {*} attrValue value
+     * @returns {boolean} attribute value == true ? true : false
+     */
+    isTrue(attrValue) {
+        return ['true', 'TRUE', 'True', '1', 1, 'Y'].includes(attrValue);
+    },
+    /**
+     * SFMC accepts multiple false values for Boolean attributes for which we are checking here
+     * @param {*} attrValue value
+     * @returns {boolean} attribute value == false ? true : false
+     */
+    isFalse(attrValue) {
+        return ['false', 'FALSE', 'False', '0', 0, 'N'].includes(attrValue);
+    },
+
     /**
      * defines how the properties.json should look like
      * used for creating a template and for checking if variables are set
@@ -180,9 +197,10 @@ const Util = {
         }
 
         // check if user is running older mcdev version than whats saved to the config
-        if (semver.gt(properties.version, packageJsonMcdev.version)) {
+        if (properties.version && semver.gt(properties.version, packageJsonMcdev.version)) {
+            // dont run this for Catalyst to MC DevTools migration
             Util.logger.error(
-                `Your Catalst version ${packageJsonMcdev.version} is lower than your project's config version ${properties.version}`
+                `Your Accenture SFMC DevTools version ${packageJsonMcdev.version} is lower than your project's config version ${properties.version}`
             );
             const questions = [
                 {
@@ -329,7 +347,7 @@ const Util = {
             }
         }
         // check if project config version is outdated compared to user's mcdev version
-        if (semver.gt(packageJsonMcdev.version, properties.version)) {
+        if (!properties.version || semver.gt(packageJsonMcdev.version, properties.version)) {
             errorMsgs.push(
                 `Your project's config version ${properties.version} is lower than your Accenture SFMC DevTools version ${packageJsonMcdev.version}`
             );
@@ -580,7 +598,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. ${metadataType} with ${searchField}='${searchValue}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. ${metadataType} with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
     /**
@@ -626,7 +644,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. list with ListName='${listName}' and r__folder_Path='${folderPath}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. list with ListName='${listName}' and r__folder_Path='${folderPath}' was not found on your BU`
         );
     },
 
@@ -662,7 +680,7 @@ const Util = {
             }
         }
         throw new Error(
-            `Missing one or more dependent metadata. list with ${searchField}='${searchValue}' was not found. Please ensure to create this first or include it in the deployment package.`
+            `Missing one or more dependent metadata. list with ${searchField}='${searchValue}' was not found on your BU`
         );
     },
     /**
@@ -675,7 +693,7 @@ const Util = {
      */
     async retryOnError(errorMsg, callback, silentError, retries) {
         if ('undefined' === typeof retries || retries === null) {
-            retries = 1;
+            retries = 3;
         }
         try {
             await callback();
@@ -686,34 +704,33 @@ const Util = {
                 ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET'].includes(ex.code)
             ) {
                 retries--;
+                Util.logger.debug(ex.stack);
+                const msg = `Connection problem. ${errorMsg} (${retries + 1} tries left)`;
                 if (silentError) {
-                    Util.logger.debug(
-                        `Connection error. ${errorMsg} - Retries left: ${retries + 1}`
-                    );
+                    Util.logger.debug(msg);
                 } else {
-                    Util.logger.error(`Connection error. ${errorMsg}`);
+                    Util.logger.warn(msg);
                 }
-                Util.logger.debug(ex.stack);
-                await this.retryOnError(errorMsg, callback, retries);
+                await this.retryOnError(errorMsg, callback, silentError, retries);
             } else if (
                 ex.code &&
                 ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET'].includes(ex.code)
             ) {
+                Util.logger.debug(ex.stack);
                 Util.logger.error(
-                    `Failed due to a Connection Error (${ex.code}) - Please check your network connection and try again`
+                    `"${errorMsg}" Failed due to a Connection Error (${ex.code}) - Please check your network connection and try again`
                 );
-                Util.logger.debug(ex.stack);
                 if (Util.logger.level === 'debug') {
                     console.log(ex.stack);
                 }
-                throw new Error(ex.message);
+                throw ex;
             } else {
-                Util.logger.error(ex.message);
                 Util.logger.debug(ex.stack);
                 if (Util.logger.level === 'debug') {
                     console.log(ex.stack);
                 }
-                throw new Error(ex.message);
+                Util.logger.error(ex.message);
+                throw ex;
             }
         }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "3.0.0",
+    "version": "3.1.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -8,7 +8,7 @@
         "type": "git",
         "url": "https://github.com/Accenture/sfmc-devtools.git"
     },
-    "homepage": "https://github.com/Accenture/sfmc-devtools",
+    "homepage": "https://github.com/Accenture/sfmc-devtools#readme",
     "bugs": {
         "url": "https://github.com/Accenture/sfmc-devtools/issues",
         "email": "joern.berkefeld@accenture.com"
@@ -19,7 +19,7 @@
     },
     "main": "./lib/index.js",
     "bin": {
-        "mcdev": "./lib/index.js"
+        "mcdev": "./lib/cli.js"
     },
     "engines": {
         "node": ">=14.16"
@@ -27,45 +27,44 @@
     "scripts": {
         "start": "node lib/index.js",
         "mcdev": "node lib/index.js",
-        "postinstall": "node postinstall.js",
         "build": "run-s lint docs",
         "debug": "node --nolazy --inspect-brk=9229 lib/index.js",
         "docs": "jsdoc2md --files lib/**/*.js > docs/dist/documentation.md",
         "lint": "eslint --fix lib/**/*.js && eslint --fix test/**/*.js && prettier --write lib/**/*.js",
-        "test": "mocha",
+        "test": "mocha --recursive",
         "upgrade": "npm-check --update",
         "prepare": "husky install"
     },
     "dependencies": {
         "bluebird": "3.7.2",
-        "cli-progress": "3.9.0",
+        "cli-progress": "3.9.1",
         "command-exists": "1.2.9",
         "console.table": "0.10.0",
-        "fs-extra": "9.1.0",
-        "inquirer": "8.0.0",
+        "fs-extra": "10.0.0",
+        "inquirer": "8.2.0",
         "json-to-table": "4.2.1",
-        "mustache": "4.1.0",
-        "prettier": "2.2.1",
-        "semver": "5.7.1",
+        "mustache": "4.2.0",
+        "prettier": "2.5.1",
+        "semver": "7.3.5",
         "sfmc-fuelsdk-node": "2.4.0",
-        "simple-git": "2.37.0",
+        "simple-git": "2.48.0",
         "sql-formatter-plus": "1.3.6",
         "toposort": "2.0.2",
         "update-notifier-git": "5.0.3",
         "winston": "3.3.3",
-        "yargs": "16.2.0"
+        "yargs": "17.3.0"
     },
     "devDependencies": {
         "chai": "4.3.4",
-        "eslint": "7.22.0",
-        "eslint-config-prettier": "8.1.0",
+        "eslint": "8.4.1",
+        "eslint-config-prettier": "8.3.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-mocha": "8.1.0",
-        "eslint-plugin-prettier": "3.3.1",
-        "husky": "5.1.3",
-        "jsdoc-to-markdown": "7.0.0",
-        "lint-staged": "10.5.4",
-        "mocha": "8.3.2",
+        "eslint-plugin-mocha": "10.0.1",
+        "eslint-plugin-prettier": "4.0.0",
+        "husky": "7.0.4",
+        "jsdoc-to-markdown": "7.1.0",
+        "lint-staged": "12.1.2",
+        "mocha": "9.1.3",
         "npm-check": "5.9.2",
         "npm-run-all": "4.1.5"
     },
@@ -73,9 +72,6 @@
         "*.{js,jsx,ts,tsx}": [
             "eslint --fix",
             "prettier --write"
-        ],
-        "*.{md}": [
-            "prettier --write"
         ]
     }
 }

package/test/util/file.js

@@ -0,0 +1,51 @@
+const assert = require('chai').assert;
+const File = require('../../lib/util/file');
+const fs = require('fs-extra');
+const path = require('path');
+
+const dataDir = 'test_tmp/file/';
+
+describe('File', () => {
+    after(() => {
+        fs.removeSync(dataDir);
+    });
+    describe('#writeJSONToFile()', () => {
+        it('should create json file and directory', async () => {
+            assert.strictEqual(fs.existsSync(dataDir + 'test1.json'), false);
+            const jsonContent = {
+                string: 'abc',
+                boolean: true,
+                number: 5,
+                array: ['asd', 4, 'asdf'],
+                obj: {
+                    name: 'object',
+                },
+            };
+            await File.writeJSONToFile(dataDir, 'test1', jsonContent);
+            assert.deepEqual(fs.readJSONSync(dataDir + 'test1.json'), jsonContent);
+        });
+    });
+    describe('#copyFile()', () => {
+        it('should copy file from one path to another', async () => {
+            const source = path.join(dataDir, 'sourceFile.txt');
+            const target = path.join(dataDir, 'targetFile.txt');
+            fs.writeFileSync(source, 'filecontent');
+            assert.strictEqual(fs.existsSync(source), true);
+            await File.copyFile(source, target);
+            assert.strictEqual(fs.existsSync(target), true);
+            assert.deepEqual(fs.readFileSync(source), fs.readFileSync(target));
+        });
+        it("should skip copy if source file doesn't exist", async () => {
+            const source = path.join(dataDir, 'doesnt_exist_source.txt');
+            const target = path.join(dataDir, 'doesnt_exist_target.txt');
+            assert.strictEqual(fs.existsSync(source), false);
+            const result = await File.copyFile(source, target);
+            assert.strictEqual(fs.existsSync(target), false);
+            assert.deepEqual(result, {
+                status: 'skipped',
+                statusMessage: 'deleted from repository',
+                file: source,
+            });
+        });
+    });
+});

package/postinstall.js

@@ -1,41 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-const greenOnBlack = '\x1b[32m\x1b[40m';
-const highlight = '\x1b[7m';
-const reset = '\x1b[0m';
-console.log(greenOnBlack); // green on black
-console.log('Congratulations: You installed Accenture Salesforce Marketing Cloud DevTools!');
-console.log(
-    `If you have existing Accenture SFMC DevTools projects please run ${highlight}mcdev upgrade${reset}${greenOnBlack} in each of your project directories.`
-);
-
-console.log(reset); // reset cli colors
-
-/*
-Color reference
-Reset = "\x1b[0m"
-Bright = "\x1b[1m"
-Dim = "\x1b[2m"
-Underscore = "\x1b[4m"
-Blink = "\x1b[5m"
-Reverse = "\x1b[7m"
-Hidden = "\x1b[8m"
-
-FgBlack = "\x1b[30m"
-FgRed = "\x1b[31m"
-FgGreen = "\x1b[32m"
-FgYellow = "\x1b[33m"
-FgBlue = "\x1b[34m"
-FgMagenta = "\x1b[35m"
-FgCyan = "\x1b[36m"
-FgWhite = "\x1b[37m"
-
-BgBlack = "\x1b[40m"
-BgRed = "\x1b[41m"
-BgGreen = "\x1b[42m"
-BgYellow = "\x1b[43m"
-BgBlue = "\x1b[44m"
-BgMagenta = "\x1b[45m"
-BgCyan = "\x1b[46m"
-BgWhite = "\x1b[47m"
-*/

package/test/deployer.js

@@ -1,16 +0,0 @@
-const assert = require('chai').assert;
-const Deployer = require('../lib/Deployer');
-const testDataDir = 'test/data/deployer/';
-
-describe('Deployer', () => {
-    describe('#readBUMetadata', () => {
-        it('should read metadata from local filesystem', async () => {
-            const metadata = Deployer.readBUMetadata(testDataDir);
-            // Check that metadata was successfully read
-            assert.exists(metadata.dataExtension);
-            assert.exists(metadata.dataExtension.Test);
-            assert.exists(metadata.dataExtension.Test.columns.idField);
-            assert.exists(metadata.folder);
-        });
-    });
-});

package/test/util.js

@@ -1,26 +0,0 @@
-const assert = require('chai').assert;
-const fs = require('fs-extra');
-const Util = require('../lib/util');
-const dataDir = 'test_tmp/util/';
-
-describe('Util', () => {
-    after(() => {
-        fs.removeSync(dataDir);
-    });
-    describe('#writeJSONToFile', () => {
-        it('should create json file and directory', async () => {
-            assert.strictEqual(fs.existsSync(dataDir + 'test1.json'), false);
-            const jsonContent = {
-                string: 'abc',
-                boolean: true,
-                number: 5,
-                array: ['asd', 4, 'asdf'],
-                obj: {
-                    name: 'object',
-                },
-            };
-            await Util.writeJSONToFile(dataDir, 'test1', jsonContent);
-            assert.deepEqual(fs.readJSONSync(dataDir + 'test1.json'), jsonContent);
-        });
-    });
-});