@atlaskit/analytics-next/dist/es2019/hooks/usePlatformLeafEventHandler.js

React components, HOCs and hooks to assist with tracking user activity with React components

import { useCallback } from 'react';
import { useAnalyticsEvents } from './useAnalyticsEvents';
import { useTrackedRef } from './useTrackedRef';
// WARNING: This hook will only function correctly for leaf node components - as in
// no children inside the component will require analytics themselves.
// Ignoring this warning will mean the analytics context of child components will not
// include the context of this component, .e.g, lost data.
// If you are going to have child components that require analytics use withAnalytics
// or AnalyticsContext component instead.
export function usePlatformLeafEventHandler({
  fn,
  action,
  componentName,
  actionSubject,
  packageName,
  packageVersion,
  analyticsData
}) {
  const {
    createAnalyticsEvent
  } = useAnalyticsEvents();

  // We put analyticsData and fn in a ref so that we don't need to break
  // memoization.
  // Generally these could be defined by consumers inline
  // and so we do this to avoid breaking memoization of useCallback
  const dataRef = useTrackedRef(analyticsData);
  const fnRef = useTrackedRef(fn);
  const handler = useCallback(value => {
    const analyticsEvent = createAnalyticsEvent({
      action,
      actionSubject: actionSubject || componentName,
      attributes: {
        componentName,
        packageName,
        packageVersion
      }
    });

    // To avoid wrapping this component in AnalyticsContext we manually
    // push the parent context's meta data into the context.
    // Note: this new 'context'
    const context = {
      componentName,
      packageName,
      packageVersion,
      ...dataRef.current
    };
    analyticsEvent.context.push(context);

    // fire an event on the atlaskit channel
    const clone = analyticsEvent.clone();
    if (clone) {
      clone.fire('atlaskit');
    }
    fnRef.current(value, analyticsEvent);
  }, [
  // These are strings and won't change
  action, componentName, actionSubject, packageName, packageVersion,
  // This function is memoized in the context
  createAnalyticsEvent,
  // these are a stable ref because of the useTrackedRef hook
  dataRef, fnRef]);
  return handler;
}