All files / src/common/hooks useDebouncedNavigation.ts

0% Statements 0/182
0% Branches 0/1
0% Functions 0/1
0% Lines 0/182

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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
import { useCallback, useEffect, useRef, useState } from 'react';
import { useNavigate } from 'react-router-dom';
import { useQueryClient } from '@tanstack/react-query';
import { useLogger } from '@common/utils/logger/useLogger';
import { invalidateForOperation } from '@common/utils/optimizedCacheInvalidation';
import { usePrefetchNewsletterDetail } from './useNewsletterDetail';
 
interface NavigationOptions {
  from?: string;
  fromReadingQueue?: boolean;
  fromNewsletterSources?: boolean;
  replace?: boolean;
  prefetch?: boolean;
  debounceDelay?: number;
}
 
interface UseDebouncedNavigationReturn {
  navigateToNewsletter: (newsletterId: string, options?: NavigationOptions) => Promise<void>;
  navigateToNextNewsletter: (
    currentId: string,
    newsletterIds: string[],
    options?: NavigationOptions
  ) => void;
  navigateToPreviousNewsletter: (
    currentId: string,
    newsletterIds: string[],
    options?: NavigationOptions
  ) => void;
  cancelPendingNavigation: () => void;
  isNavigating: boolean;
  pendingNavigationId: string | null;
}
 
/**
 * Hook for debounced newsletter navigation with prefetching
 * Reduces database queries during rapid navigation
 */
export const useDebouncedNavigation = (): UseDebouncedNavigationReturn => {
  const navigate = useNavigate();
  const queryClient = useQueryClient();
  const log = useLogger('useDebouncedNavigation');
  const { prefetchNewsletter } = usePrefetchNewsletterDetail();
 
  const [isNavigating, setIsNavigating] = useState(false);
  const [pendingNavigationId, setPendingNavigationId] = useState<string | null>(null);
 
  // Refs for debouncing
  const navigationTimeoutRef = useRef<NodeJS.Timeout | null>(null);
  const lastNavigationTime = useRef<number>(0);
  const navigationQueue = useRef<string[]>([]);
 
  // Cancel any pending navigation
  const cancelPendingNavigation = useCallback(() => {
    if (navigationTimeoutRef.current) {
      clearTimeout(navigationTimeoutRef.current);
      navigationTimeoutRef.current = null;
    }
    setPendingNavigationId(null);
    setIsNavigating(false);
    navigationQueue.current = [];
  }, []);
 
  // Core navigation function with debouncing
  const navigateToNewsletter = useCallback(
    async (newsletterId: string, options: NavigationOptions = {}) => {
      const {
        from,
        fromReadingQueue = false,
        fromNewsletterSources = false,
        replace = false,
        prefetch = true,
        debounceDelay = 200,
      } = options;
 
      // Cancel any pending navigation
      cancelPendingNavigation();
 
      // Track navigation intent
      setPendingNavigationId(newsletterId);
      setIsNavigating(true);
 
      // Add to navigation queue for tracking
      navigationQueue.current.push(newsletterId);
 
      // Calculate time since last navigation
      const now = Date.now();
      const timeSinceLastNav =
        lastNavigationTime.current === 0 ? 0 : now - lastNavigationTime.current;
 
      log.debug('Navigation requested', {
        action: 'navigation_request',
        metadata: {
          newsletterId,
          timeSinceLastNav,
          queueLength: navigationQueue.current.length,
        },
      });
 
      // Perform navigation after debounce delay
      navigationTimeoutRef.current = setTimeout(async () => {
        try {
          // Only navigate if this is still the pending navigation
          if (pendingNavigationId === newsletterId) {
            // Prefetch newsletter data if enabled
            if (prefetch) {
              await prefetchNewsletter(newsletterId, { priority: true });
            }
 
            // Trigger cache invalidation for navigation
            invalidateForOperation(queryClient, 'navigation', [newsletterId]);
 
            // Navigate to the newsletter
            navigate(`/newsletters/${newsletterId}`, {
              replace,
              state: {
                from,
                fromReadingQueue,
                fromNewsletterSources,
              },
            });
 
            // Update last navigation time after successful navigation
            lastNavigationTime.current = Date.now();
 
            log.debug('Navigation completed', {
              action: 'navigation_complete',
              metadata: {
                newsletterId,
                navigationTime: Date.now() - now,
              },
            });
          }
        } catch (error) {
          log.error(
            'Navigation failed',
            {
              action: 'navigation_error',
              metadata: { newsletterId },
            },
            error instanceof Error ? error : new Error(String(error))
          );
        } finally {
          setIsNavigating(false);
          setPendingNavigationId(null);
          navigationQueue.current = [];
        }
      }, debounceDelay);
    },
    [navigate, queryClient, log, prefetchNewsletter, cancelPendingNavigation, pendingNavigationId]
  );
 
  // Navigate to next newsletter in list
  const navigateToNextNewsletter = useCallback(
    (currentId: string, newsletterIds: string[], options: NavigationOptions = {}) => {
      const currentIndex = newsletterIds.indexOf(currentId);
      if (currentIndex === -1 || currentIndex === newsletterIds.length - 1) {
        log.debug('No next newsletter available', {
          action: 'navigate_next',
          metadata: { currentId, currentIndex },
        });
        return;
      }
 
      const nextId = newsletterIds[currentIndex + 1];
 
      // Prefetch the next newsletter after the one we're navigating to
      if (currentIndex + 2 < newsletterIds.length) {
        const afterNextId = newsletterIds[currentIndex + 2];
        prefetchNewsletter(afterNextId, { priority: false }).catch(() => {
          // Ignore prefetch errors
        });
      }
 
      navigateToNewsletter(nextId, options);
    },
    [navigateToNewsletter, log, prefetchNewsletter]
  );
 
  // Navigate to previous newsletter in list
  const navigateToPreviousNewsletter = useCallback(
    (currentId: string, newsletterIds: string[], options: NavigationOptions = {}) => {
      const currentIndex = newsletterIds.indexOf(currentId);
      if (currentIndex === -1 || currentIndex === 0) {
        log.debug('No previous newsletter available', {
          action: 'navigate_previous',
          metadata: { currentId, currentIndex },
        });
        return;
      }
 
      const previousId = newsletterIds[currentIndex - 1];
 
      // Prefetch the newsletter before the one we're navigating to
      if (currentIndex - 2 >= 0) {
        const beforePreviousId = newsletterIds[currentIndex - 2];
        prefetchNewsletter(beforePreviousId, { priority: false }).catch(() => {
          // Ignore prefetch errors
        });
      }
 
      navigateToNewsletter(previousId, options);
    },
    [navigateToNewsletter, log, prefetchNewsletter]
  );
 
  // Cleanup on unmount
  useEffect(() => {
    return () => {
      cancelPendingNavigation();
    };
  }, [cancelPendingNavigation]);
 
  return {
    navigateToNewsletter,
    navigateToNextNewsletter,
    navigateToPreviousNewsletter,
    cancelPendingNavigation,
    isNavigating,
    pendingNavigationId,
  };
};
 
