All files / src/common/hooks useNewsletterNavigation.ts

51.74% Statements 178/344
57.62% Branches 34/59
33.33% Functions 1/3
51.74% Lines 178/344

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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 4661x 1x 1x 1x   1x 1x 1x                                                                               1x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x     16x 16x     16x   16x                         16x 16x 16x 16x   16x 16x 16x 16x   16x                     16x                                   16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x     16x     16x     16x 16x   16x     16x 16x 16x 16x 16x 16x 16x 16x 16x 14x   16x 16x 16x     16x 16x 16x   16x 16x 16x     16x 16x 1x 1x 1x 1x 1x 1x 1x   15x   16x 1x                     1x 1x 1x 1x 1x 1x 1x   14x 16x 16x 16x   16x                               14x 14x 14x 14x 14x 14x 16x     16x 16x   16x 16x     14x 16x 16x     16x 15x                           16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x     16x 2x   2x                   2x                     2x 16x   16x 2x     2x                                                         2x                     2x                           2x                     2x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x     16x 16x 16x 16x     16x         16x 16x     16x 15x 15x   16x   16x 16x 16x 16x 16x 16x 16x 16x     16x 16x 16x 16x 16x           1x                                           1x                        
import { useLogger } from '@common/utils/logger/useLogger';
import { normalizeNewsletterFilter } from '@common/utils/newsletterUtils';
import { useCallback, useMemo } from 'react';
import { useLocation } from 'react-router-dom';
import type { NewsletterFilter, NewsletterWithRelations } from '../types';
import { useInfiniteNewsletters } from './infiniteScroll';
import { useInboxFilters } from './useInboxFilters';
import { useReadingQueue } from './useReadingQueue';
 
export interface NewsletterNavigationState {
  currentNewsletter: NewsletterWithRelations | null;
  previousNewsletter: NewsletterWithRelations | null;
  nextNewsletter: NewsletterWithRelations | null;
  currentIndex: number;
  totalCount: number;
  hasPrevious: boolean;
  hasNext: boolean;
  isLoading: boolean;
}
 
export interface NewsletterNavigationActions {
  navigateToPrevious: () => string | null;
  navigateToNext: () => string | null;
  preloadAdjacent: () => void;
}
 
export interface UseNewsletterNavigationOptions {
  enabled?: boolean;
  preloadAdjacent?: boolean;
  debug?: boolean;
  /** Override context detection and use specific filter */
  overrideFilter?: NewsletterFilter;
  /** Force use of reading queue context */
  forceReadingQueue?: boolean;
  /** Force use of specific source filter */
  forceSourceFilter?: string;
}
 
export interface UseNewsletterNavigationReturn
  extends NewsletterNavigationState,
  NewsletterNavigationActions { }
 
/**
 * Custom hook for newsletter navigation functionality
 * Provides next/previous navigation within the current context
 * Respects current view (inbox, reading queue, source) filters and maintains navigation state
 */
