documenso/packages/lib/client-only/hooks/use-analytics.ts

import { posthog } from 'posthog-js';

import { useFeatureFlags } from '@documenso/lib/client-only/providers/feature-flag';
import {
  FEATURE_FLAG_GLOBAL_SESSION_RECORDING,
  extractPostHogConfig,
} from '@documenso/lib/constants/feature-flags';

export function useAnalytics() {
  const featureFlags = useFeatureFlags();
  const isPostHogEnabled = extractPostHogConfig();

  /**
   * Capture an analytic event.
   *
   * @param event The event name.
   * @param properties Properties to attach to the event.
   */
  const capture = (event: string, properties?: Record<string, unknown>) => {
    if (!isPostHogEnabled) {
      return;
    }

    posthog.capture(event, properties);
  };

  /**
   * Start the session recording.
   *
   * @param eventFlag The event to check against feature flags to determine whether tracking is enabled.
   */
  const startSessionRecording = (eventFlag?: string) => {
    const isSessionRecordingEnabled = featureFlags.getFlag(FEATURE_FLAG_GLOBAL_SESSION_RECORDING);
    const isSessionRecordingEnabledForEvent = Boolean(eventFlag && featureFlags.getFlag(eventFlag));

    if (!isPostHogEnabled || !isSessionRecordingEnabled || !isSessionRecordingEnabledForEvent) {
      return;
    }

    posthog.startSessionRecording();
  };

  /**
   * Stop the current session recording.
   */
  const stopSessionRecording = () => {
    const isSessionRecordingEnabled = featureFlags.getFlag(FEATURE_FLAG_GLOBAL_SESSION_RECORDING);

    if (!isPostHogEnabled || !isSessionRecordingEnabled) {
      return;
    }

    posthog.stopSessionRecording();
  };

  return {
    capture,
    startSessionRecording,
    stopSessionRecording,
  };
}