feat(compass-indexes): Add segment event tracking for search index support on views COMPASS-9964 (#7592)

* initial commit

* fix category

---------

Co-authored-by: Jimmy Choi <[email protected]>

Author: JimmyChoiMDB

packages/compass-indexes/src/components/indexes-toolbar/indexes-toolbar.tsx

@@ -28,6 +28,7 @@ import { indexViewChanged } from '../../modules/index-view';
 import type { CollectionStats } from '../../modules/collection-stats';
 import type { Document } from 'mongodb';
 import { VIEW_PIPELINE_UTILS } from '@mongodb-js/mongodb-constants';
+import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
 
 const toolbarButtonsContainer = css({
   display: 'flex',
@@ -321,6 +322,8 @@ export const CreateIndexButton: React.FunctionComponent<
   indexView,
   isViewPipelineSearchQueryable,
 }) => {
+  const track = useTelemetry();
+
   const onActionDispatch = useCallback(
     (action: CreateIndexActions) => {
       switch (action) {
@@ -338,7 +341,12 @@ export const CreateIndexButton: React.FunctionComponent<
       return (
         <Button
           disabled={!isWritable || !isViewPipelineSearchQueryable}
-          onClick={onCreateSearchIndexClick}
+          onClick={() => {
+            onCreateSearchIndexClick();
+            track('Create Search Index for View Clicked', {
+              context: 'Indexes Tab',
+            });
+          }}
           variant="primary"
           size="small"
         >

packages/compass-indexes/src/components/indexes/indexes.tsx

@@ -134,6 +134,7 @@ const AtlasIndexesBanner = ({
   onDismissClick: () => void;
 }) => {
   const { atlasMetadata } = useConnectionInfo();
+  const track = useTelemetry();
 
   if (!atlasMetadata || dismissed) {
     return null;
@@ -151,6 +152,11 @@ const AtlasIndexesBanner = ({
             clusterName: atlasMetadata.clusterName,
             namespace,
           })}
+          onClick={() => {
+            track('Atlas Search Indexes for View Link Clicked', {
+              context: 'Indexes Tab',
+            });
+          }}
           hideExternalIcon
         >
           {linkTitle}

packages/compass-indexes/src/components/search-indexes-table/search-indexes-table.tsx

@@ -41,6 +41,7 @@ import { useConnectionInfo } from '@mongodb-js/compass-connections/provider';
 import { useWorkspaceTabId } from '@mongodb-js/compass-workspaces/provider';
 import type { CollectionStats } from '../../modules/collection-stats';
 import { VIEW_PIPELINE_UTILS } from '@mongodb-js/mongodb-constants';
+import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
 
 type SearchIndexesTableProps = {
   namespace: string;
@@ -71,6 +72,8 @@ function ZeroState({
   onOpenCreateModalClick: () => void;
   isViewPipelineSearchQueryable: boolean;
 }) {
+  const track = useTelemetry();
+
   return (
     <EmptyContent
       icon={ZeroGraphic}
@@ -83,7 +86,12 @@ function ZeroState({
           justify="middle"
           trigger={
             <Button
-              onClick={onOpenCreateModalClick}
+              onClick={() => {
+                onOpenCreateModalClick();
+                track('Create Search Index for View Clicked', {
+                  context: 'Indexes Tab',
+                });
+              }}
               data-testid="create-atlas-search-index-button"
               variant="primary"
               size="small"

packages/compass-telemetry/src/telemetry-events.ts

@@ -3240,6 +3240,36 @@ type MockDataScriptCopiedEvent = CommonEvent<{
   };
 }>;
 
+/**
+ * This event is fired when a user clicks the link to Atlas Search in the Indexes tab for a view.
+ *
+ * @category Indexes
+ */
+type AtlasSearchIndexesForViewLinkClickedEvent = CommonEvent<{
+  name: 'Atlas Search Indexes for View Link Clicked';
+  payload: {
+    /**
+     * The context/screen from which the link was clicked.
+     */
+    context: 'Indexes Tab';
+  };
+}>;
+
+/**
+ * This event is fired when a user clicks the button to create a search index for a view.
+ *
+ * @category Indexes
+ */
+type CreateSearchIndexForViewClickedEvent = CommonEvent<{
+  name: 'Create Search Index for View Clicked';
+  payload: {
+    /**
+     * The context/screen from which the link was clicked.
+     */
+    context: 'Indexes Tab';
+  };
+}>;
+
 export type TelemetryEvent =
   | AggregationCanceledEvent
   | AggregationCopiedEvent
@@ -3270,6 +3300,7 @@ export type TelemetryEvent =
   | AiResponseGeneratedEvent
   | ApplicationLaunchedEvent
   | AtlasLinkClickedEvent
+  | AtlasSearchIndexesForViewLinkClickedEvent
   | AtlasSkillsCtaClickedEvent
   | AtlasSkillsCtaDismissedEvent
   | AtlasSignInErrorEvent
@@ -3293,6 +3324,7 @@ export type TelemetryEvent =
   | ConnectionFailedEvent
   | ConnectionImportedEvent
   | ConnectionRemovedEvent
+  | CreateSearchIndexForViewClickedEvent
   | CurrentOpShowOperationDetailsEvent
   | DatabaseCreatedEvent
   | DataModelingDiagramCollectionAdded