/**
 * Hook for preloading newsletters in a list for smoother navigation
 */
export const useNewsletterPreloader = (
  newsletterIds: string[],
  options: {
    enabled?: boolean;
    preloadCount?: number;
    currentIndex?: number;
  } = {}
) => {
  const { enabled = true, preloadCount = 2, currentIndex = 0 } = options;
  const { prefetchNewsletter } = usePrefetchNewsletterDetail();
  const log = useLogger('useNewsletterPreloader');
 
  useEffect(() => {
    if (!enabled || newsletterIds.length === 0) return;
 
    const preloadNewsletters = async () => {
      const startIndex = Math.max(0, currentIndex - preloadCount);
      const endIndex = Math.min(newsletterIds.length - 1, currentIndex + preloadCount);
 
      const preloadPromises: Promise<void>[] = [];
 
      for (let i = startIndex; i <= endIndex; i++) {
        if (i !== currentIndex) {
          preloadPromises.push(
            prefetchNewsletter(newsletterIds[i], { priority: false }).catch(() => {
              // Ignore individual prefetch errors
            })
          );
        }
      }
 
      if (preloadPromises.length > 0) {
        log.debug('Preloading newsletters', {
          action: 'preload_start',
          metadata: {
            count: preloadPromises.length,
            range: { startIndex, endIndex },
          },
        });
 
        await Promise.allSettled(preloadPromises);
      }
    };
 
    preloadNewsletters();
  }, [enabled, newsletterIds, currentIndex, preloadCount, prefetchNewsletter, log]);
};