Skip to content

refactor(useDeleteDocumentMutation): pass args on mutate #171

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −24
Open

refactor(useDeleteDocumentMutation): pass args on mutate #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 14 additions & 16 deletions packages/react/src/firestore/useDeleteDocumentMutation.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ describe("useDeleteDocumentMutation", () => {
const initialSnapshot = await getDoc(docRef);
expect(initialSnapshot.exists()).toBe(true);

const { result } = renderHook(() => useDeleteDocumentMutation(docRef), {
const { result } = renderHook(() => useDeleteDocumentMutation(), {
wrapper,
});

expect(result.current.isPending).toBe(false);
expect(result.current.isIdle).toBe(true);

await act(() => result.current.mutate());
await act(() => result.current.mutate(docRef));

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
Expand All @@ -59,11 +59,11 @@ describe("useDeleteDocumentMutation", () => {
) as DocumentReference<TestDoc>;
await setDoc(docRef, { foo: "test", num: 123 });

const { result } = renderHook(() => useDeleteDocumentMutation(docRef), {
const { result } = renderHook(() => useDeleteDocumentMutation(), {
wrapper,
});

await act(() => result.current.mutate());
await act(() => result.current.mutate(docRef));

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
Expand All @@ -76,12 +76,11 @@ describe("useDeleteDocumentMutation", () => {
test("handles errors when deleting from restricted collection", async () => {
const restrictedDocRef = doc(firestore, "restrictedCollection", "someDoc");

const { result } = renderHook(
() => useDeleteDocumentMutation(restrictedDocRef),
{ wrapper }
);
const { result } = renderHook(() => useDeleteDocumentMutation(), {
wrapper,
});

await act(() => result.current.mutate());
await act(() => result.current.mutate(restrictedDocRef));

await waitFor(() => {
expect(result.current.isError).toBe(true);
Expand All @@ -98,15 +97,15 @@ describe("useDeleteDocumentMutation", () => {

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

await act(() => result.current.mutate());
await act(() => result.current.mutate(docRef));

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
Expand All @@ -120,12 +119,11 @@ describe("useDeleteDocumentMutation", () => {
test("handles deletion of non-existent document", async () => {
const nonExistentDocRef = doc(firestore, "tests", "doesNotExist");

const { result } = renderHook(
() => useDeleteDocumentMutation(nonExistentDocRef),
{ wrapper }
);
const { result } = renderHook(() => useDeleteDocumentMutation(), {
wrapper,
});

await act(() => result.current.mutate());
await act(() => result.current.mutate(nonExistentDocRef));

await waitFor(() => {
expect(result.current.isSuccess).toBe(true);
Expand Down
24 changes: 16 additions & 8 deletions packages/react/src/firestore/useDeleteDocumentMutation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,28 @@ import {
type DocumentReference,
} from "firebase/firestore";

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

export function useDeleteDocumentMutation<
AppModelType extends DocumentData = DocumentData,
DbModelType extends DocumentData = DocumentData
>(
documentRef: DocumentReference<AppModelType, DbModelType>,
options?: FirestoreUseMutationOptions<void, FirestoreError>
options?: FirestoreUseMutationOptions<
void,
FirestoreError,
DocumentReference<AppModelType, DbModelType>
>
) {
return useMutation<void, FirestoreError>({
return useMutation<
void,
FirestoreError,
DocumentReference<AppModelType, DbModelType>
>({
...options,
mutationFn: () => deleteDoc(documentRef),
mutationFn: (documentRef) => deleteDoc(documentRef),
});
}