Files
flyer-crawler.projectium.com/src/hooks/queries/useLeaderboardQuery.ts
Torben Sorensen 3d91d59b9c
All checks were successful
Deploy to Test Environment / deploy-to-test (push) Successful in 16m53s
refactor: update API response handling across multiple queries to ensure compliance with ADR-028
- Removed direct return of json.data in favor of structured error handling.
- Implemented checks for success and data array in useActivityLogQuery, useBestSalePricesQuery, useBrandsQuery, useCategoriesQuery, useFlyerItemsForFlyersQuery, useFlyerItemsQuery, useFlyersQuery, useLeaderboardQuery, useMasterItemsQuery, usePriceHistoryQuery, useShoppingListsQuery, useSuggestedCorrectionsQuery, and useWatchedItemsQuery.
- Updated unit tests to reflect changes in expected behavior when API response does not conform to the expected structure.
- Updated package.json to use the latest version of @sentry/vite-plugin.
- Adjusted vite.config.ts for local development SSL configuration.
- Added self-signed SSL certificate and key for local development.
2026-01-17 21:45:51 -08:00

44 lines
1.5 KiB
TypeScript

// src/hooks/queries/useLeaderboardQuery.ts
import { useQuery } from '@tanstack/react-query';
import { fetchLeaderboard } from '../../services/apiClient';
import { queryKeys } from '../../config/queryKeys';
import type { LeaderboardUser } from '../../types';
/**
* Query hook for fetching the public leaderboard.
*
* @param limit - Number of top users to fetch (default: 10)
* @param enabled - Whether the query should run (default: true)
* @returns TanStack Query result with LeaderboardUser array
*
* @example
* ```tsx
* const { data: leaderboard = [], isLoading, error } = useLeaderboardQuery(10);
* ```
*/
export const useLeaderboardQuery = (limit: number = 10, enabled: boolean = true) => {
return useQuery({
queryKey: queryKeys.leaderboard(limit),
queryFn: async (): Promise<LeaderboardUser[]> => {
const response = await fetchLeaderboard(limit);
if (!response.ok) {
const error = await response.json().catch(() => ({
message: `Request failed with status ${response.status}`,
}));
throw new Error(error.message || 'Failed to fetch leaderboard');
}
const json = await response.json();
// ADR-028: API returns { success: true, data: [...] }
// If success is false or data is not an array, return empty array to prevent .map() errors
if (!json.success || !Array.isArray(json.data)) {
return [];
}
return json.data;
},
enabled,
staleTime: 1000 * 60 * 2, // 2 minutes - leaderboard can change moderately
});
};