SONAR-25925 Add Jira integration to Project settings in SQS

GitOrigin-RevId: cea38b672c65ce382435d6aea7bcb0b2f26f6367

Author: Hartesic

apps/sq-server/src/main/js/apps/settings/components/AdditionalCategories.tsx

@@ -20,8 +20,10 @@
 
 import * as React from 'react';
 import { ExtendedSettingDefinition } from '~shared/types/settings';
+import { addons } from '~sq-server-addons/index';
 import { NEW_CODE_PERIOD_CATEGORY } from '~sq-server-commons/constants/settings';
 import { translate } from '~sq-server-commons/helpers/l10n';
+import { Feature } from '~sq-server-commons/types/features';
 import { Component } from '~sq-server-commons/types/types';
 import {
   ADVANCED_SECURITY_CATEGORY,
@@ -31,6 +33,7 @@ import {
   AUTHENTICATION_CATEGORY,
   EARLY_ACCESS_FEATURES_CATEGORY,
   EMAIL_NOTIFICATION_CATEGORY,
+  JIRA_PROJECT_BINDING_CATEGORY,
   LANGUAGES_CATEGORY,
   MODE_CATEGORY,
   PULL_REQUEST_DECORATION_BINDING_CATEGORY,
@@ -61,6 +64,7 @@ export interface AdditionalCategory {
   key: string;
   name: string;
   renderComponent: (props: AdditionalCategoryComponentProps) => React.ReactNode;
+  requiredFeatures?: Feature[];
   requiresBranchSupport?: boolean;
 }
 
@@ -172,6 +176,15 @@ export const ADDITIONAL_CATEGORIES: AdditionalCategory[] = [
     availableForProject: false,
     displayTab: true,
   },
+  {
+    key: JIRA_PROJECT_BINDING_CATEGORY,
+    name: translate('project_settings.category.jira_binding'),
+    renderComponent: getProjectJiraBindingComponent,
+    availableGlobally: false,
+    availableForProject: true,
+    displayTab: true,
+    requiredFeatures: [Feature.JiraIntegration],
+  },
 ];
 
 function getLanguagesComponent(props: AdditionalCategoryComponentProps) {
@@ -217,3 +230,11 @@ function getAdvancedSecurityComponent(props: AdditionalCategoryComponentProps) {
 function getEarlyAccessFeaturesComponent() {
   return <EarlyAccessFeatures />;
 }
+
+function getProjectJiraBindingComponent({ component }: AdditionalCategoryComponentProps) {
+  if (addons.jira === undefined || component === undefined) {
+    return null;
+  }
+
+  return <addons.jira.JiraProjectBinding component={component} />;
+}

apps/sq-server/src/main/js/apps/settings/components/AllCategoriesList.tsx

@@ -82,7 +82,8 @@ function AllCategoriesList(props: Readonly<CategoriesListProps>) {
           (props.hasFeature(Feature.BranchSupport) || !c.requiresBranchSupport) &&
           (props.hasFeature(Feature.FixSuggestions) ||
             props.hasFeature(Feature.FixSuggestionsMarketing) ||
-            c.key !== AI_CODE_FIX_CATEGORY)
+            c.key !== AI_CODE_FIX_CATEGORY) &&
+          (c.requiredFeatures === undefined || c.requiredFeatures.every(props.hasFeature))
         );
       }),
     );

apps/sq-server/src/main/js/apps/settings/components/__tests__/SettingsApp-it.tsx

@@ -41,6 +41,16 @@ import { Feature } from '~sq-server-commons/types/features';
 import { Component } from '~sq-server-commons/types/types';
 import routes from '../../routes';
 
+jest.mock('~sq-server-addons/index', () => ({
+  addons: {
+    ...jest.requireActual<typeof import('~sq-server-addons/index')>('~sq-server-addons/index')
+      .addons,
+    jira: {
+      JiraProjectBinding: () => <h1>JiraProjectBindingHeding</h1>,
+    },
+  },
+}));
+
 let settingsMock: SettingsServiceMock;
 let scaSettingsMock: ScaServiceSettingsMock;
 let modeHandler: ModeServiceMock;
