@mablhq/mabl-cli 2.31.44 → 2.34.5

package/api/basicApiClient.js

@@ -104,10 +104,12 @@ class BasicApiClient {
                 };
                 break;
             case types_1.AuthType.Bearer:
-                if (!options.token) {
-                    throw new Error(`Auth type [${options.authType}] requires token`);
+                if (!options.token && !options.tokenAccessor) {
+                    throw new Error(`Auth type [${options.authType}] requires token or tokenAccessor`);
+                }
+                if (options.token) {
+                    config.headers.authorization = `Bearer ${options.token}`;
                 }
-                config.headers.authorization = `Bearer ${options.token}`;
                 break;
             case types_1.AuthType.None:
                 break;
@@ -128,6 +130,19 @@ class BasicApiClient {
         this.httpRequestConfig = config;
         this.httpClient = axios_1.default.create(config);
         this.httpClient.defaults.headers.common = { ...config.headers };
+        const { tokenAccessor } = options;
+        if (tokenAccessor) {
+            this.httpClient.interceptors.request.use(async (config) => {
+                const token = await tokenAccessor();
+                if (token) {
+                    config.headers = {
+                        ...config.headers,
+                        authorization: `Bearer ${token}`,
+                    };
+                }
+                return config;
+            });
+        }
         this.retryConfig = options.retryConfig;
         this.debugLogger = (_e = options.debugLogger) !== null && _e !== void 0 ? _e : logUtils_1.logInternal;
     }

package/api/mablApiClient.js

@@ -410,7 +410,7 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             throw toApiError(`Failed to get Flows`, error);
         }
     }
