-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusePublishedVariables.test.tsx
More file actions
517 lines (442 loc) · 15.3 KB
/
usePublishedVariables.test.tsx
File metadata and controls
517 lines (442 loc) · 15.3 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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
import { renderHook, waitFor } from '@testing-library/react'
import useSWR from 'swr'
import { describe, expect, it, vi } from 'vitest'
import type { Mock } from 'vitest'
import { fetcher as apiFetcher } from 'api/fetcher'
import { FigmaVarsProvider } from '../../src/contexts/FigmaVarsProvider'
import { usePublishedVariables } from '../../src/hooks/usePublishedVariables'
import * as useFigmaTokenContextModule from '../../src/contexts/useFigmaTokenContext'
import {
mockLocalVariablesResponse,
mockPublishedVariablesResponse,
} from '../mocks/variables'
import { FIGMA_PUBLISHED_VARIABLES_PATH } from '../../src/constants'
import type { ReactNode } from 'react'
// Mock the useSWR hook
vi.mock('swr')
vi.mock('api/fetcher', () => ({
fetcher: vi.fn(),
}))
const mockedUseSWR = useSWR as Mock
const mockedApiFetcher = apiFetcher as Mock
const wrapper = ({ children }: { children: ReactNode }) => (
<FigmaVarsProvider
token='test-token'
fileKey='test-key'>
{children}
</FigmaVarsProvider>
)
const wrapperNoToken = ({ children }: { children: ReactNode }) => (
<FigmaVarsProvider
token={null}
fileKey='test-key'>
{children}
</FigmaVarsProvider>
)
const wrapperNoFileKey = ({ children }: { children: ReactNode }) => (
<FigmaVarsProvider
token='test-token'
fileKey={null}>
{children}
</FigmaVarsProvider>
)
const wrapperWithFallbackFile = ({ children }: { children: ReactNode }) => (
<FigmaVarsProvider
token='test-token'
fileKey='test-key'
fallbackFile={mockPublishedVariablesResponse}>
{children}
</FigmaVarsProvider>
)
const wrapperWithFallbackFileString = ({
children,
}: {
children: ReactNode
}) => (
<FigmaVarsProvider
token='test-token'
fileKey='test-key'
fallbackFile={JSON.stringify(mockPublishedVariablesResponse)}>
{children}
</FigmaVarsProvider>
)
const wrapperWithFallbackFileNoCredentials = ({
children,
}: {
children: ReactNode
}) => (
<FigmaVarsProvider
token={null}
fileKey={null}
fallbackFile={mockPublishedVariablesResponse}>
{children}
</FigmaVarsProvider>
)
describe('usePublishedVariables', () => {
it('should return loading state initially', () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: undefined,
isLoading: true,
isValidating: false,
})
const { result } = renderHook(() => usePublishedVariables(), { wrapper })
expect(result.current.isLoading).toBe(true)
expect(result.current.isValidating).toBe(false)
})
it('should return published variables on successful fetch', async () => {
mockedUseSWR.mockReturnValue({
data: mockPublishedVariablesResponse,
error: undefined,
isLoading: false,
isValidating: false,
})
const { result } = renderHook(() => usePublishedVariables(), { wrapper })
await waitFor(() => {
expect(result.current.isLoading).toBe(false)
expect(result.current.data).toEqual(mockPublishedVariablesResponse)
expect(result.current.error).toBeUndefined()
expect(result.current.isValidating).toBe(false)
})
})
it('should return an error when fetch fails', async () => {
const error = new Error('Failed to fetch')
mockedUseSWR.mockReturnValue({
data: undefined,
error: error,
isLoading: false,
isValidating: false,
})
const { result } = renderHook(() => usePublishedVariables(), { wrapper })
await waitFor(() => {
expect(result.current.isLoading).toBe(false)
expect(result.current.data).toBeUndefined()
expect(result.current.error).toBe(error)
expect(result.current.isValidating).toBe(false)
})
})
it('should return isValidating true when revalidating', () => {
mockedUseSWR.mockReturnValue({
data: mockPublishedVariablesResponse,
error: undefined,
isLoading: false,
isValidating: true,
})
const { result } = renderHook(() => usePublishedVariables(), { wrapper })
expect(result.current.isValidating).toBe(true)
expect(result.current.isLoading).toBe(false)
})
it('should not call useSWR when token is missing', () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: undefined,
isLoading: false,
isValidating: false,
})
renderHook(() => usePublishedVariables(), { wrapper: wrapperNoToken })
expect(mockedUseSWR).toHaveBeenCalledWith(
null,
expect.any(Function),
undefined
)
})
it('should not call useSWR when fileKey is missing', () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: undefined,
isLoading: false,
isValidating: false,
})
renderHook(() => usePublishedVariables(), { wrapper: wrapperNoFileKey })
expect(mockedUseSWR).toHaveBeenCalledWith(
null,
expect.any(Function),
undefined
)
})
it('should use fallbackFile when provided as object', () => {
// Mock the custom fetcher behavior for fallbackFile
mockedUseSWR.mockImplementation(key => {
if (key && Array.isArray(key) && key[0] && key[1]) {
// Simulate the custom fetcher being called and returning fallback data
return {
data: mockPublishedVariablesResponse,
error: null,
isLoading: false,
isValidating: false,
}
}
return {
data: undefined,
error: null,
isLoading: false,
isValidating: false,
}
})
const { result } = renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFile,
})
expect(result.current.data).toEqual(mockPublishedVariablesResponse)
expect(result.current.error).toBeNull()
expect(result.current.isLoading).toBe(false)
expect(result.current.isValidating).toBe(false)
})
it('should parse fallbackFile when provided as string in custom fetcher', async () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: null,
isLoading: false,
isValidating: false,
})
const fallbackString = JSON.stringify(mockPublishedVariablesResponse)
const jsonParseSpy = vi.spyOn(JSON, 'parse')
renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFileString,
})
const useSWRCalls = mockedUseSWR.mock.calls
expect(useSWRCalls.length).toBeGreaterThan(0)
const call = useSWRCalls[0]
expect(call).toBeDefined()
const [, fetcher] = call as [
unknown,
([url, token]: readonly [string, string]) => Promise<unknown>,
]
expect(typeof fetcher).toBe('function')
const resultData = await fetcher([
FIGMA_PUBLISHED_VARIABLES_PATH('test-key'),
'test-token',
] as const)
expect(resultData).toEqual(mockPublishedVariablesResponse)
expect(jsonParseSpy).toHaveBeenCalledWith(fallbackString)
jsonParseSpy.mockRestore()
})
it('should call api fetcher when fallbackFile is not provided', async () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: null,
isLoading: false,
isValidating: false,
})
mockedApiFetcher.mockResolvedValue(mockPublishedVariablesResponse)
renderHook(() => usePublishedVariables(), {
wrapper,
})
const useSWRCalls = mockedUseSWR.mock.calls
expect(useSWRCalls.length).toBeGreaterThan(0)
const call = useSWRCalls[0]
expect(call).toBeDefined()
const [key, fetcher] = call as [
unknown,
([url, token]: readonly [string, string]) => Promise<unknown>,
]
// Key uses absolute URL for consistency
expect(key).toEqual([
'https://api.figma.com/v1/files/test-key/variables/published',
'test-token',
])
expect(typeof fetcher).toBe('function')
const resultData = await fetcher([
'https://api.figma.com/v1/files/test-key/variables/published',
'test-token',
] as const)
expect(resultData).toEqual(mockPublishedVariablesResponse)
expect(mockedApiFetcher).toHaveBeenCalledWith(
'https://api.figma.com/v1/files/test-key/variables/published',
'test-token'
)
})
it('should throw error from fetcher when token/fileKey/fallbackFile are missing', async () => {
mockedUseSWR.mockReturnValue({
data: undefined,
error: null,
isLoading: false,
isValidating: false,
})
renderHook(() => usePublishedVariables(), {
wrapper: wrapperNoToken,
})
const useSWRCalls = mockedUseSWR.mock.calls
expect(useSWRCalls.length).toBeGreaterThan(0)
const call = useSWRCalls[0]
expect(call).toBeDefined()
const [key, fetcher] = call as [
unknown,
(
...args: [readonly [string, string]] | [string, string]
) => Promise<unknown>,
]
expect(key).toBeNull()
expect(typeof fetcher).toBe('function')
// The fetcher should throw an error when called without credentials
await expect(fetcher('', '')).rejects.toThrow(
'Missing URL or token for live API request'
)
})
it('should use fallbackFile when provided as string', () => {
// Mock the custom fetcher behavior for fallbackFile string
mockedUseSWR.mockImplementation(key => {
if (key && Array.isArray(key) && key[0] && key[1]) {
// Simulate the custom fetcher being called and returning fallback data
return {
data: mockPublishedVariablesResponse,
error: null,
isLoading: false,
isValidating: false,
}
}
return {
data: undefined,
error: null,
isLoading: false,
isValidating: false,
}
})
const { result } = renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFileString,
})
expect(result.current.data).toEqual(mockPublishedVariablesResponse)
expect(result.current.error).toBeNull()
expect(result.current.isLoading).toBe(false)
expect(result.current.isValidating).toBe(false)
})
it('should use fallbackFile when both token and fileKey are null', () => {
// Mock the custom fetcher behavior for fallbackFile when both token and fileKey are null
mockedUseSWR.mockImplementation(key => {
if (key && Array.isArray(key) && key[0] && key[1]) {
// Simulate the custom fetcher being called and returning fallback data
return {
data: mockPublishedVariablesResponse,
error: null,
isLoading: false,
isValidating: false,
}
}
return {
data: undefined,
error: null,
isLoading: false,
isValidating: false,
}
})
const { result } = renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFileNoCredentials,
})
expect(result.current.data).toEqual(mockPublishedVariablesResponse)
expect(result.current.error).toBeNull()
expect(result.current.isLoading).toBe(false)
expect(result.current.isValidating).toBe(false)
})
it('should test custom fetcher logic directly for published endpoint', async () => {
// Test the actual custom fetcher logic by calling it directly
// When fallbackFile is present, the key should be a fallback key (not live key)
// This ensures fallback data is cached under fallback keys, preventing cache pollution
renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFile,
})
// Get the custom fetcher function from the useSWR call
const useSWRCalls = mockedUseSWR.mock.calls
expect(useSWRCalls.length).toBeGreaterThan(0)
const call = useSWRCalls[0]
expect(call).toBeDefined()
const [key, fetcher] = call as [
unknown,
(url: string, token: string) => Promise<unknown>,
]
// Key should be fallback key (not live key) when fallbackFile is present
// This prevents fallback data from being cached under live API keys
expect(Array.isArray(key)).toBe(true)
const keyArray = key as [string, string]
expect(keyArray[0]).toMatch(/^fallback-figma-vars-provider-/)
expect(keyArray[1]).toBe('fallback')
expect(typeof fetcher).toBe('function')
// Call the custom fetcher directly to test the fallbackFile logic
const resultData = await fetcher(
'https://api.figma.com/v1/files/test-key/variables/published',
'test-token'
)
expect(resultData).toEqual(mockPublishedVariablesResponse)
})
it('should test custom fetcher logic with no credentials', async () => {
// Test the actual custom fetcher logic by calling it directly when both token and fileKey are null
renderHook(() => usePublishedVariables(), {
wrapper: wrapperWithFallbackFileNoCredentials,
})
// Get the custom fetcher function from the useSWR call
const useSWRCalls = mockedUseSWR.mock.calls
expect(useSWRCalls.length).toBeGreaterThan(0)
const call = useSWRCalls[0]
expect(call).toBeDefined()
const [key, fetcher] = call as [
unknown,
(url: string, token: string) => Promise<unknown>,
]
// Key should match pattern: ['fallback-${providerId}', 'fallback']
// React's useId() returns format like :r1:, :r2:, etc.
expect(Array.isArray(key)).toBe(true)
const keyArray = key as [string, string]
expect(keyArray[0]).toMatch(/^fallback-figma-vars-provider-/)
expect(keyArray[1]).toBe('fallback')
expect(typeof fetcher).toBe('function')
// Call the custom fetcher directly to test the fallbackFile logic
const resultData = await fetcher(keyArray[0], 'fallback')
expect(resultData).toEqual(mockPublishedVariablesResponse)
})
it('should use default providerId when providerId is null', () => {
// Mock the context hook to return undefined providerId for this test only
// Omit providerId to test the ?? 'default' fallback
const spy = vi
.spyOn(useFigmaTokenContextModule, 'useFigmaTokenContext')
.mockReturnValue({
token: null,
fileKey: null,
fallbackFile: mockPublishedVariablesResponse,
parsedFallbackFile: mockPublishedVariablesResponse,
} as ReturnType<typeof useFigmaTokenContextModule.useFigmaTokenContext>)
mockedUseSWR.mockReturnValue({
data: mockPublishedVariablesResponse,
error: null,
isLoading: false,
isValidating: false,
})
renderHook(() => usePublishedVariables())
// Verify the key uses 'default' when providerId is null
expect(mockedUseSWR).toHaveBeenCalledWith(
['fallback-default', 'fallback'],
expect.any(Function),
undefined
)
spy.mockRestore()
})
it('should not affect local variables mocks used by other tests', () => {
expect(
mockLocalVariablesResponse.meta.variables['VariableID:1:1']
).toBeDefined()
})
it('should use live key when fallbackFile exists but parsedFallbackFile is invalid', () => {
const spy = vi
.spyOn(useFigmaTokenContextModule, 'useFigmaTokenContext')
.mockReturnValue({
token: 'test-token',
fileKey: 'test-key',
fallbackFile: '{invalid-json}',
parsedFallbackFile: undefined,
providerId: 'test-provider',
} as ReturnType<typeof useFigmaTokenContextModule.useFigmaTokenContext>)
mockedUseSWR.mockReturnValue({
data: undefined,
error: undefined,
isLoading: false,
isValidating: false,
})
renderHook(() => usePublishedVariables())
expect(mockedUseSWR).toHaveBeenCalledWith(
[
'https://api.figma.com/v1/files/test-key/variables/published',
'test-token',
],
expect.any(Function),
undefined
)
spy.mockRestore()
})
})