add support for abort signal in provided dataProviders

marmelab · Jan 26, 2024 · afab2c4 · afab2c4
1 parent 199735b
commit afab2c4
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 32 deletions.
diff --git a/packages/ra-data-graphql/src/index.ts b/packages/ra-data-graphql/src/index.ts
@@ -185,6 +185,11 @@ const buildGraphQLProvider = async (
                 ...query,
                 fetchPolicy: 'network-only',
                 ...getOptions(otherOptions.query, raFetchMethod, resource),
+                context: {
+                    fetchOptions: {
+                        signal: params?.signal,
+                    },
+                },
             };
 
             return (

diff --git a/packages/ra-data-json-server/src/index.ts b/packages/ra-data-json-server/src/index.ts
@@ -46,24 +46,28 @@ export default (apiUrl, httpClient = fetchUtils.fetchJson): DataProvider => ({
         };
         const url = `${apiUrl}/${resource}?${stringify(query)}`;
 
-        return httpClient(url).then(({ headers, json }) => {
-            if (!headers.has('x-total-count')) {
-                throw new Error(
-                    'The X-Total-Count header is missing in the HTTP Response. The jsonServer Data Provider expects responses for lists of resources to contain this header with the total number of results to build the pagination. If you are using CORS, did you declare X-Total-Count in the Access-Control-Expose-Headers header?'
-                );
+        return httpClient(url, { signal: params?.signal }).then(
+            ({ headers, json }) => {
+                if (!headers.has('x-total-count')) {
+                    throw new Error(
+                        'The X-Total-Count header is missing in the HTTP Response. The jsonServer Data Provider expects responses for lists of resources to contain this header with the total number of results to build the pagination. If you are using CORS, did you declare X-Total-Count in the Access-Control-Expose-Headers header?'
+                    );
+                }
+                return {
+                    data: json,
+                    total: parseInt(
+                        headers.get('x-total-count').split('/').pop(),
+                        10
+                    ),
+                };
             }
-            return {
-                data: json,
-                total: parseInt(
-                    headers.get('x-total-count').split('/').pop(),
-                    10
-                ),
-            };
-        });
+        );
     },
 
     getOne: (resource, params) =>
-        httpClient(`${apiUrl}/${resource}/${params.id}`).then(({ json }) => ({
+        httpClient(`${apiUrl}/${resource}/${params.id}`, {
+            signal: params?.signal,
+        }).then(({ json }) => ({
             data: json,
         })),
 
@@ -72,7 +76,9 @@ export default (apiUrl, httpClient = fetchUtils.fetchJson): DataProvider => ({
             id: params.ids,
         };
         const url = `${apiUrl}/${resource}?${stringify(query)}`;
-        return httpClient(url).then(({ json }) => ({ data: json }));
+        return httpClient(url, { signal: params?.signal }).then(({ json }) => ({
+            data: json,
+        }));
     },
 
     getManyReference: (resource, params) => {
@@ -88,20 +94,22 @@ export default (apiUrl, httpClient = fetchUtils.fetchJson): DataProvider => ({
         };
         const url = `${apiUrl}/${resource}?${stringify(query)}`;
 
-        return httpClient(url).then(({ headers, json }) => {
-            if (!headers.has('x-total-count')) {
-                throw new Error(
-                    'The X-Total-Count header is missing in the HTTP Response. The jsonServer Data Provider expects responses for lists of resources to contain this header with the total number of results to build the pagination. If you are using CORS, did you declare X-Total-Count in the Access-Control-Expose-Headers header?'
-                );
+        return httpClient(url, { signal: params?.signal }).then(
+            ({ headers, json }) => {
+                if (!headers.has('x-total-count')) {
+                    throw new Error(
+                        'The X-Total-Count header is missing in the HTTP Response. The jsonServer Data Provider expects responses for lists of resources to contain this header with the total number of results to build the pagination. If you are using CORS, did you declare X-Total-Count in the Access-Control-Expose-Headers header?'
+                    );
+                }
+                return {
+                    data: json,
+                    total: parseInt(
+                        headers.get('x-total-count').split('/').pop(),
+                        10
+                    ),
+                };
             }
-            return {
-                data: json,
-                total: parseInt(
-                    headers.get('x-total-count').split('/').pop(),
-                    10
-                ),
-            };
-        });
+        );
     },
 
     update: (resource, params) =>

diff --git a/packages/ra-data-simple-rest/src/index.ts b/packages/ra-data-simple-rest/src/index.ts
@@ -58,8 +58,9 @@ export default (
                       headers: new Headers({
                           Range: `${resource}=${rangeStart}-${rangeEnd}`,
                       }),
+                      signal: params?.signal,
                   }
-                : {};
+                : { signal: params?.signal };
 
         return httpClient(url, options).then(({ headers, json }) => {
             if (!headers.has(countHeader)) {
@@ -81,7 +82,9 @@ export default (
     },
 
     getOne: (resource, params) =>
-        httpClient(`${apiUrl}/${resource}/${params.id}`).then(({ json }) => ({
+        httpClient(`${apiUrl}/${resource}/${params.id}`, {
+            signal: params?.signal,
+        }).then(({ json }) => ({
             data: json,
         })),
 
@@ -90,7 +93,9 @@ export default (
             filter: JSON.stringify({ id: params.ids }),
         };
         const url = `${apiUrl}/${resource}?${stringify(query)}`;
-        return httpClient(url).then(({ json }) => ({ data: json }));
+        return httpClient(url, { signal: params?.signal }).then(({ json }) => ({
+            data: json,
+        }));
     },
 
     getManyReference: (resource, params) => {
@@ -116,8 +121,9 @@ export default (
                       headers: new Headers({
                           Range: `${resource}=${rangeStart}-${rangeEnd}`,
                       }),
+                      signal: params?.signal,
                   }
-                : {};
+                : { signal: params?.signal };
 
         return httpClient(url, options).then(({ headers, json }) => {
             if (!headers.has(countHeader)) {