SCA-1091 Implement Rescan Settings (#3448)

Co-authored-by: Greg Aubert <gregoire.aubert@sonarsource.com>
GitOrigin-RevId: a5174f42db793164b385b652743980ecf382e2ce

Author: 2 people

apps/sq-server/src/main/js/apps/settings/__tests__/utils-test.ts

@@ -18,15 +18,15 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-import { hasMessage } from '~sq-server-commons/helpers/l10n';
-import { mockComponent } from '~sq-server-commons/helpers/mocks/component';
-import { mockDefinition, mockSettingValue } from '~sq-server-commons/helpers/mocks/settings';
 import {
   ExtendedSettingDefinition,
-  Setting,
   SettingFieldDefinition,
   SettingType,
-} from '~sq-server-commons/types/settings';
+} from '~shared/types/settings';
+import { hasMessage } from '~sq-server-commons/helpers/l10n';
+import { mockComponent } from '~sq-server-commons/helpers/mocks/component';
+import { mockDefinition, mockSettingValue } from '~sq-server-commons/helpers/mocks/settings';
+import { Setting } from '~sq-server-commons/types/settings';
 import {
   buildSettingLink,
   getDefaultValue,

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

@@ -19,9 +19,9 @@
  */
 
 import * as React from 'react';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import { NEW_CODE_PERIOD_CATEGORY } from '~sq-server-commons/constants/settings';
 import { translate } from '~sq-server-commons/helpers/l10n';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import {
   ADVANCED_SECURITY_CATEGORY,

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

@@ -20,11 +20,9 @@
 
 import { keyBy } from 'lodash';
 import * as React from 'react';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import { getValues } from '~sq-server-commons/api/settings';
-import {
-  ExtendedSettingDefinition,
-  SettingDefinitionAndValue,
-} from '~sq-server-commons/types/settings';
+import { SettingDefinitionAndValue } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import { SETTING_CONFIRMATION_MESSAGE_IDS } from '../constants';
 import SubCategoryDefinitionsList from './SubCategoryDefinitionsList';

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

@@ -30,19 +30,15 @@ import {
 } from '@sonarsource/echoes-react';
 import * as React from 'react';
 import { FormattedMessage, useIntl } from 'react-intl';
+import { ExtendedSettingDefinition, SettingType, SettingValue } from '~shared/types/settings';
 import { translate, translateWithParameters } from '~sq-server-commons/helpers/l10n';
 import { parseError } from '~sq-server-commons/helpers/request';
 import {
   useGetValueQuery,
   useResetSettingsMutation,
   useSaveValueMutation,
 } from '~sq-server-commons/queries/settings';
-import {
-  ExtendedSettingDefinition,
-  SettingDefinitionAndValue,
-  SettingType,
-  SettingValue,
-} from '~sq-server-commons/types/settings';
+import { SettingDefinitionAndValue } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import {
   combineDefinitionAndSettingValue,

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

@@ -21,8 +21,9 @@
 import { Button, ButtonGroup, ButtonVariety, Text } from '@sonarsource/echoes-react';
 import * as React from 'react';
 import { Modal } from '~design-system';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import { translate, translateWithParameters } from '~sq-server-commons/helpers/l10n';
-import { ExtendedSettingDefinition, Setting } from '~sq-server-commons/types/settings';
+import { Setting } from '~sq-server-commons/types/settings';
 import { getDefaultValue, getPropertyName, isEmptyValue } from '../utils';
 
 type Props = {

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

@@ -18,37 +18,32 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-import { Heading, Text, Tooltip } from '@sonarsource/echoes-react';
-import { SafeHTMLInjection, SanitizeLevel } from '~shared/helpers/sanitize';
-import { translateWithParameters } from '~sq-server-commons/helpers/l10n';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
-import { getPropertyDescription, getPropertyName } from '../utils';
+import { Text, Tooltip } from '@sonarsource/echoes-react';
+import { FormattedMessage, useIntl } from 'react-intl';
+import DefinitionDescriptionBase from '~shared/components/configuration/DefinitionDescriptionBase';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 
 interface Props {
   definition: ExtendedSettingDefinition;
 }
 
 export default function DefinitionDescription({ definition }: Readonly<Props>) {
-  const propertyName = getPropertyName(definition);
-  const description = getPropertyDescription(definition);
+  const intl = useIntl();
 
   return (
-    <div className="sw-w-abs-300">
-      <Heading as="h4" className="sw-text-ellipsis sw-overflow-hidden">
-        {propertyName}
-      </Heading>
-
-      {description && (
-        <SafeHTMLInjection htmlAsString={description} sanitizeLevel={SanitizeLevel.RESTRICTED}>
-          <div className="markdown sw-mt-1" />
-        </SafeHTMLInjection>
-      )}
-
-      <Tooltip content={translateWithParameters('settings.key_x', definition.key)}>
+    <DefinitionDescriptionBase definition={definition}>
+      <Tooltip
+        content={intl.formatMessage(
+          {
+            id: 'settings.key_x',
+          },
+          { 0: definition.key },
+        )}
+      >
         <Text as="div" className="sw-mt-4" isSubtle>
-          {translateWithParameters('settings.key_x', definition.key)}
+          <FormattedMessage id="settings.key_x" values={{ 0: definition.key }} />
         </Text>
       </Tooltip>
-    </div>
+    </DefinitionDescriptionBase>
   );
 }

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

@@ -20,10 +20,10 @@
 
 import { useIntl } from 'react-intl';
 import { Title } from '~design-system';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import InstanceMessage from '~sq-server-commons/components/common/InstanceMessage';
 import { getInstance } from '~sq-server-commons/helpers/system';
 import { Feature } from '~sq-server-commons/types/features';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import { usePurchasableFeature } from '../utils';
 import SettingsSearch from './SettingsSearch';

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

@@ -19,9 +19,9 @@
  */
 
 import * as React from 'react';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import { getDefinitions } from '~sq-server-commons/api/settings';
 import withComponentContext from '~sq-server-commons/context/componentContext/withComponentContext';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import '../styles.css';
 import SettingsAppRenderer from './SettingsAppRenderer';

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

@@ -25,9 +25,9 @@ import { Helmet } from 'react-helmet-async';
 import { LargeCenteredLayout, themeBorder } from '~design-system';
 import { withRouter } from '~shared/components/hoc/withRouter';
 import { Location } from '~shared/types/router';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import ModeBanner from '~sq-server-commons/components/common/ModeBanner';
 import { translate } from '~sq-server-commons/helpers/l10n';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import { CATEGORY_OVERRIDES } from '../constants';
 import { getDefaultCategory } from '../utils';

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

@@ -23,11 +23,11 @@ import lunr, { LunrIndex } from 'lunr';
 import * as React from 'react';
 import { withRouter } from '~shared/components/hoc/withRouter';
 import { Router } from '~shared/types/router';
+import { ExtendedSettingDefinition } from '~shared/types/settings';
 import withAvailableFeatures, {
   WithAvailableFeaturesProps,
 } from '~sq-server-commons/context/available-features/withAvailableFeatures';
 import { KeyboardKeys } from '~sq-server-commons/helpers/keycodes';
-import { ExtendedSettingDefinition } from '~sq-server-commons/types/settings';
 import { Component } from '~sq-server-commons/types/types';
 import {
   ADDITIONAL_PROJECT_SETTING_DEFINITIONS,