-
Notifications
You must be signed in to change notification settings - Fork 70
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
Add useEnableNetworkMutation #112
Draft
HassanBahati
wants to merge
1
commit into
invertase:next
Choose a base branch
from
HassanBahati:ft-add-useEnableNetworkMutation
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+122
−1
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
100 changes: 100 additions & 0 deletions
100
packages/react/src/firestore/useEnableNetworkMutation.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
import React from "react"; | ||
import { describe, expect, test, beforeEach } from "vitest"; | ||
import { renderHook, act, waitFor } from "@testing-library/react"; | ||
import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; | ||
import { | ||
expectFirestoreError, | ||
firestore, | ||
wipeFirestore, | ||
} from "~/testing-utils"; | ||
import { useEnableNetworkMutation } from "./useEnableNetworkMutation"; | ||
import { | ||
doc, | ||
getDoc, | ||
disableNetwork, | ||
setDoc, | ||
enableNetwork, | ||
} from "firebase/firestore"; | ||
|
||
const queryClient = new QueryClient({ | ||
defaultOptions: { | ||
queries: { retry: false }, | ||
mutations: { retry: false }, | ||
}, | ||
}); | ||
|
||
const wrapper = ({ children }: { children: React.ReactNode }) => ( | ||
<QueryClientProvider client={queryClient}>{children}</QueryClientProvider> | ||
); | ||
|
||
describe("useEnableNetworkMutation", () => { | ||
beforeEach(async () => { | ||
queryClient.clear(); | ||
await disableNetwork(firestore); | ||
await wipeFirestore(); | ||
}); | ||
|
||
test("should successfully enable the Firestore network", async () => { | ||
const { result } = renderHook(() => useEnableNetworkMutation(firestore), { | ||
wrapper, | ||
}); | ||
|
||
await act(() => result.current.mutate()); | ||
|
||
await waitFor(() => expect(result.current.isSuccess).toBe(true)); | ||
|
||
// Verify that network operations successfully execute | ||
const docRef = doc(firestore, "tests", "enabledNetwork"); | ||
await setDoc(docRef, { foo: "bar" }); | ||
|
||
try { | ||
const snapshot = await getDoc(docRef); | ||
expect(snapshot?.exists()).toBe(true); | ||
expect(snapshot?.data()?.foo).toBe("bar"); | ||
} catch (error) { | ||
expectFirestoreError(error, "unavailable"); | ||
} | ||
}); | ||
|
||
test("should correctly reset mutation state after operations", async () => { | ||
const { result } = renderHook(() => useEnableNetworkMutation(firestore), { | ||
wrapper, | ||
}); | ||
|
||
await act(() => result.current.mutate()); | ||
|
||
await waitFor(() => expect(result.current.isSuccess).toBe(true)); | ||
|
||
act(() => result.current.reset()); | ||
|
||
await waitFor(() => { | ||
expect(result.current.isIdle).toBe(true); | ||
expect(result.current.data).toBeUndefined(); | ||
expect(result.current.error).toBeNull(); | ||
}); | ||
}); | ||
|
||
test("should work correctly when network is already enabled", async () => { | ||
await enableNetwork(firestore); | ||
|
||
const { result } = renderHook(() => useEnableNetworkMutation(firestore), { | ||
wrapper, | ||
}); | ||
|
||
await act(() => result.current.mutate()); | ||
|
||
await waitFor(() => expect(result.current.isSuccess).toBe(true)); | ||
|
||
// Verify that network operations successfully execute | ||
const docRef = doc(firestore, "tests", "alreadyEnabledNetwork"); | ||
await setDoc(docRef, { foo: "bar" }); | ||
|
||
try { | ||
const snapshot = await getDoc(docRef); | ||
expect(snapshot?.exists()).toBe(true); | ||
expect(snapshot?.data()?.foo).toBe("bar"); | ||
} catch (error) { | ||
expectFirestoreError(error, "unavailable"); | ||
} | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
import { useMutation, type UseMutationOptions } from "@tanstack/react-query"; | ||
import { | ||
type FirestoreError, | ||
type Firestore, | ||
enableNetwork, | ||
} from "firebase/firestore"; | ||
|
||
type FirestoreUseMutationOptions<TData = unknown, TError = Error> = Omit< | ||
UseMutationOptions<TData, TError, void>, | ||
"mutationFn" | ||
>; | ||
|
||
export function useEnableNetworkMutation( | ||
firestore: Firestore, | ||
options?: FirestoreUseMutationOptions<void, FirestoreError> | ||
) { | ||
return useMutation<void, FirestoreError>({ | ||
...options, | ||
mutationFn: () => enableNetwork(firestore), | ||
}); | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These tests don't make sense (I don't think) - should it throw, or work?