chore(indexes): add feature flag for rolling indexes COMPASS-8507 (#6509

)

* chore(indexes): add feature flag for rolling indexes

* chore: remove custom docker registry

.evergreen/start-atlas-cloud-cluster.sh

@@ -2,6 +2,7 @@
 
 RUN_ID="$(date +"%s")-$(git rev-parse --short HEAD)"
 DELETE_AFTER="$(date -u -Iseconds -d '+2 hours' 2>/dev/null || date -u -Iseconds -v '+2H')"
+DOCKER_REGISTRY="${DOCKER_REGISTRY:-docker.io}"
 
 # This script helps to automatically provision Atlas cluster for running the e2e
 # tests against. In CI this will always create a new cluster and delete it when
@@ -39,8 +40,8 @@ DELETE_AFTER="$(date -u -Iseconds -d '+2 hours' 2>/dev/null || date -u -Iseconds
 #     MCLI_ORG_ID           Org ID
 #     MCLI_PROJECT_ID       Project ID
 #
-#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_USERNAME         Cloud user you created
-#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_PASSWORD         Cloud user password
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_USERNAME  Cloud user you created
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_PASSWORD  Cloud user password
 #
 # - Source the script followed by running the tests to make sure that some
 #   variables exported from this script are available for the test env:
@@ -68,7 +69,7 @@ function atlascli() {
     -e MCLI_ORG_ID \
     -e MCLI_PROJECT_ID \
     -e MCLI_OPS_MANAGER_URL \
-    mongodb/atlas atlas $@
+    "$DOCKER_REGISTRY/mongodb/atlas" atlas $@
 }
 
 cleanup() {

packages/compass-indexes/src/components/create-index-form/create-index-form.tsx

@@ -10,6 +10,7 @@ import {
   useConnectionInfo,
   useConnectionSupports,
 } from '@mongodb-js/compass-connections/provider';
+import { usePreference } from 'compass-preferences-model/provider';
 
 const createIndexModalFieldsStyles = css({
   margin: `${spacing[4]}px 0 ${spacing[5]}px 0`,
@@ -43,10 +44,13 @@ function CreateIndexForm({
   onRemoveFieldClick,
 }: CreateIndexFormProps) {
   const { id: connectionId } = useConnectionInfo();
+  const rollingIndexesFeatureEnabled = !!usePreference('enableRollingIndexes');
   const supportsRollingIndexes = useConnectionSupports(
     connectionId,
     'rollingIndexCreation'
   );
+  const showRollingIndexOption =
+    rollingIndexesFeatureEnabled && supportsRollingIndexes;
   const schemaFields = useAutocompleteFields(namespace);
   const schemaFieldNames = useMemo(() => {
     return schemaFields
@@ -95,7 +99,7 @@ function CreateIndexForm({
             <CollapsibleInput name="columnstoreProjection"></CollapsibleInput>
           )}
           <CheckboxInput name="sparse"></CheckboxInput>
-          {supportsRollingIndexes && (
+          {showRollingIndexOption && (
             <CheckboxInput name="buildInRollingProcess"></CheckboxInput>
           )}
         </div>

packages/compass-indexes/src/index.spec.tsx

@@ -60,6 +60,11 @@ describe('CompassIndexesPlugin', function () {
           instanceSize: 'VERY BIG',
           metricsType: 'replicaSet',
         } as any,
+      },
+      {
+        preferences: {
+          enableRollingIndexes: true,
+        },
       }
     );
   }

packages/compass-indexes/src/index.ts

@@ -18,6 +18,7 @@ import { createLoggerLocator } from '@mongodb-js/compass-logging/provider';
 import { telemetryLocator } from '@mongodb-js/compass-telemetry/provider';
 import { IndexesTabTitle } from './plugin-title';
 import { atlasServiceLocator } from '@mongodb-js/atlas-service/provider';
+import { preferencesLocator } from 'compass-preferences-model/provider';
 
 export const CompassIndexesHadronPlugin = registerHadronPlugin(
   {
@@ -36,6 +37,7 @@ export const CompassIndexesHadronPlugin = registerHadronPlugin(
     track: telemetryLocator,
     collection: collectionModelLocator,
     atlasService: atlasServiceLocator,
+    preferences: preferencesLocator,
   }
 );
 

packages/compass-indexes/src/modules/index.ts

@@ -20,6 +20,7 @@ import type { ConnectionInfoRef } from '@mongodb-js/compass-connections/provider
 import type { IndexesDataServiceProps } from '../stores/store';
 import type { Collection } from '@mongodb-js/compass-app-stores/provider';
 import type { RollingIndexesService } from './rolling-indexes-service';
+import type { PreferencesAccess } from 'compass-preferences-model';
 const reducer = combineReducers({
   // From instance.isWritable. Used to know if the create button should be
   // enabled.
@@ -76,6 +77,7 @@ export type IndexesExtraArgs = {
     regularIndexes: ReturnType<typeof setInterval> | null;
     searchIndexes: ReturnType<typeof setInterval> | null;
   };
+  preferences: PreferencesAccess;
 };
 export type IndexesThunkDispatch<A extends Action = AnyAction> = ThunkDispatch<
   RootState,

packages/compass-indexes/src/modules/regular-indexes.ts

@@ -369,7 +369,13 @@ const fetchIndexes = (
   return async (
     dispatch,
     getState,
-    { dataService, collection, connectionInfoRef, rollingIndexesService }
+    {
+      dataService,
+      collection,
+      connectionInfoRef,
+      rollingIndexesService,
+      preferences,
+    }
   ) => {
     const {
       isReadonlyView,
@@ -387,16 +393,21 @@ const fetchIndexes = (
       return;
     }
 
-    const isRollingIndexesSupported = connectionSupports(
+    const clusterSupportsRollingIndexes = connectionSupports(
       connectionInfoRef.current,
       'rollingIndexCreation'
     );
+    const rollingIndexesEnabled =
+      !!preferences.getPreferences().enableRollingIndexes;
+
+    const shouldFetchRollingIndexes =
+      clusterSupportsRollingIndexes && rollingIndexesEnabled;
 
     try {
       dispatch(fetchIndexesStarted(reason));
       const promises = [
         dataService.indexes(namespace),
-        isRollingIndexesSupported
+        shouldFetchRollingIndexes
           ? rollingIndexesService.listRollingIndexes(namespace)
           : undefined,
       ] as [Promise<IndexDefinition[]>, Promise<AtlasIndexStats[]> | undefined];

packages/compass-indexes/src/stores/store.ts

@@ -32,6 +32,7 @@ import {
 } from '../modules/collection-stats';
 import type { AtlasService } from '@mongodb-js/atlas-service/provider';
 import { RollingIndexesService } from '../modules/rolling-indexes-service';
+import type { PreferencesAccess } from 'compass-preferences-model';
 
 export type IndexesDataServiceProps =
   | 'indexes'
@@ -60,6 +61,7 @@ export type IndexesPluginServices = {
   collection: Collection;
   track: TrackFunction;
   atlasService: AtlasService;
+  preferences: PreferencesAccess;
 };
 
 export type IndexesPluginOptions = {
@@ -85,6 +87,7 @@ export function activateIndexesPlugin(
     dataService,
     collection: collectionModel,
     atlasService,
+    preferences,
   }: IndexesPluginServices,
   { on, cleanup, addCleanup }: ActivateHelpers
 ) {
@@ -119,6 +122,7 @@ export function activateIndexesPlugin(
           connectionInfoRef
         ),
         pollingIntervalRef,
+        preferences,
       })
     )
   );

packages/compass-indexes/test/setup-store.ts

@@ -160,6 +160,13 @@ export const setupStore = (
       collection: createMockCollection(),
       connectionInfoRef,
       atlasService,
+      preferences: {
+        getPreferences() {
+          return {
+            enableRollingIndexes: true,
+          };
+        },
+      } as any,
       ...services,
     },
     createActivateHelpers()

packages/compass-preferences-model/src/feature-flags.ts

@@ -20,6 +20,7 @@ export type FeatureFlags = {
   enableRenameCollectionModal: boolean;
   enableQueryHistoryAutocomplete: boolean;
   enableProxySupport: boolean;
+  enableRollingIndexes: boolean;
 };
 
 export const featureFlags: Required<{
@@ -84,4 +85,11 @@ export const featureFlags: Required<{
       long: 'Allows users to specify proxy configuration for the entire Compass application.',
     },
   },
+
+  enableRollingIndexes: {
+    stage: 'development',
+    description: {
+      short: 'Enable creating indexes with the rolling build in Atlas Cloud',
+    },
+  },
 };

packages/compass-web/sandbox/index.tsx

@@ -76,6 +76,7 @@ const App = () => {
             atlasServiceBackendPreset: atlasServiceSandboxBackendVariant,
             enableCreatingNewConnections: !isAtlas,
             enableGlobalWrites: isAtlas,
+            enableRollingIndexes: isAtlas,
           }}
           onTrack={sandboxTelemetry.track}
           onDebug={sandboxLogger.debug}