Function useLogImpression

packages/shared/src/hooks/feed/useLogImpression.ts:25–185

(
  item: FeedItem,
  index: number,
  columns: number,
  column: number,
  row: number,
  feedName: string,
  ranking?: string,
  highlightColSpan?: number,
  origin?: Origin,
)

export const generateHighlightLogEventKey = (id: string): string => `hi-${id}`;

export default function useLogImpression(
  item: FeedItem,
  index: number,
  columns: number,
  column: number,
  row: number,
  feedName: string,
  ranking?: string,
  highlightColSpan?: number,
  origin?: Origin,
): (node?: Element | null) => void {
  const { logEventStart, logEventEnd } = useLogContext();
  const postLogEvent = usePostLogEvent();
  const { ref: inViewRef, inView } = useInView({
    threshold: 0.5,
  });

  useEffect(() => {
    if (item.type === 'post') {
      const eventKey = generatePostLogEventKey(item.post.id);
      if (inView && !item.post.impressionStatus) {
        const significance = item.post.hero?.significance;
        logEventStart(
          eventKey,
          postLogEvent(LogEvent.Impression, item.post, {
            columns,
            column,
            row,
            extra: {
              ...feedLogExtra(
                feedName,
                ranking,
                { scroll_y: window.scrollY },
                origin,
              ).extra,
              clickbait_badge: isShareLikePost(item.post)
                ? item.post.sharedPost?.clickbaitTitleDetected
                : item.post.clickbaitTitleDetected,
              feedback: item.post.type === PostType.Article ? true : undefined,
              ...(!!significance && {
                highlight_significance: significance,
                ...(!!highlightColSpan && {
                  highlight_col_span: highlightColSpan,
                }),
              }),
            },
          }),
        );
        // eslint-disable-next-line no-param-reassign
        item.post.impressionStatus = ImpressionStatus.LOGGING;
      } else if (
        !inView &&
        item.post.impressionStatus === ImpressionStatus.LOGGING
      ) {
        logEventEnd(eventKey);
        // eslint-disable-next-line no-param-reassign
        item.post.impressionStatus = ImpressionStatus.LOGGED;
      }