chore: move show classifications and show criticality to new approach

Signed-off-by: Dominikus Hellgartner <dominikus.hellgartner@tngtech.com>

src/ElectronBackend/main/__tests__/menu.test.ts

@@ -5,7 +5,7 @@
 import electron, { BrowserWindow, MenuItemConstructorOptions } from 'electron';
 
 import { createMenu } from '../menu';
-import { UserSettings } from '../user-settings';
+import { UserSettingsProvider } from '../user-settings-provider';
 
 jest.mock('electron', () => ({
   BrowserWindow: class BrowserWindowMock {},
@@ -48,7 +48,7 @@ describe('create menu', () => {
   ];
   testCases.forEach((testCase) => {
     it(`evaluates ${testCase.darkMode ? 'dark' : 'light'} mode properly`, async () => {
-      await UserSettings.init();
+      await UserSettingsProvider.init();
       const mainWindow = new BrowserWindow();
 
       // Important to set this up only here and not in the mock setup

src/ElectronBackend/main/__tests__/user-settings.test.ts

@@ -9,7 +9,7 @@ import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 
 import { DEFAULT_USER_SETTINGS } from '../../../shared/shared-constants';
-import { UserSettings } from '../user-settings';
+import { UserSettingsProvider } from '../user-settings-provider';
 
 describe('UserSettings', () => {
   let temporaryDir: string | undefined = undefined;
@@ -25,7 +25,7 @@ describe('UserSettings', () => {
   });
 
   it('sets up the default values if empty', async () => {
-    await UserSettings.init();
+    await UserSettingsProvider.init();
 
     const result = await settings.get();
 
@@ -35,7 +35,7 @@ describe('UserSettings', () => {
   it('overwrites only the non set values if there are already values set', async () => {
     await settings.set('qaMode', true);
 
-    await UserSettings.init();
+    await UserSettingsProvider.init();
 
     const result = await settings.get();
 
@@ -48,7 +48,7 @@ describe('UserSettings', () => {
 
     await settings.set('qaMode', true);
 
-    await UserSettings.init();
+    await UserSettingsProvider.init();
 
     const result = await settings.get();
 

src/ElectronBackend/main/main.ts

@@ -21,7 +21,7 @@ import {
 import { createMenu } from './menu';
 import { DisabledMenuItemHandler } from './menu/DisabledMenuItemHandler';
 import { openFileFromCliOrEnvVariableIfProvided } from './openFileFromCliOrEnvVariableIfProvided';
-import { UserSettings } from './user-settings';
+import { UserSettingsProvider } from './user-settings-provider';
 
 export async function main(): Promise<void> {
   try {
@@ -35,7 +35,7 @@ export async function main(): Promise<void> {
 
     const mainWindow = createWindow();
 
-    await UserSettings.init();
+    await UserSettingsProvider.init();
     Menu.setApplicationMenu(await createMenu(mainWindow));
 
     mainWindow.webContents.session.webRequest.onBeforeSendHeaders(
@@ -93,11 +93,13 @@ export async function main(): Promise<void> {
     );
     ipcMain.handle(IpcChannel.OpenLink, openLinkListener);
     ipcMain.handle(IpcChannel.GetUserSettings, (_, key) =>
-      UserSettings.get(key),
+      UserSettingsProvider.get(key),
+    );
+    ipcMain.handle(IpcChannel.GetFullUserSettings, () =>
+      UserSettingsProvider.get(),
     );
-    ipcMain.handle(IpcChannel.GetFullUserSettings, () => UserSettings.get());
     ipcMain.handle(IpcChannel.SetUserSettings, (_, { key, value }) =>
-      UserSettings.set(key, value, { skipNotification: true }),
+      UserSettingsProvider.set(key, value, { skipNotification: true }),
     );
 
     await loadWebApp(mainWindow);

src/ElectronBackend/main/menu/viewMenu.ts

@@ -7,7 +7,7 @@ import { MenuItemConstructorOptions } from 'electron';
 
 import { text } from '../../../shared/text';
 import { getIconBasedOnTheme } from '../iconHelpers';
-import { UserSettings } from '../user-settings';
+import { UserSettingsProvider } from '../user-settings-provider';
 import { switchableMenuItem } from './switchableMenuItem';
 
 function getShowDevTools(): MenuItemConstructorOptions {
@@ -61,7 +61,7 @@ function getShowClassifications(
     id: 'show-classifications',
     label: text.menu.viewSubmenu.showClassifications,
     onToggle: (newState: boolean) =>
-      UserSettings.set('showClassifications', newState),
+      UserSettingsProvider.set('showClassifications', newState),
   });
 }
 
@@ -72,22 +72,25 @@ function getShowCriticality(
     id: 'show-criticality',
     label: text.menu.viewSubmenu.showCriticality,
     onToggle: (newState: boolean) =>
-      UserSettings.set('showCriticality', newState),
+      UserSettingsProvider.set('showCriticality', newState),
   });
 }
 
 function getQaMode(qaMode: boolean | null): Array<MenuItemConstructorOptions> {
   return switchableMenuItem(qaMode, {
     id: 'qa-mode',
     label: text.menu.viewSubmenu.qaMode,
-    onToggle: (newState: boolean) => UserSettings.set('qaMode', newState),
+    onToggle: (newState: boolean) =>
+      UserSettingsProvider.set('qaMode', newState),
   });
 }
 
 export async function getViewMenu(): Promise<MenuItemConstructorOptions> {
-  const qaMode = await UserSettings.get('qaMode');
-  const showCriticality = await UserSettings.get('showCriticality');
-  const showClassifications = await UserSettings.get('showClassifications');
+  const qaMode = await UserSettingsProvider.get('qaMode');
+  const showCriticality = await UserSettingsProvider.get('showCriticality');
+  const showClassifications = await UserSettingsProvider.get(
+    'showClassifications',
+  );
   return {
     label: text.menu.view,
     submenu: [

src/ElectronBackend/main/user-settings.ts → src/ElectronBackend/main/user-settings-provider.ts

@@ -10,7 +10,7 @@ import { AllowedFrontendChannels } from '../../shared/ipc-channels';
 import { DEFAULT_USER_SETTINGS } from '../../shared/shared-constants';
 import { UserSettings as IUserSettings } from '../../shared/shared-types';
 
-export class UserSettings {
+export class UserSettingsProvider {
   public static async init() {
     if (process.argv.includes('--reset') || process.env.RESET) {
       log.info('Resetting user settings');
@@ -45,11 +45,12 @@ export class UserSettings {
     await settings.set(path, value);
 
     if (!skipNotification) {
+      const partialSettingsToUpdate = Object.fromEntries([[path, value]]);
       BrowserWindow.getAllWindows().forEach((window) => {
-        window.webContents.send(AllowedFrontendChannels.UserSettingsChanged, {
-          path,
-          value,
-        });
+        window.webContents.send(
+          AllowedFrontendChannels.UserSettingsChanged,
+          partialSettingsToUpdate,
+        );
       });
     }
   }

src/Frontend/Components/AttributionForm/AuditingOptions/AuditingOptions.util.tsx

@@ -64,8 +64,8 @@ export function useAuditingOptions({
     getIsPreferenceFeatureEnabled,
   );
   const classifications = useAppSelector(getClassifications);
-  const [showClassifications] = useShowClassifications();
-  const [showCriticality] = useShowCriticality();
+  const showClassifications = useShowClassifications();
+  const showCriticality = useShowCriticality();
 
   const source = useMemo(() => {
     const sourceName =

src/Frontend/Components/AttributionForm/__tests__/AttributionForm.test.tsx

@@ -17,10 +17,9 @@ import {
   setConfig,
   setFrequentLicenses,
 } from '../../../state/actions/resource-actions/all-views-simple-actions';
+import { setUserSetting } from '../../../state/actions/user-settings-actions/user-settings-actions';
 import { getTemporaryDisplayPackageInfo } from '../../../state/selectors/resource-selectors';
-import { SHOW_CLASSIFICATIONS_KEY } from '../../../state/variables/use-show-classifications';
 import { renderComponent } from '../../../test-helpers/render';
-import { setUserSetting } from '../../../test-helpers/user-settings-helpers';
 import { generatePurl } from '../../../util/handle-purl';
 import { AttributionForm } from '../AttributionForm';
 
@@ -241,7 +240,7 @@ describe('AttributionForm', () => {
         });
 
         renderComponent(<AttributionForm packageInfo={packageInfo} />, {
-          actions: [setUserSetting('showCriticality', false)],
+          actions: [setUserSetting({ showCriticality: false })],
         });
 
         const criticalityChip = screen.queryByTestId(
@@ -258,7 +257,7 @@ describe('AttributionForm', () => {
         });
 
         renderComponent(<AttributionForm packageInfo={packageInfo} />, {
-          actions: [setUserSetting(SHOW_CLASSIFICATIONS_KEY, true)],
+          actions: [setUserSetting({ showClassifications: true })],
         });
 
         const classificationChip = screen.getByTestId(
@@ -273,7 +272,7 @@ describe('AttributionForm', () => {
         });
 
         renderComponent(<AttributionForm packageInfo={packageInfo} />, {
-          actions: [setUserSetting(SHOW_CLASSIFICATIONS_KEY, false)],
+          actions: [setUserSetting({ showClassifications: false })],
         });
 
         const classificationChip = screen.queryByTestId(

src/Frontend/Components/PackageCard/PackageCard.tsx

@@ -143,8 +143,8 @@ export const PackageCard = memo(
       }),
       [cardConfig, packageInfo, classification_mapping],
     );
-    const [showClassifications] = useShowClassifications();
-    const [showCriticality] = useShowCriticality();
+    const showClassifications = useShowClassifications();
+    const showCriticality = useShowCriticality();
     const rightIcons = useMemo(
       () =>
         getRightIcons(

src/Frontend/Components/PackageCard/__tests__/PackageCard.test.tsx

@@ -7,9 +7,8 @@ import { screen } from '@testing-library/react';
 import { Criticality, RawCriticality } from '../../../../shared/shared-types';
 import { faker } from '../../../../testing/Faker';
 import { setConfig } from '../../../state/actions/resource-actions/all-views-simple-actions';
-import { SHOW_CLASSIFICATIONS_KEY } from '../../../state/variables/use-show-classifications';
+import { setUserSetting } from '../../../state/actions/user-settings-actions/user-settings-actions';
 import { renderComponent } from '../../../test-helpers/render';
-import { setUserSetting } from '../../../test-helpers/user-settings-helpers';
 import { PackageCard } from '../PackageCard';
 
 describe('The PackageCard', () => {
@@ -148,7 +147,7 @@ describe('The PackageCard', () => {
                 1: faker.opossum.classificationEntry(),
               },
             }),
-            setUserSetting(SHOW_CLASSIFICATIONS_KEY, false),
+            setUserSetting({ showClassifications: false }),
           ],
         },
       );
@@ -194,7 +193,7 @@ describe('The PackageCard', () => {
 
       renderComponent(
         <PackageCard packageInfo={packageInfo} onClick={jest.fn()} />,
-        { actions: [setUserSetting('showCriticality', false)] },
+        { actions: [setUserSetting({ showCriticality: false })] },
       );
 
       const criticalityIcon = screen.queryByLabelText('Criticality icon');

src/Frontend/Components/ProjectStatisticsPopup/ProjectStatisticsPopup.tsx

@@ -94,8 +94,8 @@ export const ProjectStatisticsPopup: React.FC = () => {
 
   const [selectedTab, setSelectedTab] = useState(0);
 
-  const [showClassifications] = useShowClassifications();
-  const [showCriticality] = useShowCriticality();
+  const showClassifications = useShowClassifications();
+  const showCriticality = useShowCriticality();
 
   return (
     <NotificationPopup

src/Frontend/Components/ProjectStatisticsPopup/__tests__/ProjectStatisticsPopup.test.tsx

@@ -8,11 +8,9 @@ import userEvent from '@testing-library/user-event';
 import { Attributions, Criticality } from '../../../../shared/shared-types';
 import { text } from '../../../../shared/text';
 import { loadFromFile } from '../../../state/actions/resource-actions/load-actions';
-import { SHOW_CLASSIFICATIONS_KEY } from '../../../state/variables/use-show-classifications';
-import { SHOW_CRITICALITY_KEY } from '../../../state/variables/use-show-criticality';
+import { setUserSetting } from '../../../state/actions/user-settings-actions/user-settings-actions';
 import { getParsedInputFileEnrichedWithTestData } from '../../../test-helpers/general-test-helpers';
 import { renderComponent } from '../../../test-helpers/render';
-import { setUserSetting } from '../../../test-helpers/user-settings-helpers';
 import { ProjectStatisticsPopup } from '../ProjectStatisticsPopup';
 
 const testManualAttributions: Attributions = {
@@ -307,7 +305,7 @@ describe('The ProjectStatisticsPopup', () => {
   it('does not show the classification statistics if it has been disabled', () => {
     renderComponent(<ProjectStatisticsPopup />, {
       actions: [
-        setUserSetting(SHOW_CLASSIFICATIONS_KEY, false),
+        setUserSetting({ showClassifications: false }),
         loadFromFile(getParsedInputFileEnrichedWithTestData(fileSetup)),
       ],
     });
@@ -323,7 +321,7 @@ describe('The ProjectStatisticsPopup', () => {
   it('does not show the criticality statistics if it has been disabled', () => {
     renderComponent(<ProjectStatisticsPopup />, {
       actions: [
-        setUserSetting(SHOW_CRITICALITY_KEY, false),
+        setUserSetting({ showCriticality: false }),
         loadFromFile(getParsedInputFileEnrichedWithTestData(fileSetup)),
       ],
     });

src/Frontend/Components/ResourceBrowser/ResourcesTree/ResourcesTreeNode/ResourcesTreeNode.tsx

@@ -55,8 +55,8 @@ export function ResourcesTreeNode({ node, nodeId, nodeName }: TreeNode) {
 
   const canHaveChildren = node !== 1;
   const classification_mapping = useAppSelector(getClassifications);
-  const [showClassifications] = useShowClassifications();
-  const [showCriticality] = useShowCriticality();
+  const showClassifications = useShowClassifications();
+  const showCriticality = useShowCriticality();
 
   return (
     <ResourcesTreeNodeLabel

src/Frontend/Components/SortButton/useSortingOptions.tsx

@@ -27,8 +27,8 @@ export interface SortOptionConfiguration {
 export type SortConfiguration = Record<SortOption, SortOptionConfiguration>;
 
 export function useSortConfiguration(): SortConfiguration {
-  const [showClassifications] = useShowClassifications();
-  const [showCriticality] = useShowCriticality();
+  const showClassifications = useShowClassifications();
+  const showCriticality = useShowCriticality();
 
   return useMemo(() => {
     return {

src/Frontend/Components/SwitchableProcessBar/SwitchableProcessBar.tsx

@@ -43,8 +43,8 @@ interface ProgressBarSwitchConfiguration {
 }
 
 export const SwitchableProcessBar: React.FC = () => {
-  const [showClassifications] = useShowClassifications();
-  const [showCriticality] = useShowCriticality();
+  const showClassifications = useShowClassifications();
+  const showCriticality = useShowCriticality();
 
   const switchableProgressBarConfiguration: Record<
     SelectedProgressBar,

src/Frontend/Components/SwitchableProcessBar/__tests__/SwitchableProcessBar.test.tsx

@@ -6,10 +6,10 @@ import { fireEvent, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 
 import { text } from '../../../../shared/text';
+import { setUserSetting } from '../../../state/actions/user-settings-actions/user-settings-actions';
 import { setVariable } from '../../../state/actions/variables-actions/variables-actions';
 import { PROGRESS_DATA } from '../../../state/variables/use-progress-data';
 import { renderComponent } from '../../../test-helpers/render';
-import { setUserSetting } from '../../../test-helpers/user-settings-helpers';
 import { ProgressBarData } from '../../../types/types';
 import { SwitchableProcessBar } from '../SwitchableProcessBar';
 
@@ -114,7 +114,7 @@ describe('SwitchableProcessBar', () => {
     renderComponent(<SwitchableProcessBar />, {
       actions: [
         setVariable<ProgressBarData>(PROGRESS_DATA, PROGRESS_BAR_DATA),
-        setUserSetting('showClassifications', true),
+        setUserSetting({ showClassifications: true }),
       ],
     });
 
@@ -136,7 +136,7 @@ describe('SwitchableProcessBar', () => {
     renderComponent(<SwitchableProcessBar />, {
       actions: [
         setVariable<ProgressBarData>(PROGRESS_DATA, PROGRESS_BAR_DATA),
-        setUserSetting('showClassifications', false),
+        setUserSetting({ showClassifications: false }),
       ],
     });
 
@@ -154,7 +154,7 @@ describe('SwitchableProcessBar', () => {
     renderComponent(<SwitchableProcessBar />, {
       actions: [
         setVariable<ProgressBarData>(PROGRESS_DATA, PROGRESS_BAR_DATA),
-        setUserSetting('showCriticality', false),
+        setUserSetting({ showCriticality: false }),
       ],
     });
 
@@ -172,8 +172,7 @@ describe('SwitchableProcessBar', () => {
     renderComponent(<SwitchableProcessBar />, {
       actions: [
         setVariable<ProgressBarData>(PROGRESS_DATA, PROGRESS_BAR_DATA),
-        setUserSetting('showCriticality', false),
-        setUserSetting('showClassifications', false),
+        setUserSetting({ showCriticality: false, showClassifications: false }),
       ],
     });
 

src/Frontend/state/reducers/user-settings-reducer.ts

@@ -2,8 +2,8 @@
 // SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
 //
 // SPDX-License-Identifier: Apache-2.0
-import { UserSettings } from '../../../ElectronBackend/main/user-settings';
 import { DEFAULT_USER_SETTINGS } from '../../../shared/shared-constants';
+import { UserSettings } from '../../../shared/shared-types';
 import {
   ACTION_SET_USER_SETTING,
   UserSettingsAction,