export const useNewsletterNavigation = (
  currentNewsletterId: string | null,
  options: UseNewsletterNavigationOptions = {}
): UseNewsletterNavigationReturn => {
  const log = useLogger('useNewsletterNavigation');
  const location = useLocation();
  const {
    enabled = false,
    preloadAdjacent = true,
    debug = false,
    overrideFilter,
    forceReadingQueue = false,
    forceSourceFilter,
  } = options;
 
  // Get current inbox filters and reading queue
  const { newsletterFilter } = useInboxFilters();
  const { readingQueue = [] } = useReadingQueue() || {};
 
  // Determine the context and build appropriate filter
  const contextualFilter: NewsletterFilter = useMemo(() => {
    // Use override filter if provided
    if (overrideFilter) {
      console.log('🔍 DEBUG: useNewsletterNavigation using overrideFilter', {
        overrideFilter,
        currentNewsletterId,
      });
      return {
        ...overrideFilter,
        orderBy: 'received_at',
        ascending: false,
      };
    }
 
    // Detect context from URL and options
    const isReadingQueueContext =
      forceReadingQueue ||
      location.pathname.includes('/reading-queue') ||
      location.pathname.includes('/queue');
 
    const isNewsletterSourceContext =
      forceSourceFilter ||
      location.pathname.includes('/sources/') ||
      location.search.includes('source=');
 
    if (isReadingQueueContext) {
      // For reading queue, we don't use the regular filter system
      // Instead we'll use the reading queue data directly
      return {
        is_read: undefined,
        search: 'reading_queue',
        order_by: 'received_at',
        ascending: false,
      } as NewsletterFilter;
    }
 
    if (isNewsletterSourceContext) {
      // Extract source from URL or use forced source
      const sourceId =
        forceSourceFilter ||
        new URLSearchParams(location.search).get('source') ||
        location.pathname.split('/sources/')[1]?.split('/')[0];
 
      if (sourceId) {
        return {
          ...newsletterFilter,
          source_id: sourceId,
          order_by: 'received_at',
          ascending: false,
        };
      }
    }
 
    // Default to current inbox filters
    console.log('🔍 DEBUG: useNewsletterNavigation using default newsletterFilter', {
      newsletterFilter,
      currentNewsletterId,
    });
    return {
      ...newsletterFilter,
      order_by: 'received_at',
      ascending: false,
    };
  }, [
    overrideFilter,
    forceReadingQueue,
    forceSourceFilter,
    location.pathname,
    location.search,
    newsletterFilter,
  ]);
 
  // Normalize contextualFilter before passing to useInfiniteNewsletters
  const normalizedContextualFilter = useMemo(() => normalizeNewsletterFilter(contextualFilter), [contextualFilter]);
 
  // Handle reading queue context separately
  const isUsingReadingQueue = contextualFilter.search === 'reading_queue';
 
  // For reading queue, use the queue data directly
  const readingQueueNewsletters = useMemo(() => {
    if (!isUsingReadingQueue) return [];
    return readingQueue.map((item) => item.newsletter).filter(Boolean);
  }, [isUsingReadingQueue, readingQueue]);
 
  // Fetch newsletters using normalized contextual filters (skip if using reading queue)
  const {
    newsletters: fetchedNewsletters,
    isLoading,
    totalCount,
    hasNextPage,
    fetchNextPage,
    isFetchingNextPage,
  } = useInfiniteNewsletters(normalizedContextualFilter, {
    enabled: enabled && !!currentNewsletterId && !isUsingReadingQueue &&
      (window.location.pathname.includes('/newsletters/') &&
        window.location.pathname.split('/').length > 2),
    pageSize: 50, // Larger page size for better navigation experience
    debug,
  });
 
  // Use appropriate newsletter list based on context
  const newsletters = useMemo(() => {
    return isUsingReadingQueue ? readingQueueNewsletters : fetchedNewsletters;
  }, [isUsingReadingQueue, readingQueueNewsletters, fetchedNewsletters]);
 
  const contextTotalCount = useMemo(() => {
    return isUsingReadingQueue ? readingQueue.length : totalCount;
  }, [isUsingReadingQueue, readingQueue.length, totalCount]);
 
  // Find current newsletter and its position
  const navigationState = useMemo(() => {
    if (!currentNewsletterId || !newsletters.length) {
      return {
        currentNewsletter: null,
        currentIndex: -1,
        previousNewsletter: null,
        nextNewsletter: null,
      };
    }
 
    const currentIndex = newsletters.findIndex((n) => n.id === currentNewsletterId);
 
    if (currentIndex === -1) {
      if (debug) {
        log.debug('Current newsletter not found in list', {
          action: 'find_current_newsletter',
          metadata: {
            currentNewsletterId,
            newslettersCount: newsletters.length,
            firstFewIds: newsletters.slice(0, 5).map((n) => n.id),
          },
        });
      }
 
      return {
        currentNewsletter: null,
        currentIndex: -1,
        previousNewsletter: null,
        nextNewsletter: null,
      };
    }
 
    const currentNewsletter = newsletters[currentIndex];
    const previousNewsletter = currentIndex > 0 ? newsletters[currentIndex - 1] : null;
    const nextNewsletter =
      currentIndex < newsletters.length - 1 ? newsletters[currentIndex + 1] : null;
 
    if (debug) {
      log.debug('Navigation state calculated', {
        action: 'calculate_navigation_state',
        metadata: {
          currentIndex,
          totalNewsletters: newsletters.length,
          hasPrevious: !!previousNewsletter,
          hasNext: !!nextNewsletter,
          previousId: previousNewsletter?.id,
          nextId: nextNewsletter?.id,
          context: isUsingReadingQueue ? 'reading_queue' : 'filtered_inbox',
          contextFilter: contextualFilter,
        },
      });
    }
 
    return {
      currentNewsletter,
      currentIndex,
      previousNewsletter,
      nextNewsletter,
    };
  }, [currentNewsletterId, newsletters, debug, log]);
 
  // Check if we need to fetch more pages for navigation (only for non-reading-queue contexts)
  const needsMoreData = useMemo(() => {
    if (isUsingReadingQueue) return false; // Reading queue is already fully loaded
 
    const { currentIndex } = navigationState;
    if (currentIndex === -1) return false;
 
    // If we're near the end and there are more pages, we should fetch
    const isNearEnd = currentIndex >= newsletters.length - 5;
    return isNearEnd && hasNextPage && !isFetchingNextPage;
  }, [isUsingReadingQueue, navigationState, newsletters.length, hasNextPage, isFetchingNextPage]);
 
  // Auto-fetch more data when needed (only for non-reading-queue contexts)
  const preloadAdjacentNewsletters = useCallback(() => {
    if (needsMoreData && preloadAdjacent && !isUsingReadingQueue) {
      if (debug) {
        log.debug('Preloading adjacent newsletters', {
          action: 'preload_adjacent',
          metadata: {
            currentIndex: navigationState.currentIndex,
            totalLoaded: newsletters.length,
            hasNextPage,
            context: 'filtered_inbox',
          },
        });
      }
      fetchNextPage();
    }
  }, [
    needsMoreData,
    preloadAdjacent,
    isUsingReadingQueue,
    fetchNextPage,
    debug,
    log,
    navigationState.currentIndex,
    newsletters.length,
    hasNextPage,
  ]);
 
  // Navigation functions
  const navigateToPrevious = useCallback((): string | null => {
    const { previousNewsletter } = navigationState;
 
    if (!previousNewsletter) {
      if (debug) {
        log.debug('No previous newsletter available', {
          action: 'navigate_previous',
          metadata: { currentIndex: navigationState.currentIndex },
        });
      }
      return null;
    }
 
    if (debug) {
      log.debug('Navigating to previous newsletter', {
        action: 'navigate_previous',
        metadata: {
          fromId: currentNewsletterId,
          toId: previousNewsletter.id,
          currentIndex: navigationState.currentIndex,
        },
      });
    }
 
    return previousNewsletter.id;
  }, [navigationState, currentNewsletterId, debug, log]);
 
  const navigateToNext = useCallback((): string | null => {
    const { nextNewsletter, currentIndex } = navigationState;
 
    // For reading queue, no need to fetch more pages
    if (isUsingReadingQueue) {
      if (!nextNewsletter) {
        if (debug) {
          log.debug('No next newsletter available in reading queue', {
            action: 'navigate_next',
            metadata: {
              currentIndex: navigationState.currentIndex,
              totalInQueue: readingQueue.length,
            },
          });
        }
        return null;
      }
 
      if (debug) {
        log.debug('Navigating to next newsletter in reading queue', {
          action: 'navigate_next',
          metadata: {
            fromId: currentNewsletterId,
            toId: nextNewsletter.id,
            currentIndex: navigationState.currentIndex,
          },
        });
      }
 
      return nextNewsletter.id;
    }
 
    // For filtered inbox, try to fetch more if needed
    if (!nextNewsletter && hasNextPage && !isFetchingNextPage) {
      if (debug) {
        log.debug('Fetching next page for navigation', {
          action: 'navigate_next_fetch',
          metadata: { currentIndex, totalLoaded: newsletters.length },
        });
      }
      fetchNextPage();
      return null; // User will need to try again after fetch
    }
 
    if (!nextNewsletter) {
      if (debug) {
        log.debug('No next newsletter available', {
          action: 'navigate_next',
          metadata: {
            currentIndex: navigationState.currentIndex,
            hasNextPage,
            isFetchingNextPage,
          },
        });
      }
      return null;
    }
 
    if (debug) {
      log.debug('Navigating to next newsletter', {
        action: 'navigate_next',
        metadata: {
          fromId: currentNewsletterId,
          toId: nextNewsletter.id,
          currentIndex: navigationState.currentIndex,
        },
      });
    }
 
    return nextNewsletter.id;
  }, [
    navigationState,
    currentNewsletterId,
    isUsingReadingQueue,
    readingQueue.length,
    hasNextPage,
    isFetchingNextPage,
    fetchNextPage,
    debug,
    log,
    newsletters.length,
  ]);
 
  // Determine navigation availability
  const hasPrevious = navigationState.currentIndex > 0;
  const hasNext = useMemo(() => {
    const { currentIndex } = navigationState;
    if (currentIndex === -1) return false;
 
    // For reading queue, only check current data
    if (isUsingReadingQueue) {
      return currentIndex < newsletters.length - 1;
    }
 
    // For filtered inbox, has next if there's a next newsletter in current data OR more pages to fetch
    return currentIndex < newsletters.length - 1 || hasNextPage;
  }, [navigationState, newsletters.length, hasNextPage, isUsingReadingQueue]);
 
  // Auto-preload when position changes
  if (enabled && preloadAdjacent) {
    preloadAdjacentNewsletters();
  }
 
  return {
    // State
    currentNewsletter: navigationState.currentNewsletter,
    previousNewsletter: navigationState.previousNewsletter,
    nextNewsletter: navigationState.nextNewsletter,
    currentIndex: navigationState.currentIndex,
    totalCount: contextTotalCount,
    hasPrevious,
    hasNext,
    isLoading: isUsingReadingQueue ? false : isLoading || isFetchingNextPage,
 
    // Actions
    navigateToPrevious,
    navigateToNext,
    preloadAdjacent: preloadAdjacentNewsletters,
  };
};
 
