Skip to content

Update date handling #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielfdsilva merged 1 commit into from
Dec 17, 2025
+26 −22
Merged

Update date handling #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/hooks/useStacSearch.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,10 @@ describe('useStacSearch — API supports POST', () => {
await waitFor(() => expect(result.current.results).toEqual({ data: '12345' }));
// Validate POST payload
const postPayload = parseRequestPayload(fetch.mock.calls[1][1]);
expect(postPayload).toEqual({ datetime: '2022-01-17/2022-05-17', limit: 25 });
expect(postPayload).toEqual({
datetime: '2022-01-17T00:00:00Z/2022-05-17T23:59:59Z',
limit: 25,
});
});

it('includes open date range in search (no to-date)', async () => {
Expand All @@ -215,7 +218,7 @@ describe('useStacSearch — API supports POST', () => {
await waitFor(() => expect(result.current.results).toEqual({ data: '12345' }));
// Validate POST payload
const postPayload = parseRequestPayload(fetch.mock.calls[1][1]);
expect(postPayload).toEqual({ datetime: '2022-01-17/..', limit: 25 });
expect(postPayload).toEqual({ datetime: '2022-01-17T00:00:00Z/..', limit: 25 });
});

it('includes open date range in search (no from-date)', async () => {
Expand All @@ -242,7 +245,7 @@ describe('useStacSearch — API supports POST', () => {
await waitFor(() => expect(result.current.results).toEqual({ data: '12345' }));
// Validate POST payload
const postPayload = parseRequestPayload(fetch.mock.calls[1][1]);
expect(postPayload).toEqual({ datetime: '../2022-05-17', limit: 25 });
expect(postPayload).toEqual({ datetime: '../2022-05-17T23:59:59Z', limit: 25 });
});

it('handles error with JSON response', async () => {
Expand Down Expand Up @@ -799,7 +802,7 @@ describe('useStacSearch — API supports GET', () => {
await waitFor(() => expect(fetch).toHaveBeenCalledTimes(2));
// Assert fetch URL and results
expect(fetch.mock.calls[1][0]).toEqual(
'https://fake-stac-api.net/search?limit=25&datetime=2022-01-17%2F2022-05-17'
'https://fake-stac-api.net/search?limit=25&datetime=2022-01-17T00%3A00%3A00Z%2F2022-05-17T23%3A59%3A59Z'
);
expect(result.current.results).toEqual({ data: '12345' });
});
Expand All @@ -825,7 +828,7 @@ describe('useStacSearch — API supports GET', () => {
await waitFor(() => expect(fetch).toHaveBeenCalledTimes(2));
// Assert fetch URL and results
expect(fetch.mock.calls[1][0]).toEqual(
'https://fake-stac-api.net/search?limit=25&datetime=2022-01-17%2F..'
'https://fake-stac-api.net/search?limit=25&datetime=2022-01-17T00%3A00%3A00Z%2F..'
);
expect(result.current.results).toEqual({ data: '12345' });
});
Expand All @@ -851,7 +854,7 @@ describe('useStacSearch — API supports GET', () => {
await waitFor(() => expect(fetch).toHaveBeenCalledTimes(2));
// Assert fetch URL and results
expect(fetch.mock.calls[1][0]).toEqual(
'https://fake-stac-api.net/search?limit=25&datetime=..%2F2022-05-17'
'https://fake-stac-api.net/search?limit=25&datetime=..%2F2022-05-17T23%3A59%3A59Z'
);
expect(result.current.results).toEqual({ data: '12345' });
});
Expand Down
18 changes: 9 additions & 9 deletions src/stac-api/StacApi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,32 @@ describe('StacApi', () => {
expect(result).toBeUndefined();
});

it('should format date range with from and to', () => {
it('should format date range with from and to appending time parts', () => {
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');
expect(result).toBe('2025-12-01T00:00:00Z/2025-12-31T23:59:59Z');
});

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/..');
expect(result).toBe('2025-12-01T00:00:00Z/..');
});

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');
expect(result).toBe('../2025-12-31T23:59:59Z');
});

it('should handle full datetime strings', () => {
const dateRange = {
from: '2025-12-01T00:00:00Z',
to: '2025-12-31T23:59:59Z',
from: '2025-12-01T11:11:11Z',
to: '2025-12-31T11:11:11Z',
};
const result = stacApi.makeDatetimePayload(dateRange);
expect(result).toBe('2025-12-01T00:00:00Z/2025-12-31T23:59:59Z');
expect(result).toBe('2025-12-01T11:11:11Z/2025-12-31T11:11:11Z');
});
});

Expand Down Expand Up @@ -80,7 +80,7 @@ describe('StacApi', () => {
}),
body: JSON.stringify({
collections: ['sentinel-2-l2a'],
datetime: '2025-12-01/2025-12-31',
datetime: '2025-12-01T00:00:00Z/2025-12-31T23:59:59Z',
ids: undefined,
bbox: undefined,
}),
Expand All @@ -98,7 +98,7 @@ describe('StacApi', () => {
await getStacApi.search(searchPayload);

expect(mockFetch).toHaveBeenCalledWith(
'https://api.example.com/search?collections=sentinel-2-l2a&datetime=2025-12-01%2F2025-12-31',
'https://api.example.com/search?collections=sentinel-2-l2a&datetime=2025-12-01T00%3A00%3A00Z%2F2025-12-31T23%3A59%3A59Z',
expect.objectContaining({
method: 'GET',
headers: expect.objectContaining({
Expand Down
15 changes: 8 additions & 7 deletions src/stac-api/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,18 @@ class StacApi {
}

makeDatetimePayload(dateRange?: DateRange): string | undefined {
if (!dateRange) {
if (!dateRange?.from && !dateRange?.to) {
return undefined;
}

const { from, to } = dateRange;
const formatDate = (date: string | undefined, end?: boolean) => {
if (!date) return '..';

if (from || to) {
return `${from || '..'}/${to || '..'}`;
} else {
return undefined;
}
const timePart = end ? 'T23:59:59Z' : 'T00:00:00Z';
return date.includes('T') ? date : `${date}${timePart}`;
Copy link
Member

@AliceR AliceR Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is includes('T') really the best way to ensure the correct format? Seems odd to me, but also I do not know any better 🤷

};

return `${formatDate(dateRange?.from)}/${formatDate(dateRange?.to, true)}`;
}

payloadToQuery({ sortby, ...payload }: SearchPayload): string {
Expand Down