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

chore(ms): add dev dependency #274

Merged
merged 2 commits into from
Oct 29, 2023
Merged
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
1 change: 0 additions & 1 deletion configs/test-utils/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ export { delay } from './delay'
export const TEXT = 'TEXT' as const
export const ERROR_MESSAGE = 'ERROR_MESSAGE' as const
export const FALLBACK = 'FALLBACK' as const
export const MS_100 = 100 as const
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
"husky": "^8.0.3",
"jsdom": "^22.1.0",
"lint-staged": "^13.2.2",
"ms": "^3.0.0-canary.1",
"packlint": "^0.2.4",
"prettier": "^2.8.8",
"publint": "^0.2.2",
Expand Down
19 changes: 10 additions & 9 deletions packages/react-await/src/Await.spec.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import { ErrorBoundary, Suspense } from '@suspensive/react'
import { ERROR_MESSAGE, FALLBACK, MS_100, TEXT, delay } from '@suspensive/test-utils'
import { ERROR_MESSAGE, FALLBACK, TEXT, delay } from '@suspensive/test-utils'
import { act, render, screen, waitFor } from '@testing-library/react'
import ms from 'ms'
import { vi } from 'vitest'
import { Await, awaitClient, useAwait } from '.'

const key = (id: number) => ['key', id] as const

const AwaitSuccess = () => {
const awaited = useAwait({ key: key(1), fn: () => delay(MS_100).then(() => TEXT) })
const awaited = useAwait({ key: key(1), fn: () => delay(ms('0.1s')).then(() => TEXT) })

return (
<>
Expand All @@ -20,7 +21,7 @@ const AwaitSuccess = () => {
const AwaitFailure = () => {
const awaited = useAwait({
key: key(1),
fn: () => delay(MS_100).then(() => Promise.reject(new Error(ERROR_MESSAGE))),
fn: () => delay(ms('0.1s')).then(() => Promise.reject(new Error(ERROR_MESSAGE))),
})

return <>{awaited.data}</>
Expand Down Expand Up @@ -49,7 +50,7 @@ describe('useAwait', () => {
)
expect(screen.queryByText(FALLBACK)).toBeInTheDocument()

act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())

// success data cache test
Expand All @@ -73,7 +74,7 @@ describe('useAwait', () => {
</ErrorBoundary>
)
expect(screen.queryByText(FALLBACK)).toBeInTheDocument()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(ERROR_MESSAGE)).toBeInTheDocument())

// error cache test
Expand All @@ -97,7 +98,7 @@ describe('useAwait', () => {
</Suspense>
)
expect(screen.queryByText(FALLBACK)).toBeInTheDocument()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())
const resetButton = await screen.findByRole('button', { name: 'Try again' })
resetButton.click()
Expand All @@ -107,7 +108,7 @@ describe('useAwait', () => {
</Suspense>
)
expect(screen.queryByText(FALLBACK)).toBeInTheDocument()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())
})
})
Expand Down Expand Up @@ -187,7 +188,7 @@ describe('awaitClient', () => {
vi.useFakeTimers()
render(
<Suspense fallback={FALLBACK}>
<Await options={{ key: key(1), fn: () => delay(MS_100).then(() => TEXT) }}>
<Await options={{ key: key(1), fn: () => delay(ms('0.1s')).then(() => TEXT) }}>
{(awaited) => <>{awaited.data}</>}
</Await>
</Suspense>
Expand All @@ -196,7 +197,7 @@ describe('awaitClient', () => {
expect(screen.queryByText(FALLBACK)).toBeInTheDocument()
expect(screen.queryByText(TEXT)).not.toBeInTheDocument()
expect(awaitClient.getData(key(1))).toBeUndefined()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())
expect(screen.queryByText(FALLBACK)).not.toBeInTheDocument()
expect(awaitClient.getData(key(1))).toBe(TEXT)
Expand Down
11 changes: 6 additions & 5 deletions packages/react/src/AsyncBoundary.spec.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { ERROR_MESSAGE, FALLBACK, MS_100, Suspend, TEXT, ThrowError } from '@suspensive/test-utils'
import { ERROR_MESSAGE, FALLBACK, Suspend, TEXT, ThrowError } from '@suspensive/test-utils'
import { act, render, waitFor } from '@testing-library/react'
import ms from 'ms'
import type { ComponentProps } from 'react'
import { createElement } from 'react'
import { createRoot } from 'react-dom/client'
Expand Down Expand Up @@ -56,7 +57,7 @@ describe('<AsyncBoundary/>', () => {
rejectedFallback: ERROR_MESSAGE,
onError,
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
Expand All @@ -65,7 +66,7 @@ describe('<AsyncBoundary/>', () => {
expect(container.textContent).not.toBe(FALLBACK)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
expect(onError).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => {
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
Expand Down Expand Up @@ -116,7 +117,7 @@ describe('<AsyncBoundary.CSROnly/>', () => {
rejectedFallback: ERROR_MESSAGE,
onError,
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
Expand All @@ -125,7 +126,7 @@ describe('<AsyncBoundary.CSROnly/>', () => {
expect(container.textContent).not.toBe(FALLBACK)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
expect(onError).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => {
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
Expand Down
11 changes: 6 additions & 5 deletions packages/react/src/Delay.spec.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
import { MS_100, TEXT } from '@suspensive/test-utils'
import { TEXT } from '@suspensive/test-utils'
import { act, render, screen, waitFor } from '@testing-library/react'
import ms from 'ms'
import { vi } from 'vitest'
import { Delay, withDelay } from '.'

describe('<Delay/>', () => {
it('should render the children after the delay', async () => {
vi.useFakeTimers()
render(<Delay ms={MS_100}>{TEXT}</Delay>)
render(<Delay ms={ms('0.1s')}>{TEXT}</Delay>)
expect(screen.queryByText(TEXT)).not.toBeInTheDocument()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())
})
it('should render the children directly if no ms prop', () => {
Expand All @@ -17,14 +18,14 @@ describe('<Delay/>', () => {
})
})

const TEXTAfterDelay100ms = withDelay(() => <>{TEXT}</>, { ms: MS_100 })
const TEXTAfterDelay100ms = withDelay(() => <>{TEXT}</>, { ms: ms('0.1s') })

describe('withDelay', () => {
it('renders the children after the delay with component', async () => {
vi.useFakeTimers()
render(<TEXTAfterDelay100ms />)
expect(screen.queryByText(TEXT)).not.toBeInTheDocument()
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
await waitFor(() => expect(screen.queryByText(TEXT)).toBeInTheDocument())
})

Expand Down
49 changes: 25 additions & 24 deletions packages/react/src/ErrorBoundary.spec.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { ERROR_MESSAGE, FALLBACK, MS_100, TEXT, ThrowError, ThrowNull } from '@suspensive/test-utils'
import { ERROR_MESSAGE, FALLBACK, TEXT, ThrowError, ThrowNull } from '@suspensive/test-utils'
import { act, render } from '@testing-library/react'
import ms from 'ms'
import type { ComponentProps, ComponentRef } from 'react'
import { createElement, createRef } from 'react'
import { createRoot } from 'react-dom/client'
Expand Down Expand Up @@ -37,15 +38,15 @@ describe('<ErrorBoundary/>', () => {
onError,
fallback: <>{FALLBACK}</>,
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
})
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(FALLBACK)
expect(onError).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(FALLBACK)
expect(container.textContent).not.toBe(TEXT)
expect(onError).toHaveBeenCalledTimes(1)
Expand All @@ -56,14 +57,14 @@ describe('<ErrorBoundary/>', () => {
renderErrorBoundary({
fallback: (props) => <>{props.error.message}</>,
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
})
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
})
Expand All @@ -74,12 +75,12 @@ describe('<ErrorBoundary/>', () => {
renderErrorBoundary({
onError,
fallback: <>{FALLBACK}</>,
children: <ThrowNull after={MS_100}>{TEXT}</ThrowNull>,
children: <ThrowNull after={ms('0.1s')}>{TEXT}</ThrowNull>,
})
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(FALLBACK)
expect(onError).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(FALLBACK)
expect(container.textContent).not.toBe(TEXT)
expect(onError).toHaveBeenCalledTimes(1)
Expand All @@ -92,13 +93,13 @@ describe('<ErrorBoundary/>', () => {
renderErrorBoundary({
resetKeys: [0],
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
onReset,
})
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
expect(onReset).toHaveBeenCalledTimes(0)
Expand All @@ -114,13 +115,13 @@ describe('<ErrorBoundary/>', () => {
renderErrorBoundary({
resetKeys: [0],
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
onReset,
})
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)

Expand All @@ -139,13 +140,13 @@ describe('<ErrorBoundary/>', () => {
act(() =>
root.render(
<ErrorBoundary ref={errorBoundaryRef} fallback={fallbackFn} onReset={onReset}>
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
</ErrorBoundary>
)
)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(fallbackFn).toHaveBeenCalled()
fallbackFn.mock.calls[0][0].reset()
expect(onReset).toHaveBeenCalledTimes(1)
Expand All @@ -156,13 +157,13 @@ describe('<ErrorBoundary/>', () => {
vi.useFakeTimers()
renderErrorBoundary({
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
onReset,
})
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
expect(onReset).toHaveBeenCalledTimes(0)
Expand Down Expand Up @@ -206,7 +207,7 @@ describe('withErrorBoundary', () => {

const WrappedComponentWithError = withErrorBoundary(
() => (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
Expand All @@ -217,7 +218,7 @@ describe('withErrorBoundary', () => {

act(() => root.render(<WrappedComponentWithError />))
expect(container.textContent).toBe(TEXT)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
})

Expand Down Expand Up @@ -257,19 +258,19 @@ describe('useErrorBoundary', () => {
onError,
fallback: function ErrorBoundaryFallback() {
const props = useErrorBoundaryFallbackProps()
useTimeout(props.reset, MS_100)
useTimeout(props.reset, ms('0.1s'))
return <>{props.error.message}</>
},
children: createElement(() => {
const errorBoundary = useErrorBoundary()
useTimeout(() => errorBoundary.setError(new Error(ERROR_MESSAGE)), MS_100)
useTimeout(() => errorBoundary.setError(new Error(ERROR_MESSAGE)), ms('0.1s'))
return <>{TEXT}</>
}),
})
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
expect(onError).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
expect(onError).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -320,24 +321,24 @@ describe('useErrorBoundaryFallbackProps', () => {
onReset,
fallback: function ErrorBoundaryFallback() {
const props = useErrorBoundaryFallbackProps()
useTimeout(props.reset, MS_100)
useTimeout(props.reset, ms('0.1s'))

return <>{props.error.message}</>
},
children: (
<ThrowError message={ERROR_MESSAGE} after={MS_100}>
<ThrowError message={ERROR_MESSAGE} after={ms('0.1s')}>
{TEXT}
</ThrowError>
),
})
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
expect(onReset).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(ERROR_MESSAGE)
expect(container.textContent).not.toBe(TEXT)
expect(onReset).toHaveBeenCalledTimes(0)
act(() => vi.advanceTimersByTime(MS_100))
act(() => vi.advanceTimersByTime(ms('0.1s')))
expect(container.textContent).toBe(TEXT)
expect(container.textContent).not.toBe(ERROR_MESSAGE)
expect(onReset).toHaveBeenCalledTimes(1)
Expand Down
Loading
Loading