All files / src/common/hooks/infiniteScroll useInfiniteNewsletters.ts

97.28% Statements 287/295
91.25% Branches 73/80
100% Functions 4/4
97.28% Lines 287/295

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 3851x 1x 1x 1x 1x 1x     1x                                                         1x 174x 174x 174x 174x 174x   174x 174x 174x 174x 174x 174x 174x 174x     174x     174x     174x 174x   174x 174x 731x   73x 370x   731x 59x 59x 59x 731x 174x 174x   174x 79x 79x 79x 79x 174x     174x     174x     174x 174x 174x 174x 174x 174x 174x 174x 174x     174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x   174x 174x 174x 174x   174x 174x     174x 163x 163x 163x 163x 163x 163x 174x       174x 174x 174x 174x 110x 110x 110x 110x 110x   110x 110x 110x 110x   110x     110x   91x 91x 91x 91x 91x 91x   91x 110x 22x 22x 22x 22x 22x 22x 22x 110x   174x 174x   292x 216x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 216x 216x     76x     292x 292x 174x 174x 174x 174x 174x 174x 174x 174x     174x 163x 13x 13x   13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x     174x 174x 89x 9x 9x 9x 9x 9x 9x 9x 9x 9x 89x 89x   85x   174x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x   85x 174x     174x 174x     174x 163x 13x 13x 13x   13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x     174x 164x 79x 79x 11x 11x 79x 174x     174x 13x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 13x                 174x     174x 4x 1x 1x 1x 1x 1x 1x 1x 1x   4x 4x 174x   174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x 174x  
import { useLogger } from '@common/utils/logger/useLogger';
import { normalizeNewsletterFilter } from '@common/utils/newsletterUtils';
import { useInfiniteQuery } from '@tanstack/react-query';
import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
import { useAuth } from '../../contexts/AuthContext';
import { optimizedNewsletterService } from '../../services/optimizedNewsletterService';
import { NewsletterWithRelations } from '../../types';
import { NewsletterFilter } from '../../types/cache';
import { queryKeyFactory } from '../../utils/queryKeyFactory';
 
export interface UseInfiniteNewslettersOptions {
  enabled?: boolean;
  _refetchOnWindowFocus?: boolean;
  _refetchOnMount?: boolean;
  _staleTime?: number;
  pageSize?: number;
  debug?: boolean;
}
 
export interface UseInfiniteNewslettersReturn {
  newsletters: NewsletterWithRelations[];
  isLoading: boolean;
  isLoadingMore: boolean;
  error: Error | null;
  hasNextPage: boolean;
  isFetchingNextPage: boolean;
  fetchNextPage: () => void;
  refetch: () => void;
  totalCount: number;
  pageCount: number;
  currentPage: number;
}
 
/**
 * Custom hook for infinite loading of newsletters with pagination
 * Manages the business logic for fetching, caching, and paginating newsletter data
 */
export const useInfiniteNewsletters = (
  filters: NewsletterFilter = {},
  options: UseInfiniteNewslettersOptions = {}
): UseInfiniteNewslettersReturn => {
  const { user } = useAuth();
  const log = useLogger('useInfiniteNewsletters');
 
  const {
    enabled = true,
    _refetchOnWindowFocus = false,
    _refetchOnMount = false,
    _staleTime = 30000, // 30 seconds
    pageSize = 20,
    debug = false,
  } = options;
 
  // Track current page for debugging/analytics
  const [currentPage, setCurrentPage] = useState(1);
 
  // Track if component is mounted to prevent queries after unmount
  const isMounted = useRef(true);
 
  // Throttle debug logging to prevent excessive logs during rapid updates
  const lastDebugLogRef = useRef<Record<string, number>>({});
  const DEBUG_THROTTLE_MS = 100; // Only log debug messages every 100ms
 
  const throttledDebug = useCallback(
    (action: string, message: string, metadata?: Record<string, unknown>) => {
      if (!debug) return;
 
      const now = Date.now();
      const lastLog = lastDebugLogRef.current[action] || 0;
 
      if (now - lastLog > DEBUG_THROTTLE_MS) {
        log.debug(message, { action, metadata });
        lastDebugLogRef.current[action] = now;
      }
    },
    [debug, log]
  );
 
  useEffect(() => {
    isMounted.current = true;
    return () => {
      isMounted.current = false;
    };
  }, []);
 
  // Determine if query should run
  const shouldRunQuery = enabled && !!user;
 
  // Normalize filters to camelCase for query and cache
  const normalizedFilters = useMemo(() => normalizeNewsletterFilter(filters), [filters]);
 
  // Generate query key with normalized filters
  const queryKey = useMemo(() => {
    const key = queryKeyFactory.newsletters.infinite(normalizedFilters);
    throttledDebug('query_key_generated', 'Generated query key', {
      originalFilters: JSON.stringify(filters),
      normalizedFilters: JSON.stringify(normalizedFilters),
      queryKey: JSON.stringify(key),
    });
    return key;
  }, [filters, normalizedFilters, throttledDebug]);
 
  // Build API query parameters from normalized filters - memoize to prevent unnecessary re-renders
  const baseQueryParams = useMemo(() => {
    const params = {
      search: normalizedFilters.search,
      isRead: normalizedFilters.isRead,
      isArchived: normalizedFilters.isArchived,
      isLiked: normalizedFilters.isLiked,
      tagIds: normalizedFilters.tagIds ? [...normalizedFilters.tagIds] : undefined, // Create a new array to ensure stability
      sourceIds: normalizedFilters.sourceIds ? [...normalizedFilters.sourceIds] : undefined, // Create a new array to ensure stability
      dateFrom: normalizedFilters.dateFrom,
      dateTo: normalizedFilters.dateTo,
      limit: pageSize,
      orderBy: normalizedFilters.orderBy || 'received_at',
      orderDirection: normalizedFilters.orderDirection || 'desc',
    };
 
    throttledDebug('base_query_params_built', 'Base query params built', {
      params: JSON.stringify(params),
      filters: JSON.stringify(normalizedFilters),
    });
 
    return params;
  }, [normalizedFilters, pageSize, throttledDebug]);
 
  // Debug: Log enabled condition
  useEffect(() => {
    throttledDebug('enabled_condition_check', 'Enabled condition check', {
      enabled,
      hasUser: !!user,
      userId: user?.id,
      enabledCondition: enabled && !!user,
    });
  }, [enabled, user, throttledDebug]);
 
  // Infinite query for newsletters
  // In useInfiniteNewsletters.ts
  const { data, isLoading, error, fetchNextPage, hasNextPage, isFetchingNextPage, refetch } =
    useInfiniteQuery({
      queryKey,
      queryFn: async ({ pageParam = 0 }) => {
        throttledDebug('fetch_page', 'Fetching newsletters page', {
          page: pageParam / pageSize + 1,
          offset: pageParam,
          filters: JSON.stringify(normalizedFilters),
        });
 
        const queryParams = {
          ...baseQueryParams,
          offset: pageParam,
        };
 
        try {
          // Use NewsletterService as the single source of truth
          // The service will handle tag filtering internally
          const result = await optimizedNewsletterService.getAll(queryParams);
 
          throttledDebug('fetch_page_success', 'Newsletters fetched successfully', {
            count: result.data.length,
            total: result.count,
            hasMore: result.hasMore,
            page: pageParam / pageSize + 1,
          });
 
          return result;
        } catch (err) {
          throttledDebug('fetch_page_error', 'Failed to fetch newsletters', {
            pageParam,
            pageSize,
            filters: JSON.stringify(normalizedFilters),
          });
          throw err;
        }
      },
 
      enabled: shouldRunQuery,
      getNextPageParam: (lastPage, allPages) => {
        // Check if there's more data available
        if (!lastPage.hasMore) {
          if (debug) {
            log.debug('No more pages available - hasMore is false', {
              action: 'no_more_pages',
              metadata: {
                totalCount: lastPage.count,
                currentPageDataLength: lastPage.data.length,
                hasMore: lastPage.hasMore,
                totalPages: allPages.length,
                totalFetched: allPages.reduce((sum, page) => sum + page.data.length, 0),
              },
            });
          }
          return undefined;
        }
 
        // Calculate next offset based on current data
        const totalFetched = allPages.reduce((sum, page) => sum + page.data.length, 0);
 
        // Return next offset if there's more data, otherwise undefined
        return lastPage.hasMore && totalFetched < lastPage.count ? totalFetched : undefined;
      },
      initialPageParam: 0,
      staleTime: _staleTime, // Use configurable stale time from options
      refetchOnWindowFocus: _refetchOnWindowFocus,
      refetchOnMount: _refetchOnMount, // Can be overridden via options
      refetchOnReconnect: false, // Prevent refetch on reconnect
      retry: 3,
      retryDelay: (attemptIndex) => Math.min(1000 * Math.pow(2, attemptIndex), 10000),
    });
 
  // Debug: Log query state - optimized to reduce re-renders
  useEffect(() => {
    if (debug) {
      const pagesCount = data?.pages?.length || 0;
      const totalNewsletters = data?.pages?.reduce((sum, page) => sum + page.data.length, 0) || 0;
 
      log.debug('Query state updated', {
        action: 'query_state_updated',
        metadata: {
          enabled: enabled && !!user,
          hasUser: !!user,
          userId: user?.id,
          isLoading,
          hasError: !!error,
          hasData: !!data,
          pagesCount,
          totalNewsletters,
          hasNextPage,
          isFetchingNextPage,
          queryKey: JSON.stringify(queryKey),
        },
      });
    }
  }, [
    debug,
    enabled,
    user,
    isLoading,
    error,
    hasNextPage,
    isFetchingNextPage,
    log,
    queryKey,
    data,
  ]);
 
  // Flatten all pages into a single array of newsletters
  const newsletters = useMemo(() => {
    if (!data?.pages) {
      if (debug) {
        log.debug('No data pages available', {
          action: 'no_data_pages',
          metadata: {
            hasData: !!data,
            dataKeys: data ? Object.keys(data) : [],
            pagesLength: data?.pages?.length || 0,
          },
        });
      }
      return [];
    }
 
    const allNewsletters = data.pages.flatMap((page) => page.data);
 
    if (debug) {
      log.debug('Total newsletters loaded', {
        action: 'calculate_total_newsletters',
        metadata: {
          count: allNewsletters.length,
          pages: data.pages.length,
          lastPageSize: data.pages[data.pages.length - 1]?.data.length || 0,
          firstPageData:
            data.pages[0]?.data?.slice(0, 2).map((n) => ({ id: n.id, title: n.title })) || [],
          allPagesDataLengths: data.pages.map((page) => page.data?.length || 0),
        },
      });
    }
 
    return allNewsletters;
  }, [data, debug, log]);
 
  // Calculate metadata
  const totalCount = data?.pages[0]?.count || 0;
  const pageCount = Math.ceil(totalCount / pageSize);
 
  // Debug logging for hasNextPage calculation - optimized to reduce re-renders
  useEffect(() => {
    if (debug) {
      const pagesLength = data?.pages?.length || 0;
      const lastPageHasMore = data?.pages?.[data.pages.length - 1]?.hasMore;
      const lastPageDataLength = data?.pages?.[data.pages.length - 1]?.data?.length || 0;
 
      log.debug('hasNextPage calculation', {
        action: 'has_next_page_calculation',
        metadata: {
          hasNextPage,
          totalCount,
          currentNewsletters: newsletters.length,
          pageCount,
          currentPage,
          isFetchingNextPage,
          pages: pagesLength,
          lastPageHasMore,
          lastPageDataLength,
        },
      });
    }
  }, [
    hasNextPage,
    totalCount,
    newsletters.length,
    pageCount,
    currentPage,
    isFetchingNextPage,
    debug,
    log,
    data,
  ]);
 
  // Update current page when data changes
  useMemo(() => {
    if (data?.pages) {
      const newCurrentPage = data.pages.length;
      if (newCurrentPage !== currentPage) {
        setCurrentPage(newCurrentPage);
      }
    }
  }, [data, currentPage]);
 
  // Enhanced fetch next page with error handling
  const handleFetchNextPage = useCallback(() => {
    if (hasNextPage && !isFetchingNextPage) {
      if (debug) {
        log.debug('Loading next page', {
          action: 'load_next_page',
          metadata: {
            currentNewsletters: newsletters.length,
            totalCount,
            hasNextPage,
          },
        });
      }
      fetchNextPage();
    } else if (debug) {
      log.debug('Skipping next page load', {
        action: 'skip_next_page_load',
        metadata: {
          hasNextPage,
          isFetchingNextPage,
        },
      });
    }
  }, [hasNextPage, isFetchingNextPage, fetchNextPage, debug, newsletters.length, totalCount, log]);
 
  // Enhanced refetch with debug logging
  const handleRefetch = useCallback(() => {
    if (debug) {
      log.debug('Refetching newsletters', {
        action: 'refetch_newsletters',
        metadata: {
          filters: JSON.stringify(normalizedFilters),
          currentCount: newsletters.length,
        },
      });
    }
 
    setCurrentPage(1);
    return refetch();
  }, [refetch, debug, normalizedFilters, newsletters.length, log]);
 
  return {
    newsletters,
    isLoading,
    isLoadingMore: isFetchingNextPage,
    error: error as Error | null,
    hasNextPage: hasNextPage || false,
    isFetchingNextPage,
    fetchNextPage: handleFetchNextPage,
    refetch: handleRefetch,
    totalCount,
    pageCount,
    currentPage,
  };
};