Skip to content

test(svelte-query/createQuery): switch to fake timers, replace 'waitFor' with 'vi.waitFor', and add 'expect' #9384

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

Merged
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
56 changes: 38 additions & 18 deletions packages/svelte-query/tests/createQuery/createQuery.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, expect, test } from 'vitest'
import { fireEvent, render, waitFor } from '@testing-library/svelte'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { fireEvent, render } from '@testing-library/svelte'
import { derived, get, writable } from 'svelte/store'
import { QueryClient } from '@tanstack/query-core'
import { sleep } from '@tanstack/query-test-utils'
Expand All @@ -11,6 +11,14 @@ import type { Writable } from 'svelte/store'
import type { QueryObserverResult } from '@tanstack/query-core'

describe('createQuery', () => {
beforeEach(() => {
vi.useFakeTimers()
})

afterEach(() => {
vi.useRealTimers()
})

test('Return the correct states for a successful query', async () => {
const statesStore: Writable<Array<QueryObserverResult>> = writable([])

Expand All @@ -30,7 +38,7 @@ describe('createQuery', () => {
},
})

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Status: success')).toBeInTheDocument()
})

Expand Down Expand Up @@ -111,7 +119,9 @@ describe('createQuery', () => {
},
})

await waitFor(() => rendered.getByText('Status: error'))
await vi.waitFor(() =>
expect(rendered.getByText('Status: error')).toBeInTheDocument(),
)

const states = get(statesStore)

Expand Down Expand Up @@ -218,7 +228,7 @@ describe('createQuery', () => {
},
})

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Status: success')).toBeInTheDocument()
})
})
Expand All @@ -244,7 +254,7 @@ describe('createQuery', () => {
},
})

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Status: success')).toBeInTheDocument()
})
})
Expand Down Expand Up @@ -272,21 +282,21 @@ describe('createQuery', () => {
},
})

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Data: 1')).toBeInTheDocument()
expect(rendered.queryByText('Data: 2')).not.toBeInTheDocument()
})

writableStore.set(2)

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Data: 1')).not.toBeInTheDocument()
expect(rendered.queryByText('Data: 2')).toBeInTheDocument()
})

writableStore.set(1)

await waitFor(() => {
await vi.waitFor(() => {
expect(rendered.queryByText('Data: 1')).toBeInTheDocument()
expect(rendered.queryByText('Data: 2')).not.toBeInTheDocument()
})
Expand All @@ -302,11 +312,15 @@ describe('createQuery', () => {
},
})

await waitFor(() => rendered.getByText('Data: 0'))
await vi.waitFor(() =>
expect(rendered.getByText('Data: 0')).toBeInTheDocument(),
)

fireEvent.click(rendered.getByRole('button', { name: 'setCount' }))

await waitFor(() => rendered.getByText('Data: 1'))
await vi.waitFor(() =>
expect(rendered.getByText('Data: 1')).toBeInTheDocument(),
)

const states = get(statesStore)

Expand Down Expand Up @@ -354,13 +368,15 @@ describe('createQuery', () => {
},
})

await waitFor(() => rendered.getByText('Data: 0'))
await vi.waitFor(() =>
expect(rendered.getByText('Data: 0')).toBeInTheDocument(),
)

fireEvent.click(rendered.getByRole('button', { name: /Increment/i }))

await waitFor(() => {
rendered.getByText('Count: 1')
rendered.getByText('Data: undefined')
await vi.waitFor(() => {
expect(rendered.getByText('Count: 1')).toBeInTheDocument()
expect(rendered.getByText('Data: undefined')).toBeInTheDocument()
})

const states = get(statesStore)
Expand Down Expand Up @@ -398,13 +414,17 @@ describe('createQuery', () => {
},
})

await waitFor(() => rendered.getByText('Data: 1'))
await vi.waitFor(() =>
expect(rendered.getByText('Data: 1')).toBeInTheDocument(),
)
fireEvent.click(rendered.getByRole('button', { name: /Remove/i }))

await sleep(5)
await vi.advanceTimersByTimeAsync(5)

fireEvent.click(rendered.getByRole('button', { name: /Refetch/i }))
await waitFor(() => rendered.getByText('Data: 2'))
await vi.waitFor(() =>
expect(rendered.getByText('Data: 2')).toBeInTheDocument(),
)

const states = get(statesStore)

Expand Down
Loading