mcdev 5.0.2 → 5.2.0

package/lib/util/util.js

@@ -3,10 +3,10 @@
 const TYPE = require('../../types/mcdev.d');
 const MetadataDefinitions = require('./../MetadataTypeDefinitions');
 const packageJsonMcdev = require('../../package.json');
+const child_process = require('node:child_process');
 const process = require('node:process');
 const toposort = require('toposort');
 const winston = require('winston');
-const child_process = require('node:child_process');
 
 /**
  * Util that contains logger and simple util methods
@@ -80,12 +80,12 @@ const Util = {
             return false;
         }
     },
+
     /**
      * ensure provided MarketList exists and it's content including markets and BUs checks out
      *
      * @param {string} mlName name of marketList
      * @param {TYPE.Mcdevrc} properties General configuration to be used in retrieve
-     * @returns {void} throws errors if problems were found
      */
     verifyMarketList(mlName, properties) {
         if (properties.marketList[mlName]) {
@@ -131,29 +131,32 @@ const Util = {
      * @returns {void}
      */
     signalFatalError() {
-        Util.logger.debug('Util.signalFataError() sets process.exitCode = 1');
-        process.exitCode = 1;
+        Util.logger.debug('Util.signalFataError() sets process.exitCode = 1 unless already set');
+        process.exitCode ||= 1;
     },
     /**
-     * SFMC accepts multiple true values for Boolean attributes for which we are checking here
+     * SFMC accepts multiple true values for Boolean attributes for which we are checking here.
+     * The same problem occurs when evaluating boolean CLI flags
      *
      * @param {*} attrValue value
      * @returns {boolean} attribute value == true ? true : false
      */
     isTrue(attrValue) {
-        return ['true', 'TRUE', 'True', '1', 1, 'Y', true].includes(attrValue);
+        return ['true', 'TRUE', 'True', '1', 1, 'Y', 'y', true].includes(attrValue);
     },
     /**
-     * SFMC accepts multiple false values for Boolean attributes for which we are checking here
+     * SFMC accepts multiple false values for Boolean attributes for which we are checking here.
+     * The same problem occurs when evaluating boolean CLI flags
      *
      * @param {*} attrValue value
      * @returns {boolean} attribute value == false ? true : false
      */
     isFalse(attrValue) {
-        return ['false', 'FALSE', 'False', '0', 0, 'N', false].includes(attrValue);
+        return ['false', 'FALSE', 'False', '0', 0, 'N', 'n', false].includes(attrValue);
     },
+
     /**
-     * helper for {@link Mcdev.retrieve}, {@link Mcdev.retrieveAsTemplate} and {@link Mcdev.deploy}
+     * helper for Mcdev.retrieve, Mcdev.retrieveAsTemplate and 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
@@ -227,6 +230,76 @@ const Util = {
 
         return typeChoices;
     },
+    /**
+     * wrapper around our standard winston logging to console and logfile
+     *
+     * @param {boolean} [noLogFile] optional flag to indicate if we should log to file; CLI logs are always on
+     * @returns {object} initiated logger for console and file
+     */
+    _createNewLoggerTransport: function (noLogFile = false) {
+        // {
+        //   error: 0,
+        //   warn: 1,
+        //   info: 2,
+        //   http: 3,
+        //   verbose: 4,
+        //   debug: 5,
+        //   silly: 6
+        // }
+        if (
+            process.env.VSCODE_AMD_ENTRYPOINT === 'vs/workbench/api/node/extensionHostProcess' ||
+            process.env.VSCODE_CRASH_REPORTER_PROCESS_TYPE === 'extensionHost'
+        ) {
+            Util.OPTIONS.noLogColors = true;
+        }
+        const logFileName = new Date().toISOString().split(':').join('.');
+        const transports = {
+            console: new winston.transports.Console({
+                // Write logs to Console
+                level: Util.OPTIONS.loggerLevel || 'info',
+                format: winston.format.combine(
+                    Util.OPTIONS.noLogColors
+                        ? winston.format.uncolorize()
+                        : winston.format.colorize(),
+                    winston.format.timestamp({ format: 'HH:mm:ss' }),
+                    winston.format.simple(),
+                    winston.format.printf(
+                        (info) => `${info.timestamp} ${info.level}: ${info.message}`
+                    )
+                ),
+            }),
+        };
+        if (!noLogFile) {
+            transports.file = new winston.transports.File({
+                // Write logs to logfile
+                filename: 'logs/' + logFileName + '.log',
+                level: 'debug', // log everything
+                format: winston.format.combine(
+                    winston.format.uncolorize(),
+                    winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
+                    winston.format.simple(),
+                    winston.format.printf(
+                        (info) => `${info.timestamp} ${info.level}: ${info.message}`
+                    )
+                ),
+            });
+            transports.fileError = new winston.transports.File({
+                // Write logs to additional error-logfile for better visibility of errors
+                filename: 'logs/' + logFileName + '-errors.log',
+                level: 'error', // only log errors
+                lazy: true, // if true, log files will be created on demand, not at the initialization time.
+                format: winston.format.combine(
+                    winston.format.uncolorize(),
+                    winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
+                    winston.format.simple(),
+                    winston.format.printf(
+                        (info) => `${info.timestamp} ${info.level}: ${info.message}`
+                    )
+                ),
+            });
+        }
+        return transports;
+    },
 
     loggerTransports: null,
     /**
@@ -235,7 +308,91 @@ const Util = {
      * @type {TYPE.Logger}
      */
     logger: null,
-    restartLogger: startLogger,
+    /**
+     * initiate winston logger
+     *
+     * @param {boolean} [restart] if true, logger will be restarted; otherwise, an existing logger will be used
+     * @param {boolean} [noLogFile] if false, logger will log to file; otherwise, only to console
+     * @returns {void}
+     */
+    startLogger: function (restart = false, noLogFile = false) {
+        if (
+            !(
+                Util.loggerTransports === null ||
+                restart ||
+                (!Util.loggerTransports?.file && !noLogFile && !Util.OPTIONS?.noLogFile)
+            )
+        ) {
+            // logger already started
+            return;
+        }
+        Util.loggerTransports = this._createNewLoggerTransport(
+            noLogFile || Util.OPTIONS?.noLogFile
+        );
+        const myWinston = winston.createLogger({
+            level: Util.OPTIONS.loggerLevel,
+            levels: winston.config.npm.levels,
+            transports: Object.values(Util.loggerTransports),
+        });
+        const winstonError = myWinston.error;
+        const winstonExtension = {
+            /**
+             * helper that prints better stack trace for errors
+             *
+             * @param {Error} ex the error
+             * @param {string} [message] optional custom message to be printed as error together with the exception's message
+             * @returns {void}
+             */
+            errorStack: function (ex, message) {
+                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 + ':');
+                    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;
+                /* eslint-disable unicorn/prefer-ternary */
+                if (
+                    [
+                        'ETIMEDOUT',
+                        'EHOSTUNREACH',
+                        'ENOTFOUND',
+                        'ECONNRESET',
+                        'ECONNABORTED',
+                    ].includes(ex.code)
+                ) {
+                    // the stack would just return a one-liner that does not help
+                    stack = new Error().stack; // eslint-disable-line unicorn/error-message
+                } else {
+                    stack = ex.stack;
+                }
+                /* eslint-enable unicorn/prefer-ternary */
+                myWinston.debug(stack);
+            },
+            /**
+             * errors should cause surrounding applications to take notice
+             * hence we overwrite the default error function here
+             *
+             * @param {string} msg - the message to log
+             * @returns {void}
+             */
+            error: function (msg) {
+                winstonError(msg);
+                Util.signalFatalError();
+            },
+        };
+        Util.logger = Object.assign(myWinston, winstonExtension);
+
+        const processArgv = process.argv.slice(2);
+        Util.logger.debug(
+            `:: mcdev ${packageJsonMcdev.version} :: ⚡ mcdev ${processArgv.join(' ')}`
+        );
+    },
     /**
      * Logger helper for Metadata functions
      *
@@ -296,6 +453,7 @@ const Util = {
         }
         return str;
     },
+
     /**
      * get key of an object based on the first matching value
      *
@@ -312,6 +470,31 @@ const Util = {
         throw new Error(`${val} not found in object`);
     },
 
+    /**
+     *helper for Mcdev.fixKeys. Retrieve dependent metadata
+     *
+     * @param {string} fixedType type of the metadata passed as a parameter to fixKeys function
+     * @returns {string[]} array of types that depend on the given type
+     */
+    getDependentMetadata(fixedType) {
+        const dependencies = new Set();
+
+        for (const dependentType of Object.keys(MetadataDefinitions)) {
+            if (MetadataDefinitions[dependentType].dependencies.includes(fixedType)) {
+                // fixedType was found as a dependency of dependentType
+                dependencies.add(dependentType);
+            } else if (
+                MetadataDefinitions[dependentType].dependencies.some((dependency) =>
+                    dependency.startsWith(fixedType + '-')
+                )
+            ) {
+                // if MetadataTypeDefinitions[dependentType].dependencies start with type then also add dependentType to the set; use some to check if any of the dependencies start with type
+                dependencies.add(dependentType);
+            }
+        }
+        return [...dependencies];
+    },
+
     /**
      * Returns Order in which metadata needs to be retrieved/deployed
      *
@@ -416,7 +599,7 @@ const Util = {
      * @param {string} cmd to be executed command
      * @param {string[]} [args] list of arguments
      * @param {boolean} [hideOutput] if true, output of command will be hidden from CLI
-     * @returns {string} output of command if hideOutput is true
+     * @returns {string|void} output of command if hideOutput is true
      */
     execSync(cmd, args, hideOutput) {
         args ||= [];
@@ -471,34 +654,30 @@ const Util = {
      * @returns {void}
      */
     setLoggingLevel(argv) {
-        Util.loggerTransports.console.file = 'debug';
         if (argv.silent) {
             // only errors printed to CLI
-            Util.logger.level = 'error';
             Util.OPTIONS.loggerLevel = 'error';
-            Util.loggerTransports.console.level = 'error';
             Util.logger.debug('CLI logger set to: silent');
         } else if (argv.verbose) {
             // chatty user cli logs
-            Util.logger.level = 'verbose';
             Util.OPTIONS.loggerLevel = 'verbose';
-            Util.loggerTransports.console.level = 'verbose';
             Util.logger.debug('CLI logger set to: verbose');
         } else {
             // default user cli logs
-            // TODO to be switched to "warn" when cli-process is integrated
-            Util.logger.level = 'info';
             Util.OPTIONS.loggerLevel = 'info';
-            Util.loggerTransports.console.level = 'info';
             Util.logger.debug('CLI logger set to: info / default');
         }
         if (argv.debug) {
             // enables developer output & features. no change to actual logs
-            Util.logger.level = 'debug';
             Util.OPTIONS.loggerLevel = 'debug';
-            Util.loggerTransports.console.level = 'debug';
             Util.logger.debug('CLI logger set to: debug');
         }
+        if (Util.loggerTransports?.console) {
+            Util.loggerTransports.console.level = Util.OPTIONS.loggerLevel;
+        }
+        if (Util.logger) {
+            Util.logger.level = Util.OPTIONS.loggerLevel;
+        }
     },
     /**
      * outputs a warning that the given type is still in beta
@@ -598,7 +777,7 @@ const Util = {
         });
     },
     /**
-     * helper for {@link Asset._extractCode} and {@link Script.prepExtractedCode} to determine if a code block is a valid SSJS block
+     * helper for Asset.extractCode and Script.prepExtractedCode to determine if a code block is a valid SSJS block
      *
      * @example the following is invalid:
      * <script runat="server">
@@ -642,123 +821,75 @@ const Util = {
         // no script found
         return null;
     },
-};
-/**
- * wrapper around our standard winston logging to console and logfile
- *
- * @returns {object} initiated logger for console and file
- */
-function createNewLoggerTransport() {
-    // {
-    //   error: 0,
-    //   warn: 1,
-    //   info: 2,
-    //   http: 3,
-    //   verbose: 4,
-    //   debug: 5,
-    //   silly: 6
-    // }
-    const logFileName = new Date().toISOString().split(':').join('.');
-    return {
-        console: new winston.transports.Console({
-            // Write logs to Console
-            level: 'info', // log error, warn, info
-            format: winston.format.combine(
-                winston.format.colorize(),
-                winston.format.timestamp({ format: 'HH:mm:ss' }),
-                winston.format.simple(),
-                winston.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`)
-            ),
-        }),
-        file: new winston.transports.File({
-            // Write logs to logfile
-            filename: 'logs/' + logFileName + '.log',
-            level: 'debug', // log everything
-            format: winston.format.combine(
-                winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
-                winston.format.simple(),
-                winston.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`)
-            ),
-        }),
-        fileError: new winston.transports.File({
-            // Write logs to additional error-logfile for better visibility of errors
-            filename: 'logs/' + logFileName + '-errors.log',
-            level: 'error', // only log errors
-            format: winston.format.combine(
-                winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
-                winston.format.simple(),
-                winston.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`)
-            ),
-        }),
-    };
-}
-/**
- * initiate winston logger
- *
- * @returns {void}
- */
-function startLogger() {
-    Util.loggerTransports = createNewLoggerTransport();
-    const myWinston = winston.createLogger({
-        levels: winston.config.npm.levels,
-        transports: [
-            Util.loggerTransports.console,
-            Util.loggerTransports.file,
-            Util.loggerTransports.fileError,
-        ],
-    });
-    const winstonError = myWinston.error;
-    const winstonExtension = {
-        /**
-         * helper that prints better stack trace for errors
-         *
-         * @param {Error} ex the error
-         * @param {string} [message] optional custom message to be printed as error together with the exception's message
-         * @returns {void}
-         */
-        errorStack: function (ex, message) {
-            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 + ':');
-                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;
-            /* eslint-disable unicorn/prefer-ternary */
-            if (
-                ['ETIMEDOUT', 'EHOSTUNREACH', 'ENOTFOUND', 'ECONNRESET', 'ECONNABORTED'].includes(
-                    ex.code
-                )
-            ) {
-                // the stack would just return a one-liner that does not help
-                stack = new Error().stack; // eslint-disable-line unicorn/error-message
+    /**
+     * allows us to filter just like with SQL's LIKE operator
+     *
+     * @param {string} testString field value to test
+     * @param {string} search search string in SQL LIKE format
+     * @returns {boolean} true if testString matches search
+     */
+    stringLike(testString, search) {
+        if (typeof search !== 'string' || this === null) {
+            return false;
+        }
+        // Remove special chars
+        search = search.replaceAll(
+            new RegExp('([\\.\\\\\\+\\*\\?\\[\\^\\]\\$\\(\\)\\{\\}\\=\\!\\<\\>\\|\\:\\-])', 'g'),
+            '\\$1'
+        );
+        // Replace % and _ with equivalent regex
+        search = search.replaceAll('%', '.*').replaceAll('_', '.');
+        // Check matches
+        return new RegExp('^' + search + '$', 'gi').test(testString);
+    },
+    /**
+     * returns true if no LIKE filter is defined or if all filters match
+     *
+     * @param {TYPE.MetadataTypeItem} metadata a single metadata item
+     * @param {object} [filters] only used in recursive calls
+     * @returns {boolean} true if no LIKE filter is defined or if all filters match
+     */
+    fieldsLike(metadata, filters) {
+        if (metadata.json && metadata.codeArr) {
+            // Compensate for CodeExtractItem format
+            metadata = metadata.json;
+        }
+        filters ||= Util.OPTIONS.like;
+        if (!filters) {
+            return true;
+        }
+        const fields = Object.keys(filters);
+        return fields.every((field) => {
+            // to allow passing in an array via cli, e.g. --like=field1,field2, we need to convert comma separated lists into arrays
+            const filter =
+                typeof filters[field] === 'string' && filters[field].includes(',')
+                    ? filters[field].split(',')
+                    : filters[field];
+            if (Array.isArray(metadata[field])) {
+                return metadata[field].some((f) => Util.fieldsLike(f, filter));
             } else {
-                stack = ex.stack;
+                if (typeof filter === 'string') {
+                    return Util.stringLike(metadata[field], filter);
+                } else if (Array.isArray(filter)) {
+                    return filter.some((f) => Util.stringLike(metadata[field], f));
+                } else if (typeof filter === 'object') {
+                    return Util.fieldsLike(metadata[field], filter);
+                }
             }
-            /* eslint-enable unicorn/prefer-ternary */
-            myWinston.debug(stack);
-        },
-        /**
-         * errors should cause surrounding applications to take notice
-         * hence we overwrite the default error function here
-         *
-         * @param {string} msg - the message to log
-         * @returns {void}
-         */
-        error: function (msg) {
-            winstonError(msg);
-            Util.signalFatalError();
-        },
-    };
-    Util.logger = Object.assign(myWinston, winstonExtension);
+            return false;
+        });
+    },
+    /**
+     * helper used by SOAP methods to ensure the type always uses an upper-cased first letter
+     *
+     * @param {string} str string to capitalize
+     * @returns {string} str with first letter capitalized
+     */
+    capitalizeFirstLetter(str) {
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    },
+};
 
-    Util.logger.debug(`:: mcdev ${packageJsonMcdev.version} ::`);
-}
-startLogger();
+Util.startLogger(false, true);
 
 module.exports = Util;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mcdev",
-    "version": "5.0.2",
+    "version": "5.2.0",
     "description": "Accenture Salesforce Marketing Cloud DevTools",
     "author": "Accenture: joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
     "license": "MIT",
@@ -63,7 +63,7 @@
         "command-exists": "1.2.9",
         "conf": "10.2.0",
         "console.table": "0.10.0",
-        "deep-equal": "2.2.1",
+        "deep-equal": "2.2.2",
         "fs-extra": "11.1.0",
         "inquirer": "8.2.5",
         "json-to-table": "4.2.1",
@@ -71,30 +71,30 @@
         "p-limit": "3.1.0",
         "prettier": "2.8.8",
         "prettier-plugin-sql": "0.14.0",
-        "semver": "7.5.0",
+        "semver": "7.5.4",
         "sfmc-sdk": "1.0.1",
         "simple-git": "3.18.0",
         "toposort": "2.0.2",
         "update-notifier": "5.1.0",
-        "winston": "3.8.2",
+        "winston": "3.10.0",
         "yargs": "17.7.2"
     },
     "devDependencies": {
         "assert": "2.0.0",
-        "axios-mock-adapter": "1.21.3",
+        "axios-mock-adapter": "1.21.5",
         "chai": "4.3.7",
         "chai-files": "1.4.0",
-        "eslint": "8.41.0",
-        "eslint-config-prettier": "8.7.0",
+        "eslint": "8.46.0",
+        "eslint-config-prettier": "9.0.0",
         "eslint-config-ssjs": "1.1.11",
-        "eslint-plugin-jsdoc": "45.0.0",
+        "eslint-plugin-jsdoc": "46.4.6",
         "eslint-plugin-mocha": "10.1.0",
         "eslint-plugin-prettier": "4.2.1",
-        "eslint-plugin-unicorn": "47.0.0",
-        "fast-xml-parser": "4.2.2",
+        "eslint-plugin-unicorn": "48.0.0",
+        "fast-xml-parser": "4.2.7",
         "husky": "8.0.3",
         "jsdoc-to-markdown": "8.0.0",
-        "lint-staged": "13.2.2",
+        "lint-staged": "13.2.3",
         "mocha": "10.2.0",
         "mock-fs": "5.2.0",
         "npm-check": "6.0.1",

package/test/general.test.js

@@ -14,6 +14,22 @@ describe('GENERAL', () => {
         testUtils.mockReset();
     });
 
+    describe('init ================', () => {
+        it('should init a local project without downloading BUs');
+        it('should init a local project and download all BUs');
+    });
+    describe('join ================', () => {
+        it('should clone a project from git');
+    });
+    describe('upgrade ================', () => {
+        it('should upgrade a project to the latest version');
+    });
+    describe('reloadBUs ================', () => {
+        it('should load all BUs from the server and refresh the config');
+    });
+    describe('selectTypes ================', () => {
+        it('should change which types are selected for default retrieval');
+    });
     describe('explainTypes ================', () => {
         it('without options', () => {
             handler.explainTypes();
@@ -59,4 +75,14 @@ describe('GENERAL', () => {
             return;
         });
     });
+    describe('createDeltaPkg ================', () => {
+        it('should show diff to master branch');
+        // mcdev createDeltaPkg master # resolves to master..HEAD
+        it('should show diff between master and develop branch');
+        // mcdev createDeltaPkg master..develop
+        it(
+            'should show diff between master and develop branch and filter the results to only show MyProject/BU1'
+        );
+        // mcdev createDeltaPkg master..develop --filter 'MyProject/BU1'
+    });
 });

package/test/mockRoot/.mcdevrc.json

@@ -78,5 +78,5 @@
             "triggeredSend"
         ]
     },
-    "version": "5.0.2"
+    "version": "5.2.0"
 }