Merge pull request #6886 from marmelab/fix-usemutation-options

Fix useMutation not considering returnPromise option

Author: djhi

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

@@ -6,6 +6,7 @@ import Mutation from './Mutation';
 import { CoreAdmin, Resource } from '../core';
 import { renderWithRedux } from 'ra-test';
 import { DataProviderContext } from '.';
+import useMutation from './useMutation';
 
 describe('useMutation', () => {
     it('should pass a callback to trigger the mutation', () => {
@@ -264,4 +265,46 @@ describe('useMutation', () => {
         const result = await promise;
         expect(result).toMatchObject({ data: { foo: 'bar' } });
     });
+
+    it('should return a response when returnPromise option is set at definition and the query is passed al callTime', async () => {
+        const MutationComponent = ({ query = undefined, options, children }) =>
+            children(...useMutation(query, options));
+        const dataProvider = {
+            mytype: jest.fn(() => Promise.resolve({ data: { foo: 'bar' } })),
+        };
+
+        let response = null;
+        const myPayload = {};
+        const { getByText, dispatch } = renderWithRedux(
+            <DataProviderContext.Provider value={dataProvider}>
+                <MutationComponent options={{ returnPromise: true }}>
+                    {(mutate, { loading }) => (
+                        <button
+                            className={loading ? 'loading' : 'idle'}
+                            onClick={async () =>
+                                (response = await mutate({
+                                    type: 'mytype',
+                                    resource: 'myresource',
+                                    payload: myPayload,
+                                }))
+                            }
+                        >
+                            Hello
+                        </button>
+                    )}
+                </MutationComponent>
+            </DataProviderContext.Provider>
+        );
+        const buttonElement = getByText('Hello');
+        fireEvent.click(buttonElement);
+        const action = dispatch.mock.calls[0][0];
+        expect(action.type).toEqual('CUSTOM_FETCH');
+        expect(action.payload).toEqual(myPayload);
+        expect(action.meta.resource).toEqual('myresource');
+        await waitFor(() => {
+            expect(buttonElement.className).toEqual('idle');
+        });
+
+        expect(response).toMatchObject({ data: { foo: 'bar' } });
+    });
 });

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

@@ -320,7 +320,13 @@ const mergeDefinitionAndCallTimeParameters = (
         type: callTimeQuery.type,
         resource: callTimeQuery.resource,
         payload: callTimeQuery.payload,
-        options: sanitizeOptions(callTimeOptions),
+        options: options
+            ? merge(
+                  {},
+                  sanitizeOptions(options),
+                  sanitizeOptions(callTimeOptions)
+              )
+            : sanitizeOptions(callTimeOptions),
     };
 };