chore(typescript): replace enums with const records COMPASS-10124 (#7621)

chore(typescript): replace enums with const records

Author: gribnoysup

packages/compass-aggregations/src/components/pipeline-toolbar/index.spec.tsx

@@ -11,7 +11,7 @@ import { renderWithStore } from '../../../test/configure-store';
 import { PipelineToolbar } from './index';
 import { createElectronPipelineStorage } from '@mongodb-js/my-queries-storage/electron';
 import { CompassExperimentationProvider } from '@mongodb-js/compass-telemetry';
-import { ExperimentTestGroup } from '@mongodb-js/compass-telemetry/provider';
+import { ExperimentTestGroups } from '@mongodb-js/compass-telemetry/provider';
 import type { PreferencesAccess } from 'compass-preferences-model';
 import { createSandboxFromDefaultPreferences } from 'compass-preferences-model';
 
@@ -164,7 +164,7 @@ describe('PipelineToolbar', function () {
           mockUseAssignment.returns({
             assignment: {
               assignmentData: {
-                variant: ExperimentTestGroup.atlasSkillsVariant,
+                variant: ExperimentTestGroups.atlasSkillsVariant,
               },
             },
             ...commonAsyncStatus,
@@ -173,7 +173,7 @@ describe('PipelineToolbar', function () {
           mockUseAssignment.returns({
             assignment: {
               assignmentData: {
-                variant: ExperimentTestGroup.atlasSkillsControl,
+                variant: ExperimentTestGroups.atlasSkillsControl,
               },
             },
             ...commonAsyncStatus,

packages/compass-aggregations/src/modules/aggregation.ts

@@ -41,16 +41,15 @@ export const WriteOperation = {
   Overwrite: 'overwriting',
 } as const;
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  RunAggregation = 'compass-aggeregations/runAggregation',
-  AggregationStarted = 'compass-aggregations/aggregationStarted',
-  AggregationFinished = 'compass-aggregations/aggregationFinished',
-  AggregationFailed = 'compass-aggregations/aggregationFailed',
-  AggregationCancelledByUser = 'compass-aggregations/aggregationCancelledByUser',
-  LastPageReached = 'compass-aggregations/lastPageReached',
-  ResultViewTypeChanged = 'compass-aggregations/resultViewTypeChanged',
-}
+export const ActionTypes = {
+  RunAggregation: 'compass-aggeregations/runAggregation',
+  AggregationStarted: 'compass-aggregations/aggregationStarted',
+  AggregationFinished: 'compass-aggregations/aggregationFinished',
+  AggregationFailed: 'compass-aggregations/aggregationFailed',
+  AggregationCancelledByUser: 'compass-aggregations/aggregationCancelledByUser',
+  LastPageReached: 'compass-aggregations/lastPageReached',
+  ResultViewTypeChanged: 'compass-aggregations/resultViewTypeChanged',
+} as const;
 
 type PreviousPageData = {
   page: number;
@@ -59,17 +58,17 @@ type PreviousPageData = {
 };
 
 export type RunAggregation = {
-  type: ActionTypes.RunAggregation;
+  type: typeof ActionTypes.RunAggregation;
   pipeline: Document[];
 };
 
 export type AggregationStartedAction = {
-  type: ActionTypes.AggregationStarted;
+  type: typeof ActionTypes.AggregationStarted;
   abortController: AbortController;
 };
 
 export type AggregationFinishedAction = {
-  type: ActionTypes.AggregationFinished;
+  type: typeof ActionTypes.AggregationFinished;
   documents: HadronDocument[];
   page: number;
   isLast: boolean;
@@ -81,22 +80,22 @@ export type AggregationError = {
 };
 
 export type AggregationFailedAction = {
-  type: ActionTypes.AggregationFailed;
+  type: typeof ActionTypes.AggregationFailed;
   error: AggregationError;
   page: number;
 };
 
 export type AggregationCancelledAction = {
-  type: ActionTypes.AggregationCancelledByUser;
+  type: typeof ActionTypes.AggregationCancelledByUser;
 };
 
 export type LastPageReachedAction = {
-  type: ActionTypes.LastPageReached;
+  type: typeof ActionTypes.LastPageReached;
   page: number;
 };
 
 export type ResultViewTypeChangedAction = {
-  type: ActionTypes.ResultViewTypeChanged;
+  type: typeof ActionTypes.ResultViewTypeChanged;
   viewType: 'document' | 'json';
 };
 

packages/compass-aggregations/src/modules/auto-preview.ts

@@ -7,13 +7,12 @@ import type { RestorePipelineAction } from './saved-pipeline';
 import { RESTORE_PIPELINE } from './saved-pipeline';
 import { isAction } from '../utils/is-action';
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  AutoPreviewToggled = 'compass-aggregations/autoPreviewToggled',
-}
+export const ActionTypes = {
+  AutoPreviewToggled: 'compass-aggregations/autoPreviewToggled',
+} as const;
 
 export type AutoPreviewToggledAction = {
-  type: ActionTypes.AutoPreviewToggled;
+  type: typeof ActionTypes.AutoPreviewToggled;
   value: boolean;
 };
 export type AutoPreviewAction = AutoPreviewToggledAction;

packages/compass-aggregations/src/modules/collection-stats.ts

@@ -20,13 +20,13 @@ export function pickCollectionStats(collection: Collection): CollectionStats {
   };
 }
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-enum CollectionStatsActions {
-  CollectionStatsFetched = 'compass-aggregations/collection-stats/CollectionStatsFetched',
-}
+const CollectionStatsActions = {
+  CollectionStatsFetched:
+    'compass-aggregations/collection-stats/CollectionStatsFetched',
+} as const;
 
 interface CollectionStatsFetchedAction {
-  type: CollectionStatsActions.CollectionStatsFetched;
+  type: typeof CollectionStatsActions.CollectionStatsFetched;
   collection: Collection;
 }
 

packages/compass-aggregations/src/modules/collections-fields.ts

@@ -12,27 +12,26 @@ export type CollectionInfo = Pick<Collection, 'name' | 'type'>;
 
 type CollectionType = CollectionInfo['type'];
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  CollectionsFetch = 'compass-aggregations/collectionsFetched',
-  CollectionFieldsFetched = 'compass-aggregations/collectionFieldsFetched',
-  CollectionDataUpdated = 'compass-aggregations/collectionDataUpdated',
-}
+export const ActionTypes = {
+  CollectionsFetch: 'compass-aggregations/collectionsFetched',
+  CollectionFieldsFetched: 'compass-aggregations/collectionFieldsFetched',
+  CollectionDataUpdated: 'compass-aggregations/collectionDataUpdated',
+} as const;
 
 type CollectionsFetchedAction = {
-  type: ActionTypes.CollectionsFetch;
+  type: typeof ActionTypes.CollectionsFetch;
   data: State;
 };
 
 type CollectionFieldsFetchedAction = {
-  type: ActionTypes.CollectionFieldsFetched;
+  type: typeof ActionTypes.CollectionFieldsFetched;
   collection: string;
   fields: string[];
   collectionType: CollectionType;
 };
 
 type CollectionDataUpdatedAction = {
-  type: ActionTypes.CollectionDataUpdated;
+  type: typeof ActionTypes.CollectionDataUpdated;
   collection: string;
   data: CollectionData;
 };

packages/compass-aggregations/src/modules/count-documents.ts

@@ -10,25 +10,24 @@ import { ActionTypes as ConfirmNewPipelineActions } from './is-new-pipeline-conf
 import { getPipelineFromBuilderState } from './pipeline-builder/builder-helpers';
 import { isAction } from '../utils/is-action';
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  CountStarted = 'compass-aggregations/countStarted',
-  CountFinished = 'compass-aggregations/countFinished',
-  CountFailed = 'compass-aggregations/countFailed',
-}
+export const ActionTypes = {
+  CountStarted: 'compass-aggregations/countStarted',
+  CountFinished: 'compass-aggregations/countFinished',
+  CountFailed: 'compass-aggregations/countFailed',
+} as const;
 
 type CountStartedAction = {
-  type: ActionTypes.CountStarted;
+  type: typeof ActionTypes.CountStarted;
   abortController: AbortController;
 };
 
 type CountFinishedAction = {
-  type: ActionTypes.CountFinished;
+  type: typeof ActionTypes.CountFinished;
   count: number;
 };
 
 type CountFailedAction = {
-  type: ActionTypes.CountFailed;
+  type: typeof ActionTypes.CountFailed;
 };
 
 export type Actions =

packages/compass-aggregations/src/modules/create-view/index.ts

@@ -26,50 +26,49 @@ export const INITIAL_STATE: CreateViewState = {
   pipeline: [],
 };
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-enum CreateViewActionTypes {
-  Open = 'aggregations/create-view/Open',
-  Close = 'aggregations/create-view/Close',
-  ToggleIsRunning = 'aggregations/create-view/is-running/ToggleIsRunning',
-  HandleError = 'aggregations/create-view/error/HandleError',
-  ClearError = 'aggregations/create-view/error/ClearError',
-  ChangeViewName = 'aggregations/create-view/name/ChangeName',
-  Reset = 'aggregations/create-view/reset',
-}
+const CreateViewActionTypes = {
+  Open: 'aggregations/create-view/Open',
+  Close: 'aggregations/create-view/Close',
+  ToggleIsRunning: 'aggregations/create-view/is-running/ToggleIsRunning',
+  HandleError: 'aggregations/create-view/error/HandleError',
+  ClearError: 'aggregations/create-view/error/ClearError',
+  ChangeViewName: 'aggregations/create-view/name/ChangeName',
+  Reset: 'aggregations/create-view/reset',
+} as const;
 
 export type OpenAction = {
-  type: CreateViewActionTypes.Open;
+  type: typeof CreateViewActionTypes.Open;
   connectionId: string;
   source: string;
   pipeline: unknown[];
   duplicate: boolean;
 };
 
 export type CloseAction = {
-  type: CreateViewActionTypes.Close;
+  type: typeof CreateViewActionTypes.Close;
 };
 
 export type ToggleIsRunningAction = {
-  type: CreateViewActionTypes.ToggleIsRunning;
+  type: typeof CreateViewActionTypes.ToggleIsRunning;
   isRunning: boolean;
 };
 
 export type HandleErrorAction = {
-  type: CreateViewActionTypes.HandleError;
+  type: typeof CreateViewActionTypes.HandleError;
   error: Error;
 };
 
 export type ClearErrorAction = {
-  type: CreateViewActionTypes.ClearError;
+  type: typeof CreateViewActionTypes.ClearError;
 };
 
 export type ChangeViewNameAction = {
-  type: CreateViewActionTypes.ChangeViewName;
+  type: typeof CreateViewActionTypes.ChangeViewName;
   name: string;
 };
 
 export type ResetAction = {
-  type: CreateViewActionTypes.Reset;
+  type: typeof CreateViewActionTypes.Reset;
 };
 
 export type CreateViewAction =

packages/compass-aggregations/src/modules/focus-mode.ts

@@ -3,24 +3,23 @@ import type { PipelineBuilderThunkAction } from '.';
 import { isAction } from '../utils/is-action';
 import { addStage, pipelineFromStore } from './pipeline-builder/stage-editor';
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-enum ActionTypes {
-  FocusModeEnabled = 'compass-aggregations/focusModeEnabled',
-  FocusModeDisabled = 'compass-aggregations/focusModeDisabled',
-  SelectFocusModeStage = 'compass-aggregations/selectFocusModeStage',
-}
+const ActionTypes = {
+  FocusModeEnabled: 'compass-aggregations/focusModeEnabled',
+  FocusModeDisabled: 'compass-aggregations/focusModeDisabled',
+  SelectFocusModeStage: 'compass-aggregations/selectFocusModeStage',
+} as const;
 
 type FocusModeEnabledAction = {
-  type: ActionTypes.FocusModeEnabled;
+  type: typeof ActionTypes.FocusModeEnabled;
   stageIndex: number;
 };
 
 type FocusModeDisabledAction = {
-  type: ActionTypes.FocusModeDisabled;
+  type: typeof ActionTypes.FocusModeDisabled;
 };
 
 type SelectFocusModeStageAction = {
-  type: ActionTypes.SelectFocusModeStage;
+  type: typeof ActionTypes.SelectFocusModeStage;
   index: number;
 };
 

packages/compass-aggregations/src/modules/input-documents.ts

@@ -5,23 +5,22 @@ import type { AnyAction } from 'redux';
 import { isAction } from '../utils/is-action';
 import { DEFAULT_MAX_TIME_MS } from '../constants';
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  CollapseToggled = 'aggregations/input-documents/CollapseToggled',
-  DocumentsFetchStarted = 'aggregations/input-documents/DocumentsFetchStarted',
-  DocumentsFetchFinished = 'aggregations/input-documents/DocumentsFetchFinished',
-}
+export const ActionTypes = {
+  CollapseToggled: 'aggregations/input-documents/CollapseToggled',
+  DocumentsFetchStarted: 'aggregations/input-documents/DocumentsFetchStarted',
+  DocumentsFetchFinished: 'aggregations/input-documents/DocumentsFetchFinished',
+} as const;
 
 type CollapseToggledAction = {
-  type: ActionTypes.CollapseToggled;
+  type: typeof ActionTypes.CollapseToggled;
 };
 
 type DocumentsFetchStartedAction = {
-  type: ActionTypes.DocumentsFetchStarted;
+  type: typeof ActionTypes.DocumentsFetchStarted;
 };
 
 type DocumentsFetchFinishedAction = {
-  type: ActionTypes.DocumentsFetchFinished;
+  type: typeof ActionTypes.DocumentsFetchFinished;
   documents: HadronDocument[];
   error: Error | null;
 };

packages/compass-aggregations/src/modules/is-new-pipeline-confirm.ts

@@ -5,13 +5,13 @@ import type Stage from './pipeline-builder/stage';
 import type { Document } from 'bson';
 import type { PipelineParserError } from './pipeline-builder/pipeline-parser/utils';
 
-// @ts-expect-error TODO(COMPASS-10124): replace enums with const kv objects
-export enum ActionTypes {
-  NewPipelineConfirmed = 'compass-aggregations/is-new-pipeline-confirm/newPipelineConfirmed',
-}
+export const ActionTypes = {
+  NewPipelineConfirmed:
+    'compass-aggregations/is-new-pipeline-confirm/newPipelineConfirmed',
+} as const;
 
 export type NewPipelineConfirmedAction = {
-  type: ActionTypes.NewPipelineConfirmed;
+  type: typeof ActionTypes.NewPipelineConfirmed;
   stages: Stage[];
   pipelineText: string;
   pipeline: Document[] | null;