feat: add prevent validateResponseFormat() from validating custom routes

packages/ra-core/src/dataProvider/dataFetchActions.ts

@@ -21,6 +21,11 @@ export const fetchActionsWithArrayOfRecordsResponse = [
 ];
 export const fetchActionsWithTotalResponse = ['getList', 'getManyReference'];
 
+export const reactAdminFetchActions = [
+    ...fetchActionsWithRecordResponse,
+    ...fetchActionsWithArrayOfRecordsResponse,
+];
+
 export const sanitizeFetchType = (fetchType: string) => {
     switch (fetchType) {
         case GET_LIST:

packages/ra-core/src/dataProvider/useDataProvider.spec.tsx

@@ -5,6 +5,7 @@ import expect from 'expect';
 
 import { useDataProvider } from './useDataProvider';
 import { CoreAdminContext } from '../core';
+import { GetListResult } from '..';
 
 const UseGetOne = () => {
     const [data, setData] = useState();
@@ -21,6 +22,40 @@ const UseGetOne = () => {
     return <div data-testid="loading">loading</div>;
 };
 
+const UseGetList = () => {
+    const [data, setData] = useState<GetListResult>();
+    const [error, setError] = useState();
+    const dataProvider = useDataProvider();
+    useEffect(() => {
+        dataProvider
+            .getList('posts', {
+                pagination: { page: 1, perPage: 10 },
+                sort: { field: 'id', order: 'ASC' },
+                filter: {},
+            })
+            .then(({ data, total }) => setData({ data, total }))
+            .catch(e => setError(e));
+    }, [dataProvider]);
+    if (error) return <div data-testid="error">{error.message}</div>;
+    if (data) return <div data-testid="data">{JSON.stringify(data)}</div>;
+    return <div data-testid="loading">loading</div>;
+};
+
+const UseGetCustom = () => {
+    const [data, setData] = useState();
+    const [error, setError] = useState();
+    const dataProvider = useDataProvider();
+    useEffect(() => {
+        dataProvider
+            .getCustom('posts', { id: 1 })
+            .then(res => setData(res.result))
+            .catch(e => setError(e));
+    }, [dataProvider]);
+    if (error) return <div data-testid="error">{error.message}</div>;
+    if (data) return <div data-testid="data">{JSON.stringify(data)}</div>;
+    return <div data-testid="loading">loading</div>;
+};
+
 describe('useDataProvider', () => {
     it('should return a way to call the dataProvider', async () => {
         const getOne = jest.fn(() =>
@@ -173,4 +208,71 @@ describe('useDataProvider', () => {
 
         expect(customVerb).toHaveBeenCalledWith({ id: 1 }, ['something']);
     });
+
+    it('should call getList and not show error', async () => {
+        const getList = jest.fn(() =>
+            Promise.resolve({ data: [{ id: 1, title: 'foo' }], total: 1 })
+        );
+        const dataProvider = { getList };
+        const { queryByTestId } = render(
+            <CoreAdminContext dataProvider={dataProvider}>
+                <UseGetList />
+            </CoreAdminContext>
+        );
+        expect(queryByTestId('loading')).not.toBeNull();
+        await act(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+        });
+        expect(getList).toBeCalledTimes(1);
+        expect(queryByTestId('loading')).toBeNull();
+        expect(queryByTestId('data')?.textContent).toBe(
+            '{"data":[{"id":1,"title":"foo"}],"total":1}'
+        );
+    });
+
+    it('should call getList and show error', async () => {
+        jest.spyOn(console, 'error').mockImplementation(() => {});
+
+        const getList = jest.fn(() =>
+            Promise.resolve({ data: [{ id: 1, title: 'foo' }] })
+        );
+        const dataProvider = { getList };
+        const { queryByTestId } = render(
+            <CoreAdminContext dataProvider={dataProvider}>
+                <UseGetList />
+            </CoreAdminContext>
+        );
+
+        expect(queryByTestId('loading')).not.toBeNull();
+        await act(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+        });
+        expect(getList).toBeCalledTimes(1);
+        expect(queryByTestId('loading')).toBeNull();
+        expect(queryByTestId('error')?.textContent).toBe(
+            'ra.notification.data_provider_error'
+        );
+    });
+
+    it('should call custom and not show error', async () => {
+        const getCustom = jest.fn(() =>
+            Promise.resolve({ result: [{ id: 1, title: 'foo' }] })
+        );
+        const dataProvider = { getCustom };
+        const { queryByTestId } = render(
+            <CoreAdminContext dataProvider={dataProvider}>
+                <UseGetCustom />
+            </CoreAdminContext>
+        );
+        expect(queryByTestId('loading')).not.toBeNull();
+        await act(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+        });
+        expect(getCustom).toBeCalledTimes(1);
+        expect(queryByTestId('loading')).toBeNull();
+        expect(queryByTestId('data')?.textContent).toBe(
+            '[{"id":1,"title":"foo"}]'
+        );
+        expect(queryByTestId('error')?.textContent).toBeUndefined();
+    });
 });

packages/ra-core/src/dataProvider/useDataProvider.ts

@@ -5,6 +5,7 @@ import { defaultDataProvider } from './defaultDataProvider';
 import validateResponseFormat from './validateResponseFormat';
 import { DataProvider } from '../types';
 import useLogoutIfAccessDenied from '../auth/useLogoutIfAccessDenied';
+import { reactAdminFetchActions } from './dataFetchActions';
 
 /**
  * Hook for getting a dataProvider
@@ -98,7 +99,10 @@ export const useDataProvider = <
                         return dataProvider[type]
                             .apply(dataProvider, args)
                             .then(response => {
-                                if (process.env.NODE_ENV !== 'production') {
+                                if (
+                                    process.env.NODE_ENV !== 'production' &&
+                                    reactAdminFetchActions.includes(type)
+                                ) {
                                     validateResponseFormat(response, type);
                                 }
                                 return response;