All files / app/features/messages useMarkLastSeen.ts

100% Statements 25/25
100% Branches 6/6
100% Functions 6/6
100% Lines 25/25

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 584x     4x   4x       68x       68x 68x       68x 48x 15x       68x   26x 5x 5x               68x 26x 26x 26x 2x 2x           68x 49x 8x 8x 8x       68x    
import { debounce } from "@mui/material";
import { UseMutateFunction } from "@tanstack/react-query";
import { Empty } from "google-protobuf/google/protobuf/empty_pb";
import { useEffect, useMemo, useRef } from "react";
 
import { MARK_LAST_SEEN_TIMEOUT } from "./constants";
 
export type MarkLastSeenVariables = number;
 
export default function useMarkLastSeen(
  markLastSeenMutate: UseMutateFunction<Empty, Error, MarkLastSeenVariables>,
  lastSeenMessageId?: number,
) {
  const maxMessageIdRef = useRef(0);
  const pendingMessageIdRef = useRef<number | null>(null);
  // Sync with latest lastSeenMessageId so anything below that ID doesn't get tried again.
  // Needed since lastSeenMessageId comes from react query which is initially
  // undefined so can't do useRef(lastSeenMessageId).
  useEffect(() => {
    if (lastSeenMessageId) {
      maxMessageIdRef.current = Math.max(maxMessageIdRef.current, lastSeenMessageId);
    }
  }, [lastSeenMessageId]);
 
  const debouncedMarkLastSeen = useMemo(
    () =>
      debounce((messageId: number) => {
        pendingMessageIdRef.current = null;
        markLastSeenMutate(messageId);
      }, MARK_LAST_SEEN_TIMEOUT),
    [markLastSeenMutate],
  );
 
  // Safe after unmount: callers' hook-level onSuccess still fires, unlike per-call
  // mutate(x, { onSuccess }) callbacks.
  // https://tanstack.com/query/latest/docs/framework/react/guides/mutations#mutation-side-effects
  useEffect(
    () => () => {
      debouncedMarkLastSeen.clear();
      if (pendingMessageIdRef.current !== null) {
        markLastSeenMutate(pendingMessageIdRef.current);
        pendingMessageIdRef.current = null;
      }
    },
    [debouncedMarkLastSeen, markLastSeenMutate],
  );
 
  const markLastSeen = (messageId: number) => {
    if (messageId > maxMessageIdRef.current) {
      maxMessageIdRef.current = messageId;
      pendingMessageIdRef.current = messageId;
      debouncedMarkLastSeen(messageId);
    }
  };
 
  return { markLastSeen };
}