@elisra-devops/docgen-data-provider 1.130.0 → 1.132.0

package/src/modules/JfrogDataProvider.ts

@@ -14,8 +14,11 @@ export default class JfrogDataProvider {
   }
 
   async getServiceConnectionUrlByConnectionId(teamProject: string, connectionId: string) {
-    let url = `${this.orgUrl}${teamProject}/_apis/serviceendpoint/endpoints/${connectionId}?api-version=6`;
+    let url = `${this.orgUrl}${teamProject}/_apis/serviceendpoint/endpoints/${connectionId}?api-version=7.1`;
     const serviceConnectionResponse = await TFSServices.getItemContent(url, this.tfsToken);
+    if (!serviceConnectionResponse?.url) {
+      throw new Error(`Service connection ${connectionId} returned no URL — identity may lack service-endpoint read permission`);
+    }
     logger.debug(`service connection url ${JSON.stringify(serviceConnectionResponse.url)}`);
     return serviceConnectionResponse.url;
   }
@@ -23,6 +26,11 @@ export default class JfrogDataProvider {
   async getCiDataFromJfrog(jfrogUrl: string, buildName: string, buildVersion: string): Promise<string> {
     let jfrogHeader: any = {};
     try {
+      if (!jfrogUrl) {
+        throw new Error(
+          `JFrog service connection URL is unresolved for build "${buildName}" — the caller identity may lack service-endpoint read permission`
+        );
+      }
       if (this.jfrogToken !== '') {
         jfrogHeader['Authorization'] = `Bearer ${this.jfrogToken}`;
       }
@@ -42,6 +50,9 @@ export default class JfrogDataProvider {
         this.jfrogToken !== ''
           ? await TFSServices.getJfrogRequest(getCiRequestUrl, jfrogHeader)
           : await TFSServices.getJfrogRequest(getCiRequestUrl);
+      if (!getCiResponse?.buildInfo?.url) {
+        throw new Error(`JFrog response for build "${buildName}${buildVersion}" is missing buildInfo.url`);
+      }
       logger.debug(`CI Url from JFROG: ${getCiResponse.buildInfo.url}`);
       return getCiResponse.buildInfo.url;
     } catch (err: any) {

package/src/modules/TicketsDataProvider.ts

@@ -514,6 +514,37 @@ export default class TicketsDataProvider {
     }
   }
 
+  /**
+   * Returns the project's work item type names and the complete set of valid state names.
+   * Used to validate SVD work-item filter options before generation so callers receive
+   * a descriptive error instead of a silent zero-result document.
+   *
+   * Types come from GET _apis/wit/workitemtypes (value[].name).
+   * States are extracted from the transitions map keys on the same response — each key
+   * is a state name — avoiding N extra per-type state calls.
+   *
+   * @param project - The project name.
+   * @returns An object with `types` (work item type names) and `states` (all state names across types).
+   */
+  async GetWorkItemTypeStates(project: string): Promise<{ types: string[]; states: string[] }> {
+    try {
+      const url = `${this.orgUrl}${project}/_apis/wit/workitemtypes`;
+      const { value: workItemTypes } = await TFSServices.getItemContent(url, this.token);
+      const types: string[] = (workItemTypes ?? []).map((t: any) => t?.name).filter(Boolean);
+      // transitions is a map whose keys are state names (e.g. { "Active": [...], "Closed": [...] })
+      const stateSet = new Set<string>();
+      for (const t of workItemTypes ?? []) {
+        for (const stateName of Object.keys(t?.transitions ?? {})) {
+          if (stateName) stateSet.add(stateName);
+        }
+      }
+      return { types, states: Array.from(stateSet) };
+    } catch (err: any) {
+      logger.error(`Error fetching work item type states: ${err.message}`);
+      throw err;
+    }
+  }
+
   /**
    * fetches linked queries
    * @param queries fetched queries
@@ -2334,7 +2365,7 @@ export default class TicketsDataProvider {
     const postBatch = (currentIds: any[]) =>
       this.withHistoricalApiVersionFallback('populate-workitems-batch', (apiVersion) =>
         TFSServices.getItemContent(this.appendApiVersion(baseUrl, apiVersion), this.token, 'post', {
-          $expand: 'Relations',
+          $expand: 'All',
           ids: currentIds,
         }),
       ).then(({ result }) => result);

package/src/tests/modules/JfrogDataProvider.test.ts

@@ -33,7 +33,7 @@ describe('JfrogDataProvider', () => {
 
       // Assert
       expect(TFSServices.getItemContent).toHaveBeenCalledWith(
-        `${mockOrgUrl}${mockTeamProject}/_apis/serviceendpoint/endpoints/${mockConnectionId}?api-version=6`,
+        `${mockOrgUrl}${mockTeamProject}/_apis/serviceendpoint/endpoints/${mockConnectionId}?api-version=7.1`,
         mockTfsToken
       );
       expect(logger.debug).toHaveBeenCalledWith(`service connection url "${mockResponse.url}"`);

package/src/tests/modules/gitDataProvider.test.ts

@@ -1129,8 +1129,8 @@ describe('GitDataProvider - GetItemsInCommitRange', () => {
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST for work items
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange (default: includePullRequestWorkItems=true)
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(projectId, repoId, commitRange, null, false);
@@ -1248,7 +1248,7 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
 
     (TFSServices.getItemContent as jest.Mock)
       .mockResolvedValueOnce(mockRepoData)
-      .mockResolvedValueOnce(mockPopulatedWI);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }); // batch POST for work items
 
     // Act
     const result = await gitDataProvider.getItemsForPipelineRange(
@@ -1320,8 +1320,7 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
 
     (TFSServices.getItemContent as jest.Mock)
       .mockResolvedValueOnce(mockRepoData)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPopulatedWI);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }); // single batch POST (WI id=1 deduped)
 
     // Act
     const result = await gitDataProvider.getItemsForPipelineRange(
@@ -1361,8 +1360,8 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
     const mockPopulatedWI = { id: 42, fields: { 'System.Title': 'Cross-project WI' } };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockRepoDataNoCrossLink) // repo metadata call
-      .mockResolvedValueOnce(mockPopulatedWI);        // GetWorkItem call
+      .mockResolvedValueOnce(mockRepoDataNoCrossLink)        // repo metadata call
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }); // batch POST for work items
 
     const result = await gitDataProvider.getItemsForPipelineRange(
       pipelineTeamProject,
@@ -1373,10 +1372,12 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
 
     expect(result.commitChangesArray).toHaveLength(1);
     expect(result.commitChangesArray[0].workItem.id).toBe(42);
-    // GetWorkItem should have been called with the repo's own projectId from repoData.project.id
+    // batch POST URL contains the repo's projectId (cross-project-id)
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
       expect.stringContaining('cross-project-id'),
-      expect.any(String)
+      expect.any(String),
+      'post',
+      expect.objectContaining({ ids: expect.any(Array) })
     );
   });
 
@@ -1401,7 +1402,7 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
 
     (TFSServices.getItemContent as jest.Mock)
       .mockResolvedValueOnce(mockRepoDataEmpty)
-      .mockResolvedValueOnce(mockPopulatedWI);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }); // batch POST for work items
 
     const result = await gitDataProvider.getItemsForPipelineRange(
       pipelineTeamProject,
@@ -1412,10 +1413,12 @@ describe('GitDataProvider - getItemsForPipelineRange', () => {
 
     expect(result.commitChangesArray).toHaveLength(1);
     expect(result.commitChangesArray[0].workItem.id).toBe(99);
-    // GetWorkItem should have been called with the pipeline teamProject as fallback
+    // batch POST URL contains the fallback teamProject
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
       expect.stringContaining(pipelineTeamProject),
-      expect.any(String)
+      expect.any(String),
+      'post',
+      expect.objectContaining({ ids: expect.any(Array) })
     );
     expect(logger.warn).toHaveBeenCalledWith(
       expect.stringContaining(`falling back to pipeline teamProject=${pipelineTeamProject}`)
@@ -1774,9 +1777,9 @@ describe('GitDataProvider - createLinkedRelatedItemsForSVD (via GetItemsInCommit
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockRelatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST for work items
+      .mockResolvedValueOnce(mockRelatedWI)                // GetWorkItemByUrl (linked relation)
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(
@@ -1826,8 +1829,8 @@ describe('GitDataProvider - createLinkedRelatedItemsForSVD (via GetItemsInCommit
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST for work items
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(
@@ -1877,8 +1880,8 @@ describe('GitDataProvider - createLinkedRelatedItemsForSVD (via GetItemsInCommit
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST for work items
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(
@@ -1936,9 +1939,9 @@ describe('GitDataProvider - createLinkedRelatedItemsForSVD (via GetItemsInCommit
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockRelatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST for work items
+      .mockResolvedValueOnce(mockRelatedWI)                // GetWorkItemByUrl (linked relation)
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(
@@ -2105,9 +2108,8 @@ describe('GitDataProvider - duplicate work item removal', () => {
     const mockPRsResponse = { count: 0, value: [] };
 
     (TFSServices.getItemContent as jest.Mock)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPopulatedWI)
-      .mockResolvedValueOnce(mockPRsResponse);
+      .mockResolvedValueOnce({ value: [mockPopulatedWI] }) // batch POST (WI id=1 deduped from 2 commits)
+      .mockResolvedValueOnce(mockPRsResponse);             // GetPullRequestsLinkedItemsInCommitRange
 
     // Act
     const result = await gitDataProvider.GetItemsInCommitRange(projectId, repoId, commitRange, null, false);