trm-core 9.10.5 → 10.0.0

package/dist/actions/publish/publishToRegistry.js

@@ -13,25 +13,35 @@ exports.publishToRegistry = void 0;
 const trm_commons_1 = require("trm-commons");
 const trmPackage_1 = require("../../trmPackage");
 const manifest_1 = require("../../manifest");
+/**
+ * Workflow step that builds the binary TRM artifact and uploads the release to its registry.
+ *
+ * 1- generate TRM artifact
+ *
+ * 2- publish to registry
+ *
+*/
 exports.publishToRegistry = {
     name: 'publish-to-registry',
     run: (context) => __awaiter(void 0, void 0, void 0, function* () {
-        trm_commons_1.Logger.log('Publish to registry step', true);
+        //1- generate TRM artifact
         trm_commons_1.Logger.loading(`Creating TRM package...`);
-        context.runtime.trmPackage.artifact = yield trmPackage_1.TrmArtifact.create({
-            transports: context.runtime.systemData.releasedTransports,
-            manifest: new manifest_1.Manifest(context.runtime.trmPackage.manifest),
-            sourceCode: context.runtime.abapGitData.sourceCode.zip
+        context.output.trmArtifact = yield trmPackage_1.TrmArtifact.create({
+            transports: context.runtime.aggregatedTransports,
+            manifest: new manifest_1.Manifest(context.runtime.manifest),
+            sourceCode: context.runtime.abapGit.sourceCode
         });
+        //2- publish to registry
         if (context.rawInput.packageData.tags.length > 0) {
             trm_commons_1.Logger.info(`Publishing with tag${context.rawInput.packageData.tags.length === 1 ? '' : 's'}: ${context.rawInput.packageData.tags.join(', ')}`);
         }
         trm_commons_1.Logger.loading(`Publishing...`);
-        yield context.runtime.trmPackage.package.publish({
-            artifact: context.runtime.trmPackage.artifact,
+        yield context.output.trmPackage.publish({
+            artifact: context.output.trmArtifact,
             readme: context.rawInput.publishData.readme,
             tags: context.rawInput.packageData.tags,
-            changelog: context.rawInput.publishData.changelog
+            changelog: context.rawInput.publishData.changelog,
+            retainedCustomizing: context.runtime.customizing.retained.map(o => o.trkorr)
         });
     })
 };

package/dist/actions/publish/releaseTransports.d.ts

@@ -1,3 +1,9 @@
 import { Step } from "@simonegaffurini/sammarksworkflow";
 import { PublishWorkflowContext } from ".";
+/**
+ * Workflow step that annotates and releases every generated publish transport.
+ *
+ * 1- release
+ *
+*/
 export declare const releaseTransports: Step<PublishWorkflowContext>;

package/dist/actions/publish/releaseTransports.js

@@ -12,31 +12,59 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.releaseTransports = void 0;
 const trm_commons_1 = require("trm-commons");
 const transport_1 = require("../../transport");
+/**
+ * Workflow step that annotates and releases every generated publish transport.
+ *
+ * 1- release
+ *
+*/
 exports.releaseTransports = {
     name: 'release-transport',
     run: (context) => __awaiter(void 0, void 0, void 0, function* () {
-        trm_commons_1.Logger.log('Release transports step', true);
-        const tmpFolder = context.rawInput.contextData.logTemporaryFolder;
-        context.runtime.systemData.releasedTransports.push(context.runtime.systemData.tadirTransport);
-        if (context.runtime.systemData.langTransport) {
-            context.runtime.systemData.releasedTransports.push(context.runtime.systemData.langTransport);
+        //1- release
+        context.runtime.aggregatedTransports = [context.runtime.transports.tadir, context.runtime.transports.devc];
+        if (context.runtime.transports.lang) {
+            context.runtime.aggregatedTransports.push(context.runtime.transports.lang);
         }
-        context.runtime.systemData.releasedTransports = context.runtime.systemData.releasedTransports.concat(context.runtime.systemData.custTransports);
-        context.runtime.systemData.releasedTransports.push(context.runtime.systemData.devcTransport);
+        context.runtime.aggregatedTransports = context.runtime.aggregatedTransports.concat(context.runtime.transports.cust);
         var counter = 0;
-        for (var transport of context.runtime.systemData.releasedTransports) {
-            counter++;
-            const prefix = `(${counter}/${context.runtime.systemData.releasedTransports.length}) `;
-            trm_commons_1.Logger.setPrefix(prefix);
-            trm_commons_1.Inquirer.setPrefix(prefix);
-            yield transport.addComment(`name=${context.rawInput.packageData.name}`);
-            yield transport.addComment(`version=${context.rawInput.packageData.version}`);
-            yield transport.setDocumentation(context.runtime.trmPackage.manifestXml);
-            trm_commons_1.Logger.log(`Ready to release transport ${transport.trkorr}, ${transport.trmIdentifier}`, true);
-            trm_commons_1.Logger.loading(`${transport_1.Transport.getTransportIcon()}  Releasing transport...`);
-            yield transport.release(false, false, tmpFolder);
-            trm_commons_1.Logger.removePrefix();
-            trm_commons_1.Inquirer.removePrefix();
+        const originalLoggerPrefix = trm_commons_1.Logger.getPrefix();
+        const originalInquirerPrefix = trm_commons_1.Inquirer.getPrefix();
+        try {
+            for (var transport of context.runtime.aggregatedTransports) {
+                counter++;
+                const prefix = `(${counter}/${context.runtime.aggregatedTransports.length}) `;
+                trm_commons_1.Logger.setPrefix(prefix);
+                trm_commons_1.Inquirer.setPrefix(prefix);
+                yield transport.addComment(`name=${context.rawInput.packageData.name}`);
+                yield transport.addComment(`version=${context.rawInput.packageData.version}`);
+                yield transport.setDocumentation(context.runtime.manifestXml);
+                trm_commons_1.Logger.log(`Ready to release transport ${transport.trkorr}, ${transport.trmIdentifier}`, true);
+                trm_commons_1.Logger.loading(`${transport_1.Transport.getTransportIcon()}  Releasing ${transport.trkorr}...`);
+                yield transport.release(false, false, context.rawInput.contextData.logTemporaryFolder);
+            }
+        }
+        finally {
+            trm_commons_1.Logger.setPrefix(originalLoggerPrefix);
+            trm_commons_1.Inquirer.setPrefix(originalInquirerPrefix);
+        }
+    }),
+    revert: (context) => __awaiter(void 0, void 0, void 0, function* () {
+        // A release can fail after earlier requests were already released. Walk every
+        // request independently so one status/delete failure does not hide later cleanup.
+        let firstError;
+        for (const transport of context.runtime.aggregatedTransports || []) {
+            try {
+                if (yield transport.canBeDeleted()) {
+                    yield transport.delete();
+                }
+            }
+            catch (error) {
+                firstError || (firstError = error);
+            }
+        }
+        if (firstError) {
+            throw firstError;
         }
     })
 };

package/dist/actions/publish/setCustomizingTransports.d.ts

@@ -1,3 +1,9 @@
 import { Step } from "@simonegaffurini/sammarksworkflow";
 import { PublishWorkflowContext } from ".";
+/** Keyword of `dropCustomizingTransports` that drops every transport carried over from the latest release. */
+export declare const DROP_ALL_CUSTOMIZING = "ALL";
+/**
+ * Retain customizing transports from the latest release (except those the caller drops), validate
+ * transports supplied by the user, and optionally let the user update the selection.
+ */
 export declare const setCustomizingTransports: Step<PublishWorkflowContext>;

package/dist/actions/publish/setCustomizingTransports.js

@@ -9,130 +9,256 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setCustomizingTransports = void 0;
+exports.setCustomizingTransports = exports.DROP_ALL_CUSTOMIZING = void 0;
 const trm_commons_1 = require("trm-commons");
 const transport_1 = require("../../transport");
+const ADD_OPTION = "add";
+const DONE_OPTION = "done";
+const normalizeTrkorr = (trkorr) => trkorr.trim().toUpperCase();
+/** Keyword of `dropCustomizingTransports` that drops every transport carried over from the latest release. */
+exports.DROP_ALL_CUSTOMIZING = "ALL";
+/**
+ * Resolve the carried-over transports to drop. Every identifier must name a customizing transport
+ * of the latest release (or be the `all` keyword), and none may also be requested as an addition.
+ */
+const resolveDroppedTransports = (dropInput, latestByTrkorr, requested) => {
+    const dropList = [...new Set((dropInput !== null && dropInput !== void 0 ? dropInput : []).map(normalizeTrkorr).filter(trkorr => trkorr.length > 0))];
+    if (dropList.includes(exports.DROP_ALL_CUSTOMIZING)) {
+        if (dropList.length > 1) {
+            throw new Error(`Customizing transports to drop: "${exports.DROP_ALL_CUSTOMIZING.toLowerCase()}" cannot be combined with transport requests`);
+        }
+        dropList.splice(0, 1, ...latestByTrkorr.keys());
+    }
+    const unknown = dropList.filter(trkorr => !latestByTrkorr.has(trkorr));
+    if (unknown.length > 0) {
+        const carriedOver = [...latestByTrkorr.keys()];
+        throw new Error(`Cannot drop ${unknown.join(", ")}: not a customizing transport of the latest release (${carriedOver.length > 0 ? `carried over: ${carriedOver.join(", ")}` : "none carried over"})`);
+    }
+    const conflicting = dropList.filter(trkorr => requested.includes(trkorr));
+    if (conflicting.length > 0) {
+        throw new Error(`Cannot both add and drop customizing transport ${conflicting.join(", ")}`);
+    }
+    return new Set(dropList);
+};
+const validateCustomizingTransport = (transport) => __awaiter(void 0, void 0, void 0, function* () {
+    const aggregate = [transport, ...(yield transport.getTasks())];
+    if ((yield transport.getE070()).trfunction !== "W") {
+        //a workbench transport can still be considered customizing if every object it carries
+        //is table content (i.e. has a matching E071K key entry) rather than a real repository object
+        for (const item of aggregate) {
+            const [e071, e071k] = yield Promise.all([item.getE071(), item.getE071K()]);
+            const realObject = e071
+                .filter(o => o.pgmid !== '*')
+                .find(o => !e071k.map(transport_1.getE071KOwner).some(k => k.pgmid === o.pgmid && k.object === o.object && k.objName === o.objName));
+            if (realObject) {
+                throw new Error(`Transport request must be of type customizing (${realObject.pgmid} ${realObject.object} ${realObject.objName} is not table content)`);
+            }
+        }
+    }
+    const entries = yield Promise.all(aggregate.map(item => item.getE071()));
+    if (entries.every(item => item.length === 0)) {
+        throw new Error("Transport request is empty");
+    }
+});
+/**
+ * Retain customizing transports from the latest release (except those the caller drops), validate
+ * transports supplied by the user, and optionally let the user update the selection.
+ */
 exports.setCustomizingTransports = {
-    name: 'set-customizing-transports',
+    name: "set-customizing-transports",
     filter: (context) => __awaiter(void 0, void 0, void 0, function* () {
-        if (context.rawInput.publishData.skipCustomizingTransports) {
-            trm_commons_1.Logger.log(`Skipping customizing transports publish (user input)`, true);
-            return false;
-        }
-        else {
+        if (!context.rawInput.publishData.noCustomizingTransports) {
             return true;
         }
+        trm_commons_1.Logger.log("Skipping customizing transports publish (user input)", true);
+        return false;
     }),
     run: (context) => __awaiter(void 0, void 0, void 0, function* () {
-        trm_commons_1.Logger.log('Set customizing transports step', true);
-        var customizingTransports = context.rawInput.publishData.customizingTransports;
-        customizingTransports = Object.values(customizingTransports.reduce((acc, t) => {
-            acc[t.trkorr] = t;
-            return acc;
-        }, {}));
-        if (!context.rawInput.contextData.noInquirer) {
-            const addCust = (yield trm_commons_1.Inquirer.prompt({
-                message: customizingTransports.length > 0 ? `Do you want to add more customizing transports?` : `Do you want to add customizing transports?`,
-                name: 'continue',
-                type: 'confirm',
-                default: customizingTransports.length > 0
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const publishData = context.rawInput.publishData;
+        const latestCustomizingTransports = ((_b = (_a = context.runtime.latest.data) === null || _a === void 0 ? void 0 : _a.transports) !== null && _b !== void 0 ? _b : []).filter(transport => transport.type === transport_1.TrmTransportIdentifier.CUST);
+        const latestByTrkorr = new Map(latestCustomizingTransports.map(transport => [normalizeTrkorr(transport.trkorr), transport]));
+        trm_commons_1.Logger.loading("Reading customizing transports...", ((_d = (_c = publishData.customizingTransports) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0) > 0);
+        const droppedTrkorrs = resolveDroppedTransports(publishData.dropCustomizingTransports, latestByTrkorr, ((_e = publishData.customizingTransports) !== null && _e !== void 0 ? _e : []).map(normalizeTrkorr));
+        for (const trkorr of droppedTrkorrs) {
+            const description = latestByTrkorr.get(trkorr).description;
+            trm_commons_1.Logger.info(`Dropping customizing transport ${trkorr}${description ? ` (${description})` : ""} carried over from the latest release`);
+        }
+        const selectedTrkorrs = [
+            ...latestCustomizingTransports.map(transport => transport.trkorr),
+            ...((_f = publishData.customizingTransports) !== null && _f !== void 0 ? _f : [])
+        ].map(normalizeTrkorr).filter(trkorr => !droppedTrkorrs.has(trkorr));
+        publishData.customizingTransports = [...new Set(selectedTrkorrs)];
+        let enrichedCustomizing = [];
+        for (const trkorr of publishData.customizingTransports) {
+            const retainedTransport = latestByTrkorr.get(trkorr);
+            if (retainedTransport) {
+                enrichedCustomizing.push({ trkorr, description: retainedTransport.description });
+                continue;
+            }
+            const transport = new transport_1.Transport(trkorr);
+            try {
+                yield validateCustomizingTransport(transport);
+            }
+            catch (error) {
+                const reason = error instanceof Error
+                    ? error.message.toLowerCase()
+                    : "invalid transport request";
+                throw new Error(`Unable to add transport ${trkorr}: ${reason}`);
+            }
+            enrichedCustomizing.push({
+                trkorr,
+                description: yield transport.getDescription()
+            });
+        }
+        if (!context.rawInput.contextData.noInquirer && trm_commons_1.Inquirer.isUi()) {
+            const rows = (yield trm_commons_1.Inquirer.prompt({
+                message: "Customizing transports",
+                name: "customizingTransports",
+                type: "input",
+                ui: {
+                    kind: "table",
+                    addLabel: "Add transport",
+                    value: enrichedCustomizing,
+                    columns: [{
+                            name: "trkorr",
+                            label: "Transport",
+                            required: true,
+                            case: "upper",
+                            validate: (trkorr) => __awaiter(void 0, void 0, void 0, function* () {
+                                if (latestByTrkorr.has(trkorr)) {
+                                    return true;
+                                }
+                                trm_commons_1.Logger.loading(`Validating ${trkorr}...`);
+                                try {
+                                    yield validateCustomizingTransport(new transport_1.Transport(trkorr));
+                                    return true;
+                                }
+                                catch (error) {
+                                    return error instanceof Error ? error.message : "Invalid transport request";
+                                }
+                                finally {
+                                    trm_commons_1.Logger.forceStop();
+                                }
+                            })
+                        }, {
+                            name: "description",
+                            label: "Description",
+                            maxLength: 60,
+                            placeholder: "Transport description"
+                        }]
+                },
+                validate: (input) => {
+                    const duplicate = input.find((transport, i) => input.findIndex(o => o.trkorr === transport.trkorr) !== i);
+                    return duplicate ? `${duplicate.trkorr} added more than once` : true;
+                }
+            })).customizingTransports;
+            enrichedCustomizing = [];
+            for (const row of rows) {
+                const trkorr = normalizeTrkorr(row.trkorr);
+                const retainedTransport = latestByTrkorr.get(trkorr);
+                enrichedCustomizing.push({
+                    trkorr,
+                    //descriptions of transports retained from the latest release can't change
+                    description: (_g = retainedTransport === null || retainedTransport === void 0 ? void 0 : retainedTransport.description) !== null && _g !== void 0 ? _g : (row.description || (yield new transport_1.Transport(trkorr).getDescription()))
+                });
+            }
+        }
+        else if (!context.rawInput.contextData.noInquirer) {
+            const shouldEdit = (yield trm_commons_1.Inquirer.prompt({
+                message: enrichedCustomizing.length > 0
+                    ? "Do you want to add more customizing transports?"
+                    : "Do you want to add customizing transports?",
+                name: "continue",
+                type: "confirm",
+                default: enrichedCustomizing.length > 0
             })).continue;
-            if (addCust) {
-                var option;
+            if (shouldEdit) {
+                let option;
                 do {
-                    var options = [];
-                    for (const transport of customizingTransports) {
-                        var description;
-                        try {
-                            description = yield transport.getDescription();
-                        }
-                        catch (_a) {
-                            description = '';
-                        }
-                        options.push({
-                            name: `- ${transport_1.Transport.getTransportIcon()}  ${transport.trkorr} ${description}`.trim(),
-                            value: transport
-                        });
-                    }
-                    options.push({
-                        name: `+ Add`,
-                        value: 1
-                    });
-                    options.push({
-                        name: `x Done`,
-                        value: 2
-                    });
                     option = (yield trm_commons_1.Inquirer.prompt({
-                        message: 'Select option',
-                        name: 'option',
-                        type: 'list',
-                        choices: options,
-                        default: 1
+                        message: "Select option",
+                        name: "option",
+                        type: "list",
+                        choices: [
+                            ...enrichedCustomizing.map(transport => ({
+                                name: `- ${transport_1.Transport.getTransportIcon()}  ${transport.trkorr} ${transport.description}`.trim(),
+                                value: transport
+                            })),
+                            { name: "+ Add", value: ADD_OPTION },
+                            { name: "x Done", value: DONE_OPTION }
+                        ],
+                        default: ADD_OPTION
                     })).option;
-                    if (option === 1) {
+                    if (option === ADD_OPTION) {
                         const trkorr = (yield trm_commons_1.Inquirer.prompt({
-                            message: 'Input customizing transport request',
-                            name: 'trkorr',
-                            type: 'input',
+                            message: "Input customizing transport request",
+                            name: "trkorr",
+                            type: "input",
                             validate: (input) => __awaiter(void 0, void 0, void 0, function* () {
+                                const normalizedInput = normalizeTrkorr(input);
+                                if (enrichedCustomizing.some(transport => transport.trkorr === normalizedInput)) {
+                                    return "Already added";
+                                }
+                                if (latestByTrkorr.has(normalizedInput)) {
+                                    return true;
+                                }
+                                trm_commons_1.Logger.loading(`Validating ${normalizedInput}...`);
                                 try {
-                                    if (customizingTransports.find(o => o.trkorr === input.trim())) {
-                                        return 'Already added';
-                                    }
-                                    const trFunction = (yield (new transport_1.Transport(input.trim())).getE070()).trfunction;
-                                    if (trFunction !== 'W') {
-                                        return 'Transport request must be of type customizing';
-                                    }
-                                    else {
-                                        return true;
-                                    }
+                                    yield validateCustomizingTransport(new transport_1.Transport(normalizedInput));
+                                    return true;
                                 }
-                                catch (_a) {
-                                    return 'Invalid transport request';
+                                catch (error) {
+                                    return error instanceof Error ? error.message : "Invalid transport request";
+                                }
+                                finally {
+                                    trm_commons_1.Logger.forceStop();
                                 }
                             })
                         })).trkorr;
-                        customizingTransports.push(new transport_1.Transport(trkorr.trim()));
+                        if (trkorr) {
+                            const normalizedTrkorr = normalizeTrkorr(trkorr);
+                            const retainedTransport = latestByTrkorr.get(normalizedTrkorr);
+                            enrichedCustomizing.push({
+                                trkorr: normalizedTrkorr,
+                                description: (_h = retainedTransport === null || retainedTransport === void 0 ? void 0 : retainedTransport.description) !== null && _h !== void 0 ? _h : yield new transport_1.Transport(normalizedTrkorr).getDescription()
+                            });
+                        }
                     }
-                    else if (option instanceof transport_1.Transport) {
-                        customizingTransports = customizingTransports.filter(o => o.trkorr !== option.trkorr);
+                    else if (typeof option === "object") {
+                        const selectedTrkorr = option.trkorr;
+                        //a retained transport carries the customizing of the latest release: dropping it is not undone by re-adding a request
+                        const remove = !latestByTrkorr.has(selectedTrkorr) || (yield trm_commons_1.Inquirer.prompt({
+                            message: `${selectedTrkorr} carries customizing of the latest release. Remove it from this release?`,
+                            name: "remove",
+                            type: "confirm",
+                            default: false
+                        })).remove;
+                        if (remove) {
+                            enrichedCustomizing = enrichedCustomizing.filter(transport => transport.trkorr !== selectedTrkorr);
+                        }
                     }
-                } while (option !== 2);
+                } while (option !== DONE_OPTION);
             }
-            const maxDescLength = 60 - `@X1@TRM: ${context.rawInput.packageData.name} v${context.rawInput.packageData.version} (C) `.length;
-            for (const transport of customizingTransports) {
-                try {
-                    const e070 = yield transport.getE070();
-                    if (e070.trfunction !== 'W') {
-                        trm_commons_1.Logger.warning(`Transport ${transport.trkorr} is not of type customizing`);
-                        throw new Error();
-                    }
-                    const tasks = yield transport.getTasks();
-                    var desc = yield transport.getDescription();
-                    if (!context.rawInput.contextData.noInquirer) {
-                        desc = (yield trm_commons_1.Inquirer.prompt({
-                            message: `Description of ${transport.trkorr}`,
-                            type: 'input',
-                            name: 'desc',
-                            default: desc,
-                            validate: (input) => {
-                                if (input.length > maxDescLength) {
-                                    return `Description cannot exceede ${maxDescLength} characters`;
-                                }
-                                else {
-                                    return true;
-                                }
-                            }
-                        })).desc || desc;
-                    }
-                    context.runtime.systemData.originCustomizing.push({
-                        transports: [transport].concat(tasks),
-                        description: desc
-                    });
-                }
-                catch (_b) {
-                    trm_commons_1.Logger.warning(`Invalid transport ${transport.trkorr}, ignored`);
+            for (const transport of enrichedCustomizing) {
+                if (latestByTrkorr.has(transport.trkorr)) {
+                    continue;
                 }
+                transport.description = (yield trm_commons_1.Inquirer.prompt({
+                    message: `Description of ${transport.trkorr}`,
+                    type: "input",
+                    name: "description",
+                    default: transport.description,
+                    validate: (input) => input.length <= 60 || "Description cannot exceed 60 characters"
+                })).description || transport.description;
+            }
+        }
+        for (const transport of enrichedCustomizing) {
+            if (latestByTrkorr.has(transport.trkorr)) {
+                context.runtime.customizing.retained.push(transport);
+            }
+            else {
+                context.runtime.customizing.new.push(transport);
             }
         }
     })

package/dist/actions/publish/setManifestValues.d.ts

@@ -1,3 +1,25 @@
 import { Step } from "@simonegaffurini/sammarksworkflow";
 import { PublishWorkflowContext } from ".";
+/**
+ * Workflow step that merges, collects, normalizes, and serializes release manifest values.
+ *
+ * 1- check if previous release manifest values should be copied
+ *
+ * 2- input manifest values
+ *
+ * 3- set namespace values (if necessary)
+ *
+ * 4- set registry endpoint
+ *
+ * 5- set post install activities
+ *
+ * 6- edit dependencies/sap entries/engines
+ *
+ * 7- normalize manifest values
+ *
+ * 8- transform into xml
+ *
+ * 9- generate trm package
+ *
+*/
 export declare const setManifestValues: Step<PublishWorkflowContext>;