@mablhq/playwright-tools 2.49.1

package/util/downloadUtil.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveDownloadedFileToProcessed = exports.awaitDownload = exports.getAwaitDownloadTimeout = exports.PROCESSED_DIR_NAME = void 0;
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const fsExtra = __importStar(require("fs-extra"));
+const util = __importStar(require("util"));
+const testsUtil_1 = require("../commands/tests/testsUtil");
+const AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS = 60000;
+const FILE_MIN_STABLE_TIME_MILLIS = 3000;
+const AWAIT_DOWNLOAD_POLLING_INTERVAL_MILLISECONDS = 500;
+exports.PROCESSED_DIR_NAME = 'Processed';
+function getAwaitDownloadTimeout() {
+    return AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS;
+}
+exports.getAwaitDownloadTimeout = getAwaitDownloadTimeout;
+async function awaitDownload(downloadDirectory, filePathSuffix, timeoutMillis = getAwaitDownloadTimeout()) {
+    const startTime = Date.now();
+    let foundDownloadPath;
+    let downloadComplete = false;
+    while (Date.now() - timeoutMillis < startTime && !downloadComplete) {
+        const latestFile = await getLatestFile(downloadDirectory, filePathSuffix);
+        if (latestFile) {
+            downloadComplete = true;
+            foundDownloadPath = latestFile;
+        }
+        else {
+            await (0, testsUtil_1.sleep)(AWAIT_DOWNLOAD_POLLING_INTERVAL_MILLISECONDS);
+        }
+    }
+    return foundDownloadPath;
+}
+exports.awaitDownload = awaitDownload;
+async function getLatestFile(downloadDirectory, filePathSuffix) {
+    const readDirectoryAsync = util.promisify(fs.readdir);
+    const filesInDownloadDir = await readDirectoryAsync(downloadDirectory);
+    let latestFileTime = 0;
+    let latestFilePath;
+    filesInDownloadDir.forEach((fileName) => {
+        const fullPath = `${downloadDirectory}/${fileName}`;
+        try {
+            const stats = fs.statSync(path.normalize(fullPath));
+            if (stats.isFile() &&
+                stats.ctimeMs > latestFileTime &&
+                Date.now() - stats.mtimeMs >= FILE_MIN_STABLE_TIME_MILLIS &&
+                !fullPath.includes('.crDownload') &&
+                fullPath.endsWith(filePathSuffix)) {
+                latestFileTime = stats.ctimeMs;
+                latestFilePath = fullPath;
+            }
+        }
+        catch {
+        }
+    });
+    return latestFilePath;
+}
+function moveDownloadedFileToProcessed(downloadDirectory, fileName) {
+    const processedDirectory = path.join(downloadDirectory, exports.PROCESSED_DIR_NAME);
+    const sourceLocation = path.join(downloadDirectory, fileName);
+    const destinationLocation = path.join(processedDirectory, fileName);
+    fsExtra.ensureDirSync(processedDirectory);
+    fsExtra.moveSync(sourceLocation, destinationLocation, { overwrite: true });
+}
+exports.moveDownloadedFileToProcessed = moveDownloadedFileToProcessed;

