Skip to content

feat: Add analytics for code copied, index strategy docs clicked, and updated code equivalent toggle event CLOUDP-323670 #7000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 11, 2025
Merged

feat: Add analytics for code copied, index strategy docs clicked, and updated code equivalent toggle event CLOUDP-323670 #7000

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5170b66
add analytics for input index copied + updated code equivalent toggle
rubydong Jun 11, 2025
2fb2e50
add code copied for index suggestions and event for strategy doc clicked
rubydong Jun 11, 2025
5342f13
make onCopy a required field
rubydong Jun 11, 2025
a15236f
cleaned up oncopy call
rubydong Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/compass-indexes/src/components/create-index-form/index-flow-section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ const IndexFlowSection = ({
setIsCodeEquivalentToggleChecked(value);
track('Code Equivalent Toggled', {
context: 'Create Index Modal',
toggled: value === true ? 'On' : 'Off',
});
}}
checked={isCodeEquivalentToggleChecked}
Expand All @@ -290,6 +291,11 @@ const IndexFlowSection = ({
dbName={dbName}
collectionName={collectionName}
indexNameTypeMap={indexNameTypeMap}
onCopy={() => {
track('Input Index Copied', {
context: 'Create Index Modal',
});
}}
/>
) : (
createIndexFieldsComponent
Expand Down
1 change: 1 addition & 0 deletions packages/compass-indexes/src/components/create-index-form/mdb-code-viewer.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ describe('MDBCodeViewer', () => {
dbName={dbName}
collectionName={collectionName}
indexNameTypeMap={indexNameTypeMap}
onCopy={() => {}}
/>
);
};
Expand Down
12 changes: 11 additions & 1 deletion packages/compass-indexes/src/components/create-index-form/mdb-code-viewer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,13 @@ const MDBCodeViewer = ({
dbName,
collectionName,
indexNameTypeMap,
onCopy,
dataTestId,
}: {
dbName: string;
collectionName: string;
indexNameTypeMap: Record<string, string | number>;
onCopy: () => void;
dataTestId?: string;
}) => {
const track = useTelemetry();
Expand All @@ -72,7 +74,15 @@ const MDBCodeViewer = ({

return (
<div className={containerStyles}>
<Code data-testid={dataTestId || 'mdb-code-viewer'} language="javascript">
<Code
data-testid={dataTestId || 'mdb-code-viewer'}
language="javascript"
onCopy={() => {
if (onCopy) {
onCopy();
}
}}
Copy link
Member

@Anemy Anemy Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
onCopy={() => {
if (onCopy) {
onCopy();
}
}}
onCopy={onCopy}

>
{GeneratedCode}
</Code>
<span className={programmingLanguageLinkStyles}>
Expand Down
5 changes: 5 additions & 0 deletions packages/compass-indexes/src/components/create-index-form/query-flow-section.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,11 @@ const QueryFlowSection = ({
dbName={dbName}
collectionName={collectionName}
indexNameTypeMap={indexSuggestions}
onCopy={() => {
track('Index Suggestions Copied', {
context: 'Create Index Modal',
});
}}
/>
</div>
</>
Expand Down
7 changes: 7 additions & 0 deletions packages/compass-indexes/src/components/create-index-modal/create-index-modal-header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
Link,
useDarkMode,
} from '@mongodb-js/compass-components';
import { useTelemetry } from '@mongodb-js/compass-telemetry/provider';
import React from 'react';

const headerStyle = css({
Expand All @@ -24,6 +25,7 @@ const subtitleDarkStyle = css({

const CreateIndexModalHeader = () => {
const darkMode = useDarkMode();
const track = useTelemetry();
return (
<div className={headerStyle}>
<H3 data-testid="create-index-modal-header-title">Create Index</H3>
Expand All @@ -39,6 +41,11 @@ const CreateIndexModalHeader = () => {
href="https://docs.mongodb.com/manual/applications/indexes/"
target="_blank"
rel="noopener noreferrer"
onClick={() => {
track('Index Strategies Documentation Clicked', {
context: 'Create Index Modal',
});
}}
>
Index Strategies Documentation
</Link>
Expand Down
25 changes: 25 additions & 0 deletions packages/compass-telemetry/src/telemetry-events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2817,6 +2817,7 @@ type CreateIndexCodeEquivalentToggled = CommonEvent<{
name: 'Code Equivalent Toggled';
payload: {
context: CreateIndexModalContext;
toggled: 'On' | 'Off';
};
}>;

Expand Down Expand Up @@ -2848,6 +2849,27 @@ type CreateIndexCoveredQueriesLearnMoreClicked = CommonEvent<{
};
}>;

type CreateIndexInputIndexCopied = CommonEvent<{
name: 'Input Index Copied';
payload: {
context: CreateIndexModalContext;
};
}>;

type CreateIndexIndexSuggestionsCopied = CommonEvent<{
name: 'Index Suggestions Copied';
payload: {
context: CreateIndexModalContext;
};
}>;

type CreateIndexStrategiesDocumentationClicked = CommonEvent<{
name: 'Index Strategies Documentation Clicked';
payload: {
context: CreateIndexModalContext;
};
}>;

export type TelemetryEvent =
| AggregationCanceledEvent
| AggregationCopiedEvent
Expand Down Expand Up @@ -2989,4 +3011,7 @@ export type TelemetryEvent =
| CreateIndexProgrammingLanguageLinkClicked
| CreateIndexQueryTabClicked
| CreateIndexSuggestedIndexButtonClicked
| CreateIndexInputIndexCopied
| CreateIndexIndexSuggestionsCopied
| CreateIndexStrategiesDocumentationClicked
| UUIDEncounteredEvent;
Loading