/**
 * Hook variant that provides only navigation state without actions
 * Useful for read-only navigation information
 */
export const useNewsletterNavigationState = (
  currentNewsletterId: string | null,
  options: UseNewsletterNavigationOptions = {}
): NewsletterNavigationState => {
  const navigation = useNewsletterNavigation(currentNewsletterId, options);
 
  return {
    currentNewsletter: navigation.currentNewsletter,
    previousNewsletter: navigation.previousNewsletter,
    nextNewsletter: navigation.nextNewsletter,
    currentIndex: navigation.currentIndex,
    totalCount: navigation.totalCount,
    hasPrevious: navigation.hasPrevious,
    hasNext: navigation.hasNext,
    isLoading: navigation.isLoading,
  };
};
 
/**
 * Hook variant that provides only navigation actions
 * Useful when you only need the navigation functions
 */
export const useNewsletterNavigationActions = (
  currentNewsletterId: string | null,
  options: UseNewsletterNavigationOptions = {}
): NewsletterNavigationActions => {
  const navigation = useNewsletterNavigation(currentNewsletterId, options);
 
  return {
    navigateToPrevious: navigation.navigateToPrevious,
    navigateToNext: navigation.navigateToNext,
    preloadAdjacent: navigation.preloadAdjacent,
  };
};