package/util/encodingUtil.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeTestConfigAsParamsForParsedUrlProtocol = exports.encodeTestConfigAsParamsForParsedUrlProtocol = exports.b64DecodeUnicodeNodeOrBrowser = exports.b64EncodeUnicodeInNode = exports.b64DecodeUnicodeInNode = exports.isNode = exports.TEST_CONFIG_URL_PARAM_KEY = void 0;
+const querystring_1 = __importDefault(require("querystring"));
+const domUtil_1 = require("../domUtil");
+const MAX_PARSED_URL_PROTOCOL_PARAMS_LENGTH = 2000;
+exports.TEST_CONFIG_URL_PARAM_KEY = 'scriptConfig';
+function isNode() {
+    var _a;
+    return !!((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node);
+}
+exports.isNode = isNode;
+function b64DecodeUnicodeInNode(encoded) {
+    return Buffer.from(encoded, 'base64').toString();
+}
+exports.b64DecodeUnicodeInNode = b64DecodeUnicodeInNode;
+function b64EncodeUnicodeInNode(text) {
+    return Buffer.from(text).toString('base64');
+}
+exports.b64EncodeUnicodeInNode = b64EncodeUnicodeInNode;
+function b64DecodeUnicodeNodeOrBrowser(encoded) {
+    if (isNode()) {
+        return b64DecodeUnicodeInNode(encoded);
+    }
+    return (0, domUtil_1.b64DecodeUnicode)(encoded);
+}
+exports.b64DecodeUnicodeNodeOrBrowser = b64DecodeUnicodeNodeOrBrowser;
+function encodeTestConfigAsParamsForParsedUrlProtocol(testConfig, b64Encode) {
+    const encoded = querystring_1.default.stringify({
+        ...testConfig,
+        [exports.TEST_CONFIG_URL_PARAM_KEY]: b64Encode(JSON.stringify(testConfig)),
+    });
+    if (encoded.length > MAX_PARSED_URL_PROTOCOL_PARAMS_LENGTH) {
+        throw new Error('Test parameters exceed size limit. Please use the mabl Desktop App to create or edit tests.');
+    }
+    return encoded;
+}
+exports.encodeTestConfigAsParamsForParsedUrlProtocol = encodeTestConfigAsParamsForParsedUrlProtocol;
+function decodeTestConfigAsParamsForParsedUrlProtocol(encoded, b64Decode, useV2) {
+    const params = querystring_1.default.parse(encoded);
+    if (useV2 && params[exports.TEST_CONFIG_URL_PARAM_KEY]) {
+        return JSON.parse(b64Decode(params[exports.TEST_CONFIG_URL_PARAM_KEY]));
+    }
+    delete params[exports.TEST_CONFIG_URL_PARAM_KEY];
+    return params;
+}
+exports.decodeTestConfigAsParamsForParsedUrlProtocol = decodeTestConfigAsParamsForParsedUrlProtocol;

package/util/fileUploadUtil.js

@@ -0,0 +1,146 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadFileUploadsAndSetReferenceInContext = exports.downloadAllFileUploadsAndSetContext = exports.createTempDirectoryForFileUploads = exports.createFileUploadDirectoryName = exports.removeUploadDirs = exports.cleanupOldFiles = exports.downloadFileUpload = void 0;
+const axios_1 = __importDefault(require("axios"));
+const axiosProxyConfig_1 = require("../http/axiosProxyConfig");
+const path_1 = __importDefault(require("path"));
+const fs = __importStar(require("fs-extra"));
+const stream_1 = require("stream");
+const loggingProvider_1 = require("../providers/logging/loggingProvider");
+const chalk_1 = __importDefault(require("chalk"));
+const Globals_1 = require("../Globals");
+const logUtils_1 = require("./logUtils");
+async function downloadFileUpload(fileUploadUrl, fileUpload, downloadDirectory, mablApiClient) {
+    let client;
+    if (mablApiClient) {
+        client = mablApiClient.httpClient;
+    }
+    else {
+        client = axios_1.default.create(await (0, axiosProxyConfig_1.currentProxyConfig)());
+    }
+    try {
+        const finalDirectory = path_1.default.normalize(`${downloadDirectory}/${fileUpload.id}`);
+        try {
+            fs.mkdirSync(finalDirectory);
+        }
+        catch (error) {
+            if (!error.message.includes('file already exists')) {
+                throw error;
+            }
+        }
+        const finalPath = path_1.default.normalize(`${finalDirectory}/${fileUpload.name}`);
+        const writer = fs.createWriteStream(finalPath);
+        const response = await client.get(fileUploadUrl, {
+            responseType: 'stream',
+        });
+        if (response.data.pipe) {
+            response.data.pipe(writer);
+        }
+        else if (response.status < 400) {
+            if (typeof response.data[Symbol.iterator] === 'function') {
+                stream_1.Readable.from(response.data).pipe(writer);
+            }
+            else {
+                stream_1.Readable.from([JSON.stringify(response.data)]).pipe(writer);
+            }
+        }
+        return new Promise((resolve, reject) => {
+            writer.on('finish', () => resolve(finalPath));
+            writer.on('error', reject);
+        });
+    }
+    catch (error) {
+        loggingProvider_1.logger.error(chalk_1.default.red.bold('Error encountered downloading file for File Upload Step replay'));
+        throw error;
+    }
+}
+exports.downloadFileUpload = downloadFileUpload;
+function cleanupOldFiles(ageInMs = 0) {
+    try {
+        const dir = Globals_1.Globals.getUploadDirectory();
+        const prefix = Globals_1.Globals.getUploadDirectoryPrefix();
+        fs.readdirSync(dir)
+            .filter((file) => file.startsWith(prefix) && uploadDirTooOld(file, ageInMs))
+            .forEach((file) => fs.rmSync(`${dir}/${file}`, { recursive: true, force: true }));
+    }
+    catch (e) {
+        const msg = `WARNING: error received when cleaning up old files from a previous test`;
+        (0, logUtils_1.logCliOutput)(loggingProvider_1.LogLevel.Warn, msg);
+    }
+}
+exports.cleanupOldFiles = cleanupOldFiles;
+function uploadDirTooOld(dirFullPath, ageInMs) {
+    const now = Date.now();
+    const parts = dirFullPath.split('-');
+    return (parts.length === 3 &&
+        !Number.isNaN(parseInt(parts[1])) &&
+        (ageInMs === 0 || now - parseInt(parts[1]) > ageInMs));
+}
+function removeUploadDirs(dirFullPath) {
+    const MAX_RETRIES = 5;
+    const rmOpts = {
+        recursive: true,
+        maxRetries: MAX_RETRIES,
+        force: true,
+    };
+    fs.rmSync(dirFullPath, rmOpts);
+}
+exports.removeUploadDirs = removeUploadDirs;
+function createFileUploadDirectoryName() {
+    const dir = Globals_1.Globals.getUploadDirectory();
+    const prefix = Globals_1.Globals.getUploadDirectoryPrefix();
+    return `${dir}/${prefix}${Date.now()}-`;
+}
+exports.createFileUploadDirectoryName = createFileUploadDirectoryName;
+function createTempDirectoryForFileUploads(fileUploadDirName) {
+    return fs.mkdtempSync(fileUploadDirName);
+}
+exports.createTempDirectoryForFileUploads = createTempDirectoryForFileUploads;
+async function downloadAllFileUploadsAndSetContext(apiClient, testContext, uploadDirectory, fileUploadReferences) {
+    await Promise.all(fileUploadReferences.map(async (fileRef) => {
+        const fileUploadUrl = await apiClient.getFileUploadUrl(fileRef.id);
+        const finalPathDownloaded = await downloadFileUpload(fileUploadUrl.redirectUrl, fileRef, uploadDirectory, apiClient);
+        testContext.setFileUploadReference(fileRef.id, finalPathDownloaded);
+    }));
+}
+exports.downloadAllFileUploadsAndSetContext = downloadAllFileUploadsAndSetContext;
+async function downloadFileUploadsAndSetReferenceInContext(apiClient, testContext, fileUploadReferences) {
+    const uploadDirs = testContext.getFileUploadDirs();
+    let uploadDirectoryPath;
+    if (uploadDirs.size === 0) {
+        const dirName = createFileUploadDirectoryName();
+        uploadDirectoryPath = createTempDirectoryForFileUploads(dirName);
+        testContext.addFileUploadDir(uploadDirectoryPath);
+    }
+    else {
+        uploadDirectoryPath = uploadDirs.values().next().value;
+    }
+    return downloadAllFileUploadsAndSetContext(apiClient, testContext, uploadDirectoryPath, fileUploadReferences);
+}
+exports.downloadFileUploadsAndSetReferenceInContext = downloadFileUploadsAndSetReferenceInContext;

package/util/javaScriptStepMigration.js

@@ -0,0 +1,115 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeScript = exports.hasVariableReferences = exports.attemptReusableSnippetParameterization = exports.attemptMigrationToParameterizedStep = void 0;
+const mablApi_1 = require("../mablApi");
+const encodingUtil_1 = require("./encodingUtil");
+const esprima = __importStar(require("esprima"));
+const escodegen = __importStar(require("escodegen"));
+const loggingProvider_1 = require("../providers/logging/loggingProvider");
+function attemptMigrationToParameterizedStep(descriptor) {
+    let hasVariables;
+    let migrationDisabled;
+    try {
+        const decodedJS = (0, encodingUtil_1.b64DecodeUnicodeInNode)(descriptor.encodedJS);
+        migrationDisabled = isMigrationDisabled(decodedJS);
+        hasVariables = hasVariableReferences(decodedJS);
+    }
+    catch (error) {
+        loggingProvider_1.logger.warn(`Failed to determine if the inline snippet uses variables: ${error}`);
+        return descriptor;
+    }
+    if (migrationDisabled) {
+        return descriptor;
+    }
+    if (hasVariables) {
+        return descriptor;
+    }
+    loggingProvider_1.logger.info('Converting legacy inline JavaScript step to parameterized step.');
+    return migrateInlineDescriptor(descriptor);
+}
+exports.attemptMigrationToParameterizedStep = attemptMigrationToParameterizedStep;
+function migrateInlineDescriptor(descriptor) {
+    return {
+        inlineSnippet: {
+            body: descriptor.encodedJS,
+            description: '',
+            name: 'Unnamed snippet',
+            parameters: [],
+            snippet_type: mablApi_1.SnippetTypeEnum.Javascript,
+        },
+        actionCode: descriptor.actionCode,
+        parameterOverrides: [],
+    };
+}
+function attemptReusableSnippetParameterization(snippet) {
+    if (Array.isArray(snippet.parameters)) {
+        return;
+    }
+    if (!snippet.body) {
+        return;
+    }
+    let hasVariables;
+    let migrationDisabled;
+    try {
+        const decodedJS = (0, encodingUtil_1.b64DecodeUnicodeInNode)(snippet.body);
+        migrationDisabled = isMigrationDisabled(decodedJS);
+        hasVariables = hasVariableReferences(decodedJS);
+    }
+    catch (error) {
+        loggingProvider_1.logger.warn(`Failed to determine if the reusable snippet uses variables: ${error}`);
+        return;
+    }
+    if (migrationDisabled) {
+        return;
+    }
+    if (hasVariables) {
+        loggingProvider_1.logger.info(`Skipping snippet parameter conversion due to variable usage. Snippet ID: ${snippet.id}`);
+        return;
+    }
+    loggingProvider_1.logger.info(`Migrating legacy snippet to parameterized snippet. Snippet ID: ${snippet.id}`);
+    snippet.parameters = [];
+}
+exports.attemptReusableSnippetParameterization = attemptReusableSnippetParameterization;
+function isMigrationDisabled(decodedScript) {
+    return decodedScript.indexOf('@mabl-disable-parameterization') >= 0;
+}
+function hasVariableReferences(decodedScript) {
+    const normalizedCode = normalizeScript(decodedScript);
+    const hasSignature = normalizedCode.indexOf('function mablJavaScriptStep(mablInputs') >= 0;
+    if (!hasSignature) {
+        throw new Error('Did not find expected mabl JavaScript function signature.');
+    }
+    const rex = /mablInputs/gi;
+    const match = normalizedCode.match(rex);
+    const matchCount = match ? match.length : 0;
+    return matchCount > 1;
+}
+exports.hasVariableReferences = hasVariableReferences;
+function normalizeScript(decodedScript) {
+    const tree = esprima.parseScript(decodedScript, { tolerant: true });
+    return escodegen.generate(tree);
+}
+exports.normalizeScript = normalizeScript;

package/util/jestUtil.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.itIf = exports.describeIf = void 0;
+const describeIf = (name, condition, reason, testSuite) => {
+    if (condition()) {
+        describe(name, testSuite);
+        return;
+    }
+    console.warn(`[skipped]: ${name} (reason: ${reason})`);
+    describe.skip(name, testSuite);
+};
+exports.describeIf = describeIf;
+const itIf = (name, condition, reason, fn, timeout) => {
+    if (condition()) {
+        it(name, fn, timeout);
+        return;
+    }
+    console.warn(`[skipped]: ${name} (reason: ${reason})`);
+    it.skip(name, fn);
+};
+exports.itIf = itIf;

package/util/logUtils.js

@@ -0,0 +1,131 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promiseRejectionMiddlewareMetric = exports.getPromiseSettledValues = exports.logPromiseSettledRejections = exports.logErrorVerbose = exports.formatTimestamp = exports.maybeTruncateLongMessage = exports.valueToString = exports.logWebUIAndCliOutput = exports.logWebUI = exports.findResultSeverityToLogLevel = exports.logCliOutput = exports.logInternal = exports.TRUNCATED_MESSAGE_SUFFIX = exports.VALUE_TO_STRING_DEFAULT_LIMIT = void 0;
+const mablscriptFind_1 = require("../mablscriptFind");
+const loggingProvider_1 = require("../providers/logging/loggingProvider");
+const moment_1 = __importDefault(require("moment"));
+const constants_1 = require("../commands/constants");
+const pureUtil_1 = require("./pureUtil");
+const InternalMetricsTrackingSingleton_1 = require("./InternalMetricsTrackingSingleton");
+exports.VALUE_TO_STRING_DEFAULT_LIMIT = 2048;
+exports.TRUNCATED_MESSAGE_SUFFIX = '…[truncated]';
+function logInternal(logLine, ...meta) {
+    loggingProvider_1.logger.debug(logLine, meta);
+}
+exports.logInternal = logInternal;
+function logCliOutput(logLevel, logLine) {
+    switch (logLevel) {
+        case loggingProvider_1.LogLevel.Error:
+            loggingProvider_1.logger.error(logLine);
+            break;
+        case loggingProvider_1.LogLevel.Warn:
+            loggingProvider_1.logger.warn(logLine);
+            break;
+        case loggingProvider_1.LogLevel.Info:
+            loggingProvider_1.logger.info(logLine);
+            break;
+        case loggingProvider_1.LogLevel.Debug:
+        default:
+            loggingProvider_1.logger.debug(logLine);
+    }
+}
+exports.logCliOutput = logCliOutput;
+function findResultSeverityToLogLevel(severity) {
+    switch (severity) {
+        case mablscriptFind_1.FindResultLogSeverity.Error:
+            return loggingProvider_1.LogLevel.Error;
+        case mablscriptFind_1.FindResultLogSeverity.Warn:
+            return loggingProvider_1.LogLevel.Warn;
+        case mablscriptFind_1.FindResultLogSeverity.Info:
+            return loggingProvider_1.LogLevel.Info;
+        case mablscriptFind_1.FindResultLogSeverity.Debug:
+        default:
+            return loggingProvider_1.LogLevel.Debug;
+    }
+}
+exports.findResultSeverityToLogLevel = findResultSeverityToLogLevel;
+function logWebUI(logLine, logLevel, executionContext, metadata) {
+    metadata = metadata ? JSON.parse(JSON.stringify(metadata)) : {};
+    metadata.shouldOutputInConsole = false;
+    logWebUIAndCliOutput(logLine, logLevel, executionContext, metadata);
+}
+exports.logWebUI = logWebUI;
+function logWebUIAndCliOutput(logLine, logLevel, executionContext, metadata) {
+    switch (logLevel) {
+        case loggingProvider_1.LogLevel.Error:
+            executionContext.log.error(logLine, metadata);
+            break;
+        case loggingProvider_1.LogLevel.Warn:
+            executionContext.log.warning(logLine, metadata);
+            break;
+        case loggingProvider_1.LogLevel.Info:
+            executionContext.log.info(logLine, metadata);
+            break;
+        case loggingProvider_1.LogLevel.Debug:
+        default:
+            executionContext.log.debug(logLine, metadata);
+    }
+}
+exports.logWebUIAndCliOutput = logWebUIAndCliOutput;
+function valueToString(value, maxLength = exports.VALUE_TO_STRING_DEFAULT_LIMIT) {
+    let stringValue;
+    if (typeof value === 'object') {
+        stringValue = JSON.stringify(value);
+    }
+    else {
+        stringValue = '' + value;
+    }
+    return maybeTruncateLongMessage(stringValue, maxLength);
+}
+exports.valueToString = valueToString;
+function maybeTruncateLongMessage(message, maxLength) {
+    return message.length <= maxLength
+        ? message
+        : message.slice(0, maxLength - exports.TRUNCATED_MESSAGE_SUFFIX.length) +
+            exports.TRUNCATED_MESSAGE_SUFFIX;
+}
+exports.maybeTruncateLongMessage = maybeTruncateLongMessage;
+function formatTimestamp(timeAsNumber) {
+    if (!timeAsNumber) {
+        return '';
+    }
+    return moment_1.default.utc(timeAsNumber).format(constants_1.ListTimeFormat);
+}
+exports.formatTimestamp = formatTimestamp;
+function logErrorVerbose(error, context) {
+    loggingProvider_1.logger.verbose(`Error Message: ${error.message}`);
+    loggingProvider_1.logger.verbose(`Error Type: ${error.name}`);
+    loggingProvider_1.logger.verbose(`Stack Trace:\n${error.stack}`);
+    if (context) {
+        loggingProvider_1.logger.verbose(`(error)(context) => ${JSON.stringify(context)}`);
+    }
+}
+exports.logErrorVerbose = logErrorVerbose;
+function logPromiseSettledRejections(promises, reThrow = false) {
+    promises
+        .filter(pureUtil_1.isRejectedPromise)
+        .forEach((promise) => logErrorVerbose(promise.reason));
+    const findRejectedPromise = promises.find(pureUtil_1.isRejectedPromise);
+    if (findRejectedPromise && reThrow) {
+        throw findRejectedPromise.reason;
+    }
+}
+exports.logPromiseSettledRejections = logPromiseSettledRejections;
+function getPromiseSettledValues(promises, reThrow = false) {
+    logPromiseSettledRejections(promises, reThrow);
+    return promises.filter(pureUtil_1.isFulfilledPromise).map((promise) => promise.value);
+}
+exports.getPromiseSettledValues = getPromiseSettledValues;
+async function promiseRejectionMiddlewareMetric(promise, metricName, metricValue) {
+    try {
+        return await promise;
+    }
+    catch (error) {
+        InternalMetricsTrackingSingleton_1.InternalMetricsTrackingSingleton.getInstance().addMetric(metricName, metricValue);
+        throw error;
+    }
+}
+exports.promiseRejectionMiddlewareMetric = promiseRejectionMiddlewareMetric;

package/util/markdownUtil.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summaryToElapsedTime = exports.journeyRunToElapsedTime = exports.maybeCapitalize = exports.humanizedMablStatusToGithubIcon = exports.humanizeMablStatus = exports.formatResultsAsGithubMarkdown = void 0;
+const change_case_1 = require("change-case");
+const mablApi_1 = require("../mablApi");
+const timeUtil_1 = require("./timeUtil");
+const table = require('markdown-table');
+var HumanizedMablStatuses;
+(function (HumanizedMablStatuses) {
+    HumanizedMablStatuses["Failed"] = "Failed";
+    HumanizedMablStatuses["Passed"] = "Passed";
+    HumanizedMablStatuses["RateLimited"] = "Quota Reached";
+    HumanizedMablStatuses["Running"] = "Running";
+    HumanizedMablStatuses["Stopped"] = "Stopped";
+})(HumanizedMablStatuses || (HumanizedMablStatuses = {}));
+function formatResultsAsGithubMarkdown(results) {
+    var _a;
+    const tableRows = [];
+    tableRows.push(['Plan', 'Test', 'Browser', 'Status', 'Run Time']);
+    const finalExecutions = (_a = results === null || results === void 0 ? void 0 : results.executions) !== null && _a !== void 0 ? _a : [];
+    finalExecutions.forEach((summary) => {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const retryPrefix = ((_a = summary === null || summary === void 0 ? void 0 : summary.plan_execution) === null || _a === void 0 ? void 0 : _a.is_retry) ? '[Retry] ' : '';
+        const planName = retryPrefix + ((_c = (_b = summary.plan) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : '<plan name unavailable>');
+        const humanizedPlanRunStatus = humanizeMablStatus((_d = summary === null || summary === void 0 ? void 0 : summary.plan_execution) === null || _d === void 0 ? void 0 : _d.status);
+        const planRunStatus = humanizedMablStatusToGithubIcon(humanizedPlanRunStatus) +
+            ' ' +
+            maybeCapitalize(humanizedPlanRunStatus === null || humanizedPlanRunStatus === void 0 ? void 0 : humanizedPlanRunStatus.toString());
+        const planHref = (_e = summary.plan) === null || _e === void 0 ? void 0 : _e.app_href;
+        const journeyMap = new Map();
+        (_f = summary.journeys) === null || _f === void 0 ? void 0 : _f.forEach((journeySummary) => journeyMap.set(journeySummary.id, journeySummary));
+        tableRows.push([
+            `[${planName}](${planHref})`,
+            '---',
+            '---',
+            planRunStatus,
+            summaryToElapsedTime(summary),
+        ]);
+        (_g = summary.journey_executions) === null || _g === void 0 ? void 0 : _g.forEach((journeyRun) => {
+            const humanizedJourneyRunStatus = humanizeMablStatus(journeyRun.status);
+            const journeyStatus = humanizedMablStatusToGithubIcon(humanizedJourneyRunStatus) +
+                ' ' +
+                maybeCapitalize(humanizedJourneyRunStatus === null || humanizedJourneyRunStatus === void 0 ? void 0 : humanizedJourneyRunStatus.toString());
+            const journeyBrowser = maybeCapitalize(journeyRun.browser_type);
+            const journeySummary = journeyMap.get(journeyRun.journey_id);
+            let journeyLabel = '<test name unavailable>';
+            if (journeySummary) {
+                journeyLabel = `[${retryPrefix}${journeySummary.name}](${journeySummary.app_href})`;
+            }
+            tableRows.push([
+                '',
+                journeyLabel,
+                journeyBrowser,
+                `[${journeyStatus}](${journeyRun.app_href})`,
+                journeyRunToElapsedTime(journeyRun),
+            ]);
+        });
+    });
+    return table(tableRows, {
+        align: ['l', 'l', 'l', 'l'],
+    });
+}
+exports.formatResultsAsGithubMarkdown = formatResultsAsGithubMarkdown;
+function humanizeMablStatus(status) {
+    if (status) {
+        switch (status) {
+            case mablApi_1.TestRunResult.StatusEnum.Completed:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Completed:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Succeeded:
+                return HumanizedMablStatuses.Passed;
+            case mablApi_1.TestRunResult.StatusEnum.Failed:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Failed:
+                return HumanizedMablStatuses.Failed;
+            case mablApi_1.TestRunResult.StatusEnum.Terminated:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Terminated:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Cancelled:
+                return HumanizedMablStatuses.Stopped;
+            case mablApi_1.TestRunResult.StatusEnum.Queued:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Queued:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Scheduled:
+            case mablApi_1.PlanExecutionResult.StatusEnum.Scheduling:
+            case mablApi_1.TestRunResult.StatusEnum.Running:
+            case mablApi_1.PlanExecutionResult.StatusEnum.PostExecution:
+            case mablApi_1.PlanExecutionResult.StatusEnum.PreExecution:
+                return HumanizedMablStatuses.Running;
+            case mablApi_1.TestRunResult.StatusEnum.RateLimited:
+                return HumanizedMablStatuses.RateLimited;
+        }
+    }
+    return;
+}
+exports.humanizeMablStatus = humanizeMablStatus;
+function humanizedMablStatusToGithubIcon(status) {
+    if (!status) {
+        return '';
+    }
+    switch (status) {
+        case HumanizedMablStatuses.Passed:
+            return ':heavy_check_mark:';
+        case HumanizedMablStatuses.Failed:
+            return ':x:';
+        case HumanizedMablStatuses.Stopped:
+            return ':large_orange_diamond:';
+        case HumanizedMablStatuses.Running:
+            return '🔃';
+        default:
+            throw new Error(`Unhandled humanized status [${status}]`);
+    }
+}
+exports.humanizedMablStatusToGithubIcon = humanizedMablStatusToGithubIcon;
+function maybeCapitalize(input) {
+    if (input) {
+        return (0, change_case_1.capitalCase)(input.replace('_', ' '));
+    }
+    return '';
+}
+exports.maybeCapitalize = maybeCapitalize;
+function journeyRunToElapsedTime(journeyRun) {
+    return (0, timeUtil_1.elapsedTimeToString)(journeyRun.start_time, journeyRun.stop_time);
+}
+exports.journeyRunToElapsedTime = journeyRunToElapsedTime;
+function summaryToElapsedTime(summary) {
+    return (0, timeUtil_1.elapsedTimeToString)(summary.start_time, summary.stop_time);
+}
+exports.summaryToElapsedTime = summaryToElapsedTime;