File size: 4,938 Bytes
c2b7eb3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
import { configureStore } from '@reduxjs/toolkit'
import {
  ApiProvider,
  buildCreateApi,
  coreModule,
  createApi,
  reactHooksModule,
} from '@reduxjs/toolkit/query/react'
import { fireEvent, render, waitFor } from '@testing-library/react'
import { delay } from 'msw'
import * as React from 'react'
import type { ReactReduxContextValue } from 'react-redux'
import {
  Provider,
  createDispatchHook,
  createSelectorHook,
  createStoreHook,
} from 'react-redux'

const api = createApi({
  baseQuery: async (arg: any) => {
    await delay(150)
    return { data: arg?.body ? arg.body : null }
  },
  endpoints: (build) => ({
    getUser: build.query<any, number>({
      query: (arg) => arg,
    }),
    updateUser: build.mutation<any, { name: string }>({
      query: (update) => ({ body: update }),
    }),
  }),
})

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

describe('ApiProvider', () => {
  test('ApiProvider allows a user to make queries without a traditional Redux setup', async () => {
    function User() {
      const [value, setValue] = React.useState(0)

      const { isFetching } = api.endpoints.getUser.useQuery(1, {
        skip: value < 1,
      })

      return (
        <div>
          <div data-testid="isFetching">{String(isFetching)}</div>
          <button onClick={() => setValue((val) => val + 1)}>
            Increment value
          </button>
        </div>
      )
    }

    const { getByText, getByTestId } = render(
      <ApiProvider api={api}>
        <User />
      </ApiProvider>,
    )

    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('false'),
    )
    fireEvent.click(getByText('Increment value'))
    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('true'),
    )
    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('false'),
    )
    fireEvent.click(getByText('Increment value'))
    // Being that nothing has changed in the args, this should never fire.
    expect(getByTestId('isFetching').textContent).toBe('false')
  })
  test('ApiProvider throws if nested inside a Redux context', () => {
    // Intentionally swallow the "unhandled error" message
    vi.spyOn(console, 'error').mockImplementation(() => {})
    expect(() =>
      render(
        <Provider store={configureStore({ reducer: () => null })}>
          <ApiProvider api={api}>child</ApiProvider>
        </Provider>,
      ),
    ).toThrowErrorMatchingInlineSnapshot(
      `[Error: Existing Redux context detected. If you already have a store set up, please use the traditional Redux setup.]`,
    )
  })
  test('ApiProvider allows a custom context', async () => {
    const customContext = React.createContext<ReactReduxContextValue | null>(
      null,
    )

    const createApiWithCustomContext = buildCreateApi(
      coreModule(),
      reactHooksModule({
        hooks: {
          useStore: createStoreHook(customContext),
          useSelector: createSelectorHook(customContext),
          useDispatch: createDispatchHook(customContext),
        },
      }),
    )

    const customApi = createApiWithCustomContext({
      baseQuery: async (arg: any) => {
        await delay(150)
        return { data: arg?.body ? arg.body : null }
      },
      endpoints: (build) => ({
        getUser: build.query<any, number>({
          query: (arg) => arg,
        }),
        updateUser: build.mutation<any, { name: string }>({
          query: (update) => ({ body: update }),
        }),
      }),
    })

    function User() {
      const [value, setValue] = React.useState(0)

      const { isFetching } = customApi.endpoints.getUser.useQuery(1, {
        skip: value < 1,
      })

      return (
        <div>
          <div data-testid="isFetching">{String(isFetching)}</div>
          <button onClick={() => setValue((val) => val + 1)}>
            Increment value
          </button>
        </div>
      )
    }

    const { getByText, getByTestId } = render(
      <ApiProvider api={customApi} context={customContext}>
        <User />
      </ApiProvider>,
    )

    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('false'),
    )
    fireEvent.click(getByText('Increment value'))
    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('true'),
    )
    await waitFor(() =>
      expect(getByTestId('isFetching').textContent).toBe('false'),
    )
    fireEvent.click(getByText('Increment value'))
    // Being that nothing has changed in the args, this should never fire.
    expect(getByTestId('isFetching').textContent).toBe('false')

    // won't throw if nested, because context is different
    expect(() =>
      render(
        <Provider store={configureStore({ reducer: () => null })}>
          <ApiProvider api={customApi} context={customContext}>
            child
          </ApiProvider>
        </Provider>,
      ),
    ).not.toThrow()
  })
})