feat: setting up early indexes experimentation and experiment viewed event CLOUDP-311776 (#6860)

rubydong · web-flow · commit 5abf09b07ecd · 2025-04-18T12:31:37.000-04:00
* setting up experimentation file + receiving data from mms

* update modal title, size, and description

* simplifiedexperiment viewed func

* moved growth-experiments to telemetry folder + updated hook name

* moved func to provider

* created a CreateIndexModalHeader component

* added unit tests for create-index-modal-header

* fire EV if modal is open + removed preferences from AtlasOrgPreferences

* remove extra space in modal-header

* remove extra h3 and body export

* updated styling
diff --git a/packages/compass-indexes/src/components/create-index-modal/create-index-modal-header.spec.tsx b/packages/compass-indexes/src/components/create-index-modal/create-index-modal-header.spec.tsx
@@ -0,0 +1,27 @@
+import React from 'react';
+import { render, screen } from '@mongodb-js/testing-library-compass';
+import CreateIndexModalHeader from './create-index-modal-header';
+import { expect } from 'chai';
+
+describe('CreateIndexModalHeader', () => {
+  it('renders the modal title', () => {
+    render(<CreateIndexModalHeader />);
+    const title = screen.getByTestId('create-index-modal-header-title');
+
+    expect(title.textContent).to.be.equal('Create Index');
+  });
+
+  it('renders the subtitle text', () => {
+    render(<CreateIndexModalHeader />);
+    const subtitle = screen.getByTestId('create-index-modal-header-subtitle');
+    expect(subtitle).to.exist;
+  });
+
+  it('renders the link to the Index Strategies Documentation', () => {
+    render(<CreateIndexModalHeader />);
+    const link = screen.getByRole('link', {
+      name: /Index Strategies Documentation/i,
+    });
+    expect(link).to.exist;
+  });
+});
diff --git a/packages/compass-indexes/src/components/create-index-modal/create-index-modal-header.tsx b/packages/compass-indexes/src/components/create-index-modal/create-index-modal-header.tsx
@@ -0,0 +1,45 @@
+import {
+  H3,
+  Body,
+  spacing,
+  css,
+  palette,
+  Link,
+} from '@mongodb-js/compass-components';
+import React from 'react';
+
+const headerStyle = css({
+  padding: spacing[800],
+  paddingBottom: 0,
+});
+
+const subtitleStyle = css({
+  color: palette.gray.dark1,
+});
+
+const CreateIndexModalHeader = () => {
+  return (
+    <div className={headerStyle}>
+      <H3 data-testid="create-index-modal-header-title">Create Index</H3>
+
+      <Body
+        data-testid="create-index-modal-header-subtitle"
+        className={subtitleStyle}
+      >
+        The best indexes for your application should consider a number of
+        factors, such as your data model, and the queries you use most often. To
+        learn more about indexing best practices, read the{' '}
+        <Link
+          href="https://docs.mongodb.com/manual/applications/indexes/"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Index Strategies Documentation
+        </Link>
+        .
+      </Body>
+    </div>
+  );
+};
+
+export default CreateIndexModalHeader;
diff --git a/packages/compass-indexes/src/components/create-index-modal/create-index-modal.tsx b/packages/compass-indexes/src/components/create-index-modal/create-index-modal.tsx
@@ -21,8 +21,12 @@ import type { RootState } from '../../modules';
 import {
   useTrackOnChange,
   type TrackFunction,
+  useFireExperimentViewed,
+  TestName,
 } from '@mongodb-js/compass-telemetry/provider';
 import { useConnectionInfoRef } from '@mongodb-js/compass-connections/provider';
+import { usePreference } from 'compass-preferences-model/provider';
+import CreateIndexModalHeader from './create-index-modal-header';
 
 type CreateIndexModalProps = React.ComponentProps<typeof CreateIndexForm> & {
   isVisible: boolean;
@@ -70,13 +74,28 @@ function CreateIndexModal({
     undefined
   );
 
+  // @experiment Early Journey Indexes Guidance & Awareness  | Jira Epic: CLOUDP-239367
+  const enableInIndexesGuidanceExp = usePreference('enableIndexesGuidanceExp');
+  const showIndexesGuidanceVariant =
+    usePreference('showIndexesGuidanceVariant') && enableInIndexesGuidanceExp;
+
+  useFireExperimentViewed({
+    testName: TestName.earlyJourneyIndexesGuidance,
+    shouldFire: enableInIndexesGuidanceExp && isVisible,
+  });
+
   return (
     <Modal
       open={isVisible}
       setOpen={onSetOpen}
       data-testid="create-index-modal"
+      size={showIndexesGuidanceVariant ? 'large' : 'default'}
     >
-      <ModalHeader title="Create Index" subtitle={namespace} />
+      {showIndexesGuidanceVariant ? (
+        <CreateIndexModalHeader />
+      ) : (
+        <ModalHeader title="Create Index" subtitle={namespace} />
+      )}
 
       <ModalBody>
         <CreateIndexForm namespace={namespace} {...props} />
diff --git a/packages/compass-preferences-model/src/feature-flags.ts b/packages/compass-preferences-model/src/feature-flags.ts
@@ -24,6 +24,8 @@ export type FeatureFlags = {
   enableRollingIndexes: boolean;
   enableGlobalWrites: boolean;
   enableDataModeling: boolean;
+  enableIndexesGuidanceExp: boolean;
+  showIndexesGuidanceVariant: boolean;
 };
 
 export const featureFlags: Required<{
@@ -122,4 +124,23 @@ export const featureFlags: Required<{
       short: 'Design, Visualize, and Evolve your Data Model',
     },
   },
+
+  /**
+   * Feature flags for Early Journey Indexes Guidance & Awareness  | Jira Epic: CLOUDP-239367
+   * These are passed from MMS and not editable by user
+   */
+  enableIndexesGuidanceExp: {
+    stage: 'development',
+    description: {
+      short: 'Enable Indexes Guidance Experiment',
+    },
+  },
+
+  showIndexesGuidanceVariant: {
+    stage: 'development',
+    description: {
+      short:
+        'Used to check if user is in the Indexes Guidance Experiment Variant',
+    },
+  },
 };
diff --git a/packages/compass-telemetry/src/growth-experiments.ts b/packages/compass-telemetry/src/growth-experiments.ts
@@ -0,0 +1,3 @@
+export enum TestName {
+  earlyJourneyIndexesGuidance = 'EARLY_JOURNEY_INDEXES_GUIDANCE_20250328',
+}
diff --git a/packages/compass-telemetry/src/provider.tsx b/packages/compass-telemetry/src/provider.tsx
@@ -3,6 +3,7 @@ import { createServiceLocator } from 'hadron-app-registry';
 import { createTrack, type TelemetryServiceOptions } from './generic-track';
 import { useLogger } from '@mongodb-js/compass-logging/provider';
 import type { TrackFunction } from './types';
+import { TestName } from './growth-experiments';
 
 const noop = () => {
   // noop
@@ -101,4 +102,38 @@ export function useTrackOnChange(
   }, [...dependencies, track, options.skipOnMount]);
 }
 
+/**
+ * Hook that fires Experiment Viewed if user is in an experiment
+ *
+ * @param testName - The name of the experiment to track.
+ * @param shouldFire - A boolean indicating whether to fire the event. Defaults to true.
+ *
+ * @example
+ * useFireExperimentViewed({
+ *   testName: TestName.earlyJourneyIndexesGuidance,
+ *   shouldFire: enableInIndexesGuidanceExp ,
+ * });
+ */
+export const useFireExperimentViewed = ({
+  testName,
+  shouldFire = true,
+}: {
+  testName: TestName;
+  shouldFire?: boolean;
+}) => {
+  useTrackOnChange(
+    (track: TrackFunction) => {
+      if (!shouldFire) {
+        return;
+      }
+      track('Experiment Viewed', {
+        test_name: testName,
+      });
+    },
+    [shouldFire, testName],
+    undefined
+  );
+};
+
 export type { TrackFunction };
+export { TestName };
diff --git a/packages/compass-telemetry/src/telemetry-events.ts b/packages/compass-telemetry/src/telemetry-events.ts
@@ -2673,6 +2673,11 @@ type SecretStorageNotAvailableEvent = CommonEvent<{
   payload: Record<string, never>;
 }>;
 
+type ExperimentViewedEvent = CommonEvent<{
+  name: 'Experiment Viewed';
+  payload: { test_name: string };
+}>;
+
 export type TelemetryEvent =
   | AggregationCanceledEvent
   | AggregationCopiedEvent
@@ -2793,4 +2798,5 @@ export type TelemetryEvent =
   | LargestContentfulPaintEvent
   | FirstInputDelayEvent
   | CumulativeLayoutShiftEvent
-  | TimeToFirstByteEvent;
+  | TimeToFirstByteEvent
+  | ExperimentViewedEvent;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export enum TestName {`
	`2`	`+ earlyJourneyIndexesGuidance = 'EARLY_JOURNEY_INDEXES_GUIDANCE_20250328',`
	`3`	`+}`