refactor: extract valhalla warnings handler and add unit tests

Author: lourduradjou

src/components/types.ts

@@ -213,22 +213,21 @@ export interface Address {
   country_code: string;
 }
 
+export interface ValhallaWarning {
+  code: number;
+  message: string;
+}
+
 export interface ValhallaRouteResponse {
   id: 'valhalla_directions';
   trip: Trip;
   alternates?: ValhallaRouteResponse[];
-  warnings?: {
-    code: number;
-    message: string;
-  }[];
+  warnings?: ValhallaWarning[];
 }
 
 export interface ValhallaIsochroneResponse extends GeoJSON.FeatureCollection {
   id: string;
-  warnings?: {
-    code: number;
-    message: string;
-  }[];
+  warnings?: ValhallaWarning[];
 }
 
 export interface FetchGeocodeObject {
@@ -249,8 +248,5 @@ export interface OptimizedLocation {
 export interface ValhallaOptimizedRouteResponse {
   trip: Trip;
   id?: string;
-  warnings?: {
-    code: number;
-    message: string;
-  }[];
+  warnings?: ValhallaWarning[];
 }

src/hooks/use-directions-queries.ts

@@ -22,6 +22,7 @@ import { getDirectionsLanguage } from '@/utils/directions-language';
 import { useCommonStore } from '@/stores/common-store';
 import { useDirectionsStore, type Waypoint } from '@/stores/directions-store';
 import { router } from '@/routes';
+import { handleValhallaWarnings } from '@/utils/handle-valhalla-warnings';
 
 const getActiveWaypoints = (waypoints: Waypoint[]): ActiveWaypoint[] =>
   waypoints.flatMap((wp) => wp.geocodeResults.filter((r) => r.selected));
@@ -57,16 +58,7 @@ async function fetchDirections() {
   );
 
   // Display routing warnings if present
-  if (data.warnings && data.warnings.length > 0) {
-    data.warnings.forEach((warning) => {
-      toast.warning('Routing warning', {
-        description: warning.message,
-        position: 'bottom-center',
-        duration: 5000,
-        closeButton: true,
-      });
-    });
-  }
+  handleValhallaWarnings(data.warnings);
 
   // Parse geometry for main route
   (data as ParsedDirectionsGeometry).decodedGeometry =

src/hooks/use-isochrones-queries.ts

@@ -18,6 +18,7 @@ import { calcArea } from '@/utils/geom';
 import { useCommonStore } from '@/stores/common-store';
 import { useIsochronesStore } from '@/stores/isochrones-store';
 import { router } from '@/routes';
+import { handleValhallaWarnings } from '@/utils/handle-valhalla-warnings';
 
 async function fetchIsochrones() {
   const { geocodeResults, maxRange, interval, denoise, generalize } =
@@ -52,16 +53,7 @@ async function fetchIsochrones() {
   );
 
   // Display routing warnings if present
-  if (data.warnings && data.warnings.length > 0) {
-    data.warnings.forEach((warning) => {
-      toast.warning('Isochrone warning', {
-        description: warning.message,
-        position: 'bottom-center',
-        duration: 5000,
-        closeButton: true,
-      });
-    });
-  }
+  handleValhallaWarnings(data.warnings);
 
   // Calculate area for each feature
   data.features.forEach((feature) => {

src/hooks/use-optimized-route-query.ts

@@ -13,6 +13,7 @@ import { router } from '@/routes';
 import type { ValhallaOptimizedRouteResponse } from '@/components/types';
 import type { Waypoint } from '@/stores/directions-store';
 import { getDirectionsLanguage } from '@/utils/directions-language';
+import { handleValhallaWarnings } from '@/utils/handle-valhalla-warnings';
 
 export function useOptimizedRouteQuery() {
   const waypoints = useDirectionsStore((state) => state.waypoints);
@@ -56,16 +57,7 @@ export function useOptimizedRouteQuery() {
       );
 
       // Display routing warnings if present
-      if (data.warnings && data.warnings.length > 0) {
-        data.warnings.forEach((warning) => {
-          toast.warning('Optimization warning', {
-            description: warning.message,
-            position: 'bottom-center',
-            duration: 5000,
-            closeButton: true,
-          });
-        });
-      }
+      handleValhallaWarnings(data.warnings);
 
       const processedData = {
         ...data,

src/utils/handle-valhalla-warnings.spec.ts

@@ -0,0 +1,38 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { toast } from 'sonner';
+import { handleValhallaWarnings } from './handle-valhalla-warnings';
+
+vi.mock('sonner', () => ({
+  toast: {
+    warning: vi.fn(),
+  },
+}));
+
+describe('handleValhallaWarnings', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should display toast for each warning', () => {
+    const warnings = [
+      { code: 1, message: 'Warning one' },
+      { code: 2, message: 'Warning two' },
+    ];
+
+    handleValhallaWarnings(warnings);
+
+    expect(toast.warning).toHaveBeenCalledTimes(2);
+  });
+
+  it('should not display toast when warnings are empty', () => {
+    handleValhallaWarnings([]);
+
+    expect(toast.warning).not.toHaveBeenCalled();
+  });
+
+  it('should not display toast when warnings are undefined', () => {
+    handleValhallaWarnings(undefined);
+
+    expect(toast.warning).not.toHaveBeenCalled();
+  });
+});

src/utils/handle-valhalla-warnings.ts

@@ -0,0 +1,25 @@
+import { toast } from 'sonner';
+import type { ValhallaWarning } from '@/components/types';
+import type { ExternalToast } from 'sonner';
+
+/**
+ * Displays toast notifications for warnings returned by the Valhalla API
+ * @param warnings - Optional warnings array from Valhalla API response
+ */
+
+const TOAST_CONFIG: ExternalToast = {
+  position: 'bottom-center',
+  duration: 5000,
+  closeButton: true,
+};
+
+export const handleValhallaWarnings = (warnings?: ValhallaWarning[]): void => {
+  if (!warnings?.length) return;
+
+  warnings?.forEach((warning) => {
+    toast.warning('Routing warning', {
+      description: warning.message,
+      ...TOAST_CONFIG,
+    });
+  });
+};