fix(core): protect useLogin default success handler from custom onSuccess overrides

.changeset/selfish-needles-join.md

@@ -0,0 +1,7 @@
+---
+"@refinedev/core": patch
+---
+
+Protect `useLogin` default success handler from custom `onSuccess` overrides
+
+Resolves: #5888

packages/core/src/hooks/auth/useLogin/index.spec.ts

@@ -382,6 +382,47 @@ describe("useLogin Hook", () => {
     expect(mockGo).toBeCalledWith({ to: "/", type: "replace" });
   });
 
+  it("succeed login with custom `onSuccess` handler", async () => {
+    const { result } = renderHook(
+      () => useLogin({ mutationOptions: { onSuccess: () => undefined } }),
+      {
+        wrapper: TestWrapper({
+          authProvider: {
+            login: ({ email }: any) => {
+              if (email === "test") {
+                return Promise.resolve({
+                  success: true,
+                  redirectTo: "/",
+                });
+              }
+
+              return Promise.resolve({
+                success: false,
+                error: new Error("Wrong email"),
+              });
+            },
+            check: () => Promise.resolve({ authenticated: true }),
+            onError: () => Promise.resolve({}),
+            logout: () => Promise.resolve({ success: true }),
+          },
+          routerProvider,
+        }),
+      },
+    );
+
+    const { mutate: login } = result.current ?? { mutate: () => 0 };
+
+    await act(async () => {
+      login({ email: "test" });
+    });
+
+    await waitFor(() => {
+      expect(result.current.data?.success).toBeTruthy();
+    });
+
+    expect(mockGo).toBeCalledWith({ to: "/", type: "replace" });
+  });
+
   it("should successfully login with no redirect", async () => {
     const { result } = renderHook(() => useLogin(), {
       wrapper: TestWrapper({

packages/core/src/hooks/auth/useLogin/index.ts

@@ -144,7 +144,10 @@ export function useLogin<TVariables = {}>({
   >({
     mutationKey: keys().auth().action("login").get(preferLegacyKeys),
     mutationFn: loginFromContext,
-    onSuccess: async ({ success, redirectTo, error, successNotification }) => {
+    ...(v3LegacyAuthProviderCompatible === true ? {} : mutationOptions),
+    onSuccess: async (data, variables, context) => {
+      const { success, redirectTo, error, successNotification } = data;
+
       if (success) {
         close?.("login-error");
 
@@ -176,11 +179,14 @@ export function useLogin<TVariables = {}>({
       }
 
       await invalidateAuthStore();
+
+      if (!v3LegacyAuthProviderCompatible) {
+        mutationOptions?.onSuccess?.(data, variables, context);
+      }
     },
     onError: (error: any) => {
       open?.(buildNotification(error));
     },
-    ...(v3LegacyAuthProviderCompatible === true ? {} : mutationOptions),
     meta: {
       ...(v3LegacyAuthProviderCompatible === true ? {} : mutationOptions?.meta),
       ...getXRay("useLogin", preferLegacyKeys),