@maibornwolff/alt-core-js/lib/diagramDrawing.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var fs_1 = require("fs");
var node_plantuml_1 = require("node-plantuml");
var _1 = require(".");
var util_1 = require("./util");
function isValidDiagramConfiguration(toBeValidated) {
    if (typeof toBeValidated !== 'object' || toBeValidated === null) {
        return false;
    }
    var diagramConfiguration = toBeValidated;
    return (['boolean', 'undefined'].includes(typeof diagramConfiguration.hidePlaintext) &&
        (typeof diagramConfiguration.hiddenFields === 'undefined' ||
            util_1.isArrayOfStrings(diagramConfiguration.hiddenFields)));
}
exports.isValidDiagramConfiguration = isValidDiagramConfiguration;
function getInputFile(scenario) {
    return _1.OUTPUT_DIR() + "/_" + scenario + ".input";
}
function getOutputFile(scenario) {
    return _1.OUTPUT_DIR() + "/_" + scenario + ".png";
}
var hidingText = '***';
function hideFields(payload, hiddenFields) {
    return util_1.objectFromEntries(Object.entries(payload).map(function (_a) {
        var key = _a[0], value = _a[1];
        return hiddenFields.includes(key) ? [key, hidingText] : [key, value];
    }));
}
function hideFieldsIfNeeded(payload, hiddenFields) {
    return typeof payload === 'object' &&
        payload !== null &&
        hiddenFields !== undefined &&
        hiddenFields.length !== 0
        ? hideFields(payload, hiddenFields)
        : payload;
}
function hidePlaintextIfNeeded(payload, hidePlaintext) {
    if (hidePlaintext === void 0) { hidePlaintext = false; }
    return hidePlaintext ? hidingText : payload;
}
function formatBinaryPayload(payload) {
    return "binary data (" + payload.length + " bytes)";
}
function formatPlaintextPayload(payload, diagramConfiguration) {
    return util_1.trim(hidePlaintextIfNeeded(payload, diagramConfiguration.hidePlaintext), 30);
}
function formatObjectPayload(payload, diagramConfiguration) {
    return JSON.stringify(hideFieldsIfNeeded(payload, diagramConfiguration.hiddenFields), null, 1);
}
function formatPayload(payload, diagramConfiguration) {
    if (Buffer.isBuffer(payload)) {
        return formatBinaryPayload(payload);
    }
    if (typeof payload === 'string') {
        return formatPlaintextPayload(payload, diagramConfiguration);
    }
    return formatObjectPayload(payload, diagramConfiguration);
}
exports.formatPayload = formatPayload;
function currentTimestamp() {
    return new Date().toISOString();
}
function quote(str) {
    return "\"" + str + "\"";
}
exports.initDiagramCreation = function (scenarioId) {
    fs_1.writeFileSync(getInputFile(scenarioId), '');
    var initValues = [
        '@startuml',
        'autonumber',
        'skinparam handwritten false',
        'control MQTT',
        'control AMQP',
        'actor ALT #red\n',
    ];
    fs_1.appendFileSync(getInputFile(scenarioId), initValues.join('\n'));
};
exports.addRequest = function (scenarioId, target, url, data, diagramConfiguration) {
    var quotedTarget = quote(target);
    var request = "ALT -> " + quotedTarget + ": " + url + "\nactivate " + quotedTarget + "\n" + (data
        ? "note right\n**" + currentTimestamp() + "**\n" + formatPayload(data, diagramConfiguration) + "\nend note\n"
        : '');
    fs_1.appendFileSync(getInputFile(scenarioId), request);
};
exports.addSuccessfulResponse = function (scenarioId, source, status, body, diagramConfiguration) {
    doAddResponse(scenarioId, source, status, 'green');
    if (body) {
        var note = "note left\n**" + currentTimestamp() + "**\n" + formatPayload(body, diagramConfiguration) + "\nend note\n";
        fs_1.appendFileSync(getInputFile(scenarioId), note);
    }
};
exports.addFailedResponse = function (scenarioId, source, status, body, diagramConfiguration) {
    doAddResponse(scenarioId, source, status, 'red');
    fs_1.appendFileSync(getInputFile(scenarioId), "note right:  <color red>" + formatPayload(body, diagramConfiguration) + "</color>\n||20||\n");
};
var doAddResponse = function (scenarioId, source, status, color) {
    var quotedSource = quote(source);
    fs_1.appendFileSync(getInputFile(scenarioId), quotedSource + " --> ALT: <color " + color + ">" + status + "</color>\ndeactivate " + quotedSource + "\n");
};
exports.addDelay = function (scenarioId, durationInSec) {
    fs_1.appendFileSync(getInputFile(scenarioId), "\n...sleep " + durationInSec + " s...\n");
};
exports.addWsMessage = function (scenarioId, source, payload, diagramConfiguration) {
    var quotedSource = quote(source);
    fs_1.appendFileSync(getInputFile(scenarioId), quotedSource + " -[#0000FF]->o ALT : [WS]\n");
    var note = "note left #aqua\n**" + currentTimestamp() + "**\n" + formatPayload(payload, diagramConfiguration) + "\nend note\n";
    fs_1.appendFileSync(getInputFile(scenarioId), note);
};
exports.addMqttMessage = function (scenarioId, topic, payload, diagramConfiguration) {
    fs_1.appendFileSync(getInputFile(scenarioId), "MQTT -[#green]->o ALT : " + topic + "\n");
    var note = "note right #99FF99\n**" + currentTimestamp() + "**\n" + formatPayload(payload, diagramConfiguration) + "\nend note\n";
    fs_1.appendFileSync(getInputFile(scenarioId), note);
};
exports.addMqttPublishMessage = function (scenarioId, topic, payload, diagramConfiguration) {
    fs_1.appendFileSync(getInputFile(scenarioId), "ALT -[#green]->o MQTT : " + topic + "\n");
    var note = "note left #99FF99\n**" + currentTimestamp() + "**\n" + formatPayload(JSON.parse(payload), diagramConfiguration) + "\nend note\n";
    fs_1.appendFileSync(getInputFile(scenarioId), note);
};
exports.addAMQPReceivedMessage = function (scenarioId, source, exchange, routingKey, payload, diagramConfiguration) {
    var quotedSource = quote(source);
    fs_1.appendFileSync(getInputFile(scenarioId), quotedSource + " -[#FF6600]->o ALT : " + exchange + "/" + routingKey + "\n");
    var note = "note left #FF6600\n**" + currentTimestamp() + "**\n" + formatPayload(payload, diagramConfiguration) + "\nend note\n";
    fs_1.appendFileSync(getInputFile(scenarioId), note);
};
exports.addMissingAMQPMessage = function (scenarioId, exchange, routingKey, expectedMessages, receivedMessages, errorMsg) {
    exports.addMissingAsyncMessage(scenarioId, exchange + "/" + routingKey, 'AMQP', expectedMessages, receivedMessages, errorMsg);
};
exports.addMissingMQTTMessage = function (scenarioId, topic, expectedMessages, receivedMessages, errorMsg) {
    exports.addMissingAsyncMessage(scenarioId, topic, 'MQTT', expectedMessages, receivedMessages, errorMsg);
};
exports.addMissingAsyncMessage = function (scenarioId, asyncInfo, source, expectedMessages, receivedMessages, errorMsg) {
    var quotedSource = quote(source);
    fs_1.appendFileSync(getInputFile(scenarioId), quotedSource + " -[#red]->x ALT : " + asyncInfo + "\n\n        ");
    var note = "note right #FF0000\n**" + currentTimestamp() + "**\n\n\n" + errorMsg + "\n\n\nExpected Messages:" + expectedMessages + "\nReceived Messages: " + receivedMessages + "\nend note\n";
    fs_1.appendFileSync(getInputFile(scenarioId), note);
};
exports.generateSequenceDiagram = function (scenarioId) {
    return new Promise(function (resolve) {
        fs_1.appendFileSync(getInputFile(scenarioId), '\n@enduml');
        var gen = node_plantuml_1.generate(getInputFile(scenarioId));
        gen.out.pipe(fs_1.createWriteStream(getOutputFile(scenarioId)));
        gen.out.on('end', function () { return resolve(); });
    });
};