Consolidate response parsing logic into handleStacResponse utility

AliceR · AliceR · commit 815d89eb61c6 · 2025-12-15T10:50:55.000+01:00
- Add handleStacResponse&lt;T&gt;() utility function to remove duplication
- Refactor useCollection, useCollections, useItem, useStacSearch to use utility
- Add test suite for handleStacResponse
- Add test suite for StacApi class methods
diff --git a/src/hooks/useCollection.ts b/src/hooks/useCollection.ts
@@ -1,7 +1,7 @@
 import { useQuery, type QueryObserverResult } from '@tanstack/react-query';
 import type { ApiErrorType } from '../types';
 import type { Collection } from '../types/stac';
-import { ApiError } from '../utils/ApiError';
+import { handleStacResponse } from '../utils/handleStacResponse';
 import { generateCollectionQueryKey } from '../utils/queryKeys';
 import { useStacApiContext } from '../context/useStacApiContext';
 
@@ -19,26 +19,7 @@ function useCollection(collectionId: string): StacCollectionHook {
   const fetchCollection = async (): Promise<Collection> => {
     if (!stacApi) throw new Error('No STAC API configured');
     const response: Response = await stacApi.getCollection(collectionId);
-    if (!response.ok) {
-      let detail;
-      try {
-        detail = await response.json();
-      } catch {
-        detail = await response.text();
-      }
-
-      throw new ApiError(response.statusText, response.status, detail, response.url);
-    }
-    try {
-      return await response.json();
-    } catch (error) {
-      throw new ApiError(
-        'Invalid JSON Response',
-        response.status,
-        `Response is not valid JSON: ${error instanceof Error ? error.message : String(error)}`,
-        response.url
-      );
-    }
+    return handleStacResponse<Collection>(response);
   };
 
   const {
diff --git a/src/hooks/useCollections.ts b/src/hooks/useCollections.ts
@@ -1,7 +1,7 @@
 import { useQuery, type QueryObserverResult } from '@tanstack/react-query';
 import { type ApiErrorType } from '../types';
 import type { CollectionsResponse } from '../types/stac';
-import { ApiError } from '../utils/ApiError';
+import { handleStacResponse } from '../utils/handleStacResponse';
 import { generateCollectionsQueryKey } from '../utils/queryKeys';
 import { useStacApiContext } from '../context/useStacApiContext';
 
@@ -19,26 +19,7 @@ function useCollections(): StacCollectionsHook {
   const fetchCollections = async (): Promise<CollectionsResponse> => {
     if (!stacApi) throw new Error('No STAC API configured');
     const response: Response = await stacApi.getCollections();
-    if (!response.ok) {
-      let detail;
-      try {
-        detail = await response.json();
-      } catch {
-        detail = await response.text();
-      }
-
-      throw new ApiError(response.statusText, response.status, detail, response.url);
-    }
-    try {
-      return await response.json();
-    } catch (error) {
-      throw new ApiError(
-        'Invalid JSON Response',
-        response.status,
-        `Response is not valid JSON: ${error instanceof Error ? error.message : String(error)}`,
-        response.url
-      );
-    }
+    return handleStacResponse<CollectionsResponse>(response);
   };
 
   const {
diff --git a/src/hooks/useItem.ts b/src/hooks/useItem.ts
@@ -2,7 +2,7 @@ import { useQuery, type QueryObserverResult } from '@tanstack/react-query';
 import { Item } from '../types/stac';
 import { type ApiErrorType } from '../types';
 import { useStacApiContext } from '../context/useStacApiContext';
-import { ApiError } from '../utils/ApiError';
+import { handleStacResponse } from '../utils/handleStacResponse';
 import { generateItemQueryKey } from '../utils/queryKeys';
 
 type ItemHook = {
@@ -19,26 +19,7 @@ function useItem(url: string): ItemHook {
   const fetchItem = async (): Promise<Item> => {
     if (!stacApi) throw new Error('No STAC API configured');
     const response: Response = await stacApi.get(url);
-    if (!response.ok) {
-      let detail;
-      try {
-        detail = await response.json();
-      } catch {
-        detail = await response.text();
-      }
-
-      throw new ApiError(response.statusText, response.status, detail, response.url);
-    }
-    try {
-      return await response.json();
-    } catch (error) {
-      throw new ApiError(
-        'Invalid JSON Response',
-        response.status,
-        `Response is not valid JSON: ${error instanceof Error ? error.message : String(error)}`,
-        response.url
-      );
-    }
+    return handleStacResponse<Item>(response);
   };
 
   const {
diff --git a/src/hooks/useStacSearch.ts b/src/hooks/useStacSearch.ts
@@ -3,7 +3,7 @@ import { useQuery, useQueryClient } from '@tanstack/react-query';
 import debounce from '../utils/debounce';
 import { generateStacSearchQueryKey } from '../utils/queryKeys';
 import { type ApiErrorType } from '../types';
-import { ApiError } from '../utils/ApiError';
+import { handleStacResponse } from '../utils/handleStacResponse';
 import type {
   Link,
   Bbox,
@@ -117,26 +117,7 @@ function useStacSearch(): StacSearchHook {
         ? await stacApi.search(request.payload, request.headers)
         : await stacApi.get(request.url);
 
-    if (!response.ok) {
-      let detail;
-      try {
-        detail = await response.json();
-      } catch {
-        detail = await response.text();
-      }
-
-      throw new ApiError(response.statusText, response.status, detail, response.url);
-    }
-    try {
-      return await response.json();
-    } catch (error) {
-      throw new ApiError(
-        'Invalid JSON Response',
-        response.status,
-        `Response is not valid JSON: ${error instanceof Error ? error.message : String(error)}`,
-        response.url
-      );
-    }
+    return handleStacResponse<SearchResponse>(response);
   };
 
   /**
diff --git a/src/stac-api/StacApi.test.ts b/src/stac-api/StacApi.test.ts
@@ -0,0 +1,194 @@
+import StacApi, { SearchMode } from './index';
+import type { SearchRequestPayload } from '../types/stac';
+
+// Mock fetch globally
+global.fetch = jest.fn();
+const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
+
+describe('StacApi', () => {
+  let stacApi: StacApi;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    stacApi = new StacApi('https://api.example.com', SearchMode.POST);
+  });
+
+  describe('makeDatetimePayload', () => {
+    it('should return undefined for undefined dateRange', () => {
+      const result = stacApi.makeDatetimePayload(undefined);
+      expect(result).toBeUndefined();
+    });
+
+    it('should return undefined for empty dateRange', () => {
+      const result = stacApi.makeDatetimePayload({});
+      expect(result).toBeUndefined();
+    });
+
+    it('should format date range with from and to', () => {
+      const dateRange = { from: '2025-12-01', to: '2025-12-31' };
+      const result = stacApi.makeDatetimePayload(dateRange);
+      // Simple date format for STAC API compatibility
+      expect(result).toBe('2025-12-01/2025-12-31');
+    });
+
+    it('should format date range with only from', () => {
+      const dateRange = { from: '2025-12-01' };
+      const result = stacApi.makeDatetimePayload(dateRange);
+      expect(result).toBe('2025-12-01/..');
+    });
+
+    it('should format date range with only to', () => {
+      const dateRange = { to: '2025-12-31' };
+      const result = stacApi.makeDatetimePayload(dateRange);
+      expect(result).toBe('../2025-12-31');
+    });
+
+    it('should handle full datetime strings', () => {
+      const dateRange = {
+        from: '2025-12-01T00:00:00Z',
+        to: '2025-12-31T23:59:59Z',
+      };
+      const result = stacApi.makeDatetimePayload(dateRange);
+      expect(result).toBe('2025-12-01T00:00:00Z/2025-12-31T23:59:59Z');
+    });
+  });
+
+  describe('search payload transformation', () => {
+    beforeEach(() => {
+      // Mock successful response
+      mockFetch.mockResolvedValue({
+        ok: true,
+        json: jest.fn().mockResolvedValue({ features: [] }),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } as any);
+    });
+
+    it('should transform dateRange to datetime string in POST mode', async () => {
+      const searchPayload: SearchRequestPayload = {
+        collections: ['sentinel-2-l2a'],
+        dateRange: { from: '2025-12-01', to: '2025-12-31' },
+      };
+
+      await stacApi.search(searchPayload);
+
+      expect(mockFetch).toHaveBeenCalledWith(
+        'https://api.example.com/search',
+        expect.objectContaining({
+          method: 'POST',
+          headers: expect.objectContaining({
+            'Content-Type': 'application/json',
+          }),
+          body: JSON.stringify({
+            collections: ['sentinel-2-l2a'],
+            datetime: '2025-12-01/2025-12-31',
+            ids: undefined,
+            bbox: undefined,
+          }),
+        })
+      );
+    });
+
+    it('should transform dateRange to datetime string in GET mode', async () => {
+      const getStacApi = new StacApi('https://api.example.com', SearchMode.GET);
+      const searchPayload: SearchRequestPayload = {
+        collections: ['sentinel-2-l2a'],
+        dateRange: { from: '2025-12-01', to: '2025-12-31' },
+      };
+
+      await getStacApi.search(searchPayload);
+
+      expect(mockFetch).toHaveBeenCalledWith(
+        'https://api.example.com/search?collections=sentinel-2-l2a&datetime=2025-12-01%2F2025-12-31',
+        expect.objectContaining({
+          method: 'GET',
+          headers: expect.objectContaining({
+            'Content-Type': 'application/json',
+          }),
+        })
+      );
+    });
+
+    it('should not include undefined values in POST payload', async () => {
+      const searchPayload: SearchRequestPayload = {
+        collections: ['sentinel-2-l2a'],
+      };
+
+      await stacApi.search(searchPayload);
+
+      expect(mockFetch).toHaveBeenCalledWith(
+        'https://api.example.com/search',
+        expect.objectContaining({
+          body: JSON.stringify({
+            collections: ['sentinel-2-l2a'],
+            ids: undefined,
+            bbox: undefined,
+            datetime: undefined,
+          }),
+        })
+      );
+    });
+
+    it('should not include undefined values in GET query string', async () => {
+      const getStacApi = new StacApi('https://api.example.com', SearchMode.GET);
+      const searchPayload: SearchRequestPayload = {
+        collections: ['sentinel-2-l2a'],
+      };
+
+      await getStacApi.search(searchPayload);
+
+      const expectedUrl = 'https://api.example.com/search?collections=sentinel-2-l2a';
+      expect(mockFetch).toHaveBeenCalledWith(
+        expectedUrl,
+        expect.objectContaining({
+          method: 'GET',
+        })
+      );
+    });
+  });
+
+  describe('payloadToQuery', () => {
+    it('should convert arrays to comma-separated strings', () => {
+      const payload = {
+        collections: ['col1', 'col2'],
+        ids: ['id1', 'id2', 'id3'],
+      };
+      const result = stacApi.payloadToQuery(payload);
+      expect(result).toBe('collections=col1%2Ccol2&ids=id1%2Cid2%2Cid3');
+    });
+
+    it('should convert primitive values to strings', () => {
+      const payload = {
+        collections: ['col1'],
+        datetime: '2025-12-01T00:00:00Z/2025-12-31T23:59:59Z',
+      };
+      const result = stacApi.payloadToQuery(payload);
+      expect(result).toBe(
+        'collections=col1&datetime=2025-12-01T00%3A00%3A00Z%2F2025-12-31T23%3A59%3A59Z'
+      );
+    });
+
+    it('should skip undefined values', () => {
+      const payload = {
+        collections: ['col1'],
+        ids: undefined,
+        datetime: '2025-12-01T00:00:00Z/2025-12-31T23:59:59Z',
+      };
+      const result = stacApi.payloadToQuery(payload);
+      expect(result).toBe(
+        'collections=col1&datetime=2025-12-01T00%3A00%3A00Z%2F2025-12-31T23%3A59%3A59Z'
+      );
+    });
+
+    it('should handle sortby parameter', () => {
+      const payload = {
+        collections: ['col1'],
+        sortby: [
+          { field: 'datetime', direction: 'desc' as const },
+          { field: 'id', direction: 'asc' as const },
+        ],
+      };
+      const result = stacApi.payloadToQuery(payload);
+      expect(result).toBe('collections=col1&sortby=-datetime%2C%2Bid');
+    });
+  });
+});
diff --git a/src/utils/handleStacResponse.test.ts b/src/utils/handleStacResponse.test.ts
diff --git a/src/utils/handleStacResponse.ts b/src/utils/handleStacResponse.ts
