All files / src/common/contexts FilterContext.tsx

97.06% Statements 298/307
87.67% Branches 64/73
100% Functions 6/6
97.06% Lines 298/307

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 4221x     1x                                                                       1x                 1x 157x 157x 157x 157x 157x     157x 157x     157x 157x 157x   157x 153x 153x 153x 153x 153x 153x 153x 153x 153x 157x     157x 153x     153x 153x 153x 142x 142x 142x 153x       153x 7x   7x 153x 4x   4x 153x     153x 10x 10x     153x 22x 22x     153x   16x 16x 16x   16x 16x   3x 3x 3x 3x 3x 16x   9x 9x 9x 9x 9x 9x 9x 9x 16x   1x 1x 1x 1x 1x 16x   1x 1x 1x 1x 1x 1x 1x 1x 16x   1x 1x 1x 1x 1x 16x   1x 1x 1x 1x 1x 1x 1x 16x   16x 16x 1x 1x 16x     153x 153x 153x 153x 153x 153x   153x 157x     157x   153x 153x 142x 135x 126x 111x 111x   157x     157x 157x 10x 10x   4x 10x 2x 10x 2x 10x 2x 10x   10x   10x   10x 10x 157x 157x     157x 153x 2x 2x     2x 2x   2x 2x 2x 2x 2x 2x 157x     157x 157x 12x 12x 157x 157x   157x 157x 2x 2x 157x 157x   157x 157x 6x 6x 157x 157x   157x 157x 13x 13x 157x 157x   157x 157x 35x 35x 157x 157x   157x 157x 4x 4x 2x 2x 4x 4x 157x 157x   157x 157x 2x 2x 1x 1x 2x 157x 157x   157x 157x 2x 2x 2x 157x 157x   157x 1x 157x   157x 3x 157x   157x 157x 1x   1x 1x 1x 1x 1x 1x 1x   1x 1x 157x 157x     157x 157x 28x 26x 26x 26x 26x 26x 26x 26x 28x 28x 157x 157x   157x 157x 22x 20x 20x 20x 20x 20x 20x 20x 22x 22x 157x 157x   157x   157x 157x 157x 157x     157x 157x 157x 157x 157x 157x 157x 157x 157x 157x 157x 157x 157x 157x 157x   157x 157x   1x 123x 123x     123x 123x     1x 5x 5x 5x   1x 2x 2x 2x   1x 4x 4x 4x   1x 6x 6x 6x   1x  
import { useInboxUrlParams } from '@common/hooks/useUrlParams';
import type { NewsletterFilter } from '@common/types/cache';
import type { TimeRange } from '@web/components/TimeFilter';
import React, { createContext, useCallback, useContext, useEffect, useMemo, useRef } from 'react';
import type { InboxFilterType } from '../hooks/useInboxFilters'; // Import the shared type
 
export interface FilterState {
  filter: InboxFilterType;
  sourceFilter: string | null;
  timeRange: TimeRange;
  tagIds: string[];
  groupFilters: string[];
  sortBy: string;
  sortOrder: 'asc' | 'desc';
}
 
export interface FilterActions {
  setFilter: (filter: FilterState['filter']) => void;
  setSourceFilter: (sourceId: string | null) => void;
  setTimeRange: (range: TimeRange) => void;
  setTagIds: (tagIds: string[]) => void;
  setGroupFilters: (groupIds: string[]) => void;
  toggleTag: (tagId: string) => void;
  addTag: (tagId: string) => void;
  removeTag: (tagId: string) => void;
  clearTags: () => void;
  resetFilters: () => void;
  updateFilters: (updates: Partial<FilterState>) => void;
  setSortBy: (sortBy: string) => void;
  setSortOrder: (sortOrder: 'asc' | 'desc') => void;
}
 
export interface FilterContextType extends FilterState, FilterActions {
  newsletterFilter: NewsletterFilter;
  hasActiveFilters: boolean;
  isFilterActive: (filterName: keyof FilterState) => boolean;
  useLocalTagFiltering: boolean;
}
 
const FilterContext = createContext<FilterContextType | undefined>(undefined);
 
