CLOUDP-349749: useTrackInSample

Author: carolynmcca

packages/compass-telemetry/src/atlas-skills-banner.tsx

@@ -11,7 +11,7 @@ import {
   ExperimentTestGroup,
   ExperimentTestName,
   useAssignment,
-  useFireExperimentViewed,
+  useTrackInSample,
 } from './provider';
 
 const skillsCTAContent = css({
@@ -62,10 +62,8 @@ export const useAtlasSkillsBanner = (context: SkillsBannerContextEnum) => {
     ExperimentTestGroup.atlasSkillsVariant;
 
   // Track experiment viewed when user is in experiment and banner would be shown
-  useFireExperimentViewed({
-    testName: ExperimentTestName.atlasSkills,
-    shouldFire: !!atlasSkillsAssignment,
-    additionalProperties: { screen: context },
+  useTrackInSample(ExperimentTestName.atlasSkills, !!atlasSkillsAssignment, {
+    screen: context,
   });
 
   return {

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

@@ -20,10 +20,18 @@ type GetAssignmentFn = (
   options?: types.GetAssignmentOptions<types.TypeData>
 ) => Promise<types.SDKAssignment<ExperimentTestName, string> | null>;
 
+type UseTrackInSampleHook = (
+  experimentName: ExperimentTestName,
+  shouldFireEvent?: boolean,
+  customProperties?: types.TypeData['experimentViewedProps'],
+  team?: types.TypeData['loggerTeam']
+) => typesReact.BasicHookResponse;
+
 interface CompassExperimentationProviderContextValue {
   useAssignment: UseAssignmentHook;
   assignExperiment: AssignExperimentFn;
   getAssignment: GetAssignmentFn;
+  useTrackInSample: UseTrackInSampleHook;
 }
 
 const initialContext: CompassExperimentationProviderContextValue = {
@@ -43,6 +51,15 @@ const initialContext: CompassExperimentationProviderContextValue = {
   getAssignment() {
     return Promise.resolve(null);
   },
+  useTrackInSample() {
+    return {
+      asyncStatus: null,
+      error: null,
+      isLoading: false,
+      isError: false,
+      isSuccess: true,
+    };
+  },
 };
 
 export const ExperimentationContext =
@@ -54,17 +71,26 @@ export const CompassExperimentationProvider: React.FC<{
   useAssignment: UseAssignmentHook;
   assignExperiment: AssignExperimentFn;
   getAssignment: GetAssignmentFn;
-}> = ({ children, useAssignment, assignExperiment, getAssignment }) => {
+  useTrackInSample: UseTrackInSampleHook;
+}> = ({
+  children,
+  useAssignment,
+  assignExperiment,
+  getAssignment,
+  useTrackInSample,
+}) => {
   // 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,
     getAssignment,
+    useTrackInSample,
   });
   contextValue.useAssignment = useAssignment;
   contextValue.assignExperiment = assignExperiment;
   contextValue.getAssignment = getAssignment;
+  contextValue.useTrackInSample = useTrackInSample;
 
   return (
     <ExperimentationContext.Provider value={contextValue}>
@@ -77,3 +103,8 @@ export const CompassExperimentationProvider: React.FC<{
 export const useAssignment = (...args: Parameters<UseAssignmentHook>) => {
   return useContext(ExperimentationContext).useAssignment(...args);
 };
+
+// Hook for components to access experiment assignment
+export const useTrackInSample = (...args: Parameters<UseTrackInSampleHook>) => {
+  return useContext(ExperimentationContext).useTrackInSample(...args);
+};

packages/compass-telemetry/src/provider.tsx

@@ -132,29 +132,19 @@ export function useTrackOnChange(
  *
  * @param testName - The name of the experiment to track.
  * @param shouldFire - A boolean indicating whether to fire the event. Defaults to true.
- * @param additionalProperties - Optional additional properties to include in the track call.
  *
  * @example
  * useFireExperimentViewed({
  *   testName: ExperimentTestName.earlyJourneyIndexesGuidance,
  *   shouldFire: enableInIndexesGuidanceExp ,
  * });
- *
- * @example
- * useFireExperimentViewed({
- *   testName: ExperimentTestName.atlasSkills,
- *   shouldFire: showBanner,
- *   additionalProperties: { screen: 'aggregations' },
- * });
  */
 export const useFireExperimentViewed = ({
   testName,
   shouldFire = true,
-  additionalProperties,
 }: {
   testName: ExperimentTestName;
   shouldFire?: boolean;
-  additionalProperties?: Record<string, unknown>;
 }) => {
   useTrackOnChange(
     (track: TrackFunction) => {
@@ -163,14 +153,13 @@ export const useFireExperimentViewed = ({
       }
       track('Experiment Viewed', {
         test_name: testName,
-        ...additionalProperties,
-      } as any);
+      });
     },
-    [shouldFire, testName, additionalProperties],
+    [shouldFire, testName],
     undefined
   );
 };
 
 export type { TrackFunction };
 export { ExperimentTestName, ExperimentTestGroup } from './growth-experiments';
-export { useAssignment } from './experimentation-provider';
+export { useAssignment, useTrackInSample } from './experimentation-provider';