mcdev 9.0.2 → 10.0.0

package/lib/util/devops.js

@@ -3,14 +3,96 @@ import path from 'node:path';
 import { select, confirm, Separator } from '@inquirer/prompts';
 import { Util } from './util.js';
 import Cli from './cli.js';
-import { simpleGit } from 'simple-git';
-const git = simpleGit();
+import { createGit, GitCommandError } from './git.js';
 import mcdev from '../index.js';
 import Builder from '../Builder.js';
 import MetadataType from '../MetadataTypeInfo.js';
-import jsonToTable from 'json-to-table';
+import jsonToTable from './jsonToTable.js';
 import pLimit from 'p-limit';
-import cliProgress from 'cli-progress';
+import { ProgressBar } from './progress.js';
+import { isAssetRegroupingPair } from './migrations/assetV10.js';
+
+let git;
+
+/**
+ * Returns the lazily constructed Git client.
+ *
+ * @returns {import('./git.js').GitAdapter} Git client
+ */
+function getGit() {
+    git ||= createGit();
+    return git;
+}
+
+/**
+ * Suppresses migration-only asset changes while preserving edited destinations.
+ *
+ * @param {DeltaPkgItem[]} files normalized Git changes
+ * @param {string} range compared Git range
+ * @param {Pick<import('./git.js').GitAdapter, 'revparse'>} gitClient Git client
+ * @returns {Promise.<DeltaPkgItem[]>} filtered changes
+ */
+export async function filterAssetRegroupingChanges(files, range, gitClient = getGit()) {
+    const [baseRef, targetRef] = range.split(/\.\.\.?/, 2);
+    const suppressed = new Set();
+    const ownerPairs = [];
+    for (const oldFile of files) {
+        const oldPath = oldFile.moved ? oldFile.fromPath : oldFile.file;
+        const newFile = oldFile.moved
+            ? oldFile
+            : files.find(
+                  (candidate) =>
+                      candidate !== oldFile && isAssetRegroupingPair(oldPath, candidate.file)
+              );
+        if (!newFile || !isAssetRegroupingPair(oldPath, newFile.file)) {
+            continue;
+        }
+
+        if (oldPath.endsWith('.json')) {
+            ownerPairs.push({ oldPath, newFile });
+        }
+        let oldBlob;
+        let newBlob;
+        try {
+            [oldBlob, newBlob] = await Promise.all([
+                gitClient.revparse([`${baseRef}:${oldPath}`]),
+                gitClient.revparse([`${targetRef}:${newFile.file}`]),
+            ]);
+        } catch {
+            // keep the current-layout change when committed blob equality cannot be established
+        }
+        if (oldBlob && oldBlob === newBlob) {
+            suppressed.add(oldFile);
+            suppressed.add(newFile);
+        } else if (!oldFile.moved) {
+            // avoid a false logical deletion while retaining the edited current-layout file
+            suppressed.add(oldFile);
+        }
+    }
+    // A removed extracted companion is a logical asset edit even if its owner moved unchanged.
+    // Keep that current owner selectable by copy/template consumers, which ignore deletions.
+    const remaining = files.filter((file) => !suppressed.has(file));
+    for (const { oldPath, newFile } of ownerPairs) {
+        const ownerDirectory = path.posix.dirname(oldPath);
+        const ownerKey = path.posix.basename(oldPath).replace(/\.asset-[^/]+-meta\.json$/, '');
+        const oldGroup = oldPath.match(/\.asset-([^/]+)-meta\.json$/)[1];
+        const groupMarker = `/asset/${oldGroup}/`;
+        const relativeOwner = oldPath.slice(oldPath.indexOf(groupMarker) + groupMarker.length);
+        const nested = relativeOwner.startsWith(ownerKey + '/');
+        if (
+            remaining.some(
+                (file) =>
+                    file.file !== oldPath &&
+                    (nested
+                        ? file.file.startsWith(ownerDirectory + '/')
+                        : file.file.startsWith(oldPath.slice(0, -4)))
+            )
+        ) {
+            suppressed.delete(newFile);
+        }
+    }
+    return files.filter((file) => !suppressed.has(file));
+}
 
 /**
  * @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
@@ -51,19 +133,20 @@ const DevOps = {
     async getDeltaList(properties, range, saveToDeployDir, filterPathsCSV, commitHistory) {
         const rangeUserInput = range;
         const filterPaths = filterPathsCSV
-            ? filterPathsCSV.split(',').map(
-                  (filePath) =>
-                      path
-                          .normalize(properties.directories.retrieve + filePath)
-                          .split('\\')
-                          .join('/') + '/'
-              )
+            ? filterPathsCSV
+                  .split(',')
+                  .map(
+                      (filePath) =>
+                          path
+                              .normalize(properties.directories.retrieve + filePath)
+                              .replaceAll('\\', '/') + '/'
+                  )
             : [properties.directories.retrieve];
         if (range) {
             if (!range.includes('..')) {
                 // we limit the user here somewhat by always comparing to current branch if no range was given
                 // this should make it easier in most scenrios though
-                range = range + '..HEAD';
+                range += '..HEAD';
             }
             Util.logger.info(
                 `Analyzing changes in directories: ${filterPaths} based on commit range: ${range}`
@@ -71,14 +154,14 @@ const DevOps = {
         } else {
             // get the last 10 commits by default to choose from. Default can be changed in mcdev config.
             // Current commit is skipped due to no changes
-            const commits = await git.log([
+            const commits = await getGit().log([
                 '--skip=1',
                 `-${commitHistory || properties.options.deployment.commitHistory || 10}`,
             ]);
             /** @type {({value: string, name?: string, description?: string, disabled?: boolean | string} | Separator)[]} */
             const choices = commits.all.map((commit) => ({
                 name:
-                    commit.date.split('T').join(' ').split('+')[0] +
+                    commit.date.replaceAll('T', ' ').split('+', 1)[0] +
                     ' / ' +
                     commit.message +
                     ' / ' +
@@ -104,14 +187,18 @@ const DevOps = {
         };
         let diffSummary;
         try {
-            diffSummary = await git.diffSummary([range]);
+            diffSummary = await getGit().diffSummary([range]);
         } catch (ex) {
-            const error = ex.message.startsWith('fatal: ambiguous argument')
-                ? new Error(
-                      `Make sure you checked out the branches mentioned in your git range (${rangeUserInput})`
-                  )
-                : ex;
-            throw error;
+            const invalidRange =
+                ex instanceof GitCommandError &&
+                /(?:ambiguous argument|unknown revision|bad revision)/i.test(ex.stderr);
+            if (invalidRange) {
+                throw new Error(
+                    `Make sure you checked out the branches mentioned in your git range (${rangeUserInput})`,
+                    { cause: ex }
+                );
+            }
+            throw ex;
         }
         Util.logger.info(`Found ${diffSummary.files.length} changed files in the commit range`);
         /**
@@ -120,7 +207,8 @@ const DevOps = {
         // first, process everything that can be done synchronously here
         const deltaSync = diffSummary.files
             // populate additional info for all changed files
-            .map((/** @type {DeltaPkgItem} */ file) => {
+            .map((rawFile) => {
+                const file = /** @type {DeltaPkgItem} */ (/** @type {unknown} */ (rawFile));
                 // If file was moved it's path needs to be parsed
                 file.moved = file.file.includes('=>');
                 if (file.moved) {
@@ -134,25 +222,20 @@ const DevOps = {
                     };
                     file.fromPath = path
                         .normalize(`${paths.base}${paths.before}${paths.end}`)
-                        .split('\\')
-                        .join('/');
+                        .replaceAll('\\', '/');
                     file.file = path
                         .normalize(`${paths.base}${paths.after}${paths.end}`)
-                        .split('\\')
-                        .join('/');
+                        .replaceAll('\\', '/');
                 } else {
                     file.fromPath = '-';
-                    file.file = path.normalize(file.file).split('\\').join('/');
+                    file.file = path.normalize(file.file).replaceAll('\\', '/');
                 }
 
                 // get metadata type from file name
-                file.type = file.file.split('/')[3];
+                file.type = file.file.split('/', 4)[3];
 
                 return file;
             })
-            // Filter to only handle files that start with at least one of the passed filterPaths.
-            // ! Filter happens after initial parse, because if file was moved its new path has to be calculated
-            .filter((file) => filterPaths.some((path) => file.file.startsWith(path)))
             .filter((file) => !file.file.endsWith('.error.log'))
             .filter((file) => !file.file.endsWith('.md'))
             // ensure badly named files on unsupported metadata types are not in our subset
@@ -167,25 +250,27 @@ const DevOps = {
                 }
             });
 
+        // Pair both layouts before path filtering, which may select only the current group.
+        const deltaFiltered = (await filterAssetRegroupingChanges(deltaSync, range)).filter(
+            (file) => filterPaths.some((filterPath) => file.file.startsWith(filterPath))
+        );
+
         Util.logger.info(
-            `Identified ${deltaSync.length} relevant file changes after filtering file types and folders. Processing related metadata now.`
+            `Identified ${deltaFiltered.length} relevant file changes after filtering file types and folders. Processing related metadata now.`
         );
         // second, we need to do asynchronous file operations
 
-        const extendedBar = new cliProgress.SingleBar(
-            {
-                format: '                 Processing changes [{bar}] {percentage}% | {value}/{total}',
-            },
-            cliProgress.Presets.shades_classic
-        );
-        extendedBar.start(deltaSync.length, 0);
+        const extendedBar = new ProgressBar({
+            format: '                 Processing changes [{bar}] {percentage}% | {value}/{total}',
+        });
+        extendedBar.start(deltaFiltered.length, 0);
         const rateLimit = pLimit(10);
 
         /**
          * @type {DeltaPkgItem[]}
          */
         const delta = await Promise.all(
-            deltaSync.map((/** @type {DeltaPkgItem} */ file) =>
+            deltaFiltered.map((/** @type {DeltaPkgItem} */ file) =>
                 rateLimit(async () => {
                     // Gets external key based on file name und the assumption that filename = externalKey
                     if (file.type === 'folder') {
@@ -203,8 +288,8 @@ const DevOps = {
                             .slice(0, -2)
                             .join('.');
                         if (file.type === 'asset' && !file.externalKey) {
-                            // retrieve/cred/bu/asset/message/emailkey/blocks/views.html.slots.[8maw2k7jnlb-5llcajmxaqa].asset-message-meta.html
-                            file.externalKey = file.file.split('/')[5];
+                            // retrieve/cred/bu/asset/message/emailkey/blocks/views.html.slots.[8maw2k7jnlb-5llcajmxaqa].asset-email-meta.html
+                            file.externalKey = file.file.split('/', 6)[5];
                         }
                         file.name = null;
                     }
@@ -219,8 +304,8 @@ const DevOps = {
                         file.gitAction = 'add/update';
                     }
                     gitActionsCounter[file.gitAction]++;
-                    file._credential = file.file.split('/')[1];
-                    file._businessUnit = file.file.split('/')[2];
+                    file._credential = file.file.split('/', 2)[1];
+                    file._businessUnit = file.file.split('/', 3)[2];
 
                     // Parse retrieve directory to also populate the name field (not possible for deleted files)
                     if (file.gitAction !== 'delete' && file.type !== 'folder') {
@@ -276,9 +361,7 @@ const DevOps = {
         const directoryDeltaPkg = 'logs/';
         await File.writeJSONToFile(
             directoryDeltaPkg,
-            Util.logFileName +
-                '-delta_package-' +
-                filterPathsCSV.replaceAll(',', '-').replaceAll('/', '-'),
+            Util.logFileName + '-delta_package-' + filterPathsCSV.replaceAll(/[,/]/g, '-'),
             delta
         );
         this.document(directoryDeltaPkg, filterPathsCSV, delta);
@@ -343,7 +426,7 @@ const DevOps = {
                         delta.push(
                             ...additionalFiles
                                 .map((filePath) => ({
-                                    file: path.normalize(filePath).split('\\').join('/'),
+                                    file: path.normalize(filePath).replaceAll('\\', '/'),
                                     type,
                                     gitAction: 'add/update',
                                 }))
@@ -408,15 +491,11 @@ const DevOps = {
                     results.length - skipped.length - failed.length
                 } copied, ${skipped.length} skipped, ${failed.length} failed)`
             );
-            if (skipped.length > 0) {
-                for (const file of skipped) {
-                    Util.logger.debug(`Skipped - ${file.statusMessage} - ${file.file}`);
-                }
+            for (const file of skipped) {
+                Util.logger.debug(`Skipped - ${file.statusMessage} - ${file.file}`);
             }
-            if (failed.length > 0) {
-                for (const file of failed) {
-                    Util.logger.error(`Failed - ${file.statusMessage} - ${file.file}`);
-                }
+            for (const file of failed) {
+                Util.logger.error(`Failed - ${file.statusMessage} - ${file.file}`);
             }
         }
         return delta;
@@ -534,7 +613,7 @@ const DevOps = {
             }
             Util.logger.info('=============');
 
-            // Put files into maps. One map with BU -> type -> file (for retrieveAsTemplate)
+            // Put files into maps. One map with BU -> type -> file
             // Other map only with type -> file (for buildDefinitionBulk)
             const buTypeDelta = {}; // for bt, with BU info
             const deltaDeploy = delta
@@ -560,14 +639,16 @@ const DevOps = {
             for (const buFrom in buTypeDelta) {
                 for (const type of Object.keys(buTypeDelta[buFrom])) {
                     if (
-                        Array.isArray(properties.metaDataTypes.createDeltaPkg) &&
-                        !properties.metaDataTypes.createDeltaPkg.includes(type)
+                        !Array.isArray(properties.metaDataTypes.createDeltaPkg) ||
+                        properties.metaDataTypes.createDeltaPkg.includes(type)
                     ) {
-                        Util.logger.warn(
-                            `Skipping ${type} for build based on config.metaDataTypes.createDeltaPkg: ${buTypeDelta[buFrom][type].join(', ')}`
-                        );
-                        delete buTypeDelta[buFrom][type];
+                        continue;
                     }
+
+                    Util.logger.warn(
+                        `Skipping ${type} for build based on config.metaDataTypes.createDeltaPkg: ${buTypeDelta[buFrom][type].join(', ')}`
+                    );
+                    delete buTypeDelta[buFrom][type];
                 }
                 // Run buildTemplate for each business unit for each type
                 await mcdev.build(
@@ -603,18 +684,22 @@ const DevOps = {
         let output = `# Deployment Report\n\n`;
         let tableSeparator = '';
         for (const column of tabled[0]) {
-            if (column !== '') {
-                output += `| ${column} `;
-                tableSeparator += '| --- ';
+            if (column === '') {
+                continue;
             }
+
+            output += `| ${column} `;
+            tableSeparator += '| --- ';
         }
         output += `|\n${tableSeparator}|\n`;
         for (let i = 1; i < tabled.length; i++) {
             for (let field of tabled[i]) {
-                if (field !== '') {
-                    field = field === true ? '✓' : field === false ? '✗' : field;
-                    output += `| ${field} `;
+                if (field === '') {
+                    continue;
                 }
+
+                field = field === true ? '✓' : field === false ? '✗' : field;
+                output += `| ${field} `;
             }
             output += '|\n';
         }
@@ -622,9 +707,7 @@ const DevOps = {
             // write to disk (asynchronously)
             File.writeToFile(
                 directory,
-                Util.logFileName +
-                    '-delta_package-' +
-                    filterPathsCSV.replaceAll(',', '-').replaceAll('/', '-'),
+                Util.logFileName + '-delta_package-' + filterPathsCSV.replaceAll(/[,/]/g, '-'),
                 'md',
                 output
             );
@@ -742,12 +825,14 @@ const DevOps = {
                         metadataList.push(type + ':"' + key + '"');
                     }
                 }
-                if (metadataList.length) {
-                    Util.logger.warn(
-                        `Run the following to delete ${metadataList.length} potentially existing old files in ${targetBu}`
-                    );
-                    Util.logger.warn(`mcdev delete ${targetBu} -m ${metadataList.join(' ')}`);
+                if (!metadataList.length) {
+                    continue;
                 }
+
+                Util.logger.warn(
+                    `Run the following to delete ${metadataList.length} potentially existing old files in ${targetBu}`
+                );
+                Util.logger.warn(`mcdev delete ${targetBu} -m ${metadataList.join(' ')}`);
             }
         }
     },