mcdev 3.1.3 → 4.0.0

package/lib/util/file.js

@@ -1,19 +1,18 @@
 /* eslint-disable no-control-regex */
 'use strict';
 
+const TYPE = require('../../types/mcdev.d');
 const fs = require('fs-extra');
 const packageJson = require('../../package.json');
-const path = require('path');
+const path = require('node:path');
 const prettier = require('prettier');
 const Util = require('./util');
-const sql = require('sql-formatter-plus');
-const updateNotifier = require('update-notifier-git');
+const updateNotifier = require('update-notifier');
 
 // inform user when there is an update
 const notifier = updateNotifier({
     pkg: packageJson,
     updateCheckInterval: 1000 * 3600 * 24, // once per day
-    remoteUrl: packageJson.repository.url.split('git+')[1],
 });
 // Notify using the built-in convenience method
 notifier.notify();
@@ -24,9 +23,10 @@ notifier.notify();
 const File = {
     /**
      * copies a file from one path to another
-     * @param {String} from - full filepath including name of existing file
-     * @param {String} to - full filepath including name where file should go
-     * @returns {Object} - results object
+     *
+     * @param {string} from - full filepath including name of existing file
+     * @param {string} to - full filepath including name where file should go
+     * @returns {object} - results object
      */
     async copyFile(from, to) {
         try {
@@ -34,21 +34,20 @@ const File = {
             return { status: 'ok', file: from };
         } catch (ex) {
             // This can happen in some cases where referencing files deleted in Commit
-            if (ex.message.startsWith('ENOENT: no such file or directory')) {
-                return {
-                    status: 'skipped',
-                    statusMessage: 'deleted from repository',
-                    file: from,
-                };
-            } else {
-                return { status: 'failed', statusMessage: ex.message, file: from };
-            }
+            return ex.message.startsWith('ENOENT: no such file or directory')
+                ? {
+                      status: 'skipped',
+                      statusMessage: 'deleted from repository',
+                      file: from,
+                  }
+                : { status: 'failed', statusMessage: ex.message, file: from };
         }
     },
     /**
      * makes sure Windows accepts path names
-     * @param {String} path - filename or path
-     * @returns {String} - corrected string
+     *
+     * @param {string} path - filename or path
+     * @returns {string} - corrected string
      */
     filterIllegalPathChars(path) {
         return (
@@ -69,13 +68,20 @@ const File = {
                 // convert closing-curly brackets back for templating
                 .split('%7D')
                 .join('}')
+                // convert brackets back for asset blocks
+                .split('%5B')
+                .join('[')
+                // convert brackets back for asset blocks
+                .split('%5D')
+                .join(']')
         );
     },
 
     /**
      * makes sure Windows accepts file names
-     * @param {String} filename - filename or path
-     * @returns {String} - corrected string
+     *
+     * @param {string} filename - filename or path
+     * @returns {string} - corrected string
      */
     filterIllegalFilenames(filename) {
         return (
@@ -90,13 +96,20 @@ const File = {
                 // convert closing-curly brackets back for templating
                 .split('%7D')
                 .join('}')
+                // convert brackets back for asset blocks
+                .split('%5B')
+                .join('[')
+                // convert brackets back for asset blocks
+                .split('%5D')
+                .join(']')
         );
     },
 
     /**
      * makes sure Windows accepts file names
-     * @param {String} filename - filename or path
-     * @returns {String} - corrected string
+     *
+     * @param {string} filename - filename or path
+     * @returns {string} - corrected string
      */
     reverseFilterIllegalFilenames(filename) {
         return decodeURIComponent(filename).split('_STAR_').join('*');
@@ -104,10 +117,12 @@ const File = {
 
     /**
      * Takes various types of path strings and formats into a platform specific path
+     *
      * @param {string|string[]} denormalizedPath directory the file will be written to
-     * @returns {String} Path strings
+     * @returns {string} Path strings
      */
     normalizePath: function (denormalizedPath) {
+        /* eslint-disable unicorn/prefer-ternary */
         if (Array.isArray(denormalizedPath)) {
             // if the value is undefined set to empty string to allow parsing
             return path.join(...denormalizedPath.map((val) => val || ''));
@@ -115,22 +130,22 @@ const File = {
             // if directory is empty put . as otherwill will write to c://
             return path.join(denormalizedPath || '.');
         }
+        /* eslint-enable unicorn/prefer-ternary */
     },
     /**
      * Saves json content to a file in the local file system. Will create the parent directory if it does not exist
+     *
      * @param {string|string[]} directory directory the file will be written to
-     * @param {String} filename name of the file without '.json' ending
-     * @param {Object} content filecontent
+     * @param {string} filename name of the file without '.json' ending
+     * @param {object} content filecontent
      * @returns {Promise} Promise
      */
     writeJSONToFile: async function (directory, filename, content) {
         directory = this.filterIllegalPathChars(this.normalizePath(directory));
         filename = this.filterIllegalFilenames(filename);
-        if (!fs.existsSync(directory)) {
-            fs.mkdirpSync(directory);
-        }
+        await fs.ensureDir(directory);
         try {
-            await fs.writeJSON(path.join(directory, filename + '.json'), content, { spaces: 4 });
+            return fs.writeJSON(path.join(directory, filename + '.json'), content, { spaces: 4 });
         } catch (ex) {
             Util.logger.error('File.writeJSONToFile:: error | ' + ex.message);
         }
@@ -138,57 +153,30 @@ const File = {
     /**
      * Saves beautified files in the local file system. Will create the parent directory if it does not exist
      * ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
+     *
      * @param {string|string[]} directory directory the file will be written to
-     * @param {String} filename name of the file without suffix
-     * @param {String} filetype filetype ie. JSON or SSJS
-     * @param {String} content filecontent
-     * @param {Object} [templateVariables] templating variables to be replaced in the metadata
-     * @returns {Promise<Boolean>} Promise
+     * @param {string} filename name of the file without suffix
+     * @param {string} filetype filetype ie. JSON or SSJS
+     * @param {string} content filecontent
+     * @param {TYPE.TemplateMap} [templateVariables] templating variables to be replaced in the metadata
+     * @returns {Promise.<boolean>} Promise
      */
     writePrettyToFile: async function (directory, filename, filetype, content, templateVariables) {
-        let formatted;
-        if (filetype === 'sql') {
-            formatted = this._beautify_sql(content);
-        } else {
-            // we need to ensure formatted is a String, not a Promise
-            formatted = await this._beautify_prettier(directory, filename, filetype, content);
-        }
+        let formatted = await this._beautify_prettier(directory, filename, filetype, content);
         if (templateVariables) {
             formatted = Util.replaceByObject(formatted, templateVariables);
         }
-
         return this.writeToFile(directory, filename, filetype, formatted);
     },
-    /**
-     * helper for writePrettyToFile, applying sql formatting onto given stringified content
-     * @param {String} content filecontent
-     * @returns {String} original string on error; formatted string on success
-     */
-    _beautify_sql: function (content) {
-        let formatted;
-        try {
-            formatted = sql.format(content, {
-                language: 'sql', // Defaults to "sql"
-                indent: '    ', // Defaults to two spaces,W
-                uppercase: true, // Defaults to false
-                linesBetweenQueries: 1, // Defaults to 1
-            });
-            // if templating variables were in the code, those now have extra spaces
-            formatted = formatted.split('{ { { ').join('{{{').split(' } } }').join('}}}');
-        } catch (ex) {
-            Util.logger.debug('SQL Formatter Exception: ' + ex.message);
-            formatted = content;
-        }
-        return formatted;
-    },
     /**
      * helper for writePrettyToFile, applying prettier onto given stringified content
      * ! Important: run 'await File.initPrettier()' in your MetadataType.retrieve() once before hitting this
+     *
      * @param {string|string[]} directory directory the file will be written to
-     * @param {String} filename name of the file without suffix
-     * @param {String} filetype filetype ie. JSON or SSJS
-     * @param {String} content filecontent
-     * @returns {String} original string on error; formatted string on success
+     * @param {string} filename name of the file without suffix
+     * @param {string} filetype filetype ie. JSON or SSJS
+     * @param {string} content filecontent
+     * @returns {string} original string on error; formatted string on success
      */
     _beautify_prettier: function (directory, filename, filetype, content) {
         if (!FileFs.prettierConfig) {
@@ -234,6 +222,9 @@ const File = {
                 case 'md':
                     FileFs.prettierConfig.parser = 'markdown';
                     break;
+                case 'sql':
+                    FileFs.prettierConfig.parser = 'sql';
+                    break;
                 default:
                     FileFs.prettierConfig.parser = 'babel';
             }
@@ -252,7 +243,7 @@ const File = {
                 filename + '.error',
                 'log',
                 `Error Log\nParser: ${FileFs.prettierConfig.parser}\n${ex.message.replace(
-                    /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
+                    /[\u001B\u009B][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
 
                     ''
                 )}`
@@ -265,23 +256,25 @@ const File = {
     },
     /**
      * Saves text content to a file in the local file system. Will create the parent directory if it does not exist
+     *
      * @param {string|string[]} directory directory the file will be written to
-     * @param {String} filename name of the file without '.json' ending
-     * @param {String} filetype filetype suffix
-     * @param {String} content filecontent
-     * @param {Object} [encoding] added for certain file types (like images)
-     * @returns {Promise<Boolean>} Promise
+     * @param {string} filename name of the file without '.json' ending
+     * @param {string} filetype filetype suffix
+     * @param {string} content filecontent
+     * @param {object} [encoding] added for certain file types (like images)
+     * @returns {Promise.<boolean>} Promise
      */
     writeToFile: async function (directory, filename, filetype, content, encoding) {
         directory = this.filterIllegalPathChars(this.normalizePath(directory));
-        if (!fs.existsSync(directory)) {
-            fs.mkdirpSync(directory);
-        }
+        await fs.ensureDir(directory);
         // filter characters that are illegal for file names in Windows
         filename = this.filterIllegalFilenames(filename);
-
+        const filePath = path.join(directory, filename + '.' + filetype);
         try {
-            await fs.writeFile(path.join(directory, filename + '.' + filetype), content, encoding);
+            if (await fs.pathExists(filePath)) {
+                Util.logger.debug(`Overwriting: ${filePath}`);
+            }
+            await fs.writeFile(filePath, content, encoding);
             return true;
         } catch (ex) {
             Util.logger.error('File.writeToFile:: error | ' + ex.message);
@@ -291,11 +284,12 @@ const File = {
 
     /**
      * Saves json content to a file in the local file system. Will create the parent directory if it does not exist
-     * @param {String|String[]} directory directory where the file is stored
-     * @param {String} filename name of the file without '.json' ending
-     * @param {Boolean} sync should execute sync (default is async)
-     * @param {Boolean} cleanPath should execute sync (default is true)
-     * @returns {Promise|Object} Promise or JSON object depending on if async or not
+     *
+     * @param {string | string[]} directory directory where the file is stored
+     * @param {string} filename name of the file without '.json' ending
+     * @param {boolean} sync should execute sync (default is async)
+     * @param {boolean} cleanPath should execute sync (default is true)
+     * @returns {Promise | object} Promise or JSON object depending on if async or not
      */
     readJSONFile: function (directory, filename, sync, cleanPath) {
         try {
@@ -326,30 +320,32 @@ const File = {
     },
     /**
      * reads file from local file system.
-     * @param {String|String[]} directory directory where the file is stored
-     * @param {String} filename name of the file without '.json' ending
-     * @param {String} filetype filetype suffix
-     * @param {String} [encoding='utf8'] read file with encoding (defaults to utf-8)
-     * @returns {Promise<String>} file contents
+     *
+     * @param {string | string[]} directory directory where the file is stored
+     * @param {string} filename name of the file without '.json' ending
+     * @param {string} filetype filetype suffix
+     * @param {string} [encoding='utf8'] read file with encoding (defaults to utf-8)
+     * @returns {Promise.<string>} file contents
      */
-    readFile: function (directory, filename, filetype, encoding) {
+    readFilteredFilename: function (directory, filename, filetype, encoding) {
         try {
             directory = this.filterIllegalPathChars(this.normalizePath(directory));
             filename = this.filterIllegalFilenames(filename);
             return fs.readFile(path.join(directory, filename + '.' + filetype), encoding || 'utf8');
         } catch (ex) {
-            Util.logger.error('File.readFile:: error | ' + ex.message);
+            Util.logger.error('File.readFilteredFilename:: error | ' + ex.message);
         }
     },
     /**
      * reads directories to a specific depth returning an array
      * of file paths to be iterated over
+     *
      * @example ['deploy/mcdev/bu1']
-     * @param {String} directory directory to checkin
-     * @param {Number} depth how many levels to check (1 base)
-     * @param {Boolean} [includeStem] include the parent directory in the response
-     * @param {Number} [_stemLength] set recursively for subfolders. do not set manually!
-     * @returns {Promise<String[]>} array of fully defined file paths
+     * @param {string} directory directory to checkin
+     * @param {number} depth how many levels to check (1 base)
+     * @param {boolean} [includeStem] include the parent directory in the response
+     * @param {number} [_stemLength] set recursively for subfolders. do not set manually!
+     * @returns {Promise.<string[]>} array of fully defined file paths
      */
     readDirectories: async function (directory, depth, includeStem, _stemLength) {
         try {
@@ -362,8 +358,8 @@ const File = {
             for (const dirent of raw) {
                 const direntPath = path.join(directory, dirent.name);
                 if (
-                    fs.existsSync(direntPath) &&
-                    fs.lstatSync(direntPath).isDirectory() &&
+                    (await fs.pathExists(direntPath)) &&
+                    (await fs.lstat(direntPath)).isDirectory() &&
                     depth > 0
                 ) {
                     const nestedChildren = await this.readDirectories(
@@ -376,14 +372,15 @@ const File = {
                 }
             }
             if (children.length === 0) {
-                if (includeStem) {
-                    return [directory];
-                } else {
-                    // remove base directory and leading slahes and backslashes
-                    return [
-                        directory.substring(_stemLength).replace(/^\\+/, '').replace(/^\/+/, ''),
-                    ];
-                }
+                // if not includeStem then remove base directory and leading slahes and backslashes
+                return includeStem
+                    ? [directory]
+                    : [
+                          directory
+                              .slice(Math.max(0, _stemLength))
+                              .replace(/^\\+/, '')
+                              .replace(/^\/+/, ''),
+                      ];
             } else {
                 return children;
             }
@@ -396,12 +393,14 @@ const File = {
     /**
      * reads directories to a specific depth returning an array
      * of file paths to be iterated over using sync api (required in constructors)
+     * TODO - merge with readDirectories. so far the logic is really different
+     *
      * @example ['deploy/mcdev/bu1']
-     * @param {String} directory directory to checkin
-     * @param {Number} [depth] how many levels to check (1 base)
-     * @param {Boolean} [includeStem] include the parent directory in the response
-     * @param {Number} [_stemLength] set recursively for subfolders. do not set manually!
-     * @returns {String[]} array of fully defined file paths
+     * @param {string} directory directory to checkin
+     * @param {number} [depth] how many levels to check (1 base)
+     * @param {boolean} [includeStem] include the parent directory in the response
+     * @param {number} [_stemLength] set recursively for subfolders. do not set manually!
+     * @returns {string[]} array of fully defined file paths
      */
     readDirectoriesSync: function (directory, depth, includeStem, _stemLength) {
         try {
@@ -417,8 +416,8 @@ const File = {
                 children.push(directory);
             } else {
                 // remove base directory and leading slahes and backslashes
-                const currentPath = directory.substring(_stemLength).replace(path.sep, '');
-                children.push(currentPath ? currentPath : '.');
+                const currentPath = directory.slice(Math.max(0, _stemLength)).replace(path.sep, '');
+                children.push(currentPath || '.');
             }
             // read all directories
             const raw = fs.readdirSync(directory, { withFileTypes: true });
@@ -442,94 +441,24 @@ const File = {
             Util.logger.debug(ex.stack);
         }
     },
-    /**
-     * loads central properties from config file
-     * @param {Boolean} [silent] omit throwing errors and print messages; assuming not silent if not set
-     * @returns {Object} central properties object
-     */
-    loadConfigFile(silent) {
-        let properties;
-        if (fs.existsSync(Util.configFileName)) {
-            // properties = JSON.parse(fs.readFileSync(Util.configFileName, 'utf8'));
-            try {
-                properties = fs.readJsonSync(Util.configFileName);
-            } catch (ex) {
-                Util.logger.error(`${ex.code}: ${ex.message}`);
-                return;
-            }
-            if (fs.existsSync(Util.authFileName)) {
-                let auth;
-                try {
-                    auth = fs.readJsonSync(Util.authFileName);
-                } catch (ex) {
-                    Util.logger.error(`${ex.code}: ${ex.message}`);
-                    return;
-                }
-
-                if (!auth.credentials) {
-                    const err = `${Util.authFileName} is not set up correctly.`;
-                    Util.logger.error(err);
-                    throw new Error(err);
-                }
-                for (const cred in properties.credentials) {
-                    const configset = properties.credentials[cred];
-                    const authset = auth.credentials[cred];
-                    if (authset) {
-                        if (configset.eid === authset.eid) {
-                            for (const key in authset) {
-                                configset[key] = authset[key];
-                            }
-                        } else if (!silent) {
-                            const err = `'${cred}' found in ${Util.configFileName} and ${Util.authFileName} have a Enterprise ID mismatch. Please check.`;
-                            Util.logger.error(err);
-                            throw new Error(err);
-                        }
-                    } else if (!silent) {
-                        Util.logger.warn(
-                            `'${cred}' found in ${Util.configFileName} but not in ${Util.authFileName}. Please run 'mcdev init' to provide the missing credential details.`
-                        );
-                    }
-                }
-            } else if (!silent) {
-                Util.logger.warn(
-                    `${Util.authFileName} not found. Please run 'mcdev init' to provide the missing credential details.`
-                );
-            }
-        }
-        return properties;
-    },
     /**
      * helper that splits the config back into auth & config parts to save them separately
-     * @param {Object} properties central properties object
-     * @returns {Promise<void>} -
+     *
+     * @param {TYPE.Mcdevrc} properties central properties object
+     * @returns {Promise.<void>} -
      */
     async saveConfigFile(properties) {
-        const auth = { credentials: {} };
-        const config = properties;
-        for (const cred in config.credentials) {
-            auth.credentials[cred] = {};
-            // copy id+secret+tenant to auth file
-            auth.credentials[cred].clientId = config.credentials[cred].clientId;
-            auth.credentials[cred].clientSecret = config.credentials[cred].clientSecret;
-            auth.credentials[cred].tenant = config.credentials[cred].tenant;
-            // copy eid as well to make sure we can test for equality when merging the files during runtime
-            auth.credentials[cred].eid = config.credentials[cred].eid;
-            // delete id+secret from config file
-            delete config.credentials[cred].clientId;
-            delete config.credentials[cred].clientSecret;
-            delete config.credentials[cred].tenant;
-        }
         // we want to save to save the full version here to allow us to upgrade configs properly in the future
-        config.version = packageJson.version;
+        properties.version = packageJson.version;
 
-        await this.writeJSONToFile('', Util.configFileName.split('.json')[0], config);
-        await this.writeJSONToFile('', Util.authFileName.split('.json')[0], auth);
+        await this.writeJSONToFile('', Util.configFileName.split('.json')[0], properties);
         Util.logger.info(`✔️  ${Util.configFileName} and ${Util.authFileName} saved successfully`);
     },
     /**
      * Initalises Prettier formatting lib async.
-     * @param {String} [filetype='html'] filetype ie. JSON or SSJS
-     * @returns {Promise<Boolean>} success of config load
+     *
+     * @param {string} [filetype='html'] filetype ie. JSON or SSJS
+     * @returns {Promise.<boolean>} success of config load
      */
     async initPrettier(filetype) {
         if (FileFs.prettierConfig === null) {