Add a warning about different query options and mutation options meta.

Author: Madeorsk

packages/ra-core/src/controller/edit/useEditController.spec.tsx

@@ -217,6 +217,35 @@ describe('useEditController', () => {
         });
     });
 
+    it('should emit a warning when providing a different meta in query options and mutation options without redirecting', async () => {
+        const warnFn = jest.spyOn(console, 'warn').mockImplementation(() => {});
+
+        const getOne = jest
+            .fn()
+            .mockImplementationOnce(() =>
+                Promise.resolve({ data: { id: 0, title: 'hello' } })
+            );
+        const dataProvider = { getOne } as unknown as DataProvider;
+
+        render(
+            <CoreAdminContext dataProvider={dataProvider}>
+                <EditController
+                    {...defaultProps}
+                    resource="posts"
+                    queryOptions={{ meta: { foo: 'bar' } }}
+                    mutationOptions={{ meta: { foo: 'baz' } }}
+                    redirect={false}
+                >
+                    {() => <div />}
+                </EditController>
+            </CoreAdminContext>
+        );
+
+        expect(warnFn).toHaveBeenCalledWith(
+            'When not redirecting after editing, query meta and mutation meta should be the same, or you will have data update issues.'
+        );
+    });
+
     it('should call the dataProvider.update() function on save', async () => {
         const update = jest
             .fn()

packages/ra-core/src/controller/edit/useEditController.ts

@@ -89,13 +89,25 @@ export const useEditController = <
         );
     }
     const id = propsId ?? routeId;
+
     const { meta: queryMeta, ...otherQueryOptions } = queryOptions;
     const {
         meta: mutationMeta,
         onSuccess,
         onError,
         ...otherMutationOptions
     } = mutationOptions;
+
+    if (
+        (queryMeta || mutationMeta) &&
+        JSON.stringify(queryMeta) !== JSON.stringify(mutationMeta) &&
+        redirectTo === false
+    ) {
+        console.warn(
+            'When not redirecting after editing, query meta and mutation meta should be the same, or you will have data update issues.'
+        );
+    }
+
     const {
         registerMutationMiddleware,
         getMutateWithMiddlewares,
@@ -302,6 +314,7 @@ export interface EditControllerProps<
     redirect?: RedirectionSideEffect;
     resource?: string;
     transform?: TransformData;
+
     [key: string]: any;
 }
 
@@ -322,6 +335,7 @@ export interface EditControllerLoadingResult<RecordType extends RaRecord = any>
     error: null;
     isPending: true;
 }
+
 export interface EditControllerLoadingErrorResult<
     RecordType extends RaRecord = any,
     TError = Error,
@@ -330,6 +344,7 @@ export interface EditControllerLoadingErrorResult<
     error: TError;
     isPending: false;
 }
+
 export interface EditControllerRefetchErrorResult<
     RecordType extends RaRecord = any,
     TError = Error,
@@ -338,6 +353,7 @@ export interface EditControllerRefetchErrorResult<
     error: TError;
     isPending: false;
 }
+
 export interface EditControllerSuccessResult<RecordType extends RaRecord = any>
     extends EditControllerBaseResult<RecordType> {
     record: RecordType;