Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react/auth): add useReauthenticateWithCredentialMutation #167

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/react/src/auth/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export { useDeleteUserMutation } from "./useDeleteUserMutation";
// useLinkWithPopupMutation
// useLinkWithRedirectMutation
// useReauthenticateWithPhoneNumberMutation
// useReauthenticateWithCredentialMutation
export { useReauthenticateWithCredentialMutation } from "./useReauthenticateWithCredentialMutation";
// useReauthenticateWithPopupMutation
// useReauthenticateWithRedirectMutation
export { useReloadMutation } from "./useReloadMutation";
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
import { renderHook, waitFor } from "@testing-library/react";
import {
createUserWithEmailAndPassword,
signOut,
EmailAuthProvider,
type User,
} from "firebase/auth";
import { useReauthenticateWithCredentialMutation } from "./useReauthenticateWithCredentialMutation";
import { describe, test, expect, beforeEach, afterEach } from "vitest";
import { wrapper, queryClient } from "../../utils";
import { auth, expectFirebaseError, wipeAuth } from "~/testing-utils";

describe("useReauthenticateWithCredentialMutation", () => {
let user: User;

const email = "[email protected]";
const password = "TanstackQueryFirebase#123";

beforeEach(async () => {
queryClient.clear();
await wipeAuth();
const userCredential = await createUserWithEmailAndPassword(
auth,
email,
password
);
user = userCredential.user;
});

afterEach(async () => {
await signOut(auth);
});

test("should successfully reauthenticate with correct credentials", async () => {
const { result } = renderHook(
() => useReauthenticateWithCredentialMutation(),
{ wrapper }
);

const credential = EmailAuthProvider.credential(email, password);

result.current.mutate({
user,
credential,
});

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
});

expect(result.current.data?.user.email).toBe(email);
});

test("should fail with incorrect credentials", async () => {
const { result } = renderHook(
() => useReauthenticateWithCredentialMutation(),
{ wrapper }
);

const wrongCredential = EmailAuthProvider.credential(
email,
"wrongPassword"
);

result.current.mutate({
user,
credential: wrongCredential,
});

await waitFor(() => {
expect(result.current.isError).toBe(true);
});

expectFirebaseError(result.current.error, "auth/wrong-password");
});

test("should call onSuccess callback after successful reauthentication", async () => {
let callbackCalled = false;

const { result } = renderHook(
() =>
useReauthenticateWithCredentialMutation({
onSuccess: () => {
callbackCalled = true;
},
}),
{ wrapper }
);

const credential = EmailAuthProvider.credential(email, password);

result.current.mutate({
user,
credential,
});

await waitFor(() => {
expect(callbackCalled).toBe(true);
expect(result.current.isSuccess).toBe(true);
});
});

test("should call onError callback on authentication failure", async () => {
let errorCode: string | undefined;

const { result } = renderHook(
() =>
useReauthenticateWithCredentialMutation({
onError: (error) => {
errorCode = error.code;
},
}),
{ wrapper }
);

const wrongCredential = EmailAuthProvider.credential(
email,
"wrongPassword"
);

result.current.mutate({
user,
credential: wrongCredential,
});

await waitFor(() => {
expect(result.current.isError).toBe(true);
expectFirebaseError(result.current.error, "auth/wrong-password");
});
});

test("should handle multiple reauthentication attempts", async () => {
const { result } = renderHook(
() => useReauthenticateWithCredentialMutation(),
{ wrapper }
);

// First attempt - successful
const correctCredential = EmailAuthProvider.credential(email, password);
result.current.mutate({
user,
credential: correctCredential,
});

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
});

// Second attempt - with wrong password
const wrongCredential = EmailAuthProvider.credential(
email,
"wrongPassword"
);
result.current.mutate({
user,
credential: wrongCredential,
});

await waitFor(() => {
expect(result.current.isError).toBe(true);
expectFirebaseError(result.current.error, "auth/wrong-password");
});
});
});
29 changes: 29 additions & 0 deletions packages/react/src/auth/useReauthenticateWithCredentialMutation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { useMutation, type UseMutationOptions } from "@tanstack/react-query";
import {
type AuthCredential,
reauthenticateWithCredential,
type AuthError,
type User,
type UserCredential,
} from "firebase/auth";

type Variables = {
user: User;
credential: AuthCredential;
};

type AuthMutationOptions<
TData = unknown,
TError = Error,
TVariables = void
> = Omit<UseMutationOptions<TData, TError, TVariables>, "mutationFn">;

export function useReauthenticateWithCredentialMutation(
options?: AuthMutationOptions<UserCredential, AuthError, Variables>
) {
return useMutation<UserCredential, AuthError, Variables>({
...options,
mutationFn: ({ user, credential }) =>
reauthenticateWithCredential(user, credential),
});
}