@mablhq/mabl-cli 2.78.5 → 2.79.7

package/commands/mcp/mcp_cmds/tools/assignXrayToMablTest.js

@@ -58,8 +58,7 @@ const assignXrayToMablTest = (0, mcpMablTool_1.defineTool)({
                 return (0, common_1.stringToToolResult)(`There is already an Xray test case assigned to this mabl test. Follow the instructions below:
             ## Instructions
               1. Show the user the following information about the currently assigned Xray test case:
-                Name: ${xrayBinding.name}.
-                Description: ${xrayBinding.description}.
+                Xray Issue ID: ${xrayBinding.external_entity_id}.
               2. Ask the user if they want to overwrite the existing assignment. If they do, call #assign_xray_to_mabl_test again with the overwrite parameter set to true.`, true);
             }
             await mablApiClient.deleteExternalTcmBinding(externalTcmPlatform, mablEntityType, mablEntityId);

package/commands/mcp/mcp_cmds/tools/createMablTest.js

@@ -7,7 +7,7 @@ const messaging_1 = require("../../../../core/messaging/messaging");
 const mablApi_1 = require("../../../../mablApi");
 const common_1 = require("../utils/common");
 const featureSet_1 = require("../../../../api/featureSet");
-const openUtils_1 = require("../../../../core/trainer/openUtils");
+const testUtils_1 = require("../utils/testUtils");
 const createMablTest = (0, mcpMablTool_1.defineTool)({
     schema: {
         name: 'create_mabl_test',
@@ -124,21 +124,11 @@ const createMablTest = (0, mcpMablTool_1.defineTool)({
             testType: params.isApiTest ? mablApi_1.TestTypeEnum.Api : mablApi_1.TestTypeEnum.Browser,
             apiDescription: params.apiSpec,
         }, mablApiClient, false);
-        if (process.platform === openUtils_1.WIN32_PLATFORM) {
-            return {
-                content: [
-                    {
-                        type: 'text',
-                        text: `Tell the user to open the following URL to launch the mabl trainer: ${trainerUrl}. Show it using a link, trying to hide the URL full url. If you have a tool that can open a link use it.`,
-                    },
-                ],
-            };
-        }
         return {
             content: [
                 {
                     type: 'text',
-                    text: 'A mabl trainer was launched. You can finish the test creation in the mabl trainer app.',
+                    text: (0, testUtils_1.getCreateTestOutputText)(trainerUrl),
                 },
             ],
         };

package/commands/mcp/mcp_cmds/tools/createMablTestFromPlan.js

@@ -6,6 +6,7 @@ const trainingSessions_1 = require("../../../../core/trainer/trainingSessions");
 const mablApi_1 = require("../../../../mablApi");
 const common_1 = require("../utils/common");
 const featureSet_1 = require("../../../../api/featureSet");
+const testUtils_1 = require("../utils/testUtils");
 const createMablTestFromPlan = (0, mcpMablTool_1.defineTool)({
     schema: {
         name: 'create_mabl_test_from_plan',
@@ -28,7 +29,7 @@ const createMablTestFromPlan = (0, mcpMablTool_1.defineTool)({
             const deployment = await mablApiClient.getDeploymentEntity(artifact?.test_information?.deployment_id);
             url = deployment.uri;
         }
-        await (0, trainingSessions_1.trainNewTest)({
+        const trainerUrl = await (0, trainingSessions_1.trainNewTest)({
             environmentId: artifact?.test_information?.environment_id,
             applicationId: artifact?.test_information?.application_id,
             credentialsId: artifact?.test_information?.credentials_id,
@@ -56,7 +57,7 @@ const createMablTestFromPlan = (0, mcpMablTool_1.defineTool)({
             content: [
                 {
                     type: 'text',
-                    text: `A mabl trainer was launched with the planned test. You can finish the test creation in the mabl trainer app.`,
+                    text: (0, testUtils_1.getCreateTestOutputText)(trainerUrl),
                 },
             ],
         };

package/commands/mcp/mcp_cmds/tools/getXrayTestCases.js

@@ -14,6 +14,7 @@ exports.getXrayTestCasesOutputSchema = zod_1.z.object({
         summary: zod_1.z.string().optional(),
     })),
     xrayProjectId: zod_1.z.string().optional(),
+    nextOffset: zod_1.z.number().optional(),
 });
 const getXrayTestCases = (0, mcpMablTool_1.defineTool)({
     schema: {
@@ -25,6 +26,16 @@ const getXrayTestCases = (0, mcpMablTool_1.defineTool)({
                 .string()
                 .describe('The id of the Xray project to get test cases for, if not provided, all Xray projects will be queried and if there are multiple, the user will be prompted to select from which of these projects to get test cases')
                 .optional(),
+            limit: zod_1.z
+                .number()
+                .min(1)
+                .max(100)
+                .optional()
+                .describe('Maximum number of test cases to return (default: 50)'),
+            offset: zod_1.z
+                .number()
+                .optional()
+                .describe('The offset to use to get the next page of test cases'),
         }),
         outputSchema: exports.getXrayTestCasesOutputSchema,
         type: 'readOnly',
@@ -32,11 +43,14 @@ const getXrayTestCases = (0, mcpMablTool_1.defineTool)({
     handle: async (params, context) => {
         const { mablApiClient, workspaceId } = context.getCurrentContext();
         let xrayProjectId = params.xrayProjectId;
+        const limit = params.limit || 50;
+        const offset = params.offset || 0;
         if (!context.featureIsAvailable(featureSet_1.XRAY_INTEGRATION_FEATURE_FLAG)) {
             return (0, common_1.stringToToolResult)('Xray integration is not available for your account. Please contact your workspace owner or mabl support for assistance in activating this feature.', true);
         }
         if (!xrayProjectId) {
-            const { integrations: xrayProjects } = await mablApiClient.queryIntegrations(workspaceId, mablApi_1.IntegrationTypeEnum.XraySync);
+            const { integrations } = await mablApiClient.queryIntegrations(workspaceId, mablApi_1.IntegrationTypeEnum.XraySync);
+            const xrayProjects = integrations.filter((integration) => integration.enabled);
             if (!xrayProjects || xrayProjects.length === 0) {
                 return (0, common_1.stringToToolResult)('There are no Xray projects configured for this workspace. Go into your workspace to set it up.', true);
             }
@@ -47,15 +61,24 @@ const getXrayTestCases = (0, mcpMablTool_1.defineTool)({
             }
             xrayProjectId = xrayProjects[0].id;
         }
-        const { tests: xrayTests } = await mablApiClient.queryXrayTests(xrayProjectId);
+        const { tests: xrayTests } = await mablApiClient.queryXrayTests(xrayProjectId, limit, offset);
+        const nextOffset = offset + limit;
+        const nextPageExists = xrayTests && xrayTests.length === limit;
         return {
             content: [
                 {
                     type: 'text',
-                    text: (0, common_1.jsonPrettyPrint)({ xrayTests, xrayProjectId }),
+                    text: `
+          ${xrayTests?.length ?? 0} test cases returned from the Xray project
+          ${nextPageExists
+                        ? `Next page exists, call #get_xray_test_cases again with the offset parameter set to ${nextOffset} to get the next page`
+                        : 'No next page exists, you have reached the end of the test cases'}
+          The retrieved test cases are: ${(0, common_1.jsonPrettyPrint)({ xrayTests })}
+          The tests that are already being used by other test will not be shown here.
+          `,
                 },
             ],
-            structuredContent: { xrayTests, xrayProjectId },
+            structuredContent: { xrayTests, xrayProjectId, nextOffset },
         };
     },
 });

package/commands/mcp/mcp_cmds/utils/testUtils.js

@@ -4,6 +4,7 @@ exports.normalizeTest = exports.testOutputSchema = void 0;
 exports.needCredentialsError = needCredentialsError;
 exports.getViewTestUrl = getViewTestUrl;
 exports.getTestOutputUrl = getTestOutputUrl;
+exports.getCreateTestOutputText = getCreateTestOutputText;
 const zod_1 = require("zod");
 const env_1 = require("../../../../env/env");
 exports.testOutputSchema = zod_1.z.object({
@@ -51,3 +52,8 @@ function getViewTestUrl(workspaceId, invariantId) {
 function getTestOutputUrl(workspaceId, testRunId) {
     return `${env_1.BASE_APP_URL}/workspaces/${workspaceId}/output/test-runs/${testRunId}`;
 }
+function getCreateTestOutputText(trainerUrl) {
+    return `
+    A mabl trainer was launched. If you don't see the trainer running, open the following URL: ${trainerUrl} to open the trainer manually (Show the URL to the user using and explain to the user how to open it. If you have a tool that can open a link use it.).
+  `;
+}

package/commands/tests/testsUtil.js

@@ -408,44 +408,42 @@ function validateRunCommandWithLabels(testId, suppliedLabelsInclude, suppliedLab
     }
     return true;
 }
-async function pullDownTestRunConfig(testRunId, apiClient) {
-    const journeyRun = await apiClient.getTestRun(testRunId);
-    const planRun = await apiClient.getPlanRun(journeyRun.parent_execution);
-    const testDatatablevariables = journeyRun?.journey_parameters?.user_variables &&
-        (0, utils_1.variableRowAsScenario)(journeyRun?.journey_parameters?.user_variables);
-    const dataTableId = testDatatablevariables?.table_id;
-    if (dataTableId) {
-        await apiClient.getDataTable(dataTableId);
-    }
+function buildTestRunConfig(testRun, filterHttpRequests, planRun) {
+    const testDatatablevariables = testRun.journey_parameters?.user_variables &&
+        (0, utils_1.variableRowAsScenario)(testRun.journey_parameters?.user_variables);
     return {
-        basicAuthCredentialsId: planRun?.run_policy?.http_auth_credentials_required
-            ? planRun?.run_policy?.http_auth_credentials_id
-            : undefined,
-        branchName: journeyRun.journey_parameters?.source_control_tag,
-        credentialsId: planRun.run_policy?.credentials_required
-            ? planRun.run_policy?.credentials_id
-            : undefined,
+        basicAuthCredentialsId: testRun.journey_parameters?.http_auth_credentials_id ??
+            (planRun?.run_policy?.http_auth_credentials_required
+                ? planRun?.run_policy?.http_auth_credentials_id
+                : undefined),
+        branchName: testRun.journey_parameters?.source_control_tag,
+        credentialsId: testRun.journey_parameters?.credentials_id ??
+            (planRun?.run_policy?.credentials_required
+                ? planRun?.run_policy?.credentials_id
+                : undefined),
         dataTableVariables: testDatatablevariables,
-        deviceEmulation: journeyRun.journey_parameters?.device_emulation,
-        environmentId: journeyRun.journey_parameters?.deployment?.environment_id,
+        deviceEmulation: testRun.journey_parameters?.device_emulation,
+        environmentId: testRun.journey_parameters?.deployment?.environment_id,
         extraHttpHeaders: planRun?.run_policy?.http_headers_required === true
-            ? planRun?.run_policy?.http_headers?.reduce((headers, header) => ({
-                ...headers,
-                [header.name]: header.value ?? '',
-            }), {})
+            ? headerArrayToRecord(planRun?.run_policy?.http_headers)
             : undefined,
-        filterHttpRequests: false,
-        importedVariables: journeyRun.journey_parameters?.imported_variables,
-        linkCrawlerStartingUrlOverride: getLinkCrawlerUrlOverride(journeyRun),
-        localizationOptions: journeyRun.localization_options,
-        pageLoadWait: journeyRun.journey_parameters?.page_load_wait,
-        runId: journeyRun.id,
-        testId: journeyRun.journey?.invariant_id,
-        url: journeyRun.journey_parameters?.deployment?.uri,
+        filterHttpRequests,
+        importedVariables: testRun.journey_parameters?.imported_variables,
+        linkCrawlerStartingUrlOverride: getLinkCrawlerUrlOverride(testRun),
+        localizationOptions: testRun.localization_options,
+        pageLoadWait: testRun.journey_parameters?.page_load_wait,
+        runId: testRun.id,
+        testId: testRun.journey?.invariant_id,
+        url: testRun.journey_parameters?.deployment?.uri,
     };
 }
+async function pullDownTestRunConfig(testRunId, apiClient) {
+    const testRun = await apiClient.getTestRun(testRunId);
+    const planRun = await apiClient.getPlanRun(testRun.parent_execution);
+    return buildTestRunConfig(testRun, false, planRun);
+}
 async function extractTestRunConfig(executionMessage, apiClient) {
-    const journeyRun = executionMessage.journey_run ??
+    const testRun = executionMessage.journey_run ??
         (await apiClient.getTestRun(executionMessage.journey_run_id));
     const planRun = executionMessage.plan_run;
     const maybeRunnerType = planRun?.run_policy
@@ -453,31 +451,8 @@ async function extractTestRunConfig(executionMessage, apiClient) {
         ?
             planRun?.run_policy?.nodejs_runtime_variant
         : undefined;
-    const config = {
-        basicAuthCredentialsId: planRun?.run_policy?.http_auth_credentials_required
-            ? planRun?.run_policy?.http_auth_credentials_id
-            : undefined,
-        branchName: journeyRun?.journey_parameters?.source_control_tag,
-        credentialsId: planRun?.run_policy?.credentials_required
-            ? planRun?.run_policy?.credentials_id
-            : undefined,
-        dataTableVariables: journeyRun?.journey_parameters?.user_variables &&
-            (0, utils_1.variableRowAsScenario)(journeyRun?.journey_parameters?.user_variables),
-        deviceEmulation: journeyRun?.journey_parameters?.device_emulation,
-        environmentId: journeyRun?.journey_parameters?.deployment?.environment_id,
-        extraHttpHeaders: planRun?.run_policy?.http_headers_required === true
-            ? headerArrayToRecord(planRun?.run_policy?.http_headers)
-            : undefined,
-        filterHttpRequests: true,
-        importedVariables: journeyRun.journey_parameters?.imported_variables,
-        linkCrawlerStartingUrlOverride: getLinkCrawlerUrlOverride(journeyRun),
-        localizationOptions: journeyRun.localization_options,
-        pageLoadWait: journeyRun.journey_parameters?.page_load_wait,
-        runId: journeyRun.id,
-        runnerType: maybeRunnerType,
-        testId: journeyRun?.journey?.invariant_id,
-        url: journeyRun?.journey_parameters?.deployment?.uri,
-    };
+    const config = buildTestRunConfig(testRun, true, planRun);
+    config.runnerType = maybeRunnerType;
     if (executionMessage.test_type === mablApi_1.TestTypeEnum.Mobile) {
         const mobileMessage = executionMessage;
         config.mobileConfig = {

package/core/trainer/openUtils.js

@@ -63,8 +63,12 @@ async function createConfigServer(config) {
     return new Promise((resolve, reject) => {
         server.listen(0, () => {
             const port = server.address().port;
-            const requestPromise = new Promise((resolveRequest) => {
+            const requestPromise = new Promise((resolveRequest, rejectRequest) => {
+                const timeout = (0, timers_1.setTimeout)(() => {
+                    rejectRequest(new Error('Failed to open the trainer automatically. User will open the trainer manually.'));
+                }, 10_000);
                 server.on('close', () => {
+                    global.clearTimeout(timeout);
                     resolveRequest();
                 });
             });