-    async getSnippet(snippetId, preferLatestIfReusable) {
+    async getSnippet(snippetId, preferLatestIfReusable, workspaceId) {
         try {
             const queryParameter = typeof preferLatestIfReusable === 'boolean'
                 ? `?=preferLatestIfReusable=${preferLatestIfReusable}`
@@ -418,7 +418,9 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             return await this.makeGetRequest(`${this.baseApiUrl}/snippets/${snippetId}${queryParameter}`);
         }
         catch (error) {
-            throw toApiError(`Failed to get Snippet [${snippetId}]`, error);
+            throw toApiError(`Failed to get Snippet [${snippetId}]. ${workspaceId
+                ? `The Snippet was likely deleted. To recover this snippet, visit the activity feed [workspaces/${workspaceId}/settings/activity-log?activityLogEntity=snippet&activityLogEvent=delete]`
+                : ''}`, error);
         }
     }
     async getBranchById(branchId) {
@@ -641,7 +643,7 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
         }
     }
     buildDeploymentRequestBody(options) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         const requestBody = { properties: {} };
         if (options.environmentId) {
             requestBody.environment_id = options.environmentId;
@@ -661,14 +663,18 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             (_d = options.sourceControlMetadata) === null || _d === void 0 ? void 0 : _d.repoUrl;
         requestBody.properties.repository_name =
             (_e = options.sourceControlMetadata) === null || _e === void 0 ? void 0 : _e.repoName;
+        requestBody.properties.build_info_url =
+            (_f = options.sourceControlMetadata) === null || _f === void 0 ? void 0 : _f.buildInfoUrl;
+        requestBody.properties.deployment_origin = ((_g = options.sourceControlMetadata) === null || _g === void 0 ? void 0 : _g.integrationType)
+            ?
+                `mabl-${options.sourceControlMetadata.integrationType}`
+            : undefined;
+        requestBody.properties.build_id = (_h = options.sourceControlMetadata) === null || _h === void 0 ? void 0 : _h.buildId;
         const planOverrides = {};
-        if ((_f = options.browserTypes) === null || _f === void 0 ? void 0 : _f.length) {
+        if ((_j = options.browserTypes) === null || _j === void 0 ? void 0 : _j.length) {
             planOverrides.browser_types = options.browserTypes;
         }
-        if (options.runnerType) {
-            planOverrides.nodejs_runtime_variant = options.runnerType;
-        }
-        if ((_g = options.labels) === null || _g === void 0 ? void 0 : _g.length) {
+        if ((_k = options.labels) === null || _k === void 0 ? void 0 : _k.length) {
             requestBody.plan_labels = options.labels;
         }
         if (options.uri) {
@@ -695,7 +701,7 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
                 [mablApi_1.MobilePlatformEnum.Ios]: options.iOSMobileAppFileId,
             };
         }
-        if ((_h = options.httpHeaders) === null || _h === void 0 ? void 0 : _h.length) {
+        if ((_l = options.httpHeaders) === null || _l === void 0 ? void 0 : _l.length) {
             planOverrides.http_headers = options.httpHeaders.map((header) => {
                 const parts = header.split(':', 2);
                 return {
@@ -834,7 +840,7 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
         try {
             const response = await this.makePatchRequest(`${this.baseApiUrl}/journeyRuns/${journeyRunId}`, {
                 functionally_completed: false,
-                status: mablApi_1.JourneyRun.StatusEnum.Failed,
+                status: mablApi_1.TestRun.StatusEnum.Failed,
                 status_cause: cause,
             });
             return response;

package/commands/commandUtil/fileUtil.js

@@ -46,3 +46,5 @@ function writeExportedEntityToFile(output, fileExtension, entityId, fileName) {
     return fileName;
 }
 exports.writeExportedEntityToFile = writeExportedEntityToFile;
+const tester = 'hello:there:friend';
+`mobileTestRun-${tester}-${Date.now()}`.replace(/:/g, '-');

package/commands/constants.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandArgMablBranchChangesOnly = exports.CommandArgMablBranch = exports.CommandArgMablAutoLogin = exports.CommandArgMablAutoBranch = exports.CommandArgLinkBypass = exports.CommandArgLinkLabel = exports.CommandArgLimitOutput = exports.CommandArgLabels = exports.CommandArgLabelsInclude = exports.CommandArgLabelsExclude = exports.CommandArgTestInteractionSpeed = exports.CommandArgTestRunId = exports.CommandArgTestFile = exports.CommandArgKeepBrowserOpen = exports.CommandArgInput = exports.CommandArgIncludedTests = exports.CommandArgIncludeDefaults = exports.CommandArgId = exports.CommandArgUserAgent = exports.CommandArgHttpHeaders = exports.CommandArgHelp = exports.CommandArgHeadless = exports.CommandArgFromPlanId = exports.CommandArgFrom = exports.CommandArgFormat = exports.CommandArgFindPath = exports.CommandArgFastFailure = exports.CommandArgOverrideEnvironmentId = exports.CommandArgGrep = exports.CommandArgExtraArguments = exports.CommandArgExistingReport = exports.CommandArgExcludedTests = exports.CommandArgEnvironmentId = exports.CommandArgDetailLevel = exports.CommandArgDestination = exports.CommandArgDescription = exports.CommandArgDeploymentId = exports.CommandArgDecrypt = exports.CommandArgDebug = exports.CommandArgDataTables = exports.CommandArgDataTableId = exports.CommandArgCredentials = exports.CommandArgBasicAuthCredentials = exports.CommandArgBrowsers = exports.CommandArgBrowser = exports.CommandArgBranch = exports.CommandArgAuto = exports.CommandArgApplicationId = exports.CommandArgApiKey = exports.CommandArgABConfigFile = void 0;
-exports.BrowserTypeSelections = exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.ReporterOptions = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgTimezoneID = exports.CommandArgLocale = exports.CommandArgUseTestExecutionProxy = exports.CommandArgScenarioId = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTo = exports.CommandArgTrainerVersion = exports.CommandArgTraceFile = exports.CommandArgTracesPath = exports.CommandArgTestPath = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgPath = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgProject = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMobileDeviceName = exports.CommandArgMobilePlatform = exports.CommandArgMobileAppFileId = exports.CommandArgMobileAppFile = exports.CommandArgiOSdMobileAppFileId = exports.CommandArgAndroidMobileAppFileId = exports.CommandArgMulti = void 0;
-exports.SCENARIO_ID_HEADER = exports.SCENARIO_NAME_HEADER = exports.ValidBrowserTypesForLocalRuns = void 0;
+exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.ReporterOptions = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgTimezoneID = exports.CommandArgLocale = exports.CommandArgUseTestExecutionProxy = exports.CommandArgScenarioId = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTo = exports.CommandArgTrainerVersion = exports.CommandArgTraceFile = exports.CommandArgTracesPath = exports.CommandArgTestPath = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgRecordVideoPath = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgPath = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgProject = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMobileDeviceName = exports.CommandArgMobilePlatform = exports.CommandArgMobileAppFileId = exports.CommandArgMobileAppFile = exports.CommandArgiOSdMobileAppFileId = exports.CommandArgAndroidMobileAppFileId = exports.CommandArgMulti = void 0;
+exports.SCENARIO_ID_HEADER = exports.SCENARIO_NAME_HEADER = exports.ValidBrowserTypesForLocalRuns = exports.BrowserTypeSelections = void 0;
 const browserTypes_1 = require("./browserTypes");
 exports.CommandArgABConfigFile = 'ab-config-file';
 exports.CommandArgApiKey = 'api-key';
@@ -73,6 +73,7 @@ exports.CommandArgPreview = 'preview';
 exports.CommandArgContentTypes = 'types';
 exports.CommandArgPlanId = 'plan-id';
 exports.CommandArgMaxHeartbeatAge = 'max-heartbeat-age';
+exports.CommandArgRecordVideoPath = 'video-path';
 exports.CommandArgRevision = 'revision';
 exports.CommandArgSilent = 'silent';
 exports.CommandArgTestPath = 'tests-path';

package/commands/deploy/deploy_cmds/create.js

@@ -8,6 +8,7 @@ const util_1 = require("../../commandUtil/util");
 const branches_1 = require("../../commandUtil/branches");
 const awaitDeploymentCompletion_1 = require("./awaitDeploymentCompletion");
 const scmContextProvider_1 = require("../../../providers/scmContextProvider");
+const scmContextProviderV2_1 = require("../../../providers/scmContextProviderV2");
 const cliConfigProvider_1 = require("../../../providers/cliConfigProvider");
 const configKeys_1 = require("../../config/config_cmds/configKeys");
 const codeInsights_1 = require("../../commandUtil/codeInsights");
@@ -207,7 +208,6 @@ async function createDeployment(parsed) {
     if (!parsed.silent) {
         loggingProvider_1.logger.info('Creating Deployment...');
     }
-    const runnerType = parsed['runner-type'];
     const applicationId = parsed['application-id'];
     const environmentId = parsed['environment-id'];
     const workspaceId = await (0, util_1.getWorkspaceIdFromAppOrEnv)(apiClient, applicationId, environmentId);
@@ -232,7 +232,7 @@ async function createDeployment(parsed) {
     await (0, branches_1.checkBranchNameAndAutoBranchMaybe)(workspaceId, apiClient, mablBranch, parsed['auto-branch']);
     const snapshotFromBranch = parsed['snapshot-from'];
     const httpHeaders = parsed['http-headers'];
-    const scmMetadata = await collectSourceControlMetadataIfEnabled(parsed);
+    const scmMetadata = await attemptSourceControlMetadataCollection(parsed);
     const deploymentEvent = await apiClient.postDeploymentEvent({
         browserTypes: parsed.browsers,
         labels: parsed.labels,
@@ -247,7 +247,6 @@ async function createDeployment(parsed) {
         androidMobileAppFileId,
         iOSMobileAppFileId,
         mablBranch,
-        runnerType,
         snapshotFromBranch,
         sourceControlMetadata: scmMetadata,
         deploymentIds,
@@ -291,8 +290,8 @@ function printDeploymentEventResultOutput(deploymentEventId, outputWebappLink, o
     }
 }
 exports.printDeploymentEventResultOutput = printDeploymentEventResultOutput;
-async function collectSourceControlMetadataIfEnabled(parsed) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+async function attemptSourceControlMetadataCollection(parsed) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
     const userSuppliedRepositoryUrl = parsed['repository-url'];
     if (await cliConfigProvider_1.CliConfigProvider.getConfigProperty(configKeys_1.configKeys.enableSourceControlMetadataCollection)) {
         const buildInfo = await new scmContextProvider_1.ScmContextProvider(process.env).extractScmAndBuildInfo();
@@ -314,6 +313,24 @@ async function collectSourceControlMetadataIfEnabled(parsed) {
             repoName: sourceControlRepoName,
         };
     }
+    const buildInfo = new scmContextProviderV2_1.ScmContextProviderV2(process.env).extractScmAndBuildInfo();
+    if (buildInfo) {
+        const sourceControlBranch = (_m = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _m === void 0 ? void 0 : _m.branchName;
+        const sourceControlTag = (_o = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _o === void 0 ? void 0 : _o.tagName;
+        const sourceControlRepoUrl = userSuppliedRepositoryUrl !== null && userSuppliedRepositoryUrl !== void 0 ? userSuppliedRepositoryUrl : (_p = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _p === void 0 ? void 0 : _p.repoUrl;
+        const sourceControlRepoName = (_q = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _q === void 0 ? void 0 : _q.repoName;
+        const revision = (_v = (_t = (_r = parsed.revision) !== null && _r !== void 0 ? _r : (_s = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _s === void 0 ? void 0 : _s.commitSha) !== null && _t !== void 0 ? _t : (_u = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _u === void 0 ? void 0 : _u.revision) !== null && _v !== void 0 ? _v : (_w = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _w === void 0 ? void 0 : _w.revisionId;
+        return {
+            branchName: sourceControlBranch,
+            tag: sourceControlTag,
+            revision,
+            repoUrl: sourceControlRepoUrl,
+            repoName: sourceControlRepoName,
+            integrationType: (_x = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _x === void 0 ? void 0 : _x.buildType,
+            buildInfoUrl: (_y = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _y === void 0 ? void 0 : _y.buildInfoUrl,
+            buildId: (_z = buildInfo === null || buildInfo === void 0 ? void 0 : buildInfo.buildInfo) === null || _z === void 0 ? void 0 : _z.buildId,
+        };
+    }
     return {
         revision: parsed.revision,
         repoUrl: userSuppliedRepositoryUrl,

package/commands/tests/tests_cmds/run-mobile.js

@@ -87,6 +87,17 @@ exports.builder = (yargs) => {
         hidden: false,
         type: 'string',
     })
+        .option(constants_1.CommandArgMablBranch, {
+        describe: 'Mabl branch to run test against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablBranchChangesOnly, {
+        describe: 'Only execute tests changed on specified mabl branch',
+        type: 'boolean',
+        default: false,
+    })
+        .implies(constants_1.CommandArgMablBranchChangesOnly, constants_1.CommandArgMablBranch)
         .option(constants_1.CommandArgLabelsInclude, {
         describe: 'Space delimited test labels. Run tests that match any label.',
         type: 'array',
@@ -96,6 +107,11 @@ exports.builder = (yargs) => {
         describe: 'Space delimited test labels. Exclude tests that match any label.',
         type: 'array',
         conflicts: [constants_1.CommandArgId],
+    })
+        .option(constants_1.CommandArgRecordVideoPath, {
+        hidden: true,
+        describe: 'The path of a directory to save a video recording of the test to',
+        type: 'string',
     })
         .implies(constants_1.CommandArgReporterOptions, constants_1.CommandArgReporter)
         .middleware(inferMobilePlatform)
@@ -138,6 +154,8 @@ async function run(parsed) {
     await validateSystemRequirements(platformName, parsed[constants_1.CommandArgMobileDeviceName]);
     const testRunnerConfig = {
         _cliCreated: true,
+        branchName: parsed[constants_1.CommandArgMablBranch],
+        branchChangesOnly: parsed[constants_1.CommandArgMablBranchChangesOnly],
         filterHttpRequests: false,
         labelsExclude: parsed[constants_1.CommandArgLabelsExclude],
         labelsInclude: parsed[constants_1.CommandArgLabelsInclude],
@@ -149,6 +167,7 @@ async function run(parsed) {
             path: parsed[constants_1.CommandArgMobileAppFile],
             platformName,
             avdName: parsed[constants_1.CommandArgMobileDeviceName],
+            recordVideoPath: parsed[constants_1.CommandArgRecordVideoPath],
             udid: parsed[constants_1.CommandArgMobileDeviceName],
         },
     };

package/commands/tests/tests_cmds/run.js

@@ -175,7 +175,7 @@ Note: Setting the environment does not override the default URL. Please use the
         .option(constants_1.CommandArgTestInteractionSpeed, {
         describe: 'Set the speed that mabl interacts with webpages. Overrides test run settings if specified.',
         type: 'string',
-        choices: Object.keys(mablApi_1.JourneyParameters.PageLoadWaitEnum).map((pageLoadWait) => pageLoadWait.toLowerCase()),
+        choices: Object.keys(mablApi_1.TestParameters.PageLoadWaitEnum).map((pageLoadWait) => pageLoadWait.toLowerCase()),
     })
         .option(constants_1.CommandArgBrowser, {
         describe: `Target browser to execute the test against, must be one of ${constants_1.ValidBrowserTypesForLocalRuns}, defaults to ${constants_1.DefaultBrowserType}`,