refactor: Remove getFuxSettings (#634)

dwesolow · web-flow · commit d719aa455829 · 2025-07-08T08:24:56.000Z
diff --git a/web_ui/src/hooks/use-fux-notifications/use-fux-notifications.hook.ts b/web_ui/src/hooks/use-fux-notifications/use-fux-notifications.hook.ts
@@ -5,13 +5,12 @@ import { useCallback } from 'react';
 
 import { FUX_NOTIFICATION_KEYS, FUX_SETTINGS_KEYS } from '../../core/user-settings/dtos/user-settings.interface';
 import { useUserGlobalSettings } from '../../core/user-settings/hooks/use-global-settings.hook';
-import { getFuxSetting } from '../../shared/components/tutorials/utils';
 
 export const useFuxNotifications = () => {
     const settings = useUserGlobalSettings();
 
     const handleFirstAnnotation = () => {
-        const hasNeverAnnotated = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_ANNOTATED, settings.config);
+        const hasNeverAnnotated = settings.config[FUX_SETTINGS_KEYS.NEVER_ANNOTATED].value;
 
         if (hasNeverAnnotated) {
             settings.saveConfig({
@@ -24,7 +23,7 @@ export const useFuxNotifications = () => {
 
     const handleFirstAutoTraining = useCallback(
         async (projectId: string, jobId: string) => {
-            const hasNeverAutotrained = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED, settings.config);
+            const hasNeverAutotrained = settings.config[FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED].value;
 
             if (hasNeverAutotrained) {
                 await settings.saveConfig({
@@ -41,10 +40,7 @@ export const useFuxNotifications = () => {
     );
 
     const handleFirstSuccessfulAutoTraining = async (trainedModelId: string) => {
-        const hasNeverSuccessfullyAutotrained = getFuxSetting(
-            FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED,
-            settings.config
-        );
+        const hasNeverSuccessfullyAutotrained = settings.config[FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED].value;
 
         const settingToDisable = settings.config[FUX_NOTIFICATION_KEYS.AUTO_TRAINING_MODAL].isEnabled
             ? FUX_NOTIFICATION_KEYS.AUTO_TRAINING_MODAL
@@ -63,7 +59,7 @@ export const useFuxNotifications = () => {
         }
     };
     const handleFirstVisitToPredictionMode = () => {
-        const neverCheckedPredictions = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_CHECKED_PREDICTIONS, settings.config);
+        const neverCheckedPredictions = settings.config[FUX_SETTINGS_KEYS.NEVER_CHECKED_PREDICTIONS].value;
 
         if (neverCheckedPredictions) {
             settings.saveConfig({
diff --git a/web_ui/src/hooks/use-fux-notifications/use-fux-notifications.test.tsx b/web_ui/src/hooks/use-fux-notifications/use-fux-notifications.test.tsx
@@ -6,7 +6,10 @@ import { renderHook } from '@testing-library/react';
 import { FUX_NOTIFICATION_KEYS, FUX_SETTINGS_KEYS } from '../../core/user-settings/dtos/user-settings.interface';
 import { useUserGlobalSettings } from '../../core/user-settings/hooks/use-global-settings.hook';
 import { INITIAL_GLOBAL_SETTINGS } from '../../core/user-settings/utils';
-import { getMockedUserGlobalSettingsObject } from '../../test-utils/mocked-items-factory/mocked-settings';
+import {
+    getMockedUserGlobalSettings,
+    getMockedUserGlobalSettingsObject,
+} from '../../test-utils/mocked-items-factory/mocked-settings';
 import { useFuxNotifications } from './use-fux-notifications.hook';
 
 const mockSaveConfig = jest.fn();
@@ -92,12 +95,20 @@ describe('useFuxNotifications', () => {
         it('should never update settings', () => {
             jest.mocked(useUserGlobalSettings).mockImplementationOnce(() => ({
                 ...mockSettings,
-                config: {
-                    ...mockSettings.config,
-                    [FUX_SETTINGS_KEYS.USER_DISMISSED_ALL]: {
-                        value: true,
+                config: getMockedUserGlobalSettings({
+                    [FUX_SETTINGS_KEYS.NEVER_ANNOTATED]: {
+                        value: false,
                     },
-                },
+                    [FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED]: {
+                        value: false,
+                    },
+                    [FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED]: {
+                        value: false,
+                    },
+                    [FUX_SETTINGS_KEYS.NEVER_CHECKED_PREDICTIONS]: {
+                        value: false,
+                    },
+                }),
             }));
 
             const { result } = renderHook(() => useFuxNotifications());
diff --git a/web_ui/src/pages/annotator/annotator-layout.component.tsx b/web_ui/src/pages/annotator/annotator-layout.component.tsx
@@ -20,7 +20,6 @@ import { UpgradeBanner } from '../../routes/upgrade-banner/upgrade-banner.compon
 import { CoachMark } from '../../shared/components/coach-mark/coach-mark.component';
 import { SuccessfullyAutotrainedNotification } from '../../shared/components/coach-mark/fux-notifications/successfully-auto-trained-notification.component';
 import { TutorialCardBuilder } from '../../shared/components/tutorial-card/tutorial-card-builder.component';
-import { getFuxSetting } from '../../shared/components/tutorials/utils';
 import { useTutorialEnablement } from '../../shared/hooks/use-tutorial-enablement.hook';
 import { ErrorBoundary } from '../errors/error-boundary.component';
 import { useProject } from '../project-details/providers/project-provider/project-provider.component';
@@ -108,11 +107,8 @@ export const AnnotatorLayout = (): JSX.Element => {
         FUX_NOTIFICATION_KEYS.ANNOTATE_INTERACTIVELY
     );
 
-    const hasPreviouslyAutoTrained = !getFuxSetting(FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED, userGlobalSettings.config);
-    const firstAutoTrainedProjectId = getFuxSetting(
-        FUX_SETTINGS_KEYS.FIRST_AUTOTRAINED_PROJECT_ID,
-        userGlobalSettings.config
-    );
+    const hasPreviouslyAutoTrained = !userGlobalSettings.config[FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED].value;
+    const firstAutoTrainedProjectId = userGlobalSettings.config[FUX_SETTINGS_KEYS.FIRST_AUTOTRAINED_PROJECT_ID].value;
 
     const filteredLabels = project.tasks.some(isKeypointTask) ? [] : labels;
 
diff --git a/web_ui/src/pages/annotator/notification/auto-training-credits-modal/auto-training-credits-modal.component.tsx b/web_ui/src/pages/annotator/notification/auto-training-credits-modal/auto-training-credits-modal.component.tsx
@@ -17,7 +17,6 @@ import { FUX_NOTIFICATION_KEYS, FUX_SETTINGS_KEYS } from '../../../../core/user-
 import { useUserGlobalSettings } from '../../../../core/user-settings/hooks/use-global-settings.hook';
 import { UserGlobalSettings, UseSettings } from '../../../../core/user-settings/services/user-settings.interface';
 import { CreditsToConsume } from '../../../../shared/components/header/credit-balance/credits-to-consume.component';
-import { getFuxSetting } from '../../../../shared/components/tutorials/utils';
 import { useProject } from '../../../project-details/providers/project-provider/project-provider.component';
 import { useIsAutoTrainingOn } from '../../hooks/use-is-auto-training-on.hook';
 import { onFirstScheduledOrRunningAutoTrainingJob } from './util';
@@ -76,7 +75,7 @@ export const AutoTrainingCreditsModal = ({ settings }: AutoTrainingCreditsModalP
     const [isOpen, setIsOpen] = useState(false);
 
     const isAutoTrainingOn = useIsAutoTrainingOn({ project, projectIdentifier });
-    const hasNeverAutotrained = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED, settings.config);
+    const hasNeverAutotrained = settings.config[FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED].value;
     const isQueryEnabled = Boolean(isAutoTrainingOn && !settings.isSavingConfig && hasNeverAutotrained);
 
     const handleDisplayModal = async (jobId: string) => {
diff --git a/web_ui/src/pages/annotator/notification/auto-training-credits-modal/auto-training-credits-modal.test.tsx b/web_ui/src/pages/annotator/notification/auto-training-credits-modal/auto-training-credits-modal.test.tsx
@@ -10,7 +10,6 @@ import { FUX_NOTIFICATION_KEYS, FUX_SETTINGS_KEYS } from '../../../../core/user-
 import { UserGlobalSettings, UseSettings } from '../../../../core/user-settings/services/user-settings.interface';
 import { INITIAL_GLOBAL_SETTINGS } from '../../../../core/user-settings/utils';
 import { useActiveLearningConfiguration } from '../../../../shared/components/header/active-learning-configuration/use-active-learning-configuration.hook';
-import { getFuxSetting } from '../../../../shared/components/tutorials/utils';
 import { getMockedJob, getMockedJobCount } from '../../../../test-utils/mocked-items-factory/mocked-jobs';
 import {
     getMockedUserGlobalSettings,
@@ -115,7 +114,6 @@ describe('AutoTrainingCreditsModal', () => {
 
     it('modal is open and disabled by dismissing', async () => {
         const mockedSaveSettings = jest.fn();
-        jest.mocked(getFuxSetting).mockReturnValue(true);
 
         await renderApp({ mockedSaveSettings });
 
diff --git a/web_ui/src/pages/annotator/notification/auto-training-credits-modal/util.test.ts b/web_ui/src/pages/annotator/notification/auto-training-credits-modal/util.test.ts
@@ -3,7 +3,6 @@
 
 import { GETI_SYSTEM_AUTHOR_ID, JobState } from '../../../../core/jobs/jobs.const';
 import { Job, JobCount } from '../../../../core/jobs/jobs.interface';
-import { getFuxSetting } from '../../../../shared/components/tutorials/utils';
 import { getMockedJob } from '../../../../test-utils/mocked-items-factory/mocked-jobs';
 import { getMockedUserGlobalSettingsObject } from '../../../../test-utils/mocked-items-factory/mocked-settings';
 import { onFirstScheduledOrRunningAutoTrainingJob } from './util';
@@ -47,7 +46,6 @@ describe('auto-training-credits-modal utils', () => {
         });
 
         it('it is first scheduled auto-training job', () => {
-            jest.mocked(getFuxSetting).mockReturnValue(true);
             onFirstScheduledOrRunningAutoTrainingJob(
                 getMockedUserGlobalSettingsObject(),
                 mockedCallback
@@ -61,7 +59,6 @@ describe('auto-training-credits-modal utils', () => {
         });
 
         it('it is first running auto-training job', () => {
-            jest.mocked(getFuxSetting).mockReturnValue(true);
             onFirstScheduledOrRunningAutoTrainingJob(
                 getMockedUserGlobalSettingsObject(),
                 mockedCallback
@@ -75,7 +72,6 @@ describe('auto-training-credits-modal utils', () => {
         });
 
         it('it is scheduled job but user has previously auto-trained', () => {
-            jest.mocked(getFuxSetting).mockReturnValue(false);
             onFirstScheduledOrRunningAutoTrainingJob(
                 getMockedUserGlobalSettingsObject(),
                 mockedCallback
@@ -97,7 +93,6 @@ describe('auto-training-credits-modal utils', () => {
         });
 
         it('no scheduled jobs', () => {
-            jest.mocked(getFuxSetting).mockReturnValue(true);
             onFirstScheduledOrRunningAutoTrainingJob(
                 getMockedUserGlobalSettingsObject(),
                 mockedCallback
@@ -112,7 +107,6 @@ describe('auto-training-credits-modal utils', () => {
                 ['numberOfCancelledJobs'],
                 ['numberOfFailedJobs'],
             ];
-            jest.mocked(getFuxSetting).mockReturnValue(true);
             test.each(testData)('%s', (jobName) => {
                 onFirstScheduledOrRunningAutoTrainingJob(
                     getMockedUserGlobalSettingsObject(),
diff --git a/web_ui/src/pages/annotator/notification/auto-training-credits-modal/util.ts b/web_ui/src/pages/annotator/notification/auto-training-credits-modal/util.ts
@@ -7,7 +7,6 @@ import { GETI_SYSTEM_AUTHOR_ID, JobState } from '../../../../core/jobs/jobs.cons
 import { JobsResponse } from '../../../../core/jobs/services/jobs-service.interface';
 import { FUX_SETTINGS_KEYS } from '../../../../core/user-settings/dtos/user-settings.interface';
 import { UserGlobalSettings, UseSettings } from '../../../../core/user-settings/services/user-settings.interface';
-import { getFuxSetting } from '../../../../shared/components/tutorials/utils';
 
 export const onFirstScheduledOrRunningAutoTrainingJob =
     (settings: UseSettings<UserGlobalSettings>, callback: (jobId: string) => void) =>
@@ -20,7 +19,7 @@ export const onFirstScheduledOrRunningAutoTrainingJob =
         const totalScheduledJobs = Number(jobsCount.numberOfScheduledJobs);
         const totalRunningJobs = Number(jobsCount.numberOfRunningJobs);
         const hasScheduledOrRunningTrainingJobs = totalScheduledJobs > 0 || totalRunningJobs > 0;
-        const neverAutoTrained = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED, settings.config);
+        const neverAutoTrained = settings.config[FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED].value;
         const isAutoTrainingJob = jobs.find((job) => {
             return (
                 (job.state === JobState.SCHEDULED || job.state === JobState.RUNNING) &&
diff --git a/web_ui/src/shared/components/coach-mark/fux-notifications/auto-training-coach-mark.component.tsx b/web_ui/src/shared/components/coach-mark/fux-notifications/auto-training-coach-mark.component.tsx
@@ -16,7 +16,6 @@ import { useFuxNotifications } from '../../../../hooks/use-fux-notifications/use
 import { useIsAutoTrainingOn } from '../../../../pages/annotator/hooks/use-is-auto-training-on.hook';
 import { onFirstScheduledOrRunningAutoTrainingJob } from '../../../../pages/annotator/notification/auto-training-credits-modal/util';
 import { useProject } from '../../../../pages/project-details/providers/project-provider/project-provider.component';
-import { getFuxSetting } from '../../tutorials/utils';
 import { CoachMark } from '../coach-mark.component';
 
 const useAutoTrainingCoachMarkJobs = () => {
@@ -27,7 +26,7 @@ const useAutoTrainingCoachMarkJobs = () => {
     const { useGetJobs } = useJobs(projectIdentifier);
 
     const isAutoTrainingOn = useIsAutoTrainingOn({ project, projectIdentifier });
-    const neverAutoTrained = getFuxSetting(FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED, settings.config);
+    const neverAutoTrained = settings.config[FUX_SETTINGS_KEYS.NEVER_AUTOTRAINED].value;
     const isQueryEnabled = Boolean(!FEATURE_FLAG_CREDIT_SYSTEM && isAutoTrainingOn && neverAutoTrained);
 
     const handleSuccess = useCallback(
diff --git a/web_ui/src/shared/components/coach-mark/fux-notifications/successfully-auto-trained-notification.component.tsx b/web_ui/src/shared/components/coach-mark/fux-notifications/successfully-auto-trained-notification.component.tsx
@@ -18,7 +18,6 @@ import { useUserGlobalSettings } from '../../../../core/user-settings/hooks/use-
 import { useFuxNotifications } from '../../../../hooks/use-fux-notifications/use-fux-notifications.hook';
 import { useProjectIdentifier } from '../../../../hooks/use-project-identifier/use-project-identifier';
 import { useProject } from '../../../../pages/project-details/providers/project-provider/project-provider.component';
-import { getFuxSetting } from '../../tutorials/utils';
 import { CoachMark } from '../coach-mark.component';
 import { onFirstSuccessfulAutoTrainingJob } from '../utils';
 
@@ -62,11 +61,8 @@ export const SuccessfullyAutotrainedNotification = () => {
     const { data: modelsData = [] } = useProjectModelsQuery({ refetchInterval: 15000 });
     const isAnomalous = isAnomalyDomain(project.domains[0]);
 
-    const neverSuccessfullyAutoTrained = getFuxSetting(
-        FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED,
-        settings.config
-    );
-    const firstAutoTrainedModelId = getFuxSetting(FUX_SETTINGS_KEYS.FIRST_AUTOTRAINED_MODEL_ID, settings.config);
+    const neverSuccessfullyAutoTrained = settings.config[FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED].value;
+    const firstAutoTrainedModelId = settings.config[FUX_SETTINGS_KEYS.FIRST_AUTOTRAINED_MODEL_ID].value;
     const isQueryEnabled = Boolean(neverSuccessfullyAutoTrained);
 
     const trainedModel = modelsData.find((model) =>
diff --git a/web_ui/src/shared/components/coach-mark/utils.test.ts b/web_ui/src/shared/components/coach-mark/utils.test.ts
@@ -5,8 +5,10 @@ import { GETI_SYSTEM_AUTHOR_ID, JobState } from '../../../core/jobs/jobs.const';
 import { Job, JobCount } from '../../../core/jobs/jobs.interface';
 import { FUX_SETTINGS_KEYS } from '../../../core/user-settings/dtos/user-settings.interface';
 import { getMockedJob } from '../../../test-utils/mocked-items-factory/mocked-jobs';
-import { getMockedUserGlobalSettingsObject } from '../../../test-utils/mocked-items-factory/mocked-settings';
-import { getFuxSetting } from '../tutorials/utils';
+import {
+    getMockedUserGlobalSettings,
+    getMockedUserGlobalSettingsObject,
+} from '../../../test-utils/mocked-items-factory/mocked-settings';
 import { onFirstSuccessfulAutoTrainingJob } from './utils';
 
 const getJobResponse = (jobCount: Partial<JobCount> = {}, mockedJobs: Job[] = []) => ({
@@ -27,10 +29,6 @@ const getJobResponse = (jobCount: Partial<JobCount> = {}, mockedJobs: Job[] = []
     ],
 });
 
-jest.mock('../tutorials/utils', () => ({
-    getFuxSetting: jest.fn(),
-}));
-
 describe('CoachMark utils', () => {
     beforeEach(() => {
         jest.clearAllMocks();
@@ -44,48 +42,51 @@ describe('CoachMark utils', () => {
                 getMockedUserGlobalSettingsObject({}),
                 mockedCallback
             )({ pageParams: [undefined], pages: [] });
-            expect(mockedCallback).toBeCalledTimes(0);
+            expect(mockedCallback).toHaveBeenCalledTimes(0);
         });
 
         it('will not call callback when no finished jobs', () => {
             onFirstSuccessfulAutoTrainingJob(getMockedUserGlobalSettingsObject({}), mockedCallback)(getJobResponse());
-            expect(mockedCallback).toBeCalledTimes(0);
+            expect(mockedCallback).toHaveBeenCalledTimes(0);
         });
 
         it('will not call callback when previously autotrained', () => {
-            jest.mocked(getFuxSetting).mockImplementationOnce((setting) => {
-                if (setting === FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED) {
-                    return false;
-                } else {
-                    return true;
-                }
-            });
-            onFirstSuccessfulAutoTrainingJob(getMockedUserGlobalSettingsObject({}), mockedCallback)(getJobResponse());
-            expect(mockedCallback).toBeCalledTimes(0);
+            onFirstSuccessfulAutoTrainingJob(
+                getMockedUserGlobalSettingsObject({
+                    config: getMockedUserGlobalSettings({
+                        [FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED]: {
+                            value: false,
+                        },
+                    }),
+                }),
+                mockedCallback
+            )(getJobResponse());
+            expect(mockedCallback).toHaveBeenCalledTimes(0);
         });
 
         it('will not call callback when first scheduled autotraining job id doesnt match finished job id', () => {
-            jest.mocked(getFuxSetting).mockImplementationOnce((setting) => {
-                if (setting === FUX_SETTINGS_KEYS.FIRST_AUTOTRAINING_JOB_ID) {
-                    return 'random-job-id';
-                } else {
-                    return true;
-                }
-            });
-            onFirstSuccessfulAutoTrainingJob(getMockedUserGlobalSettingsObject({}), mockedCallback)(getJobResponse());
-            expect(mockedCallback).toBeCalledTimes(0);
+            onFirstSuccessfulAutoTrainingJob(
+                getMockedUserGlobalSettingsObject({
+                    config: getMockedUserGlobalSettings({
+                        [FUX_SETTINGS_KEYS.FIRST_AUTOTRAINING_JOB_ID]: {
+                            value: 'random-job-id',
+                        },
+                    }),
+                }),
+                mockedCallback
+            )(getJobResponse());
+            expect(mockedCallback).toHaveBeenCalledTimes(0);
         });
 
         it('will not call callback when first scheduled job id was not autotrained', () => {
-            jest.mocked(getFuxSetting).mockImplementation((setting) => {
-                if (setting === FUX_SETTINGS_KEYS.FIRST_AUTOTRAINING_JOB_ID) {
-                    return 'first-autotrained-job-id';
-                } else {
-                    return true;
-                }
-            });
             onFirstSuccessfulAutoTrainingJob(
-                getMockedUserGlobalSettingsObject({}),
+                getMockedUserGlobalSettingsObject({
+                    config: getMockedUserGlobalSettings({
+                        [FUX_SETTINGS_KEYS.FIRST_AUTOTRAINING_JOB_ID]: {
+                            value: 'first-autotrained-job-id',
+                        },
+                    }),
+                }),
                 mockedCallback
             )(
                 getJobResponse({ numberOfFinishedJobs: 1 }, [
@@ -97,12 +98,21 @@ describe('CoachMark utils', () => {
                 ])
             );
 
-            expect(mockedCallback).toBeCalledTimes(0);
+            expect(mockedCallback).toHaveBeenCalledTimes(0);
         });
 
         it('will call callback ', () => {
             onFirstSuccessfulAutoTrainingJob(
-                getMockedUserGlobalSettingsObject({}),
+                getMockedUserGlobalSettingsObject({
+                    config: getMockedUserGlobalSettings({
+                        [FUX_SETTINGS_KEYS.NEVER_SUCCESSFULLY_AUTOTRAINED]: {
+                            value: true,
+                        },
+                        [FUX_SETTINGS_KEYS.FIRST_AUTOTRAINING_JOB_ID]: {
+                            value: 'first-autotrained-job-id',
+                        },
+                    }),
+                }),
                 mockedCallback
             )(
                 getJobResponse({ numberOfFinishedJobs: 1 }, [
@@ -114,7 +124,7 @@ describe('CoachMark utils', () => {
                 ])
             );
 
-            expect(mockedCallback).toBeCalledTimes(1);
+            expect(mockedCallback).toHaveBeenCalledTimes(1);
         });
     });
 });
diff --git a/web_ui/src/shared/components/coach-mark/utils.ts b/web_ui/src/shared/components/coach-mark/utils.ts
diff --git a/web_ui/src/shared/components/tutorials/utils.ts b/web_ui/src/shared/components/tutorials/utils.ts
