common-qa-mcp 0.6.0 → 0.7.1

package/dist/adapters/simplifyqa/adapter.js

@@ -514,10 +514,6 @@ export class SimplifyQaAdapter {
         const rows = Array.isArray(body) ? body : Array.isArray(body?.data) ? body.data : [];
         return rows;
     }
-    /** For every FUNCTION step, resolve the referenced function's code + name via /tm/function search
-     *  (batched by distinct functionId). Mutates `tc.steps[i].functionCall` in place with
-     *  `testCaseCode`/`testCaseName`. Non-fatal on failure — the raw id still renders. Mirrors the
-     *  Excel export builder in tcfn.service.js:2696-2703. */
     async hydrateFunctionNames(tc) {
         const ids = new Set();
         for (const s of tc.steps) {
@@ -543,16 +539,33 @@ export class SimplifyQaAdapter {
                     continue;
                 byId.set(rid, { code: str(r, 'code'), name: str(r, 'name', 'title') ?? '' });
             }
+            const versionNamesById = new Map();
+            await Promise.all([...ids].map(async (fnId) => {
+                try {
+                    const versionRows = await this.fetchFunctionVersionRows(fnId);
+                    const versions = toVersionEntries(versionRows);
+                    versionNamesById.set(fnId, new Map(versions.map((v) => [v.id, v.name])));
+                }
+                catch {
+                    // Non-fatal per function: that step's version falls back to the bare uuid.
+                }
+            }));
             for (const s of tc.steps) {
                 if (s.stepType !== 'function' || !s.functionCall)
                     continue;
                 const hit = byId.get(s.functionCall.testCaseId);
-                if (!hit)
-                    continue;
-                if (hit.code)
-                    s.functionCall.testCaseCode = hit.code;
-                if (hit.name)
-                    s.functionCall.testCaseName = hit.name;
+                if (hit) {
+                    if (hit.code)
+                        s.functionCall.testCaseCode = hit.code;
+                    if (hit.name)
+                        s.functionCall.testCaseName = hit.name;
+                }
+                const versionId = s.functionCall.versionId;
+                if (versionId) {
+                    const versionName = versionNamesById.get(s.functionCall.testCaseId)?.get(versionId);
+                    if (versionName)
+                        s.functionCall.versionName = versionName;
+                }
             }
         }
         catch {
@@ -1023,11 +1036,27 @@ export class SimplifyQaAdapter {
      *  every node BEFORE that point is already persisted. */
     async createModule(input) {
         const root = await this.postOneModule(input.name, input.isRoot, input.projectId, input.description, input.parentId);
+        if (!input.isRoot && input.parentId) {
+            root.linkWarning = await this.checkChildLinked(input.parentId, root.id);
+        }
         if (input.children?.length) {
             root.children = await this.createSubtree(input.children, root.id, input.projectId, input.name, root);
         }
         return root;
     }
+    async checkChildLinked(parentId, childId) {
+        try {
+            const parent = await this.getModule(parentId);
+            const numChildId = Number.parseInt(childId, 10);
+            if (parent.childIds?.includes(numChildId))
+                return undefined;
+            return `Created with parentId=${parentId}, but a fresh read of module ${parentId} does not yet list ` +
+                `${childId} in its childIds — it may not appear under its parent in the Module screen tree until that catches up.`;
+        }
+        catch {
+            return undefined;
+        }
+    }
     /** Depth-first walk of a subtree. Stops at the first failure — everything already POSTed stays
      *  (no rollback endpoint upstream) and the failure is bubbled back on the root via `failedAt`. */
     async createSubtree(children, parentId, projectId, parentPath, root) {
@@ -1044,6 +1073,7 @@ export class SimplifyQaAdapter {
                 root.failedAt = { path, error: e instanceof Error ? e.message : String(e) };
                 return out;
             }
+            saved.linkWarning = await this.checkChildLinked(parentId, saved.id);
             if (child.children?.length) {
                 saved.children = await this.createSubtree(child.children, saved.id, projectId, path, root);
             }
@@ -1065,23 +1095,56 @@ export class SimplifyQaAdapter {
         const raw = await this.http.postJson('/pm/module', payload);
         return toModuleSaved(raw, name);
     }
-    /** PUT /pm/module/:id — partial edit. Controller reads `projectId` off the body for its
-     *  `add_module` privilege check (module.controller.js:64), so it MUST be sent even when unchanged;
-     *  we default to the connected project. Only `name` / `description` are exposed — the controller
-     *  ignores everything else the validator accepts (isRoot, parentId, childIds). */
     async updateModule(id, patch) {
-        const projectId = patch.projectId
-            ? Number.parseInt(numericId(patch.projectId), 10)
-            : this.requireProjectId();
-        const body = { projectId };
-        if (patch.name !== undefined)
-            body['name'] = patch.name;
-        if (patch.description !== undefined)
-            body['description'] = patch.description;
         const resolvedId = numericId(id);
-        const raw = await this.http.putJson(`/pm/module/${resolvedId}`, body);
+        let raw;
+        if (patch.name !== undefined || patch.description !== undefined) {
+            const projectId = patch.projectId
+                ? Number.parseInt(numericId(patch.projectId), 10)
+                : this.requireProjectId();
+            const body = { projectId };
+            if (patch.name !== undefined)
+                body['name'] = patch.name;
+            if (patch.description !== undefined)
+                body['description'] = patch.description;
+            raw = await this.http.putJson(`/pm/module/${resolvedId}`, body);
+        }
+        if (patch.parentId !== undefined) {
+            await this.reparentModule(resolvedId, patch.parentId);
+        }
         return toSavedRef(raw ?? { id: resolvedId }, false);
     }
+    async reparentModule(id, newParentId) {
+        if (newParentId === '') {
+            await this.http.putJson(`/pm/module/bulkupdate/${id}`, { isRoot: true });
+            return;
+        }
+        const targetId = numericId(newParentId);
+        if (targetId === id) {
+            throw new Error(`Cannot set module ${id} as its own parent.`);
+        }
+        const all = await this.listModules();
+        const childrenOf = new Map();
+        for (const m of all)
+            if (m.parentId)
+                childrenOf.set(m.parentId, [...(childrenOf.get(m.parentId) ?? []), m.id]);
+        const descendants = new Set();
+        const stack = [...(childrenOf.get(id) ?? [])];
+        while (stack.length) {
+            const next = stack.pop();
+            if (descendants.has(next))
+                continue;
+            descendants.add(next);
+            stack.push(...(childrenOf.get(next) ?? []));
+        }
+        if (descendants.has(targetId)) {
+            throw new Error(`Cannot move module ${id} under ${targetId} — it is already a descendant of ${id} (would detach the subtree).`);
+        }
+        if (!all.some((m) => m.id === targetId)) {
+            throw new Error(`Parent module ${targetId} not found.`);
+        }
+        await this.http.putJson(`/pm/module/bulkupdate/${id}`, { parentId: Number.parseInt(targetId, 10), isRoot: false });
+    }
     /** PATCH /pm/module — two-phase per module.controller.js:94. `confirm:false` returns the per-id
      *  dependency footprint (test cases, functions, params, objects, defects, user stories). `confirm:true`
      *  triggers the actual delete: server drops only ids with EMPTY dependencies; ids with references are
@@ -1195,12 +1258,55 @@ export class SimplifyQaAdapter {
         return withTotal(users, raw);
     }
     // ---------------------------------------------------------------------- Objects (read)
-    async getObject(id) {
+    async getObject(id, opts) {
         const raw = await this.http.getJson(`/tm/object/${numericId(id)}`);
         let doc = raw?.data ?? raw;
         if (Array.isArray(doc))
             doc = doc.length > 0 ? doc[0] : {};
-        return toObject(doc && typeof doc === 'object' ? doc : {});
+        const obj = toObject(doc && typeof doc === 'object' ? doc : {});
+        if (opts?.enrichNames)
+            await this.enrichObjectNames(obj);
+        return obj;
+    }
+    async enrichObjectNames(obj) {
+        if (obj.moduleId) {
+            try {
+                const modules = await this.listModules();
+                const match = modules.find((m) => m.id === obj.moduleId);
+                if (match)
+                    obj.moduleName = match.name;
+            }
+            catch { /* best-effort */ }
+        }
+        if (obj.parameterIds?.length) {
+            const names = await this.resolveParameterNames(obj.parameterIds);
+            const resolved = obj.parameterIds.map((pid) => names.get(pid)).filter((n) => !!n);
+            if (resolved.length)
+                obj.parameterNames = resolved;
+        }
+    }
+    async resolveParameterNames(ids) {
+        const map = new Map();
+        const numIds = ids.map((i) => Number.parseInt(i, 10)).filter(Number.isFinite);
+        if (!numIds.length)
+            return map;
+        try {
+            const projectId = this.requireProjectId();
+            const body = this.searchBody([
+                { column: 'projectId', value: projectId },
+                { column: 'id', value: numIds, regEx: false },
+            ]);
+            const raw = await this.http.postJson('/tm/parameter/search', body);
+            const rows = pickArray(raw, 'data', 'content');
+            for (const row of rows) {
+                const rid = str(row, 'id', '_id', 'parameterId');
+                const name = str(row, 'name');
+                if (rid && name)
+                    map.set(rid, name);
+            }
+        }
+        catch { /* best-effort */ }
+        return map;
     }
     // ---------------------------------------------------------------------- Deep links
     productUrlFor(entity) {
@@ -2249,15 +2355,30 @@ export class SimplifyQaAdapter {
         })().catch((e) => { this.actionCatalogCache = null; throw e; });
         return this.actionCatalogCache;
     }
