Skip to content

Improve behavior on errors when importing a dataset #74

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
merged 11 commits into from
Feb 6, 2025
Merged

Improve behavior on errors when importing a dataset #74

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2453814
Improve error display
rzats Oct 11, 2024
7982b5d
Italics
rzats Oct 11, 2024
69b2d90
Merge remote-tracking branch 'origin/dev' into rzatserkovnyi/improve-…
rzats Nov 21, 2024
64afa04
Review fixes
rzats Nov 21, 2024
be5b033
Add error to modal
rzats Dec 11, 2024
20e8fc9
Merge remote-tracking branch 'origin/dev' into rzatserkovnyi/improve-…
rzats Dec 18, 2024
cc81acb
Try explicit return
rzats Dec 18, 2024
9e4cb11
Try without explicit return
rzats Dec 18, 2024
b0c541e
Different order
rzats Dec 18, 2024
85662ec
Show error
rzats Dec 18, 2024
5c244f3
Error codes
rzats Feb 6, 2025
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
53 changes: 46 additions & 7 deletions src/api/EpiData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/restrict-template-expressions */
import UIkit from 'uikit';
import { appendIssueToTitle } from '../components/dialogs/utils';
import {
Expand Down Expand Up @@ -43,11 +44,23 @@ const ENDPOINT = process.env.EPIDATA_ENDPOINT_URL;

export const fetchOptions: RequestInit = process.env.NODE_ENV === 'development' ? { cache: 'force-cache' } : {};

function processResponse<T>(response: Response): Promise<T> {
if (response.ok) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return response.json();
}
return response.text().then((text) => {
throw new Error(`[${response.status}] ${text}`);
});
}

export function fetchImpl<T>(url: URL): Promise<T> {
const urlGetS = url.toString();
if (urlGetS.length < 4096) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
return fetch(url.toString(), fetchOptions).then((d) => d.json());
return fetch(url.toString(), fetchOptions).then((d) => {
return processResponse(d);
});
Comment on lines +61 to +63
Copy link
Contributor

Choose a reason for hiding this comment

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

would this work (or something similar)?

Suggested change
return fetch(url.toString(), fetchOptions).then((d) => {
return processResponse(d);
});
return fetch(url.toString(), fetchOptions).then(processResponse);

Copy link
Contributor

Choose a reason for hiding this comment

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

explored in #86

}
const params = new URLSearchParams(url.searchParams);
url.searchParams.forEach((d) => url.searchParams.delete(d));
Expand All @@ -56,7 +69,9 @@ export function fetchImpl<T>(url: URL): Promise<T> {
...fetchOptions,
method: 'POST',
body: params,
}).then((d) => d.json());
}).then((d) => {
return processResponse(d);
});
}

// generic epidata loader
Expand Down Expand Up @@ -147,26 +162,50 @@ export function loadDataSet(
url.searchParams.set('format', 'json');
return fetchImpl<Record<string, unknown>[]>(url)
.then((res) => {
const data = loadEpidata(title, res, columns, columnRenamings, { _endpoint: endpoint, ...params });
if (data.datasets.length == 0) {
try {
const data = loadEpidata(title, res, columns, columnRenamings, { _endpoint: endpoint, ...params });
Copy link
Contributor

Choose a reason for hiding this comment

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

can we put the try block around just this loadEpidata() line? if the other lines are throwing exceptions, we should handle them in a different way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe this is already the case? The try block is around three lines:

const data = loadEpidata(...)
if (data.datasets.length == 0) {...}
return data;

And the last two can't really error out.

Copy link
Contributor

Choose a reason for hiding this comment

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

thats what im saying -- the try scope should contain only the line(s) where we anticipate a possible exception

if (data.datasets.length == 0) {
return UIkit.modal
.alert(
`
<div class="uk-alert uk-alert-error">
<a href="${url.href}">API Link</a> returned no data, which suggests that the API has no available information for the selected location.
</div>`,
)
.then(() => null);
}
return data;
} catch (error) {
console.warn('failed loading data', error);
// EpiData API error - JSON with "message" property
if ('message' in res) {
return UIkit.modal
.alert(
`
<div class="uk-alert uk-alert-error">
[f01] Failed to fetch API data from <a href="${url.href}">API Link</a>:<br/><i>${res['message']}</i>
</div>`,
)
.then(() => null);
}
// Fallback for generic error
return UIkit.modal
.alert(
`
<div class="uk-alert uk-alert-error">
<a href="${url.href}">API Link</a> returned no data.
[f02] Failed to fetch API data from <a href="${url.href}">API Link</a>:<br/><i>${error}</i>
</div>`,
)
.then(() => null);
}
return data;
})
.catch((error) => {
console.warn('failed fetching data', error);
return UIkit.modal
.alert(
`
<div class="uk-alert uk-alert-error">
Failed to fetch API data from <a href="${url.href}">API Link</a>.
[f03] Failed to fetch API data from <a href="${url.href}">API Link</a>:<br/><i>${error}</i>
</div>`,
)
.then(() => null);
Expand Down