@elisra-devops/docgen-data-provider 1.69.13 → 1.69.15

package/src/modules/PipelinesDataProvider.ts

@@ -218,6 +218,21 @@ export default class PipelinesDataProvider {
     return `refs/heads/${b}`;
   }
 
+  private tryBuildBuildApiUrlFromPipelinesApiUrl(url?: string): string | undefined {
+    if (!url) return undefined;
+    try {
+      const parsed = new URL(url);
+      parsed.search = '';
+      const before = parsed.pathname;
+      const after = before.replace('/_apis/pipelines/', '/_apis/build/builds/');
+      if (after === before) return undefined;
+      parsed.pathname = after;
+      return parsed.toString();
+    } catch {
+      return undefined;
+    }
+  }
+
   /**
    * Searches for a build by build number without restricting by definition id.
    *
@@ -272,8 +287,7 @@ export default class PipelinesDataProvider {
     if (projectName) {
       try {
         return await this.getPipelineBuildByBuildId(projectName, buildId);
-      } catch (e1: any) {
-      }
+      } catch (e1: any) {}
     }
 
     // Some ADO instances allow build lookup without the {project} path segment.
@@ -350,7 +364,9 @@ export default class PipelinesDataProvider {
       return undefined;
     } catch (e: any) {
       logger.error(
-        `Error resolving runId by runName for pipeline ${pipelineId} (${projectName}/${desired}): ${e?.message || e}`
+        `Error resolving runId by runName for pipeline ${pipelineId} (${projectName}/${desired}): ${
+          e?.message || e
+        }`
       );
       return undefined;
     }
@@ -431,9 +447,7 @@ export default class PipelinesDataProvider {
     const definitionType = buildResponse?.definition?.type;
     const repoType = buildResponse?.repository?.type;
     return (
-      !!buildResponse &&
-      definitionType === 'build' &&
-      (repoType === 'TfsGit' || repoType === 'azureReposGit')
+      !!buildResponse && definitionType === 'build' && (repoType === 'TfsGit' || repoType === 'azureReposGit')
     );
   }
 
@@ -461,17 +475,18 @@ export default class PipelinesDataProvider {
     const resourcePipelinesByKey: Map<string, any> = new Map();
 
     if (!inPipeline?.resources?.pipelines) {
-      return new Set();
+      logger.debug('getPipelineResourcePipelinesFromObject: no pipeline resources on run');
+      return [];
     }
     const pipelineEntries = Object.entries(inPipeline.resources.pipelines);
+    logger.debug(
+      `getPipelineResourcePipelinesFromObject: resolving ${pipelineEntries.length} pipeline resources`
+    );
 
     await Promise.all(
       pipelineEntries.map(async ([resourcePipelineAlias, resource]) => {
         const resourcePipelineObj = (resource as any)?.pipeline;
         const pipelineIdCandidate = Number(resourcePipelineObj?.id);
-        const source = (resource as any)?.source;
-        const version = (resource as any)?.version;
-        const branch = (resource as any)?.branch;
 
         const rawProjectName =
           (resource as any)?.project?.name ||
@@ -480,38 +495,101 @@ export default class PipelinesDataProvider {
         const projectName = await this.normalizeProjectName(rawProjectName);
 
         if (!Number.isFinite(pipelineIdCandidate)) {
+          logger.warn(
+            `getPipelineResourcePipelinesFromObject: resource ${resourcePipelineAlias} missing numeric pipeline id`
+          );
           return;
         }
 
-        let runId: number | undefined = this.inferRunIdFromPipelineResource(resource, resourcePipelineObj?.url);
-        if (typeof runId !== 'number' || !Number.isFinite(runId)) {
-          runId = await this.resolveRunIdFromVersion({
-            projectName,
-            pipelineIdCandidate,
-            version,
-            branch,
-            source,
-          });
+        let buildResponse: any;
+        const fixedUrl = this.tryBuildBuildApiUrlFromPipelinesApiUrl(resourcePipelineObj?.url);
+        if (fixedUrl) {
+          try {
+            const fixedBuildResponse = await TFSServices.getItemContent(
+              fixedUrl,
+              this.token,
+              'get',
+              null,
+              null
+            );
+            if (this.isSupportedResourcePipelineBuild(fixedBuildResponse)) {
+              buildResponse = fixedBuildResponse;
+            }
+          } catch (err: any) {
+            logger.error(
+              `Error fetching pipeline ${resourcePipelineAlias} via fixed build url ${fixedUrl} : ${err.message}`
+            );
+          }
+        } else {
+          logger.warn(
+            `getPipelineResourcePipelinesFromObject: could not convert pipelines url to builds url for ${resourcePipelineAlias}: ${String(
+              resourcePipelineObj?.url || ''
+            )}`
+          );
         }
 
-        if (typeof runId !== 'number' || !Number.isFinite(runId)) {
+        // PowerShell-style logic: do not fall back to runId/buildNumber/run-history resolution.
+        if (!this.isSupportedResourcePipelineBuild(buildResponse)) {
+          logger.debug(
+            `getPipelineResourcePipelinesFromObject: skipping ${resourcePipelineAlias} because resolved build is missing/unsupported (project=${String(
+              projectName || ''
+            )}, pipelineIdCandidate=${pipelineIdCandidate})`
+          );
           return;
         }
 
-        let buildResponse: any;
-        try {
-          buildResponse = await this.tryGetBuildByIdWithFallback(projectName, runId);
-        } catch (err: any) {
-          logger.error(`Error fetching pipeline ${resourcePipelineAlias} run ${runId} : ${err.message}`);
-        }
         if (this.isSupportedResourcePipelineBuild(buildResponse)) {
+          const buildNumber = String(buildResponse.buildNumber || '').trim();
+          if (!buildNumber) {
+            logger.warn(
+              `Resource pipeline ${resourcePipelineAlias} resolved to buildId=${String(
+                buildResponse?.id
+              )} but buildNumber is missing, skipping`
+            );
+            return;
+          }
+
+          const expectedProjectName = String(projectName || '').trim();
+          const actualProjectName = String(buildResponse?.project?.name || '').trim();
+          if (
+            expectedProjectName &&
+            actualProjectName &&
+            expectedProjectName.toLowerCase() !== actualProjectName.toLowerCase()
+          ) {
+            logger.warn(
+              `Resource pipeline ${resourcePipelineAlias} resolved to buildId=${String(
+                buildResponse?.id
+              )} but project mismatch expected=${expectedProjectName} actual=${actualProjectName}, skipping`
+            );
+            return;
+          }
+
+          const expectedPipelineName = String(resourcePipelineObj?.name || '').trim();
+          const actualPipelineName = String(buildResponse?.definition?.name || '').trim();
+          if (
+            expectedPipelineName &&
+            actualPipelineName &&
+            expectedPipelineName.toLowerCase() !== actualPipelineName.toLowerCase()
+          ) {
+            logger.warn(
+              `Resource pipeline ${resourcePipelineAlias} resolved to buildId=${String(
+                buildResponse?.id
+              )} but pipeline name mismatch expected=${expectedPipelineName} actual=${actualPipelineName}, skipping`
+            );
+            return;
+          }
           const definitionId = buildResponse.definition?.id ?? pipelineIdCandidate;
-          const buildId = buildResponse.id ?? runId;
+          const buildId = buildResponse.id;
+          logger.debug(
+            `getPipelineResourcePipelinesFromObject: resolved ${resourcePipelineAlias} -> ${String(
+              buildResponse?.project?.name || projectName || ''
+            )}/${definitionId} runId=${buildId} repoType=${String(buildResponse?.repository?.type || '')}`
+          );
           const resourcePipelineToAdd = {
-            name: resourcePipelineAlias,
+            name: resourcePipelineObj?.name ?? resourcePipelineAlias,
             buildId,
             definitionId,
-            buildNumber: buildResponse.buildNumber ?? (resource as any)?.runName ?? (resource as any)?.version,
+            buildNumber,
             teamProject: buildResponse.project?.name ?? projectName,
             provider: buildResponse.repository?.type,
           };
@@ -543,7 +621,7 @@ export default class PipelinesDataProvider {
 
     for (const prop in repositories) {
       const resourceRepo = repositories[prop];
-      if (resourceRepo?.repository?.type !== 'azureReposGit') {
+      if (!['azureReposGit', 'TfsGit'].includes(resourceRepo?.repository?.type)) {
         continue;
       }
       const repoId = resourceRepo.repository.id;
@@ -706,11 +784,18 @@ export default class PipelinesDataProvider {
         url += `&continuationToken=${encodeURIComponent(continuationToken)}`;
       }
       try {
-        const { data, headers } = await TFSServices.getItemContentWithHeaders(url, this.token, 'get', null, null);
+        const { data, headers } = await TFSServices.getItemContentWithHeaders(
+          url,
+          this.token,
+          'get',
+          null,
+          null
+        );
         const { value = [] } = data || {};
         all.push(...value);
         // Azure DevOps returns continuation token header for next page
-        continuationToken = headers?.['x-ms-continuationtoken'] || headers?.['x-ms-continuation-token'] || undefined;
+        continuationToken =
+          headers?.['x-ms-continuationtoken'] || headers?.['x-ms-continuation-token'] || undefined;
         page++;
         logger.debug(`GetAllReleaseHistory: fetched page ${page}, cumulative ${all.length} releases`);
       } catch (err: any) {

package/src/modules/ResultDataProvider.ts

@@ -825,7 +825,7 @@ export default class ResultDataProvider {
 
     const cached = this.workItemDiscussionCache.get(id);
     if (cached !== undefined) {
-      if (cached.length === 0) {
+      if (cached.length === 0 && this.isVerboseHistoryDebugEnabled()) {
         logger.debug(
           `[History] Cache hit but empty for work item ${id} (project=${projectName}, includeAll=${includeAllHistory})`
         );
@@ -833,11 +833,9 @@ export default class ResultDataProvider {
       return includeAllHistory ? cached : cached.slice(0, 1);
     }
 
-    logger.debug(`[History] Cache miss. Fetching discussion for work item ${id} (project=${projectName})`);
-
     const fromComments = await this.tryFetchDiscussionFromComments(projectName, id);
     if (fromComments !== null) {
-      if (fromComments.length === 0) {
+      if (fromComments.length === 0 && this.isVerboseHistoryDebugEnabled()) {
         logger.debug(
           `[History] Comments API returned 0 entries for work item ${id} (project=${projectName}, includeAll=${includeAllHistory})`
         );
@@ -869,11 +867,6 @@ export default class ResultDataProvider {
     const seen = new Set<string>();
     const out: any[] = [];
 
-    let droppedEmpty = 0;
-    let droppedSystem = 0;
-    let droppedAfterStrip = 0;
-    let droppedDup = 0;
-
     for (const e of list) {
       const createdDate = String(e?.createdDate ?? '').trim();
       const createdBy = String(e?.createdBy ?? '').trim();
@@ -881,23 +874,19 @@ export default class ResultDataProvider {
       const text = typeof textRaw === 'string' ? textRaw.trim() : '';
 
       if (!text) {
-        droppedEmpty++;
         continue;
       }
       if (this.isSystemIdentity(createdBy)) {
-        droppedSystem++;
         continue;
       }
 
       const textForKey = this.stripHtmlForEmptiness(text);
       if (!textForKey) {
-        droppedAfterStrip++;
         continue;
       }
 
       const key = `${createdDate}|${createdBy}|${textForKey}`;
       if (seen.has(key)) {
-        droppedDup++;
         continue;
       }
       seen.add(key);
@@ -905,15 +894,23 @@ export default class ResultDataProvider {
       out.push({ createdDate, createdBy, text });
     }
 
-    if (out.length === 0 && list.length > 0) {
-      logger.debug(
-        `[History] normalizeDiscussionEntries dropped all entries (in=${list.length}, empty=${droppedEmpty}, system=${droppedSystem}, afterStrip=${droppedAfterStrip}, dup=${droppedDup})`
-      );
-    }
-
     return out;
   }
 
+  private isVerboseHistoryDebugEnabled(): boolean {
+    return (
+      String(process?.env?.DOCGEN_VERBOSE_HISTORY_DEBUG ?? '').toLowerCase() === 'true' ||
+      String(process?.env?.DOCGEN_VERBOSE_HISTORY_DEBUG ?? '') === '1'
+    );
+  }
+
+  private isRunResultDebugEnabled(): boolean {
+    return (
+      String(process?.env?.DOCGEN_DEBUG_RUNRESULT ?? '').toLowerCase() === 'true' ||
+      String(process?.env?.DOCGEN_DEBUG_RUNRESULT ?? '') === '1'
+    );
+  }
+
   private extractCommentText(comment: AdoWorkItemComment): string {
     const rendered = comment?.renderedText;
     // In Azure DevOps the `renderedText` field can be present but empty ("") even when `text` is populated.
@@ -1037,6 +1034,7 @@ export default class ResultDataProvider {
       let page = 0;
       const MAX_PAGES = 50;
       const seenTokens = new Set<string>();
+      const verbose = this.isVerboseHistoryDebugEnabled();
       const pageResponsesForDebug: { page: number; data: any; headers: any }[] = [];
       let firstPageDebug: { url: string; data: any; headers: any } | null = null;
 
@@ -1058,14 +1056,14 @@ export default class ResultDataProvider {
           TFSServices.getItemContentWithHeaders(url, this.token, 'get', {}, {}, false)
         );
 
-        if (!firstPageDebug) {
+        if (verbose && !firstPageDebug) {
           firstPageDebug = { url, data, headers };
         }
         const response = (data ?? {}) as AdoWorkItemCommentsResponse;
         const comments = Array.isArray(response.comments) ? response.comments : [];
         all.push(...comments);
 
-        if (pageResponsesForDebug.length < 2) {
+        if (verbose && pageResponsesForDebug.length < 2) {
           pageResponsesForDebug.push({ page: page + 1, data, headers });
         }
 
@@ -1089,23 +1087,15 @@ export default class ResultDataProvider {
       } while (continuationToken);
 
       if (all.length === 0) {
-        if (firstPageDebug) {
+        if (verbose && firstPageDebug) {
           logger.debug(
-            `[History][comments] 0 comments returned for work item ${workItemId}. ` +
-              `url=${firstPageDebug.url}`
+            `[History][comments] 0 comments returned for work item ${workItemId}. url=${firstPageDebug.url}`
           );
           logger.debug(
             `[History][comments] Raw comments API response (truncated) for work item ${workItemId} (page=1): ` +
-              this.stringifyForDebug(firstPageDebug.data, 20000)
-          );
-          logger.debug(
-            `[History][comments] Response headers for work item ${workItemId} (page=1): ` +
-              this.stringifyForDebug(firstPageDebug.headers, 2000)
+              this.stringifyForDebug(firstPageDebug.data, 5000)
           );
         }
-
-        await this.debugProbeHistoryFromUpdates(projectName, workItemId);
-        await this.debugProbeHistoryFromRevisions(projectName, workItemId);
         return [];
       }
 
@@ -1149,22 +1139,19 @@ export default class ResultDataProvider {
         .filter(Boolean) as any[];
 
       if (entries.length === 0 && all.length > 0) {
-        logger.debug(
-          `[History][comments] Work item ${workItemId} returned ${all.length} comments but 0 usable entries ` +
-            `(deleted=${deletedCount}, emptyRaw=${emptyRawCount}, emptyAfterStrip=${emptyAfterStripCount}, system=${systemIdentityCount}, pages=${page}, emptyRawIds=${emptyRawIds.join(
-              ','
-            )})`
-        );
-        const maxChars = 20000;
-        for (const p of pageResponsesForDebug) {
-          logger.debug(
-            `[History][comments] Raw comments API response (truncated) for work item ${workItemId} (page=${p.page}): ` +
-              this.stringifyForDebug(p.data, maxChars)
-          );
+        if (verbose) {
           logger.debug(
-            `[History][comments] Response headers for work item ${workItemId} (page=${p.page}): ` +
-              this.stringifyForDebug(p.headers, 2000)
+            `[History][comments] Work item ${workItemId} returned ${all.length} comments but 0 usable entries ` +
+              `(deleted=${deletedCount}, emptyRaw=${emptyRawCount}, emptyAfterStrip=${emptyAfterStripCount}, system=${systemIdentityCount}, pages=${page}, emptyRawIds=${emptyRawIds.join(
+                ','
+              )})`
           );
+          for (const p of pageResponsesForDebug) {
+            logger.debug(
+              `[History][comments] Raw comments API response (truncated) for work item ${workItemId} (page=${p.page}): ` +
+                this.stringifyForDebug(p.data, 5000)
+            );
+          }
         }
       }
 
@@ -1180,6 +1167,7 @@ export default class ResultDataProvider {
   }
 
   private async debugProbeHistoryFromUpdates(projectName: string, workItemId: number): Promise<void> {
+    if (!this.isVerboseHistoryDebugEnabled()) return;
     try {
       const url = `${this.orgUrl}${projectName}/_apis/wit/workItems/${workItemId}/updates?$top=200&api-version=7.1-preview.3`;
       const { data, headers } = await this.limit(() =>
@@ -1232,12 +1220,6 @@ export default class ResultDataProvider {
           `[History][updates] No System.History found for work item ${workItemId}. ` +
             `Field keys seen (first ${fieldKeys.length}): ${this.stringifyForDebug(fieldKeys, 4000)}`
         );
-        logger.debug(
-          `[History][updates] Sample update payloads (truncated) for work item ${workItemId}: ${this.stringifyForDebug(
-            updateSamplesForDebug,
-            20000
-          )}`
-        );
       }
 
       const continuation = this.getContinuationToken(headers, undefined);
@@ -1254,6 +1236,7 @@ export default class ResultDataProvider {
   }
 
   private async debugProbeHistoryFromRevisions(projectName: string, workItemId: number): Promise<void> {
+    if (!this.isVerboseHistoryDebugEnabled()) return;
     try {
       const url = `${this.orgUrl}${projectName}/_apis/wit/workItems/${workItemId}/revisions?$top=200&api-version=7.1-preview.3`;
       const { data } = await this.limit(() =>