-    /** POST /tm/object/createObjectSeq — get-or-create the shared object row by locator match. The
-     *  backend does the dedup (`object.controller.js:268-370`) — same-locators reuses, same-disname-
-     *  different-locators creates a suffixed one. Returns the numeric object id.
-     *
-     *  ponytail: minimum body — no thumbnail_url / pageScreenShot_url / parameterId. The recording
-     *  path enriches these; the tc_save path doesn't have screenshots to attach, and the object
-     *  works for execution without them. */
     async resolveObjectId(objectRef, projectId, moduleId, technology, objectTemplateId) {
-        const attributes = (objectRef.locators ?? []).map((l) => ({
+        const name = (objectRef.name ?? '').trim();
+        const incomingLocators = objectRef.locators ?? [];
+        if (name) {
+            try {
+                const candidates = await this.searchObjects({ query: name, limit: 20 });
+                const existing = candidates.find((c) => c.name.trim().toLowerCase() === name.toLowerCase());
+                if (existing?.id) {
+                    const key = (l) => `${l.name}::${l.value}`;
+                    const existingKeys = new Set(existing.locators.map(key));
+                    const incomingKeys = new Set(incomingLocators.map(key));
+                    const sameLocators = existingKeys.size === incomingKeys.size
+                        && [...existingKeys].every((k) => incomingKeys.has(k));
+                    if (!sameLocators && incomingLocators.length) {
+                        await this.updateObject(existing.id, { locators: incomingLocators });
+                    }
+                    return Number.parseInt(existing.id, 10);
+                }
+            }
+            catch {
+                // Lookup failed — fall through to create rather than block the save over this.
+            }
+        }
+        const attributes = incomingLocators.map((l) => ({
             name: l.name,
             value: l.value,
             ...(l.unique === true ? { unique: true } : {}),
@@ -2267,7 +2388,7 @@ export class SimplifyQaAdapter {
             moduleId,
             objecttemplateId: objectTemplateId,
             technology,
-            disname: objectRef.name ?? '',
+            disname: name,
             attributes,
             parameterId: [],
             description: '',
@@ -2276,7 +2397,7 @@ export class SimplifyQaAdapter {
         const flat = raw?.data ?? raw;
         const id = str(flat, 'id', '_id', 'objectId');
         if (!id)
-            throw new Error(`createObjectSeq returned no id for object "${objectRef.name}": ${JSON.stringify(raw)}`);
+            throw new Error(`createObjectSeq returned no id for object "${name}": ${JSON.stringify(raw)}`);
         return Number.parseInt(id, 10);
     }
     /** For every automation step, resolve `actionId` (from action name + technology) and
@@ -2586,6 +2707,26 @@ export class SimplifyQaAdapter {
             throw new Error('createObject: objectType is required (e.g. "WEB", "ANDROID") — it selects the object template ' +
                 'and cannot be changed after the object is created.');
         }
+        const wantedName = (o.name ?? '').trim();
+        if (wantedName) {
+            try {
+                const candidates = await this.searchObjects({ query: wantedName, limit: 20 });
+                const existing = candidates.find((c) => c.name.trim().toLowerCase() === wantedName.toLowerCase());
+                if (existing?.id) {
+                    const key = (l) => `${l.name}::${l.value}`;
+                    const existingKeys = new Set(existing.locators.map(key));
+                    const incomingKeys = new Set((o.locators ?? []).map(key));
+                    const sameLocators = existingKeys.size === incomingKeys.size
+                        && [...existingKeys].every((k) => incomingKeys.has(k));
+                    return sameLocators || !o.locators?.length
+                        ? existing
+                        : await this.updateObject(existing.id, { locators: o.locators });
+                }
+            }
+            catch {
+                // Lookup failed — fall through to create rather than block the save over this.
+            }
+        }
         const projectId = this.requireProjectId();
         const objecttemplateId = await this.resolveObjectTemplateId(o.objectType);
         const moduleId = await this.resolveDefaultModuleId();
@@ -2673,7 +2814,7 @@ export class SimplifyQaAdapter {
      * attribute set is even valid for this object), so editing them here — outside the create flow — is
      * out of scope; changing them means creating a new object, not "updating" this one.
      */
-    async updateObject(id, changes) {
+    async updateObject(id, changes, opts) {
         const numId = numericId(id);
         const raw = await this.http.getJson(`/tm/object/${numId}`);
         const doc = (raw?.data && typeof raw.data === 'object' ? raw.data : raw) ?? {};
@@ -2695,12 +2836,41 @@ export class SimplifyQaAdapter {
             else
                 attributes.push(merged);
         }
+        let moduleId = doc.moduleId;
+        if (changes.moduleName !== undefined) {
+            const modules = await this.listModules();
+            const wanted = changes.moduleName.trim().toLowerCase();
+            const match = modules.find((m) => m.name.toLowerCase() === wanted);
+            if (!match) {
+                const options = modules.map((m) => m.name).join(', ') || '(no modules configured in this project)';
+                throw new Error(`Module "${changes.moduleName}" not found on object ${id}. Valid modules: ${options}`);
+            }
+            moduleId = Number.parseInt(match.id, 10);
+        }
+        let parameterId = doc.parameterId ?? [];
+        if (changes.parameterNames !== undefined) {
+            const projectId = this.requireProjectId();
+            const resolved = [];
+            const unresolved = [];
+            for (const name of changes.parameterNames) {
+                const pid = await this.findParameterId(projectId, name);
+                if (pid != null)
+                    resolved.push(pid);
+                else
+                    unresolved.push(name);
+            }
+            if (unresolved.length) {
+                throw new Error(`Parameter(s) not found on object ${id}: ${unresolved.join(', ')}. Check the exact name ` +
+                    '(case-insensitive), or create the parameter first in the Parameters screen.');
+            }
+            parameterId = resolved;
+        }
         const body = {
             disname: changes.name ?? doc.disname,
-            description: doc.description,
+            description: changes.description !== undefined ? changes.description : doc.description,
             objecttemplateId: doc.objecttemplateId,
-            parameterId: doc.parameterId ?? [],
-            moduleId: doc.moduleId,
+            parameterId,
+            moduleId,
             technology: doc.technology,
             attributes,
             projectId: this.requireProjectId(),
@@ -2708,7 +2878,10 @@ export class SimplifyQaAdapter {
         };
         const res = await this.http.putJson(`/tm/object/${numId}`, body);
         const updated = (res?.data && typeof res.data === 'object' ? res.data : res) ?? doc;
-        return toObject(updated);
+        const obj = toObject(updated);
+        if (opts?.enrichNames)
+            await this.enrichObjectNames(obj);
+        return obj;
     }
     // ---------------------------------------------------------------------- Actions catalog
     async actionsCatalog(platform) {
@@ -2762,8 +2935,9 @@ export class SimplifyQaAdapter {
                 const meta = await this.fetchParameterMeta(pid);
                 if (!meta)
                     continue; // parameter deleted — skip
-                const seed = meta.protected ? (rawValue ? '*****' : '(empty)') : rawValue;
-                parameters.push({ paramId: pid, name: meta.name, seed, ...(meta.protected ? { protected: true } : {}) });
+                const isProtected = meta.protected || looksSensitive(meta.name);
+                const seed = isProtected ? (rawValue ? '*****' : '(empty)') : rawValue;
+                parameters.push({ paramId: pid, name: meta.name, seed, ...(isProtected ? { protected: true } : {}) });
             }
         }
         return { tcId: q.tcId, versionId: versionId, environmentType: env, parameters };
@@ -2942,23 +3116,19 @@ export class SimplifyQaAdapter {
         // Top-level execution doc (carries `type` = 'TC' or 'SUITE', and `executionItems[]` for a suite).
         // One extra POST per getRun call; a suite short-circuits here so no /exec/report is needed.
         if (Number.isFinite(runIdNum)) {
-            const execBody = {
-                searchFields: [
-                    { column: 'id', value: runIdNum, regEx: false },
-                    { column: 'projectId', value: projectId, regEx: false },
-                    { column: 'deleted', value: false },
-                ],
-                startIndex: 0,
-                limit: 1,
-            };
-            const execRaw = await this.http.postJson('/exec/execution/search', execBody);
-            const execDoc = pickArray(execRaw, 'data', 'content', 'executions')[0];
+            const execDoc = await this.fetchExecDoc(runIdNum, projectId);
             if (execDoc && String(execDoc.type ?? '').toUpperCase() === 'SUITE') {
                 const items = Array.isArray(execDoc.executionItems) ? execDoc.executionItems : [];
                 const children = items.map((it) => {
+                    const testcaseId = str(it, 'testcaseId');
+                    const versionId = str(it, 'versionId');
+                    const stepId = str(it, 'stepId');
                     const child = {
-                        id: str(it, 'code') ?? String(it?.id ?? ''),
+                        id: testcaseId ?? String(it?.id ?? ''),
                         state: mapRunState(str(it, 'status') ?? ''),
+                        ...(testcaseId ? { testcaseId } : {}),
+                        ...(versionId ? { versionId } : {}),
+                        ...(stepId ? { stepId } : {}),
                     };
                     const name = str(it, 'name');
                     if (name)
@@ -2991,14 +3161,33 @@ export class SimplifyQaAdapter {
         }
         const executionRunId = str(chosen, 'id', '_id') ?? '';
         const parentId = Number(chosen?.executionItemId ?? 0);
+        const stepResults = await this.fetchStepResults(runIdNum, executionRunId, parentId, projectId);
+        return {
+            runId,
+            state: mapRunState(str(chosen, 'status') ?? ''),
+            stepResults,
+            reportUrl: `${base}/user/reports/reports-page?type=TESTCASE&parentId=${parentId}&id=${runIdNum}&projectId=${projectId}`,
+        };
+    }
+    async fetchExecDoc(runIdNum, projectId) {
+        const execBody = {
+            searchFields: [
+                { column: 'id', value: runIdNum, regEx: false },
+                { column: 'projectId', value: projectId, regEx: false },
+                { column: 'deleted', value: false },
+            ],
+            startIndex: 0,
+            limit: 1,
+        };
+        const execRaw = await this.http.postJson('/exec/execution/search', execBody);
+        return pickArray(execRaw, 'data', 'content', 'executions')[0];
+    }
+    async fetchStepResults(executionId, executionRunId, parentId, projectId) {
         const stepsResp = await this.http.postJson('/reports/execution/getstepResult', {
-            executionId: Number.parseInt(numericId(runId), 10),
-            executionRunId,
-            parentId,
-            projectId,
+            executionId, executionRunId, parentId, projectId,
         });
         const rawSteps = Array.isArray(stepsResp?.data) ? stepsResp.data : [];
-        const stepResults = rawSteps.map((s) => {
+        return rawSteps.map((s) => {
             const step = {
                 n: typeof s?.seq === 'number' ? s.seq : 0,
                 description: String(s?.description ?? ''),
@@ -3028,11 +3217,44 @@ export class SimplifyQaAdapter {
             }
             return step;
         });
+    }
+    async getSuiteChildRun(suiteRunId, child) {
+        const projectId = this.requireProjectId();
+        const runIdNum = Number.parseInt(numericId(suiteRunId), 10);
+        const execDoc = await this.fetchExecDoc(runIdNum, projectId);
+        if (!execDoc)
+            throw new Error(`Suite run ${suiteRunId} not found.`);
+        const suiteNum = Number(execDoc.executionTypeId ?? 0);
+        const body = {
+            type: 'SU',
+            projectId,
+            parentId: suiteNum,
+            executionId: runIdNum,
+            tcId: Number.parseInt(numericId(child.testcaseId), 10),
+            ...(child.versionId ? { tcVersionId: child.versionId } : {}),
+            ...(child.stepId ? { stepId: child.stepId } : {}),
+        };
+        const raw = await this.http.postJson('/reports/execution/getExecutionRuns', body);
+        const runs = Array.isArray(raw?.data) ? raw.data : [];
+        const base = (this.cfg.baseUrl ?? '').replace(/\/+$/, '');
+        if (!runs.length) {
+            return { runId: suiteRunId, state: 'queued' };
+        }
+        let chosen = runs[0];
+        for (const r of runs) {
+            if (typeof r?.status === 'string' && r.status.toUpperCase() === 'FAILED') {
+                chosen = r;
+                break;
+            }
+        }
+        const executionRunId = str(chosen, 'id', '_id') ?? '';
+        const parentId = Number(chosen?.executionItemId ?? 0);
+        const stepResults = await this.fetchStepResults(runIdNum, executionRunId, parentId, projectId);
         return {
-            runId,
+            runId: suiteRunId,
             state: mapRunState(str(chosen, 'status') ?? ''),
             stepResults,
-            reportUrl: `${base}/user/reports/reports-page?type=TESTCASE&parentId=${parentId}&id=${Number.parseInt(numericId(runId), 10)}&projectId=${projectId}`,
+            reportUrl: `${base}/user/reports/reports-page?type=TESTCASE&parentId=${parentId}&id=${runIdNum}&projectId=${projectId}`,
         };
     }
     /** Most recent execution runId for a SUITE — same `/exec/execution/search` the /reports UI's