@elisra-devops/docgen-data-provider 1.109.0 → 1.110.0

package/bin/modules/TicketsDataProvider.d.ts

@@ -100,6 +100,13 @@ export default class TicketsDataProvider {
      * @returns An object containing `systemRequirementsQueryTree`.
      */
     private fetchSystemRequirementQueries;
+    /**
+     * Fetches flat Customer/System requirement queries for SysRS traceability.
+     * OneHop/tree queries are intentionally excluded for this picker.
+     */
+    private fetchFlatUpstreamQueries;
+    private fetchCustomerRequirementQueries;
+    private structureCustomerRequirementQueries;
     private fetchSrsQueries;
     private fetchSysRsQueries;
     /**
@@ -213,7 +220,7 @@ export default class TicketsDataProvider {
      * Recursively structures fetched queries into two hierarchical trees (tree1 and tree2)
      * by matching WIQL against allowed Source/Target types and optional area filters.
      * Supports leaf queries of type:
-     * - oneHop (always)
+     * - oneHop (when includeOneHopQueries === true)
      * - tree (when includeTreeQueries === true)
      * - flat (when includeFlatQueries === true)
      *
@@ -227,6 +234,7 @@ export default class TicketsDataProvider {
      * @param includeTreeQueries - Include 'tree' queries in addition to 'oneHop'. Defaults to `false`.
      * @param excludedFolderNames - Optional list of folder names to skip entirely (case-insensitive exact match).
      * @param includeFlatQueries - Include 'flat' queries (matched by [System.WorkItemType] and [System.AreaPath]). Defaults to `false`.
+     * @param includeOneHopQueries - Include 'oneHop' queries. Defaults to `true` for legacy callers.
      * @returns A promise resolving to an object with `tree1` and `tree2` nodes, or `null` for each when none match.
      * @throws Logs an error if an exception occurs during processing.
      */

package/bin/modules/TicketsDataProvider.js

@@ -27,7 +27,7 @@ const HISTORICAL_WORK_ITEM_FIELDS = [
     'Custom.TestPhase',
 ];
 /** Default fields fetched per work item in tree/flat query parsing. */
-const WI_DEFAULT_FIELDS = 'System.Description,System.Title,Microsoft.VSTS.TCM.ReproSteps,Microsoft.VSTS.CMMI.Symptom';
+const WI_DEFAULT_FIELDS = 'System.Description,System.Title,System.WorkItemType,Microsoft.VSTS.TCM.ReproSteps,Microsoft.VSTS.CMMI.Symptom';
 class TicketsDataProvider {
     constructor(orgUrl, token) {
         this.orgUrl = '';
@@ -524,6 +524,50 @@ class TicketsDataProvider {
         excludedFolderNames, true);
         return { systemRequirementsQueryTree };
     }
+    /**
+     * Fetches flat Customer/System requirement queries for SysRS traceability.
+     * OneHop/tree queries are intentionally excluded for this picker.
+     */
+    async fetchFlatUpstreamQueries(queries, excludedFolderNames = [], allowedTypes = ['requirement']) {
+        const { tree1: systemRequirementsQueryTree } = await this.structureFetchedQueries(queries, false, null, allowedTypes, [], undefined, undefined, false, excludedFolderNames, true, false);
+        return { systemRequirementsQueryTree };
+    }
+    async fetchCustomerRequirementQueries(queries) {
+        const systemRequirementsQueryTree = await this.structureCustomerRequirementQueries(queries);
+        return { systemRequirementsQueryTree };
+    }
+    async structureCustomerRequirementQueries(rootQuery, parentId = null) {
+        try {
+            if (!(rootQuery === null || rootQuery === void 0 ? void 0 : rootQuery.hasChildren)) {
+                const isExecutableQuery = !(rootQuery === null || rootQuery === void 0 ? void 0 : rootQuery.isFolder) && ['flat', 'tree', 'oneHop'].includes(rootQuery === null || rootQuery === void 0 ? void 0 : rootQuery.queryType);
+                return isExecutableQuery ? this.buildQueryNode(rootQuery, parentId) : null;
+            }
+            if (!rootQuery.children) {
+                const queryUrl = `${rootQuery.url}?$depth=2&$expand=all`;
+                const currentQuery = await tfs_1.TFSServices.getItemContent(queryUrl, this.token);
+                if (!currentQuery) {
+                    return null;
+                }
+                return await this.structureCustomerRequirementQueries(currentQuery, currentQuery.id);
+            }
+            const childResults = await Promise.all(rootQuery.children.map((child) => this.structureCustomerRequirementQueries(child, rootQuery.id)));
+            const children = childResults.filter((child) => child !== null);
+            return children.length > 0
+                ? {
+                    id: rootQuery.id,
+                    pId: parentId,
+                    value: rootQuery.name,
+                    title: rootQuery.name,
+                    children,
+                }
+                : null;
+        }
+        catch (err) {
+            logger_1.default.error(`Error occurred while constructing the customer query list ${err.message} with query ${JSON.stringify(rootQuery)}`);
+            logger_1.default.error(`Error stack ${err.message}`);
+            return null;
+        }
+    }
     async fetchSrsQueries(rootQueries) {
         const srsFolder = await this.findQueryFolderByName(rootQueries, 'srs');
         if (!srsFolder) {
@@ -553,27 +597,30 @@ class TicketsDataProvider {
     async fetchSysRsQueries(rootQueries) {
         const { root: sysRsRoot, found: sysRsRootFound } = await this.getDocTypeRoot(rootQueries, 'sysrs');
         logger_1.default.debug(`[GetSharedQueries][sysrs] using ${sysRsRootFound ? 'dedicated folder' : 'root queries'}`);
-        const systemRequirementsQueries = await this.fetchSystemRequirementQueries(sysRsRoot, [
-            'System To Customer',
-            'System To Subsystem',
-        ]);
-        const systemToCustomerFolder = await this.findChildFolderByPossibleNames(sysRsRoot, [
-            'system to customer',
-            'system-to-customer',
-            'system customer',
-            'subsystem to system',
-            'customer to system',
-        ]);
-        const systemToSubsystemFolder = await this.findChildFolderByPossibleNames(sysRsRoot, [
-            'system to subsystem',
-            'system-to-subsystem',
-            'system subsystem',
-        ]);
-        const subsystemToSystemRequirementsQueries = await this.fetchRequirementsTraceQueriesForFolder(systemToCustomerFolder);
+        const systemToSubsystemFolderNames = ['system to subsystem', 'system-to-subsystem', 'system subsystem'];
+        const systemRequirementsQueries = await this.fetchSystemRequirementQueries(sysRsRoot, systemToSubsystemFolderNames);
+        const systemToSubsystemFolder = await this.findChildFolderByPossibleNames(sysRsRoot, systemToSubsystemFolderNames);
         const systemToSubsystemRequirementsQueries = await this.fetchRequirementsTraceQueriesForFolder(systemToSubsystemFolder);
+        // Customer/System requirements (traceability table) picker: scan the entire
+        // dedicated SysRS folder for executable query nodes. The selected query
+        // defines the customer-side candidate set, so discovery does not infer
+        // "customer" semantics from WIQL. Scope is intentionally limited to the
+        // dedicated `sysrs` folder so unrelated queries from the Shared Queries root
+        // do not leak into the picker.
+        let customerRequirementsQueries = null;
+        if (sysRsRootFound) {
+            customerRequirementsQueries = await this.fetchCustomerRequirementQueries(sysRsRoot);
+        }
+        else {
+            logger_1.default.debug('[GetSharedQueries][sysrs] dedicated sysrs folder not found; skipping customer-requirements picker');
+        }
         return {
             systemRequirementsQueries,
-            subsystemToSystemRequirementsQueries,
+            customerRequirementsQueries,
+            // Legacy field retained for backward compatibility with callers/tests.
+            // The sub-system -> system trace table is out of scope for v0 and no
+            // longer sourced from a hardcoded "System to Customer" folder.
+            subsystemToSystemRequirementsQueries: null,
             systemToSubsystemRequirementsQueries,
         };
     }
@@ -1752,21 +1799,25 @@ class TicketsDataProvider {
         };
     }
     async PopulateWorkItemsByIds(workItemsArray = [], projectName = '') {
-        let url = `${this.orgUrl}${projectName}/_apis/wit/workitemsbatch`;
-        let res = [];
-        let divByMax = Math.floor(workItemsArray.length / 200);
-        let modulusByMax = workItemsArray.length % 200;
-        //iterating
+        const baseUrl = `${this.orgUrl}${projectName}/_apis/wit/workitemsbatch`;
+        // On-prem Azure DevOps Server rejects this POST with HTTP 400 unless an
+        // api-version is explicitly set on the URL. Use the same fallback chain
+        // (7.1 -> 5.1 -> no version) the historical batch hydration already uses,
+        // so the helper stays compatible with ADO cloud and older on-prem tenants.
+        const postBatch = (currentIds) => this.withHistoricalApiVersionFallback('populate-workitems-batch', (apiVersion) => tfs_1.TFSServices.getItemContent(this.appendApiVersion(baseUrl, apiVersion), this.token, 'post', {
+            $expand: 'Relations',
+            ids: currentIds,
+        })).then(({ result }) => result);
+        const res = [];
+        const divByMax = Math.floor(workItemsArray.length / 200);
+        const modulusByMax = workItemsArray.length % 200;
         for (let i = 0; i < divByMax; i++) {
-            let from = i * 200;
-            let to = (i + 1) * 200;
-            let currentIds = workItemsArray.slice(from, to);
+            const from = i * 200;
+            const to = (i + 1) * 200;
+            const currentIds = workItemsArray.slice(from, to);
             try {
-                let subRes = await tfs_1.TFSServices.getItemContent(url, this.token, 'post', {
-                    $expand: 'Relations',
-                    ids: currentIds,
-                });
-                res = [...res, ...subRes.value];
+                const subRes = await postBatch(currentIds);
+                res.push(...subRes.value);
             }
             catch (error) {
                 logger_1.default.error(`error populating workitems array`);
@@ -1774,22 +1825,18 @@ class TicketsDataProvider {
                 return [];
             }
         }
-        //compliting the rimainder
         if (modulusByMax !== 0) {
             try {
-                let currentIds = workItemsArray.slice(workItemsArray.length - modulusByMax, workItemsArray.length);
-                let subRes = await tfs_1.TFSServices.getItemContent(url, this.token, 'post', {
-                    $expand: 'Relations',
-                    ids: currentIds,
-                });
-                res = [...res, ...subRes.value];
+                const currentIds = workItemsArray.slice(workItemsArray.length - modulusByMax, workItemsArray.length);
+                const subRes = await postBatch(currentIds);
+                res.push(...subRes.value);
             }
             catch (error) {
                 logger_1.default.error(`error populating workitems array`);
                 logger_1.default.error(JSON.stringify(error));
                 return [];
             }
-        } //if
+        }
         return res;
     }
     async GetModeledQueryResults(results, project) {
@@ -2013,7 +2060,7 @@ class TicketsDataProvider {
      * Recursively structures fetched queries into two hierarchical trees (tree1 and tree2)
      * by matching WIQL against allowed Source/Target types and optional area filters.
      * Supports leaf queries of type:
-     * - oneHop (always)
+     * - oneHop (when includeOneHopQueries === true)
      * - tree (when includeTreeQueries === true)
      * - flat (when includeFlatQueries === true)
      *
@@ -2027,10 +2074,11 @@ class TicketsDataProvider {
      * @param includeTreeQueries - Include 'tree' queries in addition to 'oneHop'. Defaults to `false`.
      * @param excludedFolderNames - Optional list of folder names to skip entirely (case-insensitive exact match).
      * @param includeFlatQueries - Include 'flat' queries (matched by [System.WorkItemType] and [System.AreaPath]). Defaults to `false`.
+     * @param includeOneHopQueries - Include 'oneHop' queries. Defaults to `true` for legacy callers.
      * @returns A promise resolving to an object with `tree1` and `tree2` nodes, or `null` for each when none match.
      * @throws Logs an error if an exception occurs during processing.
      */
-    async structureFetchedQueries(rootQuery, onlyTestReq, parentId = null, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries = false, excludedFolderNames = [], includeFlatQueries = false, workItemTypeCache) {
+    async structureFetchedQueries(rootQuery, onlyTestReq, parentId = null, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries = false, excludedFolderNames = [], includeFlatQueries = false, includeOneHopQueries = true, workItemTypeCache) {
         try {
             // Per-invocation cache for ID->WorkItemType lookups; avoids global state and is safe for concurrency.
             const typeCache = workItemTypeCache !== null && workItemTypeCache !== void 0 ? workItemTypeCache : new Map();
@@ -2041,7 +2089,7 @@ class TicketsDataProvider {
             }
             if (!rootQuery.hasChildren) {
                 const isLeafCandidate = !rootQuery.isFolder &&
-                    (rootQuery.queryType === 'oneHop' ||
+                    ((includeOneHopQueries && rootQuery.queryType === 'oneHop') ||
                         (includeTreeQueries && rootQuery.queryType === 'tree') ||
                         (includeFlatQueries && rootQuery.queryType === 'flat'));
                 if (isLeafCandidate) {
@@ -2101,10 +2149,10 @@ class TicketsDataProvider {
                 if (!currentQuery) {
                     return { tree1: null, tree2: null };
                 }
-                return await this.structureFetchedQueries(currentQuery, onlyTestReq, currentQuery.id, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries, excludedFolderNames, includeFlatQueries, typeCache);
+                return await this.structureFetchedQueries(currentQuery, onlyTestReq, currentQuery.id, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries, excludedFolderNames, includeFlatQueries, includeOneHopQueries, typeCache);
             }
             // Process children recursively
-            const childResults = await Promise.all(rootQuery.children.map((child) => this.structureFetchedQueries(child, onlyTestReq, rootQuery.id, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries, excludedFolderNames, includeFlatQueries, typeCache)));
+            const childResults = await Promise.all(rootQuery.children.map((child) => this.structureFetchedQueries(child, onlyTestReq, rootQuery.id, sources, targets, sourceAreaFilter, targetAreaFilter, includeTreeQueries, excludedFolderNames, includeFlatQueries, includeOneHopQueries, typeCache)));
             // Build tree1
             const tree1Children = childResults.map((res) => res.tree1).filter((child) => child !== null);
             const tree1Node = tree1Children.length > 0