mcdev 9.0.2 → 10.0.0

package/lib/util/init.config.js

@@ -6,8 +6,6 @@ import { Util } from './util.js';
 import { confirm } from '@inquirer/prompts';
 import path from 'node:path';
 import semver from 'semver';
-import { fileURLToPath } from 'node:url';
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
@@ -38,9 +36,10 @@ const Init = {
      * helper method for this.upgradeProject that upgrades project config if needed
      *
      * @param {Mcdevrc} properties config file's json
+     * @param {string} [versionToPersist] version to store while saving config migrations
      * @returns {Promise.<boolean>} returns true if worked without errors
      */
-    async fixMcdevConfig(properties) {
+    async fixMcdevConfig(properties, versionToPersist) {
         if (!properties) {
             // skip if no config exists yet
             return true;
@@ -206,17 +205,21 @@ const Init = {
                 credentialMidsUpdated = true;
             }
             for (const bu in properties.credentials[cred].businessUnits) {
-                if (typeof properties.credentials[cred].businessUnits[bu] === 'string') {
-                    properties.credentials[cred].businessUnits[bu] = Number.parseInt(
-                        properties.credentials[cred].businessUnits[bu]
-                    );
-                    credentialMidsUpdated = true;
+                if (typeof properties.credentials[cred].businessUnits[bu] !== 'string') {
+                    continue;
                 }
+
+                properties.credentials[cred].businessUnits[bu] = Number.parseInt(
+                    properties.credentials[cred].businessUnits[bu]
+                );
+                credentialMidsUpdated = true;
             }
-            if (credentialMidsUpdated) {
-                updateConfigNeeded = true;
-                upgradeMsgs.push(`- ✔️  updated Business Unit format (${cred})`);
+            if (!credentialMidsUpdated) {
+                continue;
             }
+
+            updateConfigNeeded = true;
+            upgradeMsgs.push(`- ✔️  updated Business Unit format (${cred})`);
         }
 
         // update config
@@ -274,8 +277,10 @@ const Init = {
                     defaultRetrieveArr
                 );
             }
-            // update config
-            await File.saveConfigFile(properties);
+            // update config while retaining the prior version until all upgrade phases succeed
+            if (!(await File.saveConfigFile(properties, versionToPersist))) {
+                return false;
+            }
         } else {
             Util.logger.info(`✔️  No problems found in existing ${Util.configFileName}`);
         }
@@ -284,69 +289,52 @@ const Init = {
     },
 
     /**
-     * handles creation/update of all config file from the boilerplate
+     * handles creation/update of all config files from the boilerplate, one at a time
      *
      * @param {string} versionBeforeUpgrade 'x.y.z'
      * @returns {Promise.<boolean>} status of config file creation
      */
     async createIdeConfigFiles(versionBeforeUpgrade) {
-        Util.logger.info('Checking configuration files (existing files will not be changed):');
-        const creationLog = [];
+        Util.logger.info('Checking configuration files:');
         await File.ensureDir('deploy/');
         await File.ensureDir('src/cloudPages');
-        const relevantForced = await this._getForcedUpdateList(versionBeforeUpgrade);
-
-        await this._removeIdeConfigFiles(relevantForced);
-
-        // copy in .gitignore (cant be retrieved via npm install directly)
-        const gitignoreFileName = path.resolve(
-            __dirname,
-            Util.boilerplateDirectory,
-            'gitignore-template'
+        const forced = await this._getForcedUpdateList(versionBeforeUpgrade);
+        const creationLog = [await this._removeIdeConfigFiles(forced)];
+        const root = Util.getBoilerplatePath();
+        creationLog.push(
+            await this._createIdeConfigFile(
+                '.gitignore',
+                forced,
+                await File.readFile(path.join(root, 'gitignore-template'), 'utf8')
+            ),
+            await this._createIdeConfigFile(
+                '.npmrc',
+                forced,
+                await File.readFile(path.join(root, 'npmrc-template'), 'utf8')
+            )
         );
-        if (await File.pathExists(gitignoreFileName)) {
-            const fileContent = await File.readFile(gitignoreFileName, 'utf8');
-            creationLog.push(
-                await this._createIdeConfigFile(
-                    ['.' + path.sep, '', '.gitignore'],
-                    relevantForced,
-                    fileContent
-                )
-            );
-        } else {
-            Util.logger.debug(`Dependency file not found in ${gitignoreFileName}`);
-            return false;
+        const filesRoot = path.join(root, 'files');
+        const directories = File.readDirectoriesSync(filesRoot, 10, false);
+        if (!directories) {
+            throw new Error('Could not inspect tooling templates.');
         }
-
-        // load file list from boilerplate dir and initiate copy process
-        const boilerPlateFilesPath = path.resolve(__dirname, Util.boilerplateDirectory, 'files');
-        // ! do not switch to readDirectories before merging the two custom methods. Their logic is different!
-        const directories = await File.readDirectoriesSync(boilerPlateFilesPath, 10, false);
-        if (directories) {
-            for (const subdir of directories) {
-                // walk thru the root of our boilerplate-files  directory and all sub folders
-                const curDir = path.join(boilerPlateFilesPath, subdir);
-                for (const file of await File.readdir(curDir)) {
-                    // read all files in these directories
-                    if (!(await File.lstat(path.join(curDir, file))).isDirectory()) {
-                        // filter entries that are actually folders
-                        const fileArr = file.split('.');
-                        const ext = '.' + fileArr.pop();
-                        // awaiting the result here due to interactive optional overwrite
-                        creationLog.push(
-                            await this._createIdeConfigFile(
-                                [subdir + path.sep, fileArr.join('.'), ext],
-                                relevantForced
-                            )
-                        );
-                    }
+        for (const directory of directories) {
+            for (const name of await File.readdir(path.join(filesRoot, directory))) {
+                const source = path.join(filesRoot, directory, name);
+                if (!(await File.lstat(source)).isDirectory()) {
+                    creationLog.push(
+                        await this._createIdeConfigFile(
+                            path.normalize(path.join(directory, name)),
+                            forced,
+                            await File.readFile(source, 'utf8')
+                        )
+                    );
                 }
             }
         }
-
         if (creationLog.includes(false) && creationLog.includes(true)) {
             Util.logger.warn('✋  Configuration files creation partially failed.');
-            return true;
+            return false;
         } else if (creationLog.includes(false)) {
             Util.logger.error('❌  Configuration files creation failed.');
             return false;
@@ -356,6 +344,91 @@ const Init = {
         }
     },
 
+    /**
+     * Prompt for an ordinary configuration override.
+     *
+     * @param {string} message selection to present
+     * @param {boolean} [defaultValue] initial selection
+     * @returns {Promise.<boolean>} user's selection
+     */
+    async promptConfirmation(message, defaultValue = true) {
+        return confirm({ message, default: defaultValue });
+    },
+
+    /**
+     * Compare, optionally back up, and write one configuration file.
+     *
+     * @param {string} fileName destination path
+     * @param {{updates:string[],deletes:string[]}} forced version-gated replacements and retirements
+     * @param {string} content boilerplate contents
+     * @returns {Promise.<boolean>} success, including a declined override
+     */
+    async _createIdeConfigFile(fileName, forced, content) {
+        if (forced.deletes.includes(fileName)) {
+            return true;
+        }
+        const exists = await this._hasDirectoryEntry(fileName);
+        if (exists) {
+            if (!(await File.stat(fileName)).isFile()) {
+                throw new Error(`Configuration destination is not a regular file: ${fileName}`);
+            }
+            if ((await File.readFile(fileName, 'utf8')) === content) {
+                Util.logger.info(`- ✔️  ${fileName} found. No update needed`);
+                return true;
+            }
+            if (forced.updates.includes(fileName)) {
+                Util.logger.info(
+                    `- ✋  ${fileName} found but an update is required. Commencing with override:`
+                );
+            } else {
+                Util.logger.info(
+                    `- ✋  ${fileName} found with differences to the new standard version. We recommend updating it.`
+                );
+                if (
+                    !Util.skipInteraction &&
+                    !(await this.promptConfirmation(`Update ${fileName}?`, true))
+                ) {
+                    return true;
+                }
+            }
+            await File.rename(fileName, fileName + '.BAK');
+        }
+        const basename = path.basename(fileName);
+        const dot = basename.lastIndexOf('.');
+        const success = await File.writeToFile(
+            path.dirname(fileName),
+            basename.slice(0, dot),
+            basename.slice(dot + 1),
+            content
+        );
+        if (success) {
+            Util.logger.info(
+                `- ✔️  ${fileName} ${exists ? `updated (we created a backup of the old file under ${fileName}.BAK)` : 'created'}`
+            );
+        } else {
+            Util.logger.warn(`- ❌  ${fileName} ${exists ? 'update' : 'creation'} failed`);
+        }
+        return success;
+    },
+
+    /**
+     * Check entry occupancy without following links or hiding access errors.
+     *
+     * @param {string} fileName destination or backup path
+     * @returns {Promise.<boolean>} whether the directory entry exists
+     */
+    async _hasDirectoryEntry(fileName) {
+        try {
+            await File.lstat(fileName);
+            return true;
+        } catch (ex) {
+            if (ex.code === 'ENOENT') {
+                return false;
+            }
+            throw ex;
+        }
+    },
+
     /**
      * recursive helper for {@link Init.fixMcdevConfig} that adds missing settings
      *
@@ -373,7 +446,7 @@ const Init = {
                 updated = true;
                 propertiersCur[curKey] = {};
             }
-            fieldNameArr.splice(0, 1);
+            fieldNameArr.shift();
             return (
                 this._updateLeaf(
                     propertiersCur[curKey],
@@ -396,17 +469,19 @@ const Init = {
      * @returns {Promise.<{updates:string[],deletes:string[]}>} relevant files with path that need to be updated
      */
     async _getForcedUpdateList(projectVersion) {
+        // Normalize only the comparison; orchestration retains the original persisted version.
+        const comparisonVersion = semver.valid(projectVersion) || '0.0.0';
         // list of files that absolutely need to get overwritten, no questions asked, when upgrading from a version lower than the given.
         let forceIdeConfigUpdate;
         const updates = [];
         const deletes = [];
         if (await File.pathExists(Util.configFileName)) {
             forceIdeConfigUpdate = await File.readJSON(
-                path.resolve(__dirname, Util.boilerplateDirectory, 'forcedUpdates.json')
+                Util.getBoilerplatePath('forcedUpdates.json')
             );
             // return all if no project version was found or only changes from "newer" versions otherwise
             for (const element of forceIdeConfigUpdate) {
-                if (!projectVersion || semver.gt(element.version, projectVersion)) {
+                if (semver.gt(element.version, comparisonVersion)) {
                     updates.push(
                         // adapt it for local file systems
                         ...element.files.map((item) => path.normalize(item))
@@ -418,7 +493,6 @@ const Init = {
                         );
                     }
                 } else {
-                    continue;
                 }
             }
         }
@@ -426,102 +500,6 @@ const Init = {
         return { updates, deletes };
     },
 
-    /**
-     * handles creation/update of one config file from the boilerplate at a time
-     *
-     * @param {string[]} fileNameArr 0: path, 1: filename, 2: extension with dot
-     * @param {{updates:string[],deletes:string[]}} relevantForced if fileNameArr is in this list we require an override
-     * @param {string} [boilerplateFileContent] in case we cannot copy files 1:1 this can be used to pass in content
-     * @returns {Promise.<boolean>} install successful or error occured
-     */
-    async _createIdeConfigFile(fileNameArr, relevantForced, boilerplateFileContent) {
-        const fileName = fileNameArr.join('');
-        const boilerplateFileName = path.resolve(
-            __dirname,
-            Util.boilerplateDirectory,
-            'files',
-            fileName
-        );
-        boilerplateFileContent ||= await File.readFile(boilerplateFileName, 'utf8');
-
-        /** @type {string} */
-        let todo;
-
-        if (await File.pathExists(fileName)) {
-            if (relevantForced.deletes.includes(path.normalize(fileName))) {
-                Util.logger.info(
-                    `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
-                );
-                // eslint-disable-next-line no-useless-assignment
-                todo = 'delete';
-            } else {
-                const existingFileContent = await File.readFile(fileName, 'utf8');
-                if (existingFileContent === boilerplateFileContent) {
-                    Util.logger.info(`- ✔️  ${fileName} found. No update needed`);
-                    return true;
-                }
-            }
-
-            if (relevantForced.updates.includes(path.normalize(fileName))) {
-                Util.logger.info(
-                    `- ✋  ${fileName} found but an update is required. Commencing with override:`
-                );
-                todo = 'update';
-            } else {
-                Util.logger.info(
-                    `- ✋  ${fileName} found with differences to the new standard version. We recommend updating it.`
-                );
-                if (Util.skipInteraction) {
-                    todo = 'update';
-                } else {
-                    const overrideFile = await confirm({
-                        message: 'Would you like to update (override) it?',
-                        default: true,
-                    });
-                    if (overrideFile) {
-                        todo = 'update';
-                    } else {
-                        // skip override without error
-                        return true;
-                    }
-                }
-            }
-
-            // ensure our update is not leading to data loss in case config files were not versioned correctly by the user
-            await File.rename(fileName, fileName + '.BAK');
-        } else if (!relevantForced.deletes.includes(path.normalize(fileName))) {
-            todo = 'create';
-        }
-        if (todo === 'create' || todo === 'update') {
-            const saveStatus = await File.writeToFile(
-                fileNameArr[0],
-                fileNameArr[1],
-                fileNameArr[2].slice(1),
-                boilerplateFileContent
-            );
-
-            if (saveStatus) {
-                Util.logger.info(
-                    `- ✔️  ${fileName} ${
-                        todo === 'update'
-                            ? `updated (we created a backup of the old file under ${fileName + '.BAK'})`
-                            : 'created'
-                    }`
-                );
-                return true;
-            } else {
-                Util.logger.warn(
-                    `- ❌  ${fileName} ${todo === 'update' ? 'update' : 'creation'} failed`
-                );
-                return false;
-            }
-        } else if (todo === 'delete') {
-            await File.rename(fileName, fileName + '.BAK');
-            Util.logger.info(`- ✔️  ${fileName} removed (renamed to ${fileName + '.BAK'})`);
-            return true;
-        }
-    },
-
     /**
      * handles deletion of no longer needed config files
      *
@@ -530,14 +508,16 @@ const Init = {
      */
     async _removeIdeConfigFiles(relevantForced) {
         for (const fileName of relevantForced.deletes) {
-            if (await File.pathExists(fileName)) {
-                Util.logger.info(
-                    `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
-                );
-
-                await File.rename(fileName, fileName + '.BAK');
-                Util.logger.info(`- ✔️  ${fileName} removed (renamed to ${fileName + '.BAK'})`);
+            if (!(await this._hasDirectoryEntry(fileName))) {
+                continue;
             }
+
+            Util.logger.info(
+                `- ✋  ${fileName} found but it is required to delete it. Commencing rename instead for your convenience:`
+            );
+
+            await File.rename(fileName, fileName + '.BAK');
+            Util.logger.info(`- ✔️  ${fileName} removed (renamed to ${fileName + '.BAK'})`);
         }
         return true;
     },

package/lib/util/init.git.js

@@ -1,11 +1,33 @@
 'use strict';
+import { spawnSync } from 'node:child_process';
 import File from './file.js';
 
 import { confirm, input } from '@inquirer/prompts';
 import { Util } from './util.js';
-import commandExists from 'command-exists';
-import { simpleGit } from 'simple-git';
-const git = simpleGit();
+import { createGit } from './git.js';
+
+let git;
+
+/**
+ * Returns the lazily constructed Git client.
+ *
+ * @returns {import('./git.js').GitAdapter} Git client
+ */
+function getGit() {
+    git ||= createGit();
+    return git;
+}
+
+/**
+ * Checks whether Git can be executed without invoking a shell.
+ *
+ * @param {(command: string, args: string[], options: object) => {error?: Error, status: number | null}} [run] synchronous process runner
+ * @returns {boolean} true when `git --version` succeeds
+ */
+export function isGitInstalled(run = spawnSync) {
+    const result = run('git', ['--version'], { shell: false, stdio: 'ignore' });
+    return !result.error && result.status === 0;
+}
 
 /**
  * CLI helper class
@@ -19,8 +41,8 @@ const Init = {
      */
     async initGitRepo() {
         const result = { status: null, repoName: null };
-        // check if git is installed (https://www.npmjs.com/package/command-exists)
-        if (!commandExists.sync('git')) {
+        // check if git is installed
+        if (!isGitInstalled()) {
             Util.logger.error('Git installation not found.');
             Util.logger.error(
                 'Please follow our tutorial on installing Git: https://github.com/Accenture/sfmc-devtools#212-install-the-git-command-line'
@@ -84,16 +106,19 @@ const Init = {
      */
     async gitPush() {
         const skipInteraction = Util.skipInteraction;
-        const gitRemotes = (await git.getRemotes(true)).filter((item) => item.name === 'origin');
+        const gitClient = getGit();
+        const gitRemotes = (await gitClient.getRemotes(true)).filter(
+            (item) => item.name === 'origin'
+        );
         if (gitRemotes.length && gitRemotes[0].refs.push) {
             // check if remote repo is still empty (otherwise to risky to blindly push)
             let remoteBranchesExist;
             Util.logger.info('Checking remote Git repository for existing branches...');
             try {
                 // First, we need to update our local copy of the repo
-                await git.fetch();
+                await gitClient.fetch();
                 // Then, we can check how many remote branches 'git fetch' has found
-                remoteBranchesExist = (await git.branch(['-r'])).all.length > 0;
+                remoteBranchesExist = (await gitClient.branch(['-r'])).all.length > 0;
             } catch (ex) {
                 Util.logger.error('Could not contact remote git server: ' + ex.message);
             }
@@ -163,7 +188,7 @@ const Init = {
             if (typeof answers.gitRemoteUrl === 'string') {
                 answers.gitRemoteUrl = answers.gitRemoteUrl.trim();
                 Util.execSync('git', ['remote', 'add', 'origin', answers.gitRemoteUrl]);
-                return answers.gitRemoteUrl.split('/').pop().split('.')[0];
+                return answers.gitRemoteUrl.split('/').pop().split('.', 1)[0];
             }
         }
     },
@@ -181,7 +206,6 @@ const Init = {
         );
         let responses;
 
-        /* eslint-disable unicorn/prefer-ternary */
         if (skipInteraction) {
             responses = {
                 name: gitUser['user.name'],
@@ -221,7 +245,6 @@ const Init = {
                 }),
             };
         }
-        /* eslint-enable unicorn/prefer-ternary */
 
         if (responses.name && responses.email) {
             // name can contain spaces - wrap it in quotes
@@ -244,8 +267,9 @@ const Init = {
      * @returns {Promise.<{'user.name': string, 'user.email': string}>} user.name and user.email
      */
     async _getGitConfigUser() {
-        const names = await git.getConfig('user.name');
-        const emails = await git.getConfig('user.email');
+        const gitClient = getGit();
+        const names = await gitClient.getConfig('user.name');
+        const emails = await gitClient.getConfig('user.email');
 
         return { 'user.name': names.value || '', 'user.email': emails.value || '' };
     },

package/lib/util/init.js

@@ -397,8 +397,8 @@ const Init = {
                 'Upgrading project with newest configuration, npm dependencies & other project configurations:'
             );
 
-            // ensure an existing config is up to current specs
-            status = await InitConfig.fixMcdevConfig(properties);
+            // ensure an existing config is up to current specs without completing the version gate yet
+            status = await InitConfig.fixMcdevConfig(properties, versionBeforeUpgrade);
             if (!status) {
                 return false;
             }
@@ -416,11 +416,18 @@ const Init = {
         }
 
         // install node dependencies
-        status = await InitNpm.installDependencies(repoName);
+        status = await InitNpm.installDependencies(repoName, versionBeforeUpgrade);
         if (!status) {
             return false;
         }
 
+        if (!initial && properties) {
+            status = await File.saveConfigFile(properties);
+            if (!status) {
+                return false;
+            }
+        }
+
         return true;
     },
 
@@ -437,19 +444,21 @@ const Init = {
         const cloudServices = ['Dropbox', 'OneDrive', 'Google Drive', 'iCloud', 'CloudDocs'];
         let cloudServiceFound = false;
         for (const variable in cloudServices) {
-            if (absolutePath.includes(cloudServices[variable])) {
-                Util.logger.warn(
-                    `It seems your project folder will be synchronized via '${
-                        cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
-                    }'. This can reduce the overall performance of your computer due to conflicts with Git.`
-                );
-                Util.logger.warn(
-                    `We strongly recommend moving your project folder outside of the '${
-                        cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
-                    }' folder.`
-                );
-                cloudServiceFound = true;
+            if (!absolutePath.includes(cloudServices[variable])) {
+                continue;
             }
+
+            Util.logger.warn(
+                `It seems your project folder will be synchronized via '${
+                    cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
+                }'. This can reduce the overall performance of your computer due to conflicts with Git.`
+            );
+            Util.logger.warn(
+                `We strongly recommend moving your project folder outside of the '${
+                    cloudServices[variable] === 'CloudDocs' ? 'iCloud' : cloudServices[variable]
+                }' folder.`
+            );
+            cloudServiceFound = true;
         }
         if (!cloudServiceFound && absolutePath.includes(process.env.USERPROFILE)) {
             // warn user to not place project folder into user profile folder