@elisra-devops/docgen-data-provider 1.141.0 → 1.143.0

package/src/helpers/tfs.ts

@@ -1,5 +1,6 @@
 import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import logger from '../utils/logger';
+import { AdoRequestContext, annotateAdoError, buildAdoRequestContext, templatePath } from './requestContext';
 
 // Environment detection
 const isNode = typeof window === 'undefined' && typeof process !== 'undefined' && process.versions?.node;
@@ -83,7 +84,7 @@ export class TFSServices {
       return res;
     } catch (e) {
       logger.error(`error download zip file , url : ${url}`);
-      throw new Error(String(e));
+      throw annotateAdoError(new Error(String(e)), buildAdoRequestContext(e, { method: 'GET', url }));
     }
   }
 
@@ -178,7 +179,7 @@ export class TFSServices {
       const result = await this.axiosInstance.request(config);
       return result.data;
     } catch (e: any) {
-      this.logDetailedError(e, url);
+      this.reportFailure(e, { method: 'GET', url });
       throw e;
     }
   }
@@ -203,7 +204,7 @@ export class TFSServices {
       const result = await this.axiosInstance.request(config);
       return result;
     } catch (e: any) {
-      this.logDetailedError(e, url);
+      this.reportFailure(e, { method: requestMethod, url, data });
       throw e;
     }
   }
@@ -241,15 +242,18 @@ export class TFSServices {
           const jitter = Math.random() * 0.3 + 0.85; // Between 0.85 and 1.15
           const delay = Math.min(baseDelay * Math.pow(2, attempts - 1) * jitter, 5000);
 
-          logger.warn(`Request failed. Retrying in ${Math.round(delay)}ms (${attempts}/${maxAttempts})`);
+          const retryCtx = buildAdoRequestContext(e, { method: config.method, url, data: config.data }, attempts);
+          logger.warn(
+            `ADO request retrying: ${retryCtx.method} ${templatePath(retryCtx.url)} -> ${retryCtx.status ?? e?.code ?? 'no response'} (${attempts}/${maxAttempts}, in ${Math.round(delay)}ms)`,
+            { adoRequest: retryCtx }
+          );
           await new Promise((resolve) => setTimeout(resolve, delay));
           continue;
         }
 
-        // Log error if needed
-        if (printError) {
-          this.logDetailedError(e, url, attempts);
-        }
+        // Always annotate (so any caller that logs this error — however it words its own
+        // message — carries the request), log the dedicated record only when asked to.
+        this.reportFailure(e, { method: config.method, url, data: config.data }, attempts, printError);
 
         throw e;
       }
@@ -284,28 +288,34 @@ export class TFSServices {
   }
 
   /**
-   * Log detailed error information
+   * Describes the failed request once, attaches it to the error, and (optionally) emits the one
+   * dedicated "ADO request failed" record.
    */
