feat: Compass Experimentation Provider CLOUDP-333843

packages/compass-telemetry/.eslintrc.js

@@ -5,4 +5,26 @@ module.exports = {
     tsconfigRootDir: __dirname,
     project: ['./tsconfig-lint.json'],
   },
+  overrides: [
+    {
+      files: ['./src/**/*.ts', './src/**/*.tsx'],
+      rules: {
+        'no-restricted-imports': 'off',
+        '@typescript-eslint/no-restricted-imports': [
+          'error',
+          {
+            paths: [
+              {
+                name: '@mongodb-js/mdb-experiment-js',
+                message:
+                  'Use type-only imports from @mongodb-js/mdb-experiment-js',
+                allowTypeImports: true,
+              },
+            ],
+          },
+        ],
+        '@typescript-eslint/no-redundant-type-constituents': 'off',
+      },
+    },
+  ],
 };

packages/compass-telemetry/package.json

@@ -55,7 +55,8 @@
     "@mongodb-js/compass-logging": "^1.7.9",
     "@mongodb-js/compass-app-registry": "^9.4.18",
     "hadron-ipc": "^3.5.8",
-    "react": "^17.0.2"
+    "react": "^17.0.2",
+    "@mongodb-js/mdb-experiment-js": "1.9.0"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-compass": "^1.4.5",

packages/compass-telemetry/src/experimentation-provider.tsx

@@ -0,0 +1,62 @@
+import React, { createContext, useContext, useRef } from 'react';
+import type { types } from '@mongodb-js/mdb-experiment-js';
+import type { typesReact } from '@mongodb-js/mdb-experiment-js/react';
+
+type UseAssignmentHook = (
+  experimentName: string,
+  trackIsInSample: boolean,
+  options?: typesReact.UseAssignmentOptions<types.TypeData>
+) => typesReact.UseAssignmentResponse<types.TypeData>;
+
+type AssignExperimentFn = (
+  experimentName: string,
+  options?: types.AssignOptions<string>
+) => Promise<types.AsyncStatus | null>;
+
+interface CompassExperimentationProviderContextValue {
+  useAssignment: UseAssignmentHook;
+  assignExperiment: AssignExperimentFn;
+}
+
+const initialContext: CompassExperimentationProviderContextValue = {
+  useAssignment() {
+    return {
+      assignment: null,
+      asyncStatus: null,
+      error: null,
+      isLoading: false,
+      isError: false,
+      isSuccess: true,
+    };
+  },
+  assignExperiment() {
+    return Promise.resolve(null);
+  },
+};
+
+const ExperimentationContext =
+  createContext<CompassExperimentationProviderContextValue>(initialContext);
+
+// Provider component that accepts MMS experiment utils as props
+export const CompassExperimentationProvider: React.FC<{
+  children: React.ReactNode;
+  useAssignment: UseAssignmentHook;
+  assignExperiment: AssignExperimentFn;
+}> = ({ children, useAssignment, assignExperiment }) => {
+  // Use useRef to keep the functions up-to-date; Use mutation pattern to maintain the
+  // same object reference to prevent unnecessary re-renders of consuming components
+  const { current: contextValue } = useRef({ useAssignment, assignExperiment });
+  contextValue.useAssignment = useAssignment;
+  contextValue.assignExperiment = assignExperiment;
+
+  return (
+    <ExperimentationContext.Provider value={contextValue}>
+      {children}
+    </ExperimentationContext.Provider>
+  );
+};
+
+// Hook for components to access experiment assignment
+export const useAssignment = (...args: Parameters<UseAssignmentHook>) => {
+  return useContext(ExperimentationContext).useAssignment(...args);
+};

packages/compass-telemetry/src/index.ts

@@ -5,3 +5,5 @@ export type {
   IdentifyTraits,
   ExtraConnectionData,
 } from './types';
+
+export { CompassExperimentationProvider } from './experimentation-provider';

packages/compass-web/src/index.tsx

@@ -4,3 +4,5 @@ export type {
   OpenWorkspaceOptions,
   WorkspaceTab,
 } from '@mongodb-js/compass-workspaces';
+
+export { CompassExperimentationProvider } from '@mongodb-js/compass-telemetry';