File size: 5,348 Bytes
1e92f2d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
import { RuleTester } from '@typescript-eslint/rule-tester'
import { rule } from '../rules/stable-query-client/stable-query-client.rule'
import { normalizeIndent } from './test-utils'

const ruleTester = new RuleTester()

ruleTester.run('stable-query-client', rule, {
  valid: [
    {
      name: 'QueryClient is stable when wrapped in React.useState',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const [queryClient] = React.useState(() => new QueryClient());
          return;
        }
      `,
    },
    {
      name: 'QueryClient is stable when wrapped in useState',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const [queryClient] = useState(() => new QueryClient());
          return;
        }
      `,
    },
    {
      name: 'QueryClient is stable when wrapped in React.useMemo',
      code: normalizeIndent`
          import { QueryClient } from "@tanstack/react-query";

          function Component() {
            const [queryClient] = React.useMemo(() => new QueryClient(), []);
            return;
          }
        `,
    },
    {
      name: 'QueryClient is stable when wrapped in useAnything',
      code: normalizeIndent`
          import { QueryClient } from "@tanstack/react-query";

          function Component() {
            const [queryClient] = useAnything(() => new QueryClient());
            return;
          }
        `,
    },
    {
      name: 'QueryClient is imported from a non-tanstack package',
      code: normalizeIndent`
        import { QueryClient } from "other-library";

        function Component() {
          const queryClient = new QueryClient();
          return;
        }
      `,
    },
    {
      name: 'QueryClient is not imported from @tanstack/react-query',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/solid-query";

        function Component() {
          const queryClient = new QueryClient();
          return;
        }
      `,
    },
    {
      name: 'QueryClient is invoked outside of a function',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/solid-query";

        const queryClient = new QueryClient();

        function Component() {
          return;
        }
      `,
    },
    {
      name: 'QueryClient is invoked in a non-component function',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/solid-query";

        function someFn() {
          const queryClient = new QueryClient();
          return;
        }
      `,
    },
    {
      name: 'QueryClient is invoked in an async (react server) component',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/solid-query";

        async function AsyncComponent() {
          const queryClient = new QueryClient();
          return;
        }
      `,
    },
  ],
  invalid: [
    {
      name: 'QueryClient is not stable when it is not wrapped in React.useState in component',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const queryClient = new QueryClient();
          return;
        }
      `,
      output: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const [queryClient] = React.useState(() => new QueryClient());
          return;
        }
      `,
      errors: [{ messageId: 'unstable' }],
    },
    {
      name: 'QueryClient is not stable when it is not wrapped in React.useState in custom hook',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function useHook() {
          const queryClient = new QueryClient();
          return;
        }
      `,
      output: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function useHook() {
          const [queryClient] = React.useState(() => new QueryClient());
          return;
        }
      `,
      errors: [{ messageId: 'unstable' }],
    },
    {
      name: 'preserve QueryClient options',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const queryClient = new QueryClient({ defaultOptions: { /* */ } });
          return;
        }
      `,
      output: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const [queryClient] = React.useState(() => new QueryClient({ defaultOptions: { /* */ } }));
          return;
        }
      `,
      errors: [{ messageId: 'unstable' }],
    },
    {
      name: 'preserve QueryClient variable declarator name',
      code: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const customName = new QueryClient();
          return;
        }
      `,
      output: normalizeIndent`
        import { QueryClient } from "@tanstack/react-query";

        function Component() {
          const [customName] = React.useState(() => new QueryClient());
          return;
        }
      `,
      errors: [{ messageId: 'unstable' }],
    },
  ],
})