Repository navigation
Expand file tree
/
Copy pathcheck-react-query-patterns.ts
More file actions
469 lines (438 loc) · 17.4 KB
/
Copy pathcheck-react-query-patterns.ts
File metadata and controls
469 lines (438 loc) · 17.4 KB
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
#!/usr/bin/env bun
/**
* Enforces the project's React Query (TanStack Query v5) conventions.
*
* Biome and `check-api-validation-contracts.ts` cover formatting and the
* raw-fetch / contract boundary. This script catches React-Query-specific
* anti-patterns that neither covers:
*
* 1. missing-stale-time — useQuery/useInfiniteQuery/useSuspenseQuery without an explicit `staleTime`
* 2. queryfn-no-signal — an inline `queryFn` that takes no args (cannot forward the AbortSignal)
* 2b. stale-time-literal — `staleTime` given as a numeric literal rather than a named constant, so a
* server prefetch hydrating the same key cannot import the one value and the
* two drift apart silently. `0` is exempt: it is a sentinel meaning "always
* refetch", not a duration anyone tunes.
* 3. inline-query-key — `queryKey: ['literal', ...]` instead of a colocated key factory
* 4. key-factory-no-root — a `*Keys` factory in hooks/queries/** without an `all` root key
* 5. key-fetch-arg-drift — an identifier the queryFn forwards into the fetch (e.g. `workspaceId`)
* that is absent from the queryKey, so distinct fetch args collide on one
* cache entry. Conservative: only bare camelCase identifiers (never the
* requestJson contract arg, PascalCase/SCREAMING constants, or signal/
* pageParam machinery) are checked, and only when both a queryKey and an
* inline-arrow queryFn with a recognizable call are present.
*
* Zero tolerance across apps/sim/**: any violation fails.
*
* Escape hatch: put `// rq-lint-allow: <reason>` on the line directly above the
* flagged construct (up to 3 preceding comment lines tolerated). The reason must
* be non-empty.
*
* Usage: bun run scripts/check-react-query-patterns.ts
*/
import { readdir, readFile } from 'node:fs/promises'
import path from 'node:path'
const ROOT = path.resolve(import.meta.dir, '..')
const APP_DIR = path.join(ROOT, 'apps/sim')
/** The shared query-hook layer, where every `*Keys` factory must expose an `all` root key. */
const QUERY_HOOKS_PREFIX = 'apps/sim/hooks/queries/'
const SKIP_DIRS = new Set(['node_modules', '.next', '.turbo', 'coverage', 'dist', 'build'])
const ALLOW = 'rq-lint-allow:'
type Category =
| 'missing-stale-time'
| 'stale-time-literal'
| 'queryfn-no-signal'
| 'inline-query-key'
| 'key-factory-no-root'
| 'key-fetch-arg-drift'
interface Violation {
file: string
line: number
category: Category
message: string
snippet: string
}
const SUGGESTION: Record<Category, string> = {
'missing-stale-time':
'add an explicit staleTime (default 0 is rarely correct); e.g. staleTime: 60 * 1000',
'stale-time-literal':
'assign staleTime from a named exported constant (e.g. ENTITY_LIST_STALE_TIME) so a server ' +
'prefetch on the same query key can import the one value instead of restating it',
'queryfn-no-signal':
'destructure the AbortSignal: queryFn: ({ signal }) => fetchX(..., signal) and forward it',
'inline-query-key':
'use a colocated hierarchical key factory (entityKeys.list(id)) instead of an inline literal key',
'key-factory-no-root':
'every *Keys factory in hooks/queries/** must expose an `all` root key for prefix invalidation',
'key-fetch-arg-drift':
'every identifier the queryFn passes to fetch/requestJson must also appear in the queryKey — ' +
'otherwise distinct fetch args collide on one cache entry (cross-tenant/param cache collision)',
}
async function walk(dir: string, out: string[] = []): Promise<string[]> {
let entries
try {
entries = await readdir(dir, { withFileTypes: true })
} catch {
return out
}
for (const entry of entries) {
if (SKIP_DIRS.has(entry.name)) continue
const full = path.join(dir, entry.name)
if (entry.isDirectory()) await walk(full, out)
else if (/\.(ts|tsx)$/.test(entry.name) && !/\.(test|spec)\.(ts|tsx)$/.test(entry.name))
out.push(full)
}
return out
}
/** Returns the substring of `src` for the balanced bracket group starting at `open` (index of the opening bracket). */
function matchBalanced(src: string, open: number, openCh: string, closeCh: string): string {
let depth = 0
let inStr: string | null = null
for (let i = open; i < src.length; i++) {
const ch = src[i]
const prev = src[i - 1]
if (inStr) {
if (ch === inStr && prev !== '\\') inStr = null
continue
}
if (ch === '"' || ch === "'" || ch === '`') {
inStr = ch
continue
}
if (ch === openCh) depth++
else if (ch === closeCh) {
depth--
if (depth === 0) return src.slice(open, i + 1)
}
}
return src.slice(open)
}
function lineAt(content: string, index: number): number {
let line = 1
for (let i = 0; i < index && i < content.length; i++) if (content[i] === '\n') line++
return line
}
/** True if a `// rq-lint-allow: <reason>` annotation sits within the 3 lines above `line` (1-based). */
function hasAllow(lines: string[], line: number): boolean {
for (let i = line - 2; i >= 0 && i >= line - 5; i--) {
const text = lines[i]?.trim() ?? ''
if (text.includes(ALLOW)) {
const reason = text.slice(text.indexOf(ALLOW) + ALLOW.length).trim()
return reason.length > 0
}
if (text.length > 0 && !text.startsWith('//') && !text.startsWith('*')) break
}
return false
}
/**
* The optional explicit type argument on a query call — `useQuery<Row[]>({ ... })`.
*
* Matched rather than ignored because a call carrying one is still a query call: without this
* the scan skipped every generically-typed query, including ten in `hooks/queries`, which then
* reported zero violations while never having looked at them. One level of nesting is enough
* for the shapes that occur here (`useQuery<Record<string, T>>`).
*/
const TYPE_ARGS = String.raw`(?:\s*<[^<>()]*(?:<[^<>()]*>[^<>()]*)*>)?`
const QUERY_CALL = new RegExp(
String.raw`\b(useQuery|useInfiniteQuery|useSuspenseQuery|useSuspenseInfiniteQuery)${TYPE_ARGS}\s*\(`,
'g'
)
/**
* `useQueries` nests its option objects one level deeper — `useQueries({ queries: [ {...} ] })` —
* so the single-object walk above would read the wrapper and see one `staleTime` anywhere inside
* the array as covering every entry. It gets its own pass that visits each entry.
*/
const USE_QUERIES_CALL = new RegExp(String.raw`\buseQueries${TYPE_ARGS}\s*\(`, 'g')
/**
* Every top-level `{ ... }` inside a `queries` value, whether written as an array literal or
* produced by a `.map(...)` callback — both forms put each query's options in a brace group at
* the same nesting depth, so one balanced scan covers them.
*/
function splitObjectLiterals(value: string): string[] {
const out: string[] = []
let depth = 0
let start = -1
let inStr: string | null = null
for (let i = 0; i < value.length; i++) {
const c = value[i]
if (inStr) {
if (c === inStr && value[i - 1] !== '\\') inStr = null
continue
}
if (c === '"' || c === "'" || c === '`') {
inStr = c
continue
}
if (c === '{') {
if (depth === 0) start = i
depth++
continue
}
if (c === '}') {
depth--
if (depth === 0 && start !== -1) {
out.push(value.slice(start, i + 1))
start = -1
}
}
}
return out
}
/**
* Whether a `staleTime` value is a named constant rather than a literal duration.
*
* `0` is allowed: it is the sentinel for "always refetch", not a number anyone tunes, and the
* drift this rule prevents cannot occur when there is no window to keep in step.
*/
function isNamedStaleTime(value: string): boolean {
const trimmed = value.trim()
if (trimmed === '0') return true
return !/^[0-9]/.test(trimmed)
}
const QUERYFN_NOARG = /queryFn\s*:\s*(?:async\s+)?\(\s*\)\s*=>/
const QUERYFN_PRESENT = /queryFn\s*:/
const INLINE_KEY = /queryKey\s*:\s*\[\s*[`'"]/
const KEYS_FACTORY = /\b(?:export\s+)?const\s+\w*[kK]eys\s*[:=][^=]*?=?\s*\{/g
/**
* Identifiers that are part of the queryFn machinery (not fetch params) and
* must never be flagged as drift even though they appear in the call.
*/
const QUERYFN_NOISE = new Set([
'signal',
'pageParam',
'meta',
'queryKey',
'direction',
'client',
'true',
'false',
'null',
'undefined',
])
/**
* Extracts the value slice of `key: ...` from an options object, reading up to
* the property-terminating top-level comma. Nested brackets (arrays, calls, and
* arrow-function bodies including their own param parens) are skipped via depth
* tracking, so this correctly returns the whole `({ signal }) => fetchX(...)`
* arrow for `queryFn`, not just its parameter list.
*/
function extractOptionValue(obj: string, key: string): string | null {
const re = new RegExp(`\\b${key}\\s*:`, 'g')
const m = re.exec(obj)
if (!m) return null
let i = m.index + m[0].length
while (i < obj.length && /\s/.test(obj[i])) i++
let depth = 0
let inStr: string | null = null
let j = i
for (; j < obj.length; j++) {
const c = obj[j]
const prev = obj[j - 1]
if (inStr) {
if (c === inStr && prev !== '\\') inStr = null
continue
}
if (c === '"' || c === "'" || c === '`') {
inStr = c
continue
}
if (c === '(' || c === '[' || c === '{') depth++
else if (c === ')' || c === ']' || c === '}') {
if (depth === 0) break
depth--
} else if (c === ',' && depth === 0) break
}
return obj.slice(i, j)
}
/**
* "key/fetch-arg drift": an identifier the queryFn forwards into the fetch
* (the args of the first call expression inside the queryFn body) that does NOT
* textually appear in the queryKey. Conservative — only fires when both the
* queryKey and an inline-arrow queryFn with a recognizable call are present, and
* only for bare identifiers (optionally `x as T` / `x!`), never member access,
* literals, or queryFn machinery (signal/pageParam/etc.).
*/
function findKeyFetchArgDrift(obj: string): string[] {
const keyExpr = extractOptionValue(obj, 'queryKey')
const fnExpr = extractOptionValue(obj, 'queryFn')
if (!keyExpr || !fnExpr) return []
// Drop the arrow prefix (`async`, `(params) =>`, optional `{ return`) so the
// search begins at the queryFn body, then locate the first call expression and
// balance its argument list.
const bodyStart = /=>\s*(?:\{\s*(?:return\s+)?)?/.exec(fnExpr)
const body = bodyStart ? fnExpr.slice(bodyStart.index + bodyStart[0].length) : fnExpr
const call = /(?:await\s+)?([A-Za-z_$][\w$.]*)\s*\(/.exec(body)
if (!call) return []
const callee = call[1]
const openParen = call.index + call[0].length - 1
const argList = matchBalanced(body, openParen, '(', ')')
// Split top-level args.
const args: string[] = []
let depth = 0
let cur = ''
for (let i = 1; i < argList.length - 1; i++) {
const c = argList[i]
if (c === '(' || c === '[' || c === '{') depth++
else if (c === ')' || c === ']' || c === '}') depth--
if (c === ',' && depth === 0) {
args.push(cur)
cur = ''
} else cur += c
}
if (cur.trim()) args.push(cur)
// `requestJson(contract, ...)` / `ensureQueryData(contract, ...)` etc. take the
// contract constant as their first arg — that is module-level config, never a
// per-hook identifier, so drop it before checking.
const dropsFirstArg = /(?:^|\.)(requestJson|requestText|ensureQueryData|fetchQuery)$/.test(callee)
const checkArgs = dropsFirstArg ? args.slice(1) : args
const drifted: string[] = []
for (const raw of checkArgs) {
const id = raw
.trim()
.replace(/\s+as\s+[\w$.<>[\]| ]+$/, '')
.replace(/!+$/, '')
.trim()
// Only bare identifiers; skip member access, calls, literals, destructures, spreads.
if (!/^[A-Za-z_$][\w$]*$/.test(id)) continue
if (QUERYFN_NOISE.has(id)) continue
// Skip module-level constants (contracts/config), which are camelCase config
// ending in `Contract`, PascalCase, or SCREAMING_SNAKE — never hook params.
if (/Contract$/.test(id) || /^[A-Z]/.test(id) || /^[A-Z0-9_]+$/.test(id)) continue
// Present in the key (as a whole word) → no drift.
const inKey = new RegExp(`\\b${id}\\b`).test(keyExpr)
if (!inKey && !drifted.includes(id)) drifted.push(id)
}
return drifted
}
function scanFile(rel: string, content: string): Violation[] {
const lines = content.split('\n')
const violations: Violation[] = []
const add = (index: number, category: Category, snippet: string) => {
const line = lineAt(content, index)
if (hasAllow(lines, line)) return
violations.push({ file: rel, line, category, message: SUGGESTION[category], snippet })
}
// 1 & 2: query call objects — staleTime + queryFn signal
QUERY_CALL.lastIndex = 0
let m: RegExpExecArray | null = QUERY_CALL.exec(content)
for (; m !== null; m = QUERY_CALL.exec(content)) {
const parenStart = m.index + m[0].length - 1
const arg = matchBalanced(content, parenStart, '(', ')')
// Only inspect the literal options object form `useQuery({ ... })`.
const braceRel = arg.indexOf('{')
if (braceRel === -1) continue
const obj = matchBalanced(arg, braceRel, '{', '}')
// Accept both `staleTime: ...` and the shorthand `staleTime,`; skip objects that spread options (...opts).
if (!/\bstaleTime\b/.test(obj) && !/\.\.\.\w/.test(obj)) {
add(m.index, 'missing-stale-time', `${m[1]}({ ... }) without staleTime`)
}
const staleTimeValue = extractOptionValue(obj, 'staleTime')
if (staleTimeValue !== null && !isNamedStaleTime(staleTimeValue)) {
add(
m.index,
'stale-time-literal',
`${m[1]} staleTime is the literal ${staleTimeValue.trim()}`
)
}
if (QUERYFN_PRESENT.test(obj) && QUERYFN_NOARG.test(obj)) {
add(m.index, 'queryfn-no-signal', `${m[1]} queryFn takes no args`)
}
for (const id of findKeyFetchArgDrift(obj)) {
add(
m.index,
'key-fetch-arg-drift',
`${m[1]}: '${id}' passed to fetch but absent from queryKey`
)
}
}
// 2b: useQueries — same checks, applied to each entry of its `queries` array
USE_QUERIES_CALL.lastIndex = 0
let q: RegExpExecArray | null = USE_QUERIES_CALL.exec(content)
for (; q !== null; q = USE_QUERIES_CALL.exec(content)) {
const parenStart = q.index + q[0].length - 1
const arg = matchBalanced(content, parenStart, '(', ')')
const braceRel = arg.indexOf('{')
if (braceRel === -1) continue
const wrapper = matchBalanced(arg, braceRel, '{', '}')
const queriesValue = extractOptionValue(wrapper, 'queries')
if (queriesValue === null) continue
for (const entry of splitObjectLiterals(queriesValue)) {
if (/\.\.\.\w/.test(entry)) continue
if (!/\bstaleTime\b/.test(entry)) {
add(q.index, 'missing-stale-time', 'useQueries entry without staleTime')
}
const entryStaleTime = extractOptionValue(entry, 'staleTime')
if (entryStaleTime !== null && !isNamedStaleTime(entryStaleTime)) {
add(
q.index,
'stale-time-literal',
`useQueries entry staleTime is the literal ${entryStaleTime.trim()}`
)
}
if (QUERYFN_PRESENT.test(entry) && QUERYFN_NOARG.test(entry)) {
add(q.index, 'queryfn-no-signal', 'useQueries entry queryFn takes no args')
}
for (const id of findKeyFetchArgDrift(entry)) {
add(
q.index,
'key-fetch-arg-drift',
`useQueries: '${id}' passed to fetch but absent from queryKey`
)
}
}
}
// 3: inline query keys
for (let i = 0; i < lines.length; i++) {
if (INLINE_KEY.test(lines[i])) {
const line = i + 1
if (!hasAllow(lines, line)) {
violations.push({
file: rel,
line,
category: 'inline-query-key',
message: SUGGESTION['inline-query-key'],
snippet: lines[i].trim(),
})
}
}
}
// 4: key factory must have an `all` root (hooks/queries/** only, excluding util key files that compose others)
if (rel.startsWith(QUERY_HOOKS_PREFIX)) {
KEYS_FACTORY.lastIndex = 0
let k: RegExpExecArray | null = KEYS_FACTORY.exec(content)
for (; k !== null; k = KEYS_FACTORY.exec(content)) {
const braceIdx = content.indexOf('{', k.index)
if (braceIdx === -1) continue
const obj = matchBalanced(content, braceIdx, '{', '}')
if (!/\ball\s*:/.test(obj)) {
add(k.index, 'key-factory-no-root', 'key factory missing `all` root key')
}
}
}
return violations
}
async function main() {
const files = await walk(APP_DIR)
const all: Violation[] = []
for (const file of files) {
const rel = path.relative(ROOT, file)
const content = await readFile(file, 'utf8')
/* `useQueries` must be listed before `useQuery`: the alternation is ordered, and a trailing
`\b` after `useQuery` would reject it outright on the `s`. */
if (!/\buse(Queries|Query|InfiniteQuery|SuspenseQuery|Mutation)\b|[kK]eys\s*[:=]/.test(content))
continue
all.push(...scanFile(rel, content))
}
console.log(`React Query pattern audit — scanned ${files.length} files`)
if (all.length > 0) {
console.error(`\n✗ ${all.length} violation(s):\n`)
for (const v of all) {
console.error(` ${v.file}:${v.line} [${v.category}]`)
console.error(` ${v.snippet}`)
console.error(` → ${v.message}\n`)
}
process.exit(1)
}
console.log('\n✓ React Query pattern audit passed.')
process.exit(0)
}
main()