@@ -66,25 +76,23 @@ beforeEach(() => {
 });
 
 const ui = {
-  categoryLink: (category: string) => byRole('link', { name: category }),
   announcementHeading: byRole('heading', { name: 'property.category.general.Announcement' }),
-
-  languagesHeading: byRole('heading', { name: 'property.category.languages' }),
-  languagesSelect: byRole('combobox', { name: 'property.category.languages' }),
-  jsGeneralSubCategoryHeading: byRole('heading', { name: 'property.category.javascript.General' }),
-  scaHeading: byRole('heading', { name: 'property.sca.admin.title' }),
-
-  settingsSearchInput: byRole('searchbox', { name: 'settings.search.placeholder' }),
-  searchResultsList: byRole('menu'),
-  searchItem: (key: string) => byRole('link', { name: new RegExp(key) }),
-  searchClear: byRole('button', { name: 'clear' }),
-
+  categoryLink: (category: string) => byRole('link', { name: category }),
   externalAnalyzersAndroidHeading: byRole('heading', {
     name: 'property.category.External Analyzers.Android',
   }),
   generalComputeEngineHeading: byRole('heading', {
     name: 'property.category.general.Compute Engine',
   }),
+  jsGeneralSubCategoryHeading: byRole('heading', { name: 'property.category.javascript.General' }),
+  languagesHeading: byRole('heading', { name: 'property.category.languages' }),
+  languagesSelect: byRole('combobox', { name: 'property.category.languages' }),
+  mockedJiraProjectBindingHeading: byRole('heading', { name: 'JiraProjectBindingHeding' }),
+  scaHeading: byRole('heading', { name: 'property.sca.admin.title' }),
+  searchClear: byRole('button', { name: 'clear' }),
+  searchItem: (key: string) => byRole('link', { name: new RegExp(key) }),
+  searchResultsList: byRole('menu'),
+  settingsSearchInput: byRole('searchbox', { name: 'settings.search.placeholder' }),
 };
 
 describe('Global Settings', () => {
@@ -209,7 +217,9 @@ describe('Global Settings', () => {
 describe('Project Settings', () => {
   it('renders categories list and definitions', async () => {
     const user = userEvent.setup();
-    renderSettingsApp(mockComponent(), { featureList: [Feature.BranchSupport] });
+    renderSettingsApp(mockComponent(), {
+      featureList: [Feature.BranchSupport, Feature.JiraIntegration],
+    });
 
     const projectCategories = [
       'property.category.general',
@@ -226,11 +236,16 @@ describe('Project Settings', () => {
     // Visible only for global settings
     expect(ui.categoryLink('property.category.almintegration').query()).not.toBeInTheDocument();
 
+    expect(ui.categoryLink('project_settings.category.jira_binding').get()).toBeInTheDocument();
+
     expect(await ui.announcementHeading.find()).toBeInTheDocument();
 
     // Navigating to Languages category
     await user.click(await ui.categoryLink('property.category.languages').find());
     expect(await ui.languagesHeading.find()).toBeInTheDocument();
+
+    await user.click(await ui.categoryLink('project_settings.category.jira_binding').find());
+    expect(await ui.mockedJiraProjectBindingHeading.find()).toBeInTheDocument();
   });
 });
 

apps/sq-server/src/main/js/apps/settings/constants.tsx

@@ -37,6 +37,7 @@ export const PULL_REQUEST_DECORATION_BINDING_CATEGORY = 'pull_request_decoration
 export const EMAIL_NOTIFICATION_CATEGORY = 'email_notification';
 export const MODE_CATEGORY = 'mode';
 export const EARLY_ACCESS_FEATURES_CATEGORY = 'early_access_features';
+export const JIRA_PROJECT_BINDING_CATEGORY = 'jira_project_binding';
 
 export const CATEGORY_OVERRIDES: Record<string, string> = {
   abap: LANGUAGES_CATEGORY,

libs/sq-server-commons/src/api/mocks/ProjectsManagementServiceMock.ts

@@ -36,51 +36,64 @@ import SettingsServiceMock from './SettingsServiceMock';
 jest.mock('../project-management');
 
 const defaultProject = [
-  mockProject({ key: 'project1', name: 'Project 1' }),
+  mockProject({ key: 'project1', name: 'Project 1', uuid: 'project1-uuid' }),
   mockProject({
     key: 'project2',
     name: 'Project 2',
     visibility: Visibility.Private,
+    uuid: 'project2-uuid',
   }),
   mockProject({
     key: 'project3',
     name: 'Project 3',
     lastAnalysisDate: undefined,
+    uuid: 'project3-uuid',
+  }),
+  mockProject({
+    key: 'projectProvisioned',
+    name: 'Project 4',
+    managed: true,
+    uuid: 'projectProvisioned-uuid',
   }),
-  mockProject({ key: 'projectProvisioned', name: 'Project 4', managed: true }),
   mockProject({
     key: 'portfolio1',
     name: 'Portfolio 1',
     qualifier: ComponentQualifier.Portfolio,
+    uuid: 'portfolio1-uuid',
   }),
   mockProject({
     key: 'portfolio2',
     name: 'Portfolio 2',
     qualifier: ComponentQualifier.Portfolio,
     visibility: Visibility.Private,
+    uuid: 'portfolio2-uuid',
   }),
   mockProject({
     key: 'portfolio3',
     name: 'Portfolio 3',
     qualifier: ComponentQualifier.Portfolio,
     lastAnalysisDate: undefined,
+    uuid: 'portfolio3-uuid',
   }),
   mockProject({
     key: 'application1',
     name: 'Application 1',
     qualifier: ComponentQualifier.Application,
+    uuid: 'application1-uuid',
   }),
   mockProject({
     key: 'application2',
     name: 'Application 2',
     qualifier: ComponentQualifier.Application,
     visibility: Visibility.Private,
+    uuid: 'application2-uuid',
   }),
   mockProject({
     key: 'application3',
     name: 'Application 3',
     qualifier: ComponentQualifier.Application,
     lastAnalysisDate: undefined,
+    uuid: 'application3-uuid',
   }),
 ];
 

libs/sq-server-commons/src/api/project-management.ts

@@ -40,6 +40,7 @@ export interface ProjectBase {
     | ComponentQualifier.Application
     | ComponentQualifier.Portfolio
     | ComponentQualifier.Project;
+  uuid: string;
   visibility: Visibility;
 }
 

libs/sq-server-commons/src/helpers/mocks/projects.ts

@@ -28,6 +28,7 @@ export function mockProject(overrides: Partial<Project> = {}): Project {
     qualifier: ComponentQualifier.Project,
     visibility: Visibility.Public,
     lastAnalysisDate: '2019-01-04T09:51:48Z',
+    uuid: 'project-uuid',
     ...overrides,
   };
 }

libs/sq-server-commons/src/l10n/default.ts

@@ -8748,4 +8748,57 @@ export const defaultMessages = {
   'beamer.news.error': 'Failed to load news',
   'beamer.news.community_post': 'Community post',
   'beamer.news.no_news': 'No news available',
+
+  // ----------------------------------------------------------------------------
+  //
+  // Jira integration
+  //
+  // ----------------------------------------------------------------------------
+
+  'jira_binding.server_error': 'Internal server error. Please try again later.',
+  'project_settings.category.jira_binding': 'Jira',
+  'project_settings.jira_binding.header': 'Jira',
+  'project_settings.jira_binding.bound': 'Connected',
+  'project_settings.jira_binding.not_bound': 'Not connected',
+  'project_settings.jira_binding.description.bound':
+    '<p>You can now push SonarQube issues directly to Jira, display relevant release-related Jira information within SonarQube. For any errors, follow our <link>troubleshooting steps</link>.</p>',
+  'project_settings.jira_binding.description.not_bound':
+    '<p>Enable seamless issue management and workflow visibility.</p>  <p>Push SonarQube issues directly to Jira and display relevant release-related Jira information within SonarQube <link>by setting up your connection</link></p>',
+  'project_settings.jira_binding.key': 'Project key:',
+  'project_settings.jira_binding.remove_binding': 'Remove jira connection for project: {name}',
+  'project_settings.jira_binding.disconnect': 'Disconnect',
+  'project_settings.jira_binding.create_binding.title': 'Select a Jira project',
+  'project_settings.jira_binding.create_binding.description':
+    'By default, you will be able to push all possible issue types',
+  'project_settings.jira_binding.edit_binding.title': 'Change Jira project binding?',
+  'project_settings.jira_binding.edit_binding.description':
+    'Issues previously pushed to "{name}" and earlier will be preserved, but all new issues will be pushed to your new Jira project.',
+  'project_settings.jira_binding.organization_not_bound':
+    'Cannot connect until you bind your instance to Jira in <link>Administration -> Jira</link>',
+  'project_settings.jira_binding.no_summary':
+    'To see issues for this release, configure Jira releases and versions. See <link>instructions in our documentation</link>',
+  'project_settings.jira.binding.bind_success': '"{sqProject}" has been connected to Jira',
+  'project_settings.jira.binding.update_bind_success':
+    'You have successfully changed your Jira connection to "{name}"',
+  'project_settings.jira.binding.unbind_success': '"{sqProject}" has been disconnected from Jira',
+  'project_settings.jira_binding.work_types.at_least_one_required':
+    'At least one work type must be selected',
+  'project_settings.jira_binding.work_types.mandatory_custom_fields':
+    'Mandatory custom fields: {fields}',
+  'project_settings.jira_binding.work_types.mandatory_fields_warning.title':
+    'Some work item types can’t be pushed from SonarQube',
+  'project_settings.jira_binding.work_types.mandatory_fields_warning.text':
+    'SonarQube can’t create Jira work items with mandatory custom fields because it can’t automatically assign values to them. Remove the mandatory settings for those custom fields in Jira first.',
+  'project_settings.jira.binding.work_types.save_failed':
+    'Failed to save permitted Jira work types. Please try again later.',
+  'project_settings.jira.binding.work_types.saved_successfully':
+    'Permitted Jira work types were updated.',
+  'project_settings.jira_binding.work_types.title':
+    'Choose work types that can be pushed from SonarQube to Jira',
+  'project_settings.jira_binding.unbind_confirm.title':
+    'Do you want to disconnect this Jira project?',
+  'project_settings.jira_binding.unbind_confirm.description':
+    '{count} SonarQube {count, plural, one {issue} other {issues}} and corresponding Jira work items will no longer be synchronized. However, existing Jira work items will not be deleted.',
+  'project_settings.jira_binding.unbind_confirm.alert':
+    'Previous connections cannot be restored. Rebinding or creating a new project binding with Jira can lead to duplicate Jira work items.',
 };

libs/sq-server-commons/src/queries/project-managements.ts

@@ -18,15 +18,17 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
+import { queryOptions } from '@tanstack/react-query';
 import { createQueryHook, StaleTime } from '~shared/queries/common';
 import { ComponentQualifier } from '~shared/types/component';
 import { getComponents, Project } from '../api/project-management';
 
 const PROJECT_QUERY_PAGE_SIZE = 500;
+const PROJECTS_QUERY_KEY = 'project-search';
 
 export const useGetAllProjectsQuery = createQueryHook(() => {
   return {
-    queryKey: ['project-search', 'all'] as const,
+    queryKey: [PROJECTS_QUERY_KEY, 'all'] as const,
     queryFn: async () => {
       let pageIndex = 1;
       let totalElements = 0;
@@ -50,3 +52,15 @@ export const useGetAllProjectsQuery = createQueryHook(() => {
     staleTime: StaleTime.LIVE,
   };
 });
+
+export const useGetProjectQuery = createQueryHook((projectKey: string) => {
+  return queryOptions({
+    queryKey: [PROJECTS_QUERY_KEY, 'details', projectKey],
+    queryFn: () =>
+      getComponents({
+        projects: projectKey,
+      }),
+    select: (data) => data.components[0],
+    staleTime: StaleTime.SHORT,
+  });
+});

libs/sq-server-commons/src/sq-server-adapters/helpers/docs.ts

@@ -27,12 +27,15 @@ import { useUncataloguedDocUrl } from '../../helpers/docs';
  * they deal with the same subject matter */
 export enum SharedDocLink {
   AnalyzingDependencies = '/advanced-security/analyzing-projects-for-dependencies/',
-  DependencyRisks = '/advanced-security/reviewing-and-fixing-dependency-risks/',
-  LicenseProfiles = '/advanced-security/managing-license-profiles-and-policies/',
-  SCATroubleshooting = '/advanced-security/troubleshooting/',
   ArchitectureModel = '/design-and-architecture/configuring-the-architecture-analysis/',
   ArchitectureModelDeclaration = '/design-and-architecture/configuring-the-architecture-analysis/#declaration',
+  DependencyRisks = '/advanced-security/reviewing-and-fixing-dependency-risks/',
+  JiraIntegration = '/instance-administration/jira-integration',
+  JiraIntegrationProjectBinding = '/project-administration/jira-integration',
+  JiraIntegrationTroubleshooting = '/instance-administration/jira-integration#troubleshooting',
+  LicenseProfiles = '/advanced-security/managing-license-profiles-and-policies/',
   NewCodeDefinition = '/user-guide/about-new-code#new-code-definitions',
+  SCATroubleshooting = '/advanced-security/troubleshooting/',
 }
 
 /**