-  private static logDetailedError(error: any, url: string, attempt?: number): void {
-    let responseExcerpt: string | undefined;
-    if (error.response?.data) {
-      if (typeof error.response.data === 'string') {
-        responseExcerpt = error.response.data.substring(0, 200);
-      } else {
-        try {
-          responseExcerpt = error.response.data.message || JSON.stringify(error.response.data).substring(0, 200);
-        } catch {
-          responseExcerpt = '[unserializable response data]';
-        }
-      }
+  private static reportFailure(
+    error: any,
+    request: { method?: string; url: string; data?: unknown },
+    attempt?: number,
+    print: boolean = true
+  ): void {
+    const context = buildAdoRequestContext(error, request, attempt);
+    context.reported = print;
+    annotateAdoError(error, context);
+    if (print) {
+      this.logDetailedError(error, context);
     }
-    logger.error('ADO request failed', {
-      message: error.message,
-      stack: error.stack,
-      url,
-      status: error.response?.status,
-      responseExcerpt,
-      attempt,
+  }
+
+  /**
+   * Log detailed error information
+   */
+  private static logDetailedError(error: any, context: AdoRequestContext): void {
+    // The method, templated path and status go in the message itself: Issue grouping keys off
+    // the message, and a bare "ADO request failed" folded 401/404/500 on every endpoint into one.
+    const outcome = context.status ?? error?.code ?? 'no response';
+    logger.error(`ADO request failed: ${context.method ?? 'GET'} ${templatePath(context.url)} -> ${outcome}`, {
+      message: error?.message,
+      stack: error?.stack,
+      adoRequest: context,
     });
   }
 

package/src/modules/GitDataProvider.ts

@@ -1,6 +1,7 @@
 import { TFSServices } from '../helpers/tfs';
 import TicketsDataProvider from './TicketsDataProvider';
 import logger from '../utils/logger';
+import { describeError, logCaughtError } from '../helpers/requestContext';
 import {
   createLinkedRelation,
   createRequirementRelation,
@@ -124,7 +125,7 @@ export default class GitDataProvider {
       }
       return undefined;
     } catch (err: any) {
-      logger.warn(`File ${fileName} could not be read: ${err.message}`);
+      logger.warn(`File ${fileName} could not be read:`, describeError(err));
       return undefined;
     }
   }
@@ -1119,7 +1120,7 @@ export default class GitDataProvider {
         submodules.push(subModule);
       }
     } catch (error: any) {
-      logger.error(`Error in getSubmodulesData: ${error.message}`);
+      logCaughtError('Error in getSubmodulesData:', error);
     } finally {
       return submodules;
     }

package/src/modules/JfrogDataProvider.ts

@@ -1,6 +1,7 @@
 import { TFSServices } from '../helpers/tfs';
 
 import logger from '../utils/logger';
+import { logCaughtError } from '../helpers/requestContext';
 
 export default class JfrogDataProvider {
   orgUrl: string = '';
@@ -56,7 +57,7 @@ export default class JfrogDataProvider {
       logger.debug(`CI Url from JFROG: ${getCiResponse.buildInfo.url}`);
       return getCiResponse.buildInfo.url;
     } catch (err: any) {
-      logger.error(`Error occurred during querying JFrog using: ${err.message}`);
+      logCaughtError('Error occurred during querying JFrog using:', err);
       throw err;
     }
   }

package/src/modules/PipelinesDataProvider.ts

@@ -2,6 +2,7 @@ import { PipelineRun, Repository, ResourceRepository } from '../models/tfs-data'
 import { TFSServices } from '../helpers/tfs';
 
 import logger from '../utils/logger';
+import { logCaughtError } from '../helpers/requestContext';
 import GitDataProvider from './GitDataProvider';
 const pLimit = require('p-limit');
 const MAX_DISCOVERY_PAGES = 50;
@@ -1331,7 +1332,7 @@ export default class PipelinesDataProvider {
       }
       return res;
     } catch (err: any) {
-      logger.error(`Could not fetch Pipeline Run History: ${err.message}`);
+      logCaughtError('Could not fetch Pipeline Run History:', err);
     }
   }
 
@@ -1401,7 +1402,7 @@ export default class PipelinesDataProvider {
         // Azure DevOps returns continuation token header for next page
         continuationToken = this.getContinuationToken(headers);
       } catch (err: any) {
-        logger.error(`GetAllReleaseHistory failed: ${err.message}`);
+        logCaughtError('GetAllReleaseHistory failed:', err);
         throw err;
       }
     } while (continuationToken);
@@ -1463,7 +1464,7 @@ export default class PipelinesDataProvider {
         }
       }
     } catch (err: any) {
-      logger.error(`Error fetching pipeline ${pipelineRunId} with url ${url} : ${err.message}`);
+      logCaughtError(`Error fetching pipeline ${pipelineRunId} with url ${url} :`, err);
       return undefined;
     }
   }

package/src/modules/ResultDataProvider.ts

@@ -22,6 +22,7 @@ import type {
   MewpRunStatus,
 } from '../models/mewp-reporting';
 import logger from '../utils/logger';
+import { describeError, logCaughtError } from '../helpers/requestContext';
 import MewpExternalIngestionUtils from '../utils/mewpExternalIngestionUtils';
 import MewpExternalTableUtils, {
   MewpExternalFileValidationError,
@@ -139,7 +140,7 @@ export default class ResultDataProvider {
           this.fetchTestPoints(projectName, testPlanId, suite.testSuiteId)
             .then((testPointsItems) => ({ ...suite, testPointsItems }))
             .catch((error: any) => {
-              logger.error(`Error occurred for suite ${suite.testSuiteId}: ${error.message}`);
+              logCaughtError(`Error occurred for suite ${suite.testSuiteId}:`, error);
               return { ...suite, testPointsItems: [] };
             })
         )
@@ -274,7 +275,7 @@ export default class ResultDataProvider {
           responseSummary = '[unserializable response data]';
         }
       }
-      logger.error(`Error during getCombinedResultsSummary: ${error.message}`, { responseSummary });
+      logger.error('Error during getCombinedResultsSummary:', { ...describeError(error), responseSummary });
       // Ensure the error is rethrown to propagate it correctly
       throw new Error(error.message || 'Unknown error occurred during getCombinedResultsSummary');
     }
@@ -402,7 +403,7 @@ export default class ResultDataProvider {
 
       return fetchedTestResults;
     } catch (error: any) {
-      logger.error(`Error during getTestReporterResults: ${error.message}`);
+      logCaughtError('Error during getTestReporterResults:', error);
     }
   }
 
@@ -443,7 +444,7 @@ export default class ResultDataProvider {
 
       return { planId: testPlanId, planName, rows: rows || [] };
     } catch (error: any) {
-      logger.error(`Error during getTestReporterFlatResults: ${error.message}`);
+      logCaughtError('Error during getTestReporterFlatResults:', error);
       return { planId: testPlanId, planName: '', rows: [] };
     }
   }
@@ -745,7 +746,7 @@ export default class ResultDataProvider {
         rows,
       };
     } catch (error: any) {
-      logger.error(`Error during getMewpL2CoverageFlatResults: ${error.message}`);
+      logCaughtError('Error during getMewpL2CoverageFlatResults:', error);
       if (error instanceof MewpExternalFileValidationError) {
         throw error;
       }
@@ -1122,7 +1123,7 @@ export default class ResultDataProvider {
         rows,
       };
     } catch (error: any) {
-      logger.error(`Error during getMewpInternalValidationFlatResults: ${error.message}`);
+      logCaughtError('Error during getMewpInternalValidationFlatResults:', error);
       return defaultPayload;
     }
   }
@@ -3071,7 +3072,7 @@ export default class ResultDataProvider {
       const testPlan = await TFSServices.getItemContent(url, this.token);
       return testPlan.name;
     } catch (error: any) {
-      logger.error(`Error during fetching Test Plan Name: ${error.message}`);
+      logCaughtError('Error during fetching Test Plan Name:', error);
       return '';
     }
   }
@@ -3119,7 +3120,7 @@ export default class ResultDataProvider {
         };
       });
     } catch (error: any) {
-      logger.error(`Error during fetching Test Suites: ${error.message}`);
+      logCaughtError('Error during fetching Test Suites:', error);
       return [];
     }
   }
@@ -3292,7 +3293,7 @@ export default class ResultDataProvider {
 
       return count !== 0 ? testPoints.map((testPoint: any) => this.mapTestPoint(testPoint, projectName)) : [];
     } catch (error: any) {
-      logger.error(`Error during fetching Test Points: ${error.message}`);
+      logCaughtError('Error during fetching Test Points:', error);
       return [];
     }
   }
@@ -4473,7 +4474,7 @@ export default class ResultDataProvider {
             relatedCRs.push({ id, title, workItemType: 'Change Request', url });
           }
         } catch (err: any) {
-          logger.error(`Could not append related work item to test case ${wiByRevision.id}: ${err.message}`);
+          logCaughtError(`Could not append related work item to test case ${wiByRevision.id}:`, err);
         }
       }
     }
@@ -4856,7 +4857,7 @@ export default class ResultDataProvider {
 
             return { ...suite, testPointsItems, testCasesItems };
           } catch (error: any) {
-            logger.error(`Error occurred for suite ${suite.testSuiteId}: ${error.message}`);
+            logCaughtError(`Error occurred for suite ${suite.testSuiteId}:`, error);
             return suite;
           }
         })

package/src/modules/TestDataProvider.ts

@@ -4,6 +4,7 @@ import { TestSteps, createMomRelation, createRequirementRelation } from '../mode
 import { TestCase } from '../models/tfs-data';
 import * as xml2js from 'xml2js';
 import logger from '../utils/logger';
+import { logCaughtError } from '../helpers/requestContext';
 import Utils from '../utils/testStepParserHelper';
 import DataProviderUtils from '../utils/DataProviderUtils';
 const pLimit = require('p-limit');
@@ -56,7 +57,7 @@ export default class TestDataProvider {
 
       return result;
     } catch (error: any) {
-      logger.error(`Error fetching ${url}: ${error.message}`);
+      logCaughtError(`Error fetching ${url}:`, error);
       throw error;
     }
   }
@@ -187,7 +188,7 @@ export default class TestDataProvider {
     try {
       return await this.fetchWithCache(testsuitesUrl);
     } catch (e: any) {
-      logger.error(`Failed to get test suites: ${e.message}`);
+      logCaughtError('Failed to get test suites:', e);
       return null;
     }
   }
@@ -599,7 +600,7 @@ export default class TestDataProvider {
         }
       }
     } catch (err: any) {
-      logger.error(`Error: ${err.message} while trying to structure testCases for test suite ${suite.id}`);
+      logCaughtError(`Error while trying to structure testCases for test suite ${suite.id}:`, err);
     }
 
     return testCasesUrlList;

package/src/modules/TicketsDataProvider.ts

@@ -10,6 +10,7 @@ import { TestSteps } from '../models/tfs-data';
 import TestStepParserHelper from '../utils/testStepParserHelper';
 
 import logger from '../utils/logger';
+import { describeError, logCaughtError } from '../helpers/requestContext';
 const pLimit = require('p-limit');
 
 type FallbackFetchOutcome = {
@@ -491,7 +492,7 @@ export default class TicketsDataProvider {
           break;
       }
     } catch (err: any) {
-      logger.error(`Error occurred during fetching shared queries: ${err.message}`);
+      logCaughtError('Error occurred during fetching shared queries:', err);
       throw err;
     }
   }
@@ -527,7 +528,7 @@ export default class TicketsDataProvider {
           })
       );
     } catch (err: any) {
-      logger.error(`Error occurred during fetching fields by type: ${err.message}`);
+      logCaughtError('Error occurred during fetching fields by type:', err);
       throw err;
     }
   }
@@ -558,7 +559,7 @@ export default class TicketsDataProvider {
       }
       return { types, states: Array.from(stateSet) };
     } catch (err: any) {
-      logger.error(`Error fetching work item type states: ${err.message}`);
+      logCaughtError('Error fetching work item type states:', err);
       throw err;
     }
   }
@@ -1286,7 +1287,7 @@ export default class TicketsDataProvider {
           break;
       }
     } catch (err: any) {
-      logger.error(`Could not fetch query results for ${wiqlHref}: ${err.message}`);
+      logCaughtError(`Could not fetch query results for ${wiqlHref}:`, err);
     }
   }
 
@@ -1662,7 +1663,7 @@ export default class TicketsDataProvider {
       }
       return [...workItemsResultMap.values()];
     } catch (error: any) {
-      logger.error(`could not parse requested flat query: ${error.message}`);
+      logCaughtError('could not parse requested flat query:', error);
     }
   }
 
@@ -3562,7 +3563,7 @@ export default class TicketsDataProvider {
 
       item.fields = { ...parsedFields };
     } catch (err: any) {
-      logger.error(`Cannot filter columns: ${err.message}`);
+      logCaughtError('Cannot filter columns:', err);
       throw err;
     }
   }
@@ -3617,7 +3618,7 @@ export default class TicketsDataProvider {
 
       return workItemTypesWithIcons;
     } catch (err: any) {
-      logger.error(`Error occurred during fetching work item types: ${err.message}`);
+      logCaughtError('Error occurred during fetching work item types:', err);
       throw err;
     }
   }
@@ -3770,7 +3771,7 @@ export default class TicketsDataProvider {
             categorizedRequirements['Precedence and Criticality of Requirements'].push(requirementItem);
           }
         } catch (err: any) {
-          logger.warn(`Could not fetch work item ${workItemId}: ${err.message}`);
+          logger.warn(`Could not fetch work item ${workItemId}:`, describeError(err));
         }
       }
 
@@ -3792,7 +3793,7 @@ export default class TicketsDataProvider {
         totalCount: workItemIds.length,
       };
     } catch (err: any) {
-      logger.error(`Could not fetch categorized requirements: ${err.message}`);
+      logCaughtError('Could not fetch categorized requirements:', err);
       throw err;
     }
   }
@@ -3887,7 +3888,7 @@ export default class TicketsDataProvider {
           const relations = qr?.workItemRelations || [];
           result['req-test'] = await resolveQuerySides(cols, relations, true);
         } catch (err: any) {
-          logger.error(`GetTraceColumnsByType[req-test] failed: ${err.message}`);
+          logCaughtError('GetTraceColumnsByType[req-test] failed:', err);
           result['req-test'] = { Requirement: [], 'Test Case': [] };
         }
       }
@@ -3899,14 +3900,14 @@ export default class TicketsDataProvider {
           const relations = qr?.workItemRelations || [];
           result['test-req'] = await resolveQuerySides(cols, relations, false);
         } catch (err: any) {
-          logger.error(`GetTraceColumnsByType[test-req] failed: ${err.message}`);
+          logCaughtError('GetTraceColumnsByType[test-req] failed:', err);
           result['test-req'] = { Requirement: [], 'Test Case': [] };
         }
       }
 
       return result;
     } catch (err: any) {
-      logger.error(`GetTraceColumnsByType failed: ${err.message}`);
+      logCaughtError('GetTraceColumnsByType failed:', err);
       return {};
     }
   }