@elisra-devops/docgen-data-provider 1.63.12 → 1.67.0

package/src/modules/TicketsDataProvider.ts

@@ -69,7 +69,9 @@ export default class TicketsDataProvider {
       const fieldsArr = Array.isArray(fieldsResp?.value) ? fieldsResp.value : [];
       const candidates = fieldsArr
         .filter((f: any) => {
-          const nm = String(f?.name || '').toLowerCase().replace(/_/g, ' ');
+          const nm = String(f?.name || '')
+            .toLowerCase()
+            .replace(/_/g, ' ');
           return nm.includes('requirement type');
         })
         .map((f: any) => f?.referenceName)
@@ -569,7 +571,7 @@ export default class TicketsDataProvider {
       queries,
       false,
       null,
-      ['Epic', 'Feature', 'Requirement'],
+      ['epic', 'feature', 'requirement'],
       [],
       undefined,
       undefined,
@@ -643,8 +645,8 @@ export default class TicketsDataProvider {
         queries,
         onlySourceSide,
         null,
-        ['Epic', 'Feature', 'Requirement'],
-        ['Epic', 'Feature', 'Requirement'],
+        ['epic', 'feature', 'requirement'],
+        ['epic', 'feature', 'requirement'],
         'sys', // Source area filter for tree1: System area paths
         'soft' // Target area filter for tree1: Software area paths (tree2 will be reversed automatically)
       );
@@ -660,8 +662,8 @@ export default class TicketsDataProvider {
       folder,
       false,
       null,
-      ['Epic', 'Feature', 'Requirement'],
-      ['Epic', 'Feature', 'Requirement'],
+      ['epic', 'feature', 'requirement'],
+      ['epic', 'feature', 'requirement'],
       undefined,
       undefined,
       true
@@ -1740,9 +1742,12 @@ export default class TicketsDataProvider {
     targetAreaFilter?: string,
     includeTreeQueries: boolean = false,
     excludedFolderNames: string[] = [],
-    includeFlatQueries: boolean = false
+    includeFlatQueries: boolean = false,
+    workItemTypeCache?: Map<string, string | null>
   ): Promise<any> {
     try {
+      // Per-invocation cache for ID->WorkItemType lookups; avoids global state and is safe for concurrency.
+      const typeCache = workItemTypeCache ?? new Map<string, string | null>();
       const shouldSkipFolder =
         rootQuery?.isFolder &&
         excludedFolderNames.some(
@@ -1766,14 +1771,17 @@ export default class TicketsDataProvider {
 
           if (rootQuery.queryType === 'flat' && includeFlatQueries) {
             const allTypes = Array.from(new Set([...(sources || []), ...(targets || [])]));
-            const typesOk = this.matchesFlatWorkItemTypeCondition(wiql, allTypes);
+            const typesOk = await this.matchesFlatWorkItemTypeConditionAsync(
+              rootQuery,
+              wiql,
+              allTypes,
+              typeCache
+            );
 
             if (typesOk) {
               const allowTree1 =
                 !onlyTestReq &&
-                (sourceAreaFilter
-                  ? this.matchesFlatAreaCondition(wiql, sourceAreaFilter || '')
-                  : true);
+                (sourceAreaFilter ? this.matchesFlatAreaCondition(wiql, sourceAreaFilter || '') : true);
               const allowTree2 = targetAreaFilter
                 ? this.matchesFlatAreaCondition(wiql, targetAreaFilter || '')
                 : true;
@@ -1787,7 +1795,25 @@ export default class TicketsDataProvider {
               }
             }
           } else {
-            if (!onlyTestReq && this.matchesSourceTargetCondition(wiql, sources, targets)) {
+            let matchesForward = false;
+            if (!onlyTestReq) {
+              matchesForward = await this.matchesSourceTargetConditionAsync(
+                rootQuery,
+                wiql,
+                sources,
+                targets,
+                typeCache
+              );
+            }
+            const matchesReverse = await this.matchesSourceTargetConditionAsync(
+              rootQuery,
+              wiql,
+              targets,
+              sources,
+              typeCache
+            );
+
+            if (matchesForward) {
               const matchesAreaPath =
                 sourceAreaFilter || targetAreaFilter
                   ? this.matchesAreaPathCondition(wiql, sourceAreaFilter || '', targetAreaFilter || '')
@@ -1797,7 +1823,7 @@ export default class TicketsDataProvider {
                 tree1Node = this.buildQueryNode(rootQuery, parentId);
               }
             }
-            if (this.matchesSourceTargetCondition(wiql, targets, sources)) {
+            if (matchesReverse) {
               const matchesReverseAreaPath =
                 sourceAreaFilter || targetAreaFilter
                   ? this.matchesAreaPathCondition(wiql, targetAreaFilter || '', sourceAreaFilter || '')
@@ -1817,20 +1843,22 @@ export default class TicketsDataProvider {
       if (!rootQuery.children) {
         const queryUrl = `${rootQuery.url}?$depth=2&$expand=all`;
         const currentQuery = await TFSServices.getItemContent(queryUrl, this.token);
-        return currentQuery
-          ? await this.structureFetchedQueries(
-              currentQuery,
-              onlyTestReq,
-              currentQuery.id,
-              sources,
-              targets,
-              sourceAreaFilter,
-              targetAreaFilter,
-              includeTreeQueries,
-              excludedFolderNames,
-              includeFlatQueries
-            )
-          : { tree1: null, tree2: null };
+        if (!currentQuery) {
+          return { tree1: null, tree2: null };
+        }
+        return await this.structureFetchedQueries(
+          currentQuery,
+          onlyTestReq,
+          currentQuery.id,
+          sources,
+          targets,
+          sourceAreaFilter,
+          targetAreaFilter,
+          includeTreeQueries,
+          excludedFolderNames,
+          includeFlatQueries,
+          typeCache
+        );
       }
 
       // Process children recursively
@@ -1846,7 +1874,8 @@ export default class TicketsDataProvider {
             targetAreaFilter,
             includeTreeQueries,
             excludedFolderNames,
-            includeFlatQueries
+            includeFlatQueries,
+            typeCache
           )
         )
       );
@@ -1905,7 +1934,8 @@ export default class TicketsDataProvider {
     const tgtFilter = (targetAreaFilter || '').toLowerCase().trim();
 
     const extractAreaPaths = (owner: 'source' | 'target'): string[] => {
-      const re = new RegExp(`${owner}\\.\\[system\\.areapath\\][^']*'([^']+)'`, 'gi');
+      const ownerPattern = `(?:${owner}|\\[${owner}\\])`;
+      const re = new RegExp(`${ownerPattern}\\.\\[system\\.areapath\\][^']*'([^']+)'`, 'gi');
       const results: string[] = [];
       let match: RegExpExecArray | null;
       while ((match = re.exec(wiqlLower)) !== null) {
@@ -1930,144 +1960,300 @@ export default class TicketsDataProvider {
     return hasSourceAreaPath && hasTargetAreaPath;
   }
 
+  private async matchesSourceTargetConditionAsync(
+    queryNode: any,
+    wiql: string,
+    source: string[],
+    target: string[],
+    workItemTypeCache: Map<string, string | null>
+  ): Promise<boolean> {
+    /**
+     * Matches source+target constraints for link WIQL.
+     * For each side (Source/Target) we accept either:
+     * - explicit `[System.WorkItemType]` constraints (all types must be within the allowed list), or
+     * - explicit `[System.Id]` constraints when no type constraint exists (type is fetched by id and validated).
+     */
+    const sourceOk = await this.isLinkSideAllowedByTypeOrId(
+      queryNode,
+      wiql,
+      'Source',
+      source,
+      workItemTypeCache
+    );
+    if (!sourceOk) return false;
+    const targetOk = await this.isLinkSideAllowedByTypeOrId(
+      queryNode,
+      wiql,
+      'Target',
+      target,
+      workItemTypeCache
+    );
+    return targetOk;
+  }
+
+  private async matchesFlatWorkItemTypeConditionAsync(
+    queryNode: any,
+    wiql: string,
+    allowedTypes: string[],
+    workItemTypeCache: Map<string, string | null>
+  ): Promise<boolean> {
+    return this.isFlatQueryAllowedByTypeOrId(queryNode, wiql, allowedTypes, workItemTypeCache);
+  }
+
+  // Build a normalized node object for tree outputs
+  private buildQueryNode(rootQuery: any, parentId: any) {
+    return {
+      id: rootQuery.id,
+      pId: parentId,
+      value: rootQuery.name,
+      title: rootQuery.name,
+      queryType: rootQuery.queryType,
+      columns: rootQuery.columns,
+      wiql: rootQuery._links.wiql ?? undefined,
+      isValidQuery: true,
+    };
+  }
+
+  private getProjectFromQueryNode(queryNode: any): string | null {
+    const href =
+      queryNode?._links?.wiql?.href ||
+      queryNode?._links?.self?.href ||
+      queryNode?.url ||
+      queryNode?._links?.html?.href;
+    if (!href) return null;
+    return this.getProjectFromWiqlHref(String(href));
+  }
+
   /**
-   * Determines whether the given WIQL (Work Item Query Language) string matches the specified
-   * source and target conditions. It checks if the WIQL contains references to the specified
-   * source and target work item types.
-   *
-   * Supports both equality (=) and IN operators:
-   * - Source.[System.WorkItemType] = 'Epic'
-   * - Source.[System.WorkItemType] IN ('Epic', 'Feature', 'Requirement')
-   *
-   * @param wiql - The WIQL string to evaluate.
-   * @param source - An array of source work item types to check for in the WIQL.
-   * @param target - An array of target work item types to check for in the WIQL.
-   * @returns A boolean indicating whether the WIQL includes at least one valid source work item type
-   *          and at least one valid target work item type.
+   * Normalizes allowed work item types into a lowercase set.
    */
-  private matchesSourceTargetCondition(wiql: string, source: string[], target: string[]): boolean {
-    const isSourceIncluded = this.matchesWorkItemTypeCondition(wiql, 'Source', source);
-    const isTargetIncluded = this.matchesWorkItemTypeCondition(wiql, 'Target', target);
-    return isSourceIncluded && isTargetIncluded;
+  private normalizeAllowedTypes(allowedTypes: string[]): Set<string> {
+    return new Set((allowedTypes || []).map((t) => String(t).trim().toLowerCase()).filter(Boolean));
   }
 
   /**
-   * Helper method to check if a WIQL contains valid work item types for a given context (Source/Target).
-   * Supports both = and IN operators.
-   *
-   * @param wiql - The WIQL string to evaluate
-   * @param context - Either 'Source' or 'Target'
-   * @param allowedTypes - Array of allowed work item types
-   * @returns true if all work item types in the WIQL are in the allowedTypes array
+   * Returns true when every value in `found` exists in `allowed`.
    */
-  private matchesWorkItemTypeCondition(
-    wiql: string,
-    context: 'Source' | 'Target',
-    allowedTypes: string[]
-  ): boolean {
-    // If allowedTypes is empty, accept any work item type (for backward compatibility)
-    if (allowedTypes.length === 0) {
-      return wiql.includes(`${context}.[System.WorkItemType]`);
+  private areAllAllowed(found: Set<string>, allowed: Set<string>): boolean {
+    for (const v of found) {
+      if (!allowed.has(v)) return false;
     }
+    return true;
+  }
 
-    const fieldPattern = `${context}.\\[System.WorkItemType\\]`;
-
-    // Pattern for equality: Source.[System.WorkItemType] = 'Epic'
-    const equalityRegex = new RegExp(`${fieldPattern}\\s*=\\s*'([^']+)'`, 'gi');
+  /**
+   * Builds a regex-ready field selector for WIQL.
+   * - Link queries: Source/Target can appear as `Source.[...]` or `[Source].[...]`
+   * - Flat queries: no owner prefix, e.g. `[System.WorkItemType]`
+   */
+  private buildWiqlFieldPattern(owner: 'Source' | 'Target' | null, fieldRef: string): string {
+    const escapedField = String(fieldRef).replace(/\./g, '\\.');
+    if (!owner) {
+      return `\\[${escapedField}\\]`;
+    }
+    const ownerPattern = `(?:${owner}|\\[${owner}\\])`;
+    return `${ownerPattern}\\.\\[${escapedField}\\]`;
+  }
 
-    // Pattern for IN operator: Source.[System.WorkItemType] IN ('Epic', 'Feature', 'Requirement')
-    const inRegex = new RegExp(`${fieldPattern}\\s+IN\\s*\\(([^)]+)\\)`, 'gi');
+  /**
+   * Extracts all quoted values used in `=` or `IN (...)` comparisons for a given field.
+   * Returned values are trimmed and lowercased.
+   *
+   * Examples:
+   * - `<field> = 'Epic'`
+   * - `<field> IN ('Epic','Feature')`
+   */
+  private extractQuotedValuesForField(wiql: string, fieldPattern: string): Set<string> {
+    const wiqlStr = String(wiql || '');
+    const found = new Set<string>();
 
-    const foundTypes = new Set<string>();
+    const eqRe = new RegExp(`${fieldPattern}\\s*=\\s*'([^']+)'`, 'gi');
+    const inRe = new RegExp(`${fieldPattern}\\s+IN\\s*\\(([^)]+)\\)`, 'gi');
 
-    // Extract types from equality operators
-    let match;
-    while ((match = equalityRegex.exec(wiql)) !== null) {
-      foundTypes.add(match[1].trim());
+    let match: RegExpExecArray | null;
+    while ((match = eqRe.exec(wiqlStr)) !== null) {
+      found.add(String(match[1]).trim().toLowerCase());
     }
-
-    // Extract types from IN operators
-    while ((match = inRegex.exec(wiql)) !== null) {
-      const typesString = match[1];
-      // Extract all quoted values from the IN clause
-      const typeMatches = typesString.matchAll(/'([^']+)'/g);
-      for (const typeMatch of typeMatches) {
-        foundTypes.add(typeMatch[1].trim());
+    while ((match = inRe.exec(wiqlStr)) !== null) {
+      const inner = String(match[1] || '');
+      for (const mm of inner.matchAll(/'([^']+)'/g)) {
+        found.add(String(mm[1]).trim().toLowerCase());
       }
     }
+    return found;
+  }
 
-    // If no work item types found in WIQL, return false
-    if (foundTypes.size === 0) {
-      return false;
-    }
+  /**
+   * Extracts all numeric values used in `=` or `IN (...)` comparisons for a given field.
+   * Supports both quoted and unquoted numbers.
+   *
+   * Examples:
+   * - `<field> = 123`
+   * - `<field> IN (123, '456')`
+   */
+  private extractNumericValuesForField(wiql: string, fieldPattern: string): Set<string> {
+    const wiqlStr = String(wiql || '');
+    const found = new Set<string>();
 
-    // Check if all found types are in the allowedTypes array
-    for (const type of foundTypes) {
-      if (!allowedTypes.includes(type)) {
-        // Found a type that's not in the allowed list - reject this query
-        return false;
+    const eqRe = new RegExp(`${fieldPattern}\\s*=\\s*'?([0-9]+)'?`, 'gi');
+    const inRe = new RegExp(`${fieldPattern}\\s+IN\\s*\\(([^)]+)\\)`, 'gi');
+
+    let match: RegExpExecArray | null;
+    while ((match = eqRe.exec(wiqlStr)) !== null) {
+      found.add(String(match[1]));
+    }
+    while ((match = inRe.exec(wiqlStr)) !== null) {
+      const inner = String(match[1] || '');
+      for (const mm of inner.matchAll(/'?([0-9]+)'?/g)) {
+        found.add(String(mm[1]));
       }
     }
-
-    // All found types are valid
-    return true;
+    return found;
   }
 
-  // Build a normalized node object for tree outputs
-  private buildQueryNode(rootQuery: any, parentId: any) {
-    return {
-      id: rootQuery.id,
-      pId: parentId,
-      value: rootQuery.name,
-      title: rootQuery.name,
-      queryType: rootQuery.queryType,
-      columns: rootQuery.columns,
-      wiql: rootQuery._links.wiql ?? undefined,
-      isValidQuery: true,
-    };
+  /**
+   * Extracts work item IDs from WIQL.
+   * - Link queries: pass `context` to match `Source.[System.Id]` / `Target.[System.Id]` (with or without `[Source]`)
+   * - Flat queries: omit `context` to match `[System.Id]`
+   */
+  private extractWorkItemIdsFromWiql(wiql: string, context?: 'Source' | 'Target'): string[] {
+    const fieldPattern = this.buildWiqlFieldPattern(context ?? null, 'System.Id');
+    return [...this.extractNumericValuesForField(String(wiql || ''), fieldPattern).values()];
   }
 
   /**
-   * Matches flat query WIQL against allowed work item types.
-   * Accept when at least one type is present and all found types are within the allowed set.
+   * Determines if a link-query side (Source/Target) is allowed based on WIQL constraints.
+   *
+   * Rules:
+   * - If `allowedTypes` is empty: preserve legacy behavior by requiring that WorkItemType is present for that side.
+   * - If WIQL contains a WorkItemType constraint for that side: all specified types must be within `allowedTypes`.
+   * - Otherwise, if WIQL contains a System.Id constraint for that side: fetch the work item type(s) by id and validate.
+   * - Otherwise: reject.
    */
-  private matchesFlatWorkItemTypeCondition(wiql: string, allowedTypes: string[]): boolean {
-    // If allowedTypes is empty, accept any work item type reference
+  private async isLinkSideAllowedByTypeOrId(
+    queryNode: any,
+    wiql: string,
+    context: 'Source' | 'Target',
+    allowedTypes: string[],
+    workItemTypeCache: Map<string, string | null>
+  ): Promise<boolean> {
+    const wiqlStr = String(wiql || '');
+
+    // Preserve existing behavior when no allowedTypes are provided.
     if (!allowedTypes || allowedTypes.length === 0) {
-      return /\[System\.WorkItemType\]/i.test(wiql || '');
+      const fieldPresenceRegex = new RegExp(
+        `${this.buildWiqlFieldPattern(context, 'System.WorkItemType')}`,
+        'i'
+      );
+      return fieldPresenceRegex.test(wiqlStr);
     }
 
+    const allowed = this.normalizeAllowedTypes(allowedTypes);
+    const typeFieldPattern = this.buildWiqlFieldPattern(context, 'System.WorkItemType');
+    const typesInWiql = this.extractQuotedValuesForField(wiqlStr, typeFieldPattern);
+    if (typesInWiql.size > 0) {
+      return this.areAllAllowed(typesInWiql, allowed);
+    }
+
+    const ids = this.extractWorkItemIdsFromWiql(wiqlStr, context);
+    if (ids.length === 0) return false;
+
+    const project = this.getProjectFromQueryNode(queryNode);
+    if (!project) return false;
+
+    for (const id of ids) {
+      const wiType = await this.getWorkItemTypeById(project, id, workItemTypeCache);
+      if (!wiType) return false;
+      if (!allowed.has(String(wiType).toLowerCase())) return false;
+    }
+
+    return true;
+  }
+
+  /**
+   * Determines if a flat query is allowed based on WIQL constraints.
+   *
+   * Rules:
+   * - If `allowedTypes` is empty: preserve legacy behavior by requiring that `[System.WorkItemType]` appears in WIQL.
+   * - If WIQL contains a WorkItemType constraint: all specified types must be within `allowedTypes`.
+   * - Otherwise, if WIQL contains `[System.Id]`: fetch the work item type(s) by id and validate.
+   * - Otherwise: reject.
+   */
+  private async isFlatQueryAllowedByTypeOrId(
+    queryNode: any,
+    wiql: string,
+    allowedTypes: string[],
+    workItemTypeCache: Map<string, string | null>
+  ): Promise<boolean> {
     const wiqlStr = String(wiql || '');
-    const eqRe = /\[System\.WorkItemType\]\s*=\s*'([^']+)'/gi;
-    const inRe = /\[System\.WorkItemType\]\s+IN\s*\(([^)]+)\)/gi;
 
-    const found = new Set<string>();
-    let m: RegExpExecArray | null;
-    while ((m = eqRe.exec(wiqlStr)) !== null) {
-      found.add(m[1].trim().toLowerCase());
+    // Preserve existing behavior when no allowedTypes are provided.
+    if (!allowedTypes || allowedTypes.length === 0) {
+      return /\[System\.WorkItemType\]/i.test(wiqlStr);
     }
-    while ((m = inRe.exec(wiqlStr)) !== null) {
-      const inner = m[1];
-      for (const mm of inner.matchAll(/'([^']+)'/g)) {
-        found.add(String(mm[1]).trim().toLowerCase());
-      }
+
+    const allowed = this.normalizeAllowedTypes(allowedTypes);
+    const typeFieldPattern = this.buildWiqlFieldPattern(null, 'System.WorkItemType');
+    const typesInWiql = this.extractQuotedValuesForField(wiqlStr, typeFieldPattern);
+    if (typesInWiql.size > 0) {
+      return this.areAllAllowed(typesInWiql, allowed);
     }
 
-    if (found.size === 0) return false;
+    const ids = this.extractWorkItemIdsFromWiql(wiqlStr);
+    if (ids.length === 0) return false;
+
+    const project = this.getProjectFromQueryNode(queryNode);
+    if (!project) return false;
 
-    const allowed = new Set(allowedTypes.map((t) => String(t).toLowerCase()));
-    for (const t of found) {
-      if (!allowed.has(t)) return false;
+    for (const id of ids) {
+      const wiType = await this.getWorkItemTypeById(project, id, workItemTypeCache);
+      if (!wiType) return false;
+      if (!allowed.has(String(wiType).toLowerCase())) return false;
     }
+
     return true;
   }
 
+  /**
+   * Fetches the work item type for a given work item ID.
+   * Uses caching to avoid repeated API calls.
+   *
+   * @param project The project name
+   * @param id The work item ID
+   * @param workItemTypeCache The cache map for work item types
+   * @returns The work item type or null if not found
+   */
+  private async getWorkItemTypeById(
+    project: string,
+    id: string,
+    workItemTypeCache: Map<string, string | null>
+  ): Promise<string | null> {
+    const cacheKey = `${project}:${id}`;
+    if (workItemTypeCache.has(cacheKey)) {
+      return workItemTypeCache.get(cacheKey) ?? null;
+    }
+
+    try {
+      const url = `${this.orgUrl}${project}/_apis/wit/workitems/${id}?fields=System.WorkItemType`;
+      const wi = await this.limit(() => TFSServices.getItemContent(url, this.token));
+      const wiType = wi?.fields?.['System.WorkItemType'];
+      const normalized = wiType ? String(wiType) : null;
+      workItemTypeCache.set(cacheKey, normalized);
+      return normalized;
+    } catch (e) {
+      workItemTypeCache.set(cacheKey, null);
+      return null;
+    }
+  }
+
   /**
    * Matches flat query WIQL against an area path filter by checking any referenced [System.AreaPath].
    * Compares only the leaf segment of the path and performs a case-insensitive substring match.
    */
   private matchesFlatAreaCondition(wiql: string, areaFilter: string): boolean {
-    const filter = String(areaFilter || '').trim().toLowerCase();
+    const filter = String(areaFilter || '')
+      .trim()
+      .toLowerCase();
     if (!filter) return true;
 
     const wiqlLower = String(wiql || '').toLowerCase();
@@ -2355,30 +2541,4 @@ export default class TicketsDataProvider {
       throw err;
     }
   }
-
-  /**
-   * Helper method to flatten a tree structure into a flat array of work items
-   */
-  private flattenTreeToWorkItems(roots: any[]): any[] {
-    const result: any[] = [];
-
-    const traverse = (node: any) => {
-      if (!node) return;
-
-      result.push({
-        id: node.id,
-        title: node.title,
-        description: node.description,
-        htmlUrl: node.htmlUrl,
-        url: node.htmlUrl, // Some nodes might use url instead
-      });
-
-      if (Array.isArray(node.children)) {
-        node.children.forEach(traverse);
-      }
-    };
-
-    roots.forEach(traverse);
-    return result;
-  }
 }