chore(compass-collection): Add track events for mock data generator modal CLOUDP-333861 #7482

kylelai1 · 2025-10-21T15:58:18Z

Description

CLOUDP-333861

Adds analytics track events as per the TD

Checklist

[ x ] New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
[ x ] Misc

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
[ x ] Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

Copilot

Pull Request Overview

This PR adds comprehensive telemetry tracking for the Mock Data Generator modal feature to measure user engagement and feature usage patterns. The changes implement analytics events as specified in the technical design document for tracking user interactions throughout the mock data generation workflow.

Key changes:

Defined 9 new telemetry event types for tracking button views, modal interactions, and user actions
Instrumented modal screens and user interactions with tracking calls
Added test coverage for all new tracking events

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`packages/compass-telemetry/src/telemetry-events.ts`	Defines 9 new event types for Mock Data Generator analytics
`packages/compass-collection/src/components/mock-data-generator-modal/utils.ts`	Exports max collection nesting depth constant for reuse
`packages/compass-collection/src/components/mock-data-generator-modal/types.ts`	Adds enum for data generation steps used in telemetry
`packages/compass-collection/src/components/mock-data-generator-modal/script-screen.tsx`	Tracks script generation and copy events
`packages/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.tsx`	Tracks screen views, progression, and modal dismissal
`packages/compass-collection/src/components/mock-data-generator-modal/faker-mapping-selector.tsx`	Tracks faker method changes
`packages/compass-collection/src/components/mock-data-generator-modal/document-count-screen.tsx`	Tracks document count changes
`packages/compass-collection/src/components/mock-data-generator-modal/constants.ts`	Adds step progression map for telemetry
`packages/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx`	Tracks CTA button views and clicks
`packages/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.spec.tsx`	Tests for new tracking events in modal
`packages/compass-collection/src/components/mock-data-generator-modal/faker-mapping-selector.spec.tsx`	Tests for faker method change tracking
`packages/compass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx`	Tests for CTA button tracking events

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-21T19:41:45Z

packages/compass-collection/src/components/mock-data-generator-modal/script-screen.tsx

+        output_docs_count: documentCount,
+      });
+    }
+  });


This useEffect is missing its dependency array, which will cause the tracking event to fire on every render. Add [scriptResult.success, fakerSchema, documentCount, track] as dependencies to ensure it only fires when the script is successfully generated.

Suggested change

});

}, [scriptResult.success, fakerSchema, documentCount, track]);

co-pilot is correct here, we want to add deps here.

Added the missing deps

jcobis · 2025-10-21T20:15:55Z

packages/compass-collection/src/components/mock-data-generator-modal/faker-mapping-selector.tsx

+  const onFakerMethodChange = useCallback(
+    (newMethod: string) => {
+      track('Mock Data Faker Method Changed', {
+        field_name: activeJsonType,


Should be the field name, not the type. We can pass that into this component from mock-data-generator-modal. Also not a bad idea to include the jsonType, let's add json_type: activeJsonType here too

jcobis · 2025-10-21T20:59:59Z

...es/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.tsx

+    track('Mock Data Generator Dismissed', {
+      screen: currentStep,
+      gen_ai_features_enabled: false,
+      send_sample_values_enabled: false,


Looks like these hardcoded values snuck in here?

Fixed this, thanks for flagging!

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

jcobis · 2025-10-21T21:11:56Z

Also, missed this but let's add a Mock Data JSON Type Changed event as well, perhaps with properties:

field_name: string,
previous_json_type: MongoDBFieldType,
new_json_type: MongoDBFieldType
previous_faker_method: string,
new_faker_method: string,

mabaasit · 2025-10-22T08:52:26Z

...es/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx

+  useEffect(() => {
+    if (shouldShowMockDataButton) {
+      track('Mock Data Generator CTA Button Viewed', {
+        button_enabled: !shouldDisableMockDataButton,
+        gen_ai_features_enabled: isAIFeatureEnabled,
+        send_sample_values_enabled: isSampleDocumentPassingEnabled,
+      });
+    }
+  }, [
+    track,
+    isAIFeatureEnabled,
+    isSampleDocumentPassingEnabled,
+    shouldDisableMockDataButton,
+    shouldShowMockDataButton,
+  ]);


Here you can use useTrackOnChange hook that '@mongodb-js/compass-telemetry/provider' exports

Oh this is awesome, will use useTrackOnChange!

mabaasit · 2025-10-22T12:38:42Z

packages/compass-collection/src/components/mock-data-generator-modal/faker-mapping-selector.tsx

+      });
+      onFakerFunctionSelect(newMethod);
+    },
+    [activeJsonType, onFakerFunctionSelect, track]


Missing fieldName from deps list.

Added this here! it was a late addition

kylelai1 · 2025-10-22T19:13:54Z

Also, missed this but let's add a Mock Data JSON Type Changed event as well, perhaps with properties:
field_name: string,
previous_json_type: MongoDBFieldType,
new_json_type: MongoDBFieldType
previous_faker_method: string,
new_faker_method: string,

Added the new event!

mabaasit · 2025-10-23T07:11:26Z

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

+      | 'String'
+      | 'Number'
+      | 'Boolean'
+      | 'Date'
+      | 'Int32'
+      | 'Decimal128'
+      | 'Long'
+      | 'ObjectId'
+      | 'RegExp'
+      | 'Symbol'
+      | 'MaxKey'
+      | 'MinKey'
+      | 'Binary'
+      | 'Code'
+      | 'Timestamp'
+      | 'DBRef';


We can extract this bit to a type and then use for previous_json_type, new_json_type and within MockDataFakerMethodChangedEvent

Similarly for screens?

Sure, I can add this. Any reason that other events in the file don't use any types and just write out the union of strings?

I didn't know this until now :) I don't think there's any specific reason for this - its just that this caught my eye especially as the list a big, so made sense to type it out.

fyi - we use these types to generate Compass tracking-plan.

lol I see what you did there

mabaasit · 2025-10-23T07:25:45Z

packages/compass-collection/src/components/mock-data-generator-modal/script-screen.tsx

+    [track]
+  );
+
+  useEffect(() => {


You can also use useTrackOnChange here

jcobis

LGTM

kylelai1 added 5 commits October 21, 2025 11:55

Add track events

e088337

Merge main

df1ffe4

Fix failing test

f726ddb

Cleanup and type check

2cd34e9

Cleanup and add useCallbacks

e3ef4ae

kylelai1 marked this pull request as ready for review October 21, 2025 19:41

kylelai1 requested a review from a team as a code owner October 21, 2025 19:41

kylelai1 requested review from Copilot, jcobis and johnjackweir October 21, 2025 19:41

Copilot AI reviewed Oct 21, 2025

View reviewed changes

kylelai1 requested a review from kpamaran October 21, 2025 19:56

jcobis reviewed Oct 21, 2025

View reviewed changes

Add json_type field

6f0e462

jcobis reviewed Oct 21, 2025

View reviewed changes

packages/compass-telemetry/src/telemetry-events.ts Outdated Show resolved Hide resolved

Address comments

3482429

mabaasit reviewed Oct 22, 2025

View reviewed changes

Address comments

19d0248

kylelai1 added 8 commits October 22, 2025 15:18

Merge main

43d1dee

Version update in package.json

7d1d713

Update package-lock

3052a76

Remove compass-generative-ai

7f35366

Fix typechecks

00328f2

Change MongoDBFieldType to union of strings

8b018cc

Fix merge conflict

4ef4c13

Fix typecheck

0c7fb54

kylelai1 added 2 commits October 22, 2025 17:13

Fix failing test

9e25df1

Fix typecheck

548bc39

mabaasit reviewed Oct 23, 2025

View reviewed changes

jcobis approved these changes Oct 23, 2025

View reviewed changes

Address comments; cleanup

e53449a

kylelai1 requested a review from mabaasit October 23, 2025 15:05

Resolve merge conflicts

e8eb737

mabaasit approved these changes Oct 23, 2025

View reviewed changes

kylelai1 merged commit bf64826 into main Oct 24, 2025
170 of 180 checks passed

kylelai1 deleted the CLOUDP-333861 branch October 24, 2025 00:10

	});
	}, [scriptResult.success, fakerSchema, documentCount, track]);

chore(compass-collection): Add track events for mock data generator modal CLOUDP-333861 #7482

chore(compass-collection): Add track events for mock data generator modal CLOUDP-333861 #7482

Uh oh!

Conversation

kylelai1 commented Oct 21, 2025

Description

Checklist

Motivation and Context

Types of changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcobis commented Oct 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kylelai1 commented Oct 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcobis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants