feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator – CLOUDP-333847 #7181

jcobis · 2025-08-08T19:25:41Z

Description

Implements the Mock Data Generator button in the Collection Header Actions component. The feature adds a new "Generate Mock Data" button that appears conditionally based on experiment assignment, Atlas environment, and collection type.

Also adds the modal state to the Redux store.

Enabled

Disabled

Motivation and Context

This implements the Mock Data Generator feature integration into the Collection Header, allowing users to access AI-powered mock data generation directly from the collection view. The feature is gated behind an experiment.

Bugfix
New feature
Dependency update
Misc

Types of changes

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

Copilot

Pull Request Overview

This PR integrates the Mock Data Generator feature into the Collection Header component. The feature adds a new "Generate Mock Data" button that appears conditionally based on experiment assignment, Atlas environment, and collection type.

Adds new experiment test group enum for Mock Data Generator experimentation
Implements Mock Data Generator button in Collection Header Actions with conditional visibility
Integrates mock data generator modal with collection header state management

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/compass-telemetry/src/provider.tsx	Exports experiment test groups and assignment hook for external use
packages/compass-telemetry/src/index.ts	Adds ExperimentTestGroup export to public API
packages/compass-telemetry/src/growth-experiments.ts	Defines experiment test groups for Mock Data Generator
packages/compass-collection/src/components/collection-header/collection-header.tsx	Integrates mock data generator modal state and UI
packages/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx	Implements conditional Mock Data Generator button with experiment gating
packages/compass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx	Adds comprehensive test coverage for Mock Data Generator button behavior

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

kpamaran · 2025-08-08T20:25:52Z

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

+          trigger={
+            <div>
+              <Button
+                data-testid="collection-header-generate-mock-data"


data-testid should have a -button suffix or similar

kpamaran · 2025-08-08T20:35:47Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

@@ -168,4 +204,182 @@ describe('CollectionHeaderActions [Component]', function () {
      );
    });
  });
+
+  context('Mock Data Generator Button', function () {


I suggest adding data-testid for the tooltip and asserting its existence directly in maybe new tests like 'should show Tooltip when ...'

Good idea, how about we add this once we hook up the data so we can test its presence when collection is empty?

Sounds good

kpamaran · 2025-08-08T20:43:36Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

+
+      expect(onOpenMockDataModal).to.have.been.calledOnce;
+    });
+  });


would be nice to have a test that the modal opens initially with step MockDataGeneratorStep.AI_DISCLAIMER since that is controlled by the header

Note: what step we open up to will depend on the state of project level settings, as well as a user-level "opt in" flag. We do have the test should call onOpenMockDataModal when CTA button is clicked, so I think the step we open to will depend based on functionality we will add in later tickets. Do you think this test is sufficient for now, or would you suggest adding something?

That's good. No point in adding a test that'd be irrelevant so soon

kpamaran

Only had minor feedback around testing. Looks good in general

addaleax · 2025-08-09T00:05:41Z

packages/compass-telemetry/src/growth-experiments.ts

+export enum ExperimentTestGroup {
+  mockDataGeneratorVariant = 'mockDataGeneratorVariant',
+  mockDataGeneratorControl = 'mockDataGeneratorControl',
+}


Just a small note, it's not a hard-and-fast rule, but we generally have a mild preference for literal unions over enum types – i.e. export type ExperimentTestGroup = 'mockDataGeneratorVariant' | 'mockDataGeneratorControl'; since that has a few small advantages over enums:

You don't unnecessarily alias a value to a property name if they're both the same anyway

You can often avoid importing and resolving the module at runtime when using enum values, and instead either have a type-only import or none at all

Literal unions would be compatible with --erasableSyntaxOnly if we ever decide to adopt this flag

Literal unions are also just generally a bit more flexible and can include additional values if we need to add them later, e.g. type Foo = 'abc' | 'def' | `numeric:${number}`;

Very good point, I tend to agree. I was following the existing pattern here and I think it might have something to do with how experiments can be iterated on, as in these values can actually change. These values have to correspond to Pholiota values, so for eg. MOCK_DATA_GENERATOR_20251001 can become MOCK_DATA_GENERATOR_20260123 if an experiment iteration is conducted. See the MMS code as well. I am open to changing this though, particularly for ExperimentTestGroup

gribnoysup · 2025-08-11T07:58:08Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

+      return await renderWithActiveConnection(ui, connectionInfo);
+    } else {
+      // For tests that only need basic component rendering (readonly checks, view buttons, etc.)
+      const { render } = await import('@mongodb-js/testing-library-compass');


Why is this a dynamic import?

Consolidated

gribnoysup · 2025-08-11T07:58:22Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

+
+    if (connectionInfo) {
+      // For tests that need Atlas metadata (Mock Data Generator button visibility, etc.)
+      return await renderWithActiveConnection(ui, connectionInfo);


You can just use it for both cases, what difference does it make?

gribnoysup · 2025-08-11T07:58:49Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

+    };
+
+    const ui = (
+      <TelemetryProvider options={{ sendTrack: sinon.stub() }}>


compass-testing-library render helpers already provide default track function, why are you adding this provider?

gribnoysup · 2025-08-11T08:00:00Z

...mpass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

+      expect(
+        screen.getByTestId('collection-header-generate-mock-data-button')
+      ).to.exist;
+      expect(screen.getByText('Generate Mock Data')).to.exist;


get by text is already pretty good, get by role is even better, why do you duplicate this check with get by test id?

gribnoysup · 2025-08-11T08:03:48Z

packages/compass-collection/src/components/collection-header/collection-header.tsx

+  // Mock Data Generator modal state
+  const [isMockDataModalOpen, setIsMockDataModalOpen] = useState(false);
+  const [currentStep, setCurrentStep] = useState(
+    MockDataGeneratorStep.AI_DISCLAIMER
+  );


I'm not sure that having this as a UI state makes sense: you have form state transitions that clearly would depend on async actions that are handled by the store and reducers and syncing from store to local state is always a pain (and an antipattern that React calls out in the documentation). Shouldn't this state be moved to the store already?

Will move this to the redux store!

packages/compass-collection/src/components/collection-header/collection-header.tsx

jcobis added 2 commits August 8, 2025 11:46

WIP

8f9d83f

WIP

a0b79e0

Copilot AI review requested due to automatic review settings August 8, 2025 19:25

jcobis requested a review from a team as a code owner August 8, 2025 19:25

github-actions bot added the feat label Aug 8, 2025

jcobis added the no release notes Fix or feature not for release notes label Aug 8, 2025

Copilot AI reviewed Aug 8, 2025

View reviewed changes

...es/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx Show resolved Hide resolved

...es/compass-collection/src/components/collection-header-actions/collection-header-actions.tsx Outdated Show resolved Hide resolved

jcobis changed the title ~~feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator~~ feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator – CLOUDP-333847 Aug 8, 2025

jcobis added 2 commits August 8, 2025 15:39

Re order buttons

15ff5d3

WIP

6f3f320

kpamaran reviewed Aug 8, 2025

View reviewed changes

kpamaran approved these changes Aug 8, 2025

View reviewed changes

jcobis and others added 2 commits August 8, 2025 17:33

Rename datatest-id

8935d22

Merge branch 'main' into CLOUDP-333847

777ab8b

addaleax approved these changes Aug 9, 2025

View reviewed changes

gribnoysup reviewed Aug 11, 2025

View reviewed changes

jcobis added 2 commits August 11, 2025 14:02

Move state to redux

5163ed7

Update tests per comments

f13950b

jcobis requested a review from gribnoysup August 11, 2025 18:20

kpamaran mentioned this pull request Aug 11, 2025

feat(compass-collection): Schema Analysis Redux Integration for Collection Plugin CLOUDP-333846 #7177

Open

12 tasks

ncarbon reviewed Aug 11, 2025

View reviewed changes

packages/compass-collection/src/components/collection-header/collection-header.tsx Show resolved Hide resolved

jcobis added 2 commits August 11, 2025 17:04

Merge branch 'main' of github.com:mongodb-js/compass into CLOUDP-333847

ceefa80

Fix import

e0d431f

feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator – CLOUDP-333847 #7181

Are you sure you want to change the base?

feat(compass-collection): Collection Header Experimentation Integration for Mock Data Generator – CLOUDP-333847 #7181

Uh oh!

Conversation

jcobis commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Enabled

Disabled

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!

Uh oh!

Uh oh!

kpamaran Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kpamaran Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

kpamaran Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

kpamaran left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcobis Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

Uh oh!

jcobis commented Aug 8, 2025 •

edited

Loading

kpamaran Aug 8, 2025 •

edited

Loading

kpamaran Aug 8, 2025 •

edited

Loading

kpamaran Aug 8, 2025 •

edited

Loading

jcobis Aug 11, 2025 •

edited

Loading

gribnoysup Aug 11, 2025 •

edited

Loading