Merge pull request #10746 from marmelab/fix-useInfiniteListController-meta

Fix `useInfiniteListController` does not return response `meta`

Author: djhi

packages/ra-core/src/controller/list/useInfiniteListController.spec.tsx

@@ -740,4 +740,38 @@ describe('useInfiniteListController', () => {
             expect(authProvider.canAccess).not.toHaveBeenCalled();
         });
     });
+
+    describe('response metadata', () => {
+        it('should return response metadata as meta', async () => {
+            const getList = jest.fn().mockImplementation(() =>
+                Promise.resolve({
+                    data: [],
+                    total: 0,
+                    meta: { foo: 'bar' },
+                })
+            );
+            const dataProvider = testDataProvider({ getList });
+            const children = jest.fn().mockReturnValue(<span>children</span>);
+            const props = {
+                ...defaultProps,
+                children,
+            };
+            render(
+                <CoreAdminContext dataProvider={dataProvider}>
+                    <InfiniteListController {...props} />
+                </CoreAdminContext>
+            );
+            await waitFor(() => {
+                expect(children).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        page: 1,
+                        total: 0,
+                        hasNextPage: false,
+                        hasPreviousPage: false,
+                        meta: { foo: 'bar' },
+                    })
+                );
+            });
+        });
+    });
 });

packages/ra-core/src/controller/list/useInfiniteListController.ts

@@ -111,6 +111,7 @@ export const useInfiniteListController = <
         fetchPreviousPage,
         isFetchingPreviousPage,
         refetch,
+        meta: responseMeta,
     } = useInfiniteGetList<RecordType, ErrorType>(
         resource,
         {
@@ -223,6 +224,7 @@ export const useInfiniteListController = <
         isFetchingNextPage,
         fetchPreviousPage,
         isFetchingPreviousPage,
+        meta: responseMeta,
     } as InfiniteListControllerResult<RecordType, ErrorType>;
 };
 

packages/ra-core/src/controller/list/useListController.spec.tsx

@@ -7,6 +7,7 @@ import {
     screen,
     act,
 } from '@testing-library/react';
+import { onlineManager } from '@tanstack/react-query';
 import { testDataProvider } from '../../dataProvider';
 import { memoryStore } from '../../store';
 import { CoreAdminContext } from '../../core';
@@ -35,6 +36,10 @@ describe('useListController', () => {
         debounce: 200,
     };
 
+    beforeEach(() => {
+        onlineManager.setOnline(true);
+    });
+
     describe('queryOptions', () => {
         it('should accept custom client query options', async () => {
             jest.spyOn(console, 'error').mockImplementationOnce(() => {});
@@ -719,4 +724,38 @@ describe('useListController', () => {
             ).toBeNull();
         });
     });
+
+    describe('response metadata', () => {
+        it('should return response metadata as meta', async () => {
+            const getList = jest.fn().mockImplementation(() =>
+                Promise.resolve({
+                    data: [],
+                    total: 0,
+                    meta: { foo: 'bar' },
+                })
+            );
+            const dataProvider = testDataProvider({ getList });
+            const children = jest.fn().mockReturnValue(<span>children</span>);
+            const props = {
+                ...defaultProps,
+                children,
+            };
+            render(
+                <CoreAdminContext dataProvider={dataProvider}>
+                    <ListController {...props} />
+                </CoreAdminContext>
+            );
+            await waitFor(() => {
+                expect(children).toHaveBeenCalledWith(
+                    expect.objectContaining({
+                        page: 1,
+                        total: 0,
+                        hasNextPage: false,
+                        hasPreviousPage: false,
+                        meta: { foo: 'bar' },
+                    })
+                );
+            });
+        });
+    });
 });

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

@@ -275,4 +275,5 @@ export type UseInfiniteGetListHookValue<
 > & {
     total?: number;
     pageParam?: number;
+    meta?: any;
 };