interface FilterProviderProps {
  children: React.ReactNode;
  onFilterChange?: (filters: FilterState, newsletterFilter: NewsletterFilter) => void;
  debounceTagsMs?: number;
  useLocalTagFiltering?: boolean;
}
 
export const FilterProvider: React.FC<FilterProviderProps> = ({
  children,
  onFilterChange,
  useLocalTagFiltering = false,
}) => {
  const { params, updateParams, resetParams } = useInboxUrlParams();
 
  // Track last filter state to prevent unnecessary updates
  const lastNewsletterFilterRef = useRef<string>('');
  const lastFilterStateRef = useRef<string>('');
 
  // Extract filter state from URL params
  const validFilters = ['unread', 'read', 'liked', 'archived'];
  const filterValue = params.filter as FilterState['filter'];
  const filter: FilterState['filter'] = validFilters.includes(filterValue) ? filterValue : 'unread';
 
  const filterState: FilterState = useMemo(() => {
    return {
      filter,
      sourceFilter: (params.source as string) || null,
      timeRange: (params.time as TimeRange) || 'all',
      tagIds: (params.tags as string[]) || [],
      groupFilters: (params.groups as string[]) || [],
      sortBy: (params.sort as string) || 'received_at',
      sortOrder: (params.order as 'asc' | 'desc') || 'desc',
    };
  }, [filter, params.source, params.time, params.tags, params.groups, params.sort, params.order]);
 
  // Generate newsletter filter object with stable memoization
  const newsletterFilter = useMemo(() => {
    const filters: NewsletterFilter = {};
 
    // Handle status filter
    switch (filterState.filter) {
      case 'unread':
      default: // 'unread' is the new default
        filters.isRead = false;
        filters.isArchived = false;
        break;
      case 'read':
        filters.isRead = true;
        filters.isArchived = false;
        break;
      case 'liked':
        filters.isLiked = true;
        // Show all liked newsletters, including archived ones
        break;
      case 'archived':
        filters.isArchived = true;
        // No isRead filter for archived, show all archived
        break;
    }
 
    // Handle source filter
    if (filterState.sourceFilter) {
      filters.sourceIds = [filterState.sourceFilter];
    }
 
    // Handle tag filter (only include in server filter if not using local filtering)
    if (!useLocalTagFiltering && filterState.tagIds.length > 0) {
      filters.tagIds = [...filterState.tagIds]; // Create a new array to ensure stability
    }
 
    // Handle time range filter
    if (filterState.timeRange && filterState.timeRange !== 'all') {
      // Use local time for date calculations so 'Today' reflects the user's local day
      const now = new Date();
      let dateFrom: Date;
      let dateTo: Date | undefined;
 
      switch (filterState.timeRange) {
        case 'day': {
          // Start of the local day (local midnight)
          const startOfLocalDay = new Date(now);
          startOfLocalDay.setHours(0, 0, 0, 0);
          dateFrom = startOfLocalDay;
          break;
        }
        case 'week': {
          // Start of the current week (Monday 00:00 local time)
          const startOfWeek = new Date(now);
          startOfWeek.setHours(0, 0, 0, 0);
          const day = startOfWeek.getDay(); // 0=Sun,1=Mon,...6=Sat
          const diffSinceMonday = (day + 6) % 7; // days since Monday
          startOfWeek.setDate(startOfWeek.getDate() - diffSinceMonday);
          dateFrom = startOfWeek;
          break;
        }
        case 'month': {
          // Start of the current month at local midnight
          const startOfMonth = new Date(now.getFullYear(), now.getMonth(), 1);
          startOfMonth.setHours(0, 0, 0, 0);
          dateFrom = startOfMonth;
          break;
        }
        case 'last24h': {
          // Previous calendar day (local): [yesterday 00:00, today 00:00)
          const startOfToday = new Date(now);
          startOfToday.setHours(0, 0, 0, 0);
          const startOfYesterday = new Date(startOfToday);
          startOfYesterday.setDate(startOfYesterday.getDate() - 1);
          dateFrom = startOfYesterday;
          dateTo = startOfToday;
          break;
        }
        case '2days': {
          // Rolling 2 days (48 hours) based on local time
          const twoDaysAgo = new Date(now);
          twoDaysAgo.setDate(now.getDate() - 2);
          dateFrom = twoDaysAgo;
          break;
        }
        default: {
          // For unsupported values, fall back to start of current week
          const startOfWeek = new Date(now);
          startOfWeek.setHours(0, 0, 0, 0);
          const day = startOfWeek.getDay();
          const diffSinceMonday = (day + 6) % 7;
          startOfWeek.setDate(startOfWeek.getDate() - diffSinceMonday);
          dateFrom = startOfWeek;
        }
      }
 
      filters.dateFrom = dateFrom.toISOString();
      if (dateTo) {
        filters.dateTo = dateTo.toISOString();
      }
    }
 
    // Handle sort parameters
    if (filterState.sortBy) {
      filters.orderBy = filterState.sortBy;
    }
    if (filterState.sortOrder) {
      filters.orderDirection = filterState.sortOrder;
    }
 
    return filters;
  }, [filterState, useLocalTagFiltering]);
 
  // Check if any filters are active (non-default)
  const hasActiveFilters = useMemo(() => {
    // 'unread' is the default for status. Active if not 'unread' or other filters are set.
    return (
      filterState.filter !== 'unread' ||
      filterState.sourceFilter !== null ||
      filterState.timeRange !== 'all' ||
      filterState.tagIds.length > 0 ||
      filterState.sortBy !== 'received_at' ||
      filterState.sortOrder !== 'desc'
    );
  }, [filterState.filter, filterState.sourceFilter, filterState.timeRange, filterState.tagIds, filterState.sortBy, filterState.sortOrder]);
 
  // Check if a specific filter is active
  const isFilterActive = useCallback(
    (filterName: keyof FilterState): boolean => {
      switch (filterName) {
        case 'filter':
          // 'unread' is the default. Active if it's 'liked' or 'archived'.
          return filterState.filter !== 'unread';
        case 'sourceFilter':
          return filterState.sourceFilter !== null;
        case 'timeRange':
          return filterState.timeRange !== 'all'; // 'all' time is default
        case 'tagIds':
          return filterState.tagIds.length > 0;
        case 'sortBy':
          return filterState.sortBy !== 'received_at';
        case 'sortOrder':
          return filterState.sortOrder !== 'desc';
        default:
          return false;
      }
    },
    [filterState.filter, filterState.sourceFilter, filterState.timeRange, filterState.tagIds, filterState.sortBy, filterState.sortOrder]
  );
 
  // Only trigger onFilterChange when the newsletterFilter has actually changed
  useEffect(() => {
    if (onFilterChange) {
      const currentFilterString = JSON.stringify(newsletterFilter);
      const currentFilterStateString = JSON.stringify(filterState);
 
      // Prevent unnecessary calls if both newsletterFilter and filterState haven't changed
      if (
        lastNewsletterFilterRef.current !== currentFilterString ||
        lastFilterStateRef.current !== currentFilterStateString
      ) {
        lastNewsletterFilterRef.current = currentFilterString;
        lastFilterStateRef.current = currentFilterStateString;
        onFilterChange(filterState, newsletterFilter);
      }
    }
  }, [newsletterFilter, filterState, onFilterChange]);
 
  // Action creators
  const setFilter = useCallback(
    (filter: FilterState['filter']) => {
      updateParams({ filter });
    },
    [updateParams]
  );
 
  const setSourceFilter = useCallback(
    (sourceId: string | null) => {
      updateParams({ source: sourceId });
    },
    [updateParams]
  );
 
  const setTimeRange = useCallback(
    (range: TimeRange) => {
      updateParams({ time: range });
    },
    [updateParams]
  );
 
  const setTagIds = useCallback(
    (tagIds: string[]) => {
      updateParams({ tags: tagIds });
    },
    [updateParams]
  );
 
  const setGroupFilters = useCallback(
    (groupIds: string[]) => {
      updateParams({ groups: groupIds });
    },
    [updateParams]
  );
 
  const toggleTag = useCallback(
    (tagId: string) => {
      const currentTags = filterState.tagIds;
      const newTags = currentTags.includes(tagId)
        ? currentTags.filter((id) => id !== tagId)
        : [...currentTags, tagId];
      setTagIds(newTags);
    },
    [filterState.tagIds, setTagIds]
  );
 
  const addTag = useCallback(
    (tagId: string) => {
      const currentTags = filterState.tagIds;
      if (!currentTags.includes(tagId)) {
        setTagIds([...currentTags, tagId]);
      }
    },
    [filterState.tagIds, setTagIds]
  );
 
  const removeTag = useCallback(
    (tagId: string) => {
      const currentTags = filterState.tagIds;
      setTagIds(currentTags.filter((id) => id !== tagId));
    },
    [filterState.tagIds, setTagIds]
  );
 
  const clearTags = useCallback(() => {
    setTagIds([]);
  }, [setTagIds]);
 
  const resetFilters = useCallback(() => {
    resetParams();
  }, [resetParams]);
 
  const updateFilters = useCallback(
    (updates: Partial<FilterState>) => {
      const urlUpdates: any = {};
 
      if ('filter' in updates) urlUpdates.filter = updates.filter;
      if ('sourceFilter' in updates) urlUpdates.source = updates.sourceFilter;
      if ('timeRange' in updates) urlUpdates.time = updates.timeRange;
      if ('tagIds' in updates) urlUpdates.tags = updates.tagIds;
      if ('groupFilters' in updates) urlUpdates.groups = updates.groupFilters;
      if ('sortBy' in updates) urlUpdates.sort = updates.sortBy;
      if ('sortOrder' in updates) urlUpdates.order = updates.sortOrder;
 
      updateParams(urlUpdates);
    },
    [updateParams]
  );
 
  // Sort action creators
  const setSortBy = useCallback(
    (sortBy: string) => {
      updateParams(() => ({
        filter: filterState.filter,
        source: filterState.sourceFilter,
        time: filterState.timeRange,
        tags: filterState.tagIds,
        groups: filterState.groupFilters,
        sort: sortBy,
        order: filterState.sortOrder,
      }));
    },
    [updateParams, filterState]
  );
 
  const setSortOrder = useCallback(
    (sortOrder: 'asc' | 'desc') => {
      updateParams(() => ({
        filter: filterState.filter,
        source: filterState.sourceFilter,
        time: filterState.timeRange,
        tags: filterState.tagIds,
        groups: filterState.groupFilters,
        sort: filterState.sortBy,
        order: sortOrder,
      }));
    },
    [updateParams, filterState]
  );
 
  const contextValue: FilterContextType = {
    // State
    ...filterState,
    newsletterFilter,
    hasActiveFilters,
    useLocalTagFiltering,
 
    // Actions
    setFilter,
    setSourceFilter,
    setTimeRange,
    setTagIds,
    setGroupFilters,
    toggleTag,
    addTag,
    removeTag,
    clearTags,
    resetFilters,
    updateFilters,
    isFilterActive,
    setSortBy,
    setSortOrder,
  };
 
  return <FilterContext.Provider value={contextValue}>{children}</FilterContext.Provider>;
};
 
export const useFilters = (): FilterContextType => {
  const context = useContext(FilterContext);
  if (context === undefined) {
    throw new Error('useFilters must be used within a FilterProvider');
  }
  return context;
};
 
// Convenience hooks for specific filter types
export const useStatusFilter = () => {
  const { filter, setFilter } = useFilters();
  return { filter, setFilter };
};
 
export const useSourceFilter = () => {
  const { sourceFilter, setSourceFilter } = useFilters();
  return { sourceFilter, setSourceFilter };
};
 
export const useTimeFilter = () => {
  const { timeRange, setTimeRange } = useFilters();
  return { timeRange, setTimeRange };
};
 
export const useTagFilter = () => {
  const { tagIds, setTagIds, toggleTag, addTag, removeTag, clearTags } = useFilters();
  return { tagIds, setTagIds, toggleTag, addTag, removeTag, clearTags };
};
 
export default FilterContext;