feat(compass-collection): Collection Plugin Experimentation Assignment Integration – CLOUDP-333845 #7165

jcobis · 2025-08-04T19:57:32Z

Description

Integrates experimentation assignment into the collection plugin to support the Mock Data Generator feature. When users navigate to a collection in Atlas with AI features enabled at the org level, they are automatically assigned to the 'mock-data-generator' experiment.

Changes:

Added experimentation services integration to collection plugin
Implemented experiment assignment on collection metadata fetch
Added org-level AI feature gating using isAIFeatureEnabled()
Added comprehensive test coverage
Follows Atlas-only and AI feature gating requirements

Implementation Details:

Assignment happens during collection metadata fetch for Atlas connections (non-blocking call)
Includes error handling and debug logging

Checklist

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

Motivation and Context

The Mock Data Generator feature requires users to be assigned to the experiment when they navigate to collections in Atlas. This ticket implements the experimentation assignment integration as specified in the engineering goals:

"When a user in the experiment selects a collection from the Data Explorer and the org-level setting for Generative AI features is enabled"

The implementation ensures experiment assignment only occurs when:

User is connected to Atlas (has atlasMetadata)
Experimentation services are available
Org-level AI features are enabled (enableGenAIFeaturesAtlasOrg: true)

New feature
Bugfix
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

Integrates experimentation assignment into the Compass collection plugin to support the Mock Data Generator feature. When users navigate to a collection in Atlas with AI features enabled at the org level, they are automatically assigned to the 'mock-data-generator' experiment.

Added experimentation services integration to collection plugin
Implemented experiment assignment during collection metadata fetch for Atlas connections only
Added org-level AI feature gating and comprehensive test coverage

Reviewed Changes

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

Show a summary per file

File	Description
packages/compass-telemetry/src/provider.tsx	Adds service locator for experimentation services and exports experimentation context
packages/compass-telemetry/src/index.ts	Exports the new experimentation service locator
packages/compass-telemetry/src/experimentation-provider.tsx	Makes ExperimentationContext exportable for service locator usage
packages/compass-collection/src/stores/collection-tab.ts	Implements experiment assignment logic during collection metadata fetch
packages/compass-collection/src/stores/collection-tab.spec.ts	Adds comprehensive test coverage for experiment assignment scenarios
packages/compass-collection/src/modules/collection-tab.ts	Updates type definitions to include experimentation services
packages/compass-collection/src/index.ts	Adds service locator dependencies for experimentation integration

Copilot · 2025-08-04T19:58:05Z

packages/compass-collection/src/stores/collection-tab.ts

+      experimentationServices &&
+      experimentationServices.assignExperiment &&


[nitpick] The condition checks experimentationServices.assignExperiment twice - once for its existence and once for being truthy. Consider combining these checks or using optional chaining: experimentationServices?.assignExperiment for cleaner code.

Suggested change

experimentationServices &&

experimentationServices.assignExperiment &&

experimentationServices?.assignExperiment &&

addaleax · 2025-08-04T20:16:29Z

packages/compass-telemetry/src/provider.tsx

 import { createServiceLocator } from '@mongodb-js/compass-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';
+import { ExperimentationContext } from './experimentation-provider';
+import type { types } from '@mongodb-js/mdb-experiment-js';


Really just a small note and not a request for changes in this PR, but when I've seen packages which have exports with highly generic names, they are typically being accessed through a generic import; e.g.

import type * as exp from '@mongodb-js/mdb-experiment-js'; // ... Promise<exp.types.AsyncStatus | null>

not a big deal but in larger files this can keep one from jiggling around many unrelated concepts in the single "global namespace" of a given file, obviously for this one this is totally fine

gribnoysup · 2025-08-05T08:29:04Z

packages/compass-collection/src/stores/collection-tab.ts

+    // we're connected to Atlas,
+    // and the org-level setting for AI features is enabled
+    if (
+      experimentationServices?.assignExperiment && // Ensures experimentation services are available


As you are providing default context value, in what case are they not available?

gribnoysup · 2025-08-05T14:15:10Z

packages/compass-collection/src/stores/collection-tab.ts

+  isAIFeatureEnabled,
+  type PreferencesAccess,
+} from 'compass-preferences-model/provider';
+import { TestName } from '../../../compass-telemetry/src/growth-experiments';


We don't use relative imports for workspaces. You also shouldn't be importing from a file that is not explicitly exported. For this case you probably want to re-export this enum?

Suggested change

import { TestName } from '../../../compass-telemetry/src/growth-experiments';

import { ExperimentTestName } from '@mongodb-js/compass-telemetry/provider';

gribnoysup · 2025-08-05T14:16:10Z

packages/compass-telemetry/src/index.ts

 export { CompassExperimentationProvider } from './experimentation-provider';
+export { experimentationServiceLocator } from './provider';


This should be exported from the /provider named export, not from the index

@jcobis as I mentioned above, locators and hooks shouldn't be exported from the index export, only from provider, please remove this export

Sorry I missed this somehow! Removed it here

jcobis · 2025-08-05T16:08:07Z

Edit: Resolved by switching the export of the service locator

packages/compass-telemetry/src/provider.tsx

ncarbon · 2025-08-05T18:34:57Z

packages/compass-collection/src/stores/collection-tab.ts

+    // Assign experiment for Mock Data Generator
+    // Only assign when we're connected to Atlas and the org-level setting for AI features is enabled
+    if (
+      connectionInfoRef.current?.atlasMetadata?.clusterName && // Ensures we only assign in Atlas


We might want to check the clusterState instead of the clusterName, like in this util function. We probably want to only assign if the cluster is in IDLE state or so.

Thanks for the suggestion! I looked at the connectable function, but I think we may actually want to assign regardless of cluster status. Once we're at the collections plugin, we should already be connected anyway.
We just want to make sure we're in Atlas.

Seems like other checks for Atlas in the codebase just check for atlasMetadata.

But maybe we drop the clusterName check to match other patterns?

Got it! Up to you then!

You can't connect to clusters and get to this screen if clusters are not in connectable states, there's no reason to check for specific states here

ncarbon

LGTM!

gribnoysup · 2025-08-06T07:53:55Z

Test setup failures seem unrelated

Our main CI is green now and there is too many failures here for them to be unrelated

gribnoysup · 2025-08-06T08:02:53Z

There are pretty clear error messages in the CI log and it's very easy to reproduce by following the same steps that CI is taking (running npm run bootstrap command is enough, you can just try to compile this one package that fails specifically):

[2025/08/05 22:06:38.898] @mongodb-js/compass-collection: src/modules/collection-tab.ts(8,15): error TS2305: Module '"@mongodb-js/compass-telemetry"' has no exported member 'experimentationServiceLocator'.
[2025/08/05 22:06:38.898] @mongodb-js/compass-collection: src/stores/collection-tab.ts(12,15): error TS2305: Module '"@mongodb-js/compass-telemetry"' has no exported member 'experimentationServiceLocator'.
[2025/08/05 22:06:38.898] @mongodb-js/compass-collection: src/stores/collection-tab.ts(120,17): error TS7006: Parameter 'error' implicitly has an 'any' type.

Please adjust the code to resolve these typescript compilation issues

gribnoysup · 2025-08-06T08:07:53Z

packages/compass-collection/src/stores/collection-tab.ts

+  isAIFeatureEnabled,
+  type PreferencesAccess,
+} from 'compass-preferences-model/provider';
+import { TestName } from '@mongodb-js/compass-telemetry/provider';


TestName is a very generic name for this type, can we add experimentation to it to make it clearer what this refers to?

jcobis added 2 commits August 4, 2025 15:40

WIP

e0d6e74

Org level flag and tests

57c2bb5

Copilot AI review requested due to automatic review settings August 4, 2025 19:57

jcobis requested a review from a team as a code owner August 4, 2025 19:57

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

Copilot AI reviewed Aug 4, 2025

View reviewed changes

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

mongodb-js deleted a comment from Copilot AI Aug 4, 2025

WIP

1a32e51

addaleax approved these changes Aug 4, 2025

View reviewed changes

jcobis marked this pull request as draft August 4, 2025 20:24

WIP

4a75007

jcobis marked this pull request as ready for review August 4, 2025 20:43

gribnoysup reviewed Aug 5, 2025

View reviewed changes

jcobis force-pushed the CLOUDP-333845 branch from ee2a58d to 4a75007 Compare August 5, 2025 14:04

gribnoysup reviewed Aug 5, 2025

View reviewed changes

jcobis added 5 commits August 5, 2025 11:14

Merge remote-tracking branch 'origin/main' into CLOUDP-333845

29ce148

Absolute import

41957c6

Remove unneeded check

66413a0

Comment address

a16f2c9

Change export

73a6ea8

ncarbon reviewed Aug 5, 2025

View reviewed changes

Comment

36817d3

ncarbon approved these changes Aug 5, 2025

View reviewed changes

gribnoysup reviewed Aug 6, 2025

View reviewed changes

Change exports

b725084

Rename existing test name enum

97a3614

jcobis requested a review from gribnoysup August 6, 2025 17:30

jcobis merged commit db7e9b8 into main Aug 7, 2025
55 of 58 checks passed

jcobis deleted the CLOUDP-333845 branch August 7, 2025 15:30

		experimentationServices &&
		experimentationServices.assignExperiment &&

	experimentationServices &&
	experimentationServices.assignExperiment &&
	experimentationServices?.assignExperiment &&

	import { TestName } from '../../../compass-telemetry/src/growth-experiments';
	import { ExperimentTestName } from '@mongodb-js/compass-telemetry/provider';

		export { CompassExperimentationProvider } from './experimentation-provider';
		export { experimentationServiceLocator } from './provider';

feat(compass-collection): Collection Plugin Experimentation Assignment Integration – CLOUDP-333845 #7165

feat(compass-collection): Collection Plugin Experimentation Assignment Integration – CLOUDP-333845 #7165

Uh oh!

Conversation

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

Uh oh!

Description

Changes:

Implementation Details:

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 Aug 4, 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!

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

Uh oh!

Uh oh!

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!

ncarbon left a comment

Choose a reason for hiding this comment

Uh oh!

gribnoysup commented Aug 6, 2025

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jcobis commented Aug 4, 2025 •

edited

Loading

jcobis commented Aug 5, 2025 •

edited

Loading

gribnoysup commented Aug 6, 2025 •

edited

Loading