RHDHBUGS-2095 Scorecard plugin should use a stable api version instead of latest (#1586)

* fix(scorecard): using apiVersion for jira integration

Signed-off-by: Ihor Mykhno <[email protected]>

* refactor(scorecard): using jira apiVersion directly in Cloud and Data Center Strategies

Signed-off-by: Ihor Mykhno <[email protected]>

* chore(scorecard): update jira integration changeset

Signed-off-by: Ihor Mykhno <[email protected]>

---------

Signed-off-by: Ihor Mykhno <[email protected]>

Author: imykhno

workspaces/scorecard/.changeset/cold-moments-wave.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira': major
+---
+
+**BREAKING** The apiVersion is now deprecated and should no longer be used in the **app-config.yaml** configuration. Default supported version for Jira Data Center is 2 and for Jira Cloud is 3

workspaces/scorecard/app-config.local.EXAMPLE.yaml

@@ -54,7 +54,6 @@ jira:
   product: cloud
   baseUrl: ${JIRA_URL}
   token: ${JIRA_TOKEN}
-  #apiVersion: 3
 
 scorecard:
   plugins:

workspaces/scorecard/app-config.yaml

@@ -55,17 +55,16 @@ proxy:
 
 # Jira plugin and scorecard configuration
 jira:
-  # optional: Use the proxy configuration above
+  # Proxy Jira configuration
+  # Supported products: `cloud` or `datacenter`
+  # product: cloud
   # proxyPath: /jira/api
 
-  # Required
+  # Direct Jira configuration
+  # Supported products: `cloud` or `datacenter`
+  product: cloud
   baseUrl: ${JIRA_URL}
-  # Required
   token: ${JIRA_TOKEN}
-  # Required: Supported products: `cloud` or `datacenter`
-  product: cloud
-  # By default, the latest version is used. You can omit this prop when using the latest version.
-  apiVersion: 2
 
 # Reference documentation http://backstage.io/docs/features/techdocs/configuration
 # Note: After experimenting with basic setup, use CI/CD to generate docs

workspaces/scorecard/plugins/scorecard-backend-module-jira/README.md

@@ -2,6 +2,11 @@
 
 This is an extension module to the `backstage-plugin-scorecard-backend` plugin. It provides Jira-specific metrics for software components registered in the Backstage catalog.
 
+## Supported versions
+
+- Supported API version for Jira Cloud is **3**.
+- Supported API version for Jira Data Center is **2**.
+
 ## Prerequisites
 
 Before installing this module, ensure that the Scorecard backend plugin is integrated into your Backstage instance. Follow the [Scorecard backend plugin README](../scorecard-backend/README.md) for setup instructions.
@@ -46,8 +51,6 @@ jira:
   token: ${JIRA_TOKEN}
   # Required: Supported products: `cloud` or `datacenter`
   product: cloud
-  # Optional: By default, the latest version is used. You can omit this prop when using the latest version.
-  apiVersion: 3
 ```
 
 ### Configuration **Proxy** jira integration
@@ -60,8 +63,6 @@ jira:
   proxyPath: /jira/api
   # Required: Supported products: `cloud` or `datacenter`
   product: cloud
-  # Optional: By default, the latest version is used. You can omit this prop when using the latest version.
-  apiVersion: 3
 
 # This proxy configuration presented only as an example
 proxy:

workspaces/scorecard/plugins/scorecard-backend-module-jira/__fixtures__/testUtils.ts

@@ -55,7 +55,6 @@ interface NewMockRootConfigProps {
     baseUrl?: string;
     token?: string;
     product?: string;
-    apiVersion?: number | string;
     proxyPath?: string;
   };
 }

workspaces/scorecard/plugins/scorecard-backend-module-jira/config.d.ts

@@ -29,7 +29,6 @@ export interface Config {
       }
   ) & {
     product: string;
-    apiVersion?: number | string;
   };
   /** Configuration for scorecard plugin */
   scorecard?: {

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/clients/base.test.ts

@@ -38,6 +38,10 @@ class TestJiraClient extends JiraClient {
   extractIssueCountFromResponse(): number {
     return 10;
   }
+
+  getApiVersion(): number {
+    return 3;
+  }
 }
 
 globalThis.fetch = jest.fn();
@@ -67,7 +71,7 @@ describe('JiraClient', () => {
     mockConnectionStrategy = {
       getBaseUrl: jest
         .fn()
-        .mockReturnValue('https://example.com/api/rest/api/latest'),
+        .mockReturnValue('https://example.com/api/rest/api/3'),
       getAuthHeaders: jest
         .fn()
         .mockResolvedValue({ Authorization: 'Basic Fds31dsF32' }),
@@ -82,7 +86,7 @@ describe('JiraClient', () => {
 
   describe('constructor', () => {
     it('should create api version', () => {
-      expect((testJiraClient as any).apiVersion).toEqual('latest');
+      expect((testJiraClient as any).getApiVersion()).toEqual(3);
     });
 
     it('should create correct options', () => {
@@ -350,7 +354,12 @@ describe('JiraClient', () => {
   describe('getBaseUrl', () => {
     it('should return URL', async () => {
       const baseUrl = await (testJiraClient as any).getBaseUrl();
-      expect(baseUrl).toEqual('https://example.com/api/rest/api/latest');
+      expect(baseUrl).toEqual('https://example.com/api/rest/api/3');
+    });
+
+    it('should get api version', async () => {
+      await (testJiraClient as any).getBaseUrl();
+      expect(mockConnectionStrategy.getBaseUrl).toHaveBeenCalledWith(3);
     });
   });
 

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/clients/base.ts

@@ -17,12 +17,7 @@
 import type { Config } from '@backstage/config';
 import type { Entity } from '@backstage/catalog-model';
 import { JiraEntityFilters, JiraOptions, RequestOptions } from './types';
-import {
-  API_VERSION_DEFAULT,
-  JIRA_CONFIG_PATH,
-  JIRA_OPTIONS_PATH,
-  JIRA_MANDATORY_FILTER,
-} from '../constants';
+import { JIRA_OPTIONS_PATH, JIRA_MANDATORY_FILTER } from '../constants';
 import { ScorecardJiraAnnotations } from '../annotations';
 import { sanitizeValue, validateIdentifier, validateJQLValue } from './utils';
 import { ConnectionStrategy } from '../strategies/ConnectionStrategy';
@@ -31,24 +26,11 @@ const { PROJECT_KEY, COMPONENT, LABEL, TEAM, CUSTOM_FILTER } =
   ScorecardJiraAnnotations;
 
 export abstract class JiraClient {
-  protected readonly apiVersion: number | string;
   protected readonly options?: JiraOptions;
   protected readonly connectionStrategy: ConnectionStrategy;
 
   constructor(rootConfig: Config, connectionStrategy: ConnectionStrategy) {
-    const jiraConfig = rootConfig.getConfig(JIRA_CONFIG_PATH);
-
     this.connectionStrategy = connectionStrategy;
-    this.apiVersion =
-      jiraConfig.getOptional('apiVersion') ?? API_VERSION_DEFAULT;
-    if (
-      typeof this.apiVersion !== 'number' &&
-      typeof this.apiVersion !== 'string'
-    ) {
-      throw new Error(
-        `Invalid 'apiVersion' in configuration, must be a number or string`,
-      );
-    }
 
     const jiraOptions = rootConfig.getOptionalConfig(JIRA_OPTIONS_PATH);
     if (jiraOptions) {
@@ -65,6 +47,8 @@ export abstract class JiraClient {
 
   protected abstract extractIssueCountFromResponse(data: unknown): number;
 
+  protected abstract getApiVersion(): number;
+
   protected async sendRequest({
     url,
     method,
@@ -169,7 +153,8 @@ export abstract class JiraClient {
   }
 
   protected async getBaseUrl(): Promise<string> {
-    return this.connectionStrategy.getBaseUrl(this.apiVersion);
+    const apiVersion = this.getApiVersion();
+    return this.connectionStrategy.getBaseUrl(apiVersion);
   }
 
   protected async getAuthHeaders(): Promise<Record<string, string>> {

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/constants/jiraOpenIssues.ts

@@ -34,7 +34,9 @@ export const JIRA_CONFIG_PATH = 'jira' as const;
 export const JIRA_OPTIONS_PATH =
   'scorecard.plugins.jira.open_issues.options' as const;
 
-export const API_VERSION_DEFAULT = 'latest' as const;
+export const DATA_CENTER_API_VERSION = 2 as const;
+
+export const CLOUD_API_VERSION = 3 as const;
 
 export const JIRA_MANDATORY_FILTER =
   'type = Bug AND resolution = Unresolved' as const;

workspaces/scorecard/plugins/scorecard-backend-module-jira/src/strategies/ConnectionStrategy.test.ts

@@ -43,7 +43,7 @@ describe('ConnectionStrategy', () => {
 
     describe('getBaseUrl', () => {
       it('should return correct base URL', async () => {
-        const baseUrl = await connectionStrategy.getBaseUrl('2');
+        const baseUrl = await connectionStrategy.getBaseUrl(2);
         expect(baseUrl).toEqual('https://example.com/api/rest/api/2');
       });
     });
@@ -81,7 +81,7 @@ describe('ConnectionStrategy', () => {
 
     describe('getBaseUrl', () => {
       it('should return correct base URL', async () => {
-        const baseUrl = await connectionStrategy.getBaseUrl('2');
+        const baseUrl = await connectionStrategy.getBaseUrl(2);
         expect(baseUrl).toEqual(
           'http://localhost:0/api/proxy/jira/api/rest/api/2',
         );