forked from Creditra/Creditra-Frontend
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWalletContext.test.tsx
More file actions
506 lines (420 loc) · 19 KB
/
Copy pathWalletContext.test.tsx
File metadata and controls
506 lines (420 loc) · 19 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
/**
* WalletContext — auto-reconnect tests
*
* Cover:
* 1. No stored wallet → status stays 'disconnected', no reconnect attempt.
* 2. Stored wallet found → status transitions to 'reconnecting' on mount.
* 3. Reconnect succeeds within timeout → status becomes 'connected',
* reconnectTimedOut stays false.
* 4. Reconnect times out → reconnectTimedOut becomes true while still
* 'reconnecting'.
* 5. Reconnect succeeds after timeout → reconnectTimedOut resets to false,
* status becomes 'connected'.
* 6. Reconnect fails → status becomes 'error', reconnectTimedOut resets.
* 7. dismissReconnectBanner → sets reconnectTimedOut to false without
* changing status.
* 8. retryReconnect → re-runs the reconnect flow (status back to
* 'reconnecting', fresh timeout window).
* 9. retryReconnect is a no-op when no stored wallet preference exists.
* 10. disconnect → clears wallet, sets status to 'disconnected', resets
* reconnectTimedOut.
* 11. User-initiated connect() → uses 'connecting' (not 'reconnecting')
* and does not trip the timeout banner.
* 12. Timeout timer is cleared on unmount (no state-update-on-unmount warning).
*/
import {
render,
screen,
act,
waitFor,
} from '@testing-library/react';
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { WalletProvider, useWallet } from './WalletContext';
import * as walletUtils from '../utils/wallet';
// ─── Helpers ─────────────────────────────────────────────────────────────────
const STORED_WALLET = {
type: 'freighter' as const,
publicKey: 'GABC123...',
network: 'PUBLIC',
};
/**
* Test consumer that renders all relevant context values as data-testid
* attributes so tests can assert on them without reaching into state.
*/
function WalletContextConsumer() {
const {
status,
wallet,
error,
reconnectTimedOut,
isRemembered,
dismissReconnectBanner,
retryReconnect,
disconnect,
forgetRememberedChoice,
connect,
} = useWallet();
return (
<div>
<span data-testid="status">{status}</span>
<span data-testid="wallet">{wallet?.publicKey ?? 'null'}</span>
<span data-testid="error">{error?.type ?? 'null'}</span>
<span data-testid="reconnect-timed-out">{String(reconnectTimedOut)}</span>
<span data-testid="is-remembered">{String(isRemembered)}</span>
<button data-testid="dismiss-btn" onClick={dismissReconnectBanner}>
Dismiss
</button>
<button data-testid="retry-btn" onClick={retryReconnect}>
Retry
</button>
<button data-testid="disconnect-btn" onClick={disconnect}>
Disconnect
</button>
<button data-testid="forget-btn" onClick={forgetRememberedChoice}>
Forget choice
</button>
<button data-testid="connect-btn" data-remember="false" onClick={() => connect('freighter')}>
Connect no-remember
</button>
<button
data-testid="connect-remember-btn"
onClick={() => connect('freighter', { remember: true })}
>
Connect with remember
</button>
<button
data-testid="connect-bool-btn"
onClick={() => connect('albedo', { remember: false })}
>
Connect with remember=false
</button>
</div>
);
}
function renderProvider(timeoutMs = 200) {
return render(
<WalletProvider timeoutMs={timeoutMs}>
<WalletContextConsumer />
</WalletProvider>,
);
}
// ─── Setup / Teardown ─────────────────────────────────────────────────────────
beforeEach(() => {
vi.useFakeTimers();
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(null);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
vi.spyOn(walletUtils, 'saveWalletPreference').mockImplementation(() => {});
vi.spyOn(walletUtils, 'disconnectWallet').mockImplementation(() => {});
vi.spyOn(walletUtils, 'recordRecentWallet').mockImplementation(() => {});
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
vi.spyOn(walletUtils, 'setWalletRemembered').mockImplementation(() => {});
// Make sure legacy + new storage keys are clean so isRemembered defaults
// to false on every test.
window.localStorage.clear();
});
afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
});
// ─── Tests ────────────────────────────────────────────────────────────────────
describe('WalletContext — auto-reconnect gating with remember flag', () => {
// Gating: when `creditra-wallet-remember` is missing/false we must NOT
// kick off a reconnect, even if `wallet_info` is present (legacy users).
it('does NOT auto-reconnect when remembered flag is false', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
renderProvider();
await act(async () => { vi.runAllTimers(); });
expect(screen.getByTestId('status').textContent).toBe('disconnected');
expect(walletUtils.connectWallet).not.toHaveBeenCalled();
});
// When both flags are true we should reconnect normally.
it('auto-reconnects when both wallet_info AND remembered are present', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider(500);
await act(async () => { vi.advanceTimersByTime(10); });
expect(screen.getByTestId('status').textContent).toBe('connected');
expect(screen.getByTestId('is-remembered').textContent).toBe('true');
});
// After auto-reconnect we consider the user to have opted-in (they did, last
// session), so isRemembered mirrors the persisted truth.
it('surfaces isRemembered=true after auto-reconnect', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider(500);
await act(async () => { vi.advanceTimersByTime(10); });
expect(screen.getByTestId('is-remembered').textContent).toBe('true');
});
});
describe('WalletContext — opt-in connect', () => {
it('defaults to NOT remembering when options.remember is omitted', async () => {
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider();
await act(async () => {
screen.getByTestId('connect-btn').click();
});
await waitFor(() => {
expect(screen.getByTestId('status').textContent).toBe('connected');
});
expect(walletUtils.setWalletRemembered).toHaveBeenCalledWith(false);
expect(screen.getByTestId('is-remembered').textContent).toBe('false');
expect(walletUtils.recordRecentWallet).toHaveBeenCalledWith('freighter');
});
it('passes remember=true through to setWalletRemembered', async () => {
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider();
await act(async () => {
screen.getByTestId('connect-remember-btn').click();
});
await waitFor(() => {
expect(screen.getByTestId('status').textContent).toBe('connected');
});
expect(walletUtils.setWalletRemembered).toHaveBeenCalledWith(true);
expect(screen.getByTestId('is-remembered').textContent).toBe('true');
expect(walletUtils.recordRecentWallet).toHaveBeenCalledWith('freighter');
});
it('treats remember=false explicitly as opting out', async () => {
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue({
...STORED_WALLET,
type: 'albedo',
publicKey: 'GDEF',
});
renderProvider();
await act(async () => {
screen.getByTestId('connect-bool-btn').click();
});
await waitFor(() => {
expect(screen.getByTestId('status').textContent).toBe('connected');
});
expect(walletUtils.setWalletRemembered).toHaveBeenCalledWith(false);
expect(walletUtils.recordRecentWallet).toHaveBeenCalledWith('albedo');
});
it('does not write persisted remember state on connection failure', async () => {
vi.spyOn(walletUtils, 'connectWallet').mockRejectedValue({
type: 'connection_failed',
message: 'fail',
});
renderProvider();
await act(async () => {
screen.getByTestId('connect-remember-btn').click();
});
await waitFor(() => {
expect(screen.getByTestId('status').textContent).toBe('error');
});
// setWalletRemembered must never be called on a failed connect
expect(walletUtils.setWalletRemembered).not.toHaveBeenCalled();
});
});
describe('WalletContext — forgetRememberedChoice', () => {
it('clears the remember flag without changing connection status', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider(500);
await act(async () => { vi.advanceTimersByTime(10); });
expect(screen.getByTestId('status').textContent).toBe('connected');
await act(async () => {
screen.getByTestId('forget-btn').click();
});
// Status stays connected (we do NOT disconnect).
expect(screen.getByTestId('status').textContent).toBe('connected');
expect(walletUtils.setWalletRemembered).toHaveBeenCalledWith(false);
expect(screen.getByTestId('is-remembered').textContent).toBe('false');
});
it('forgetRememberedChoice on a fresh provider is safe (no stored wallet)', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(null);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
renderProvider();
await act(async () => { vi.runAllTimers(); });
await act(async () => {
screen.getByTestId('forget-btn').click();
});
expect(walletUtils.setWalletRemembered).toHaveBeenCalledWith(false);
expect(screen.getByTestId('status').textContent).toBe('disconnected');
});
});
describe('WalletContext — disconnect clears remember state', () => {
it('clears the remember flag via disconnect', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'isWalletRemembered').mockReturnValue(true);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider(500);
await act(async () => { vi.advanceTimersByTime(10); });
expect(screen.getByTestId('is-remembered').textContent).toBe('true');
await act(async () => {
screen.getByTestId('disconnect-btn').click();
});
expect(screen.getByTestId('status').textContent).toBe('disconnected');
expect(screen.getByTestId('is-remembered').textContent).toBe('false');
expect(walletUtils.disconnectWallet).toHaveBeenCalled();
});
});
describe('WalletContext — auto-reconnect', () => {
// 1
it('stays disconnected when no wallet is stored', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(null);
renderProvider();
await act(async () => { vi.runAllTimers(); });
expect(screen.getByTestId('status').textContent).toBe('disconnected');
expect(walletUtils.connectWallet).not.toHaveBeenCalled();
});
// 2
it('transitions to "reconnecting" immediately when a stored wallet is found', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
// connectWallet never resolves in this test (pending promise)
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
renderProvider();
// After the initial render (before any timers), status should be reconnecting
await act(async () => {});
expect(screen.getByTestId('status').textContent).toBe('reconnecting');
});
// 3
it('transitions to "connected" when reconnect succeeds within the timeout', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'connectWallet').mockResolvedValue(STORED_WALLET);
renderProvider(500); // 500 ms timeout
await act(async () => {
vi.advanceTimersByTime(10); // resolve immediately, well within timeout
});
expect(screen.getByTestId('status').textContent).toBe('connected');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
expect(screen.getByTestId('wallet').textContent).toBe(STORED_WALLET.publicKey);
});
// 4
it('sets reconnectTimedOut=true when timeout fires before reconnect resolves', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
// Keep the connect pending
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
renderProvider(300); // 300 ms timeout
await act(async () => {
vi.advanceTimersByTime(301); // fire the timeout
});
expect(screen.getByTestId('status').textContent).toBe('reconnecting');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('true');
});
// 5
it('resets reconnectTimedOut to false when reconnect eventually succeeds', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
let resolveConnect!: (v: typeof STORED_WALLET) => void;
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(
new Promise((res) => { resolveConnect = res; }),
);
renderProvider(200);
// Fire the timeout
await act(async () => { vi.advanceTimersByTime(201); });
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('true');
// Now let the connect finish
await act(async () => { resolveConnect(STORED_WALLET); });
await waitFor(() => {
expect(screen.getByTestId('status').textContent).toBe('connected');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
});
});
// 6
it('transitions to "error" and resets reconnectTimedOut when reconnect fails', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'connectWallet').mockRejectedValue({
type: 'connection_failed',
message: 'Extension unavailable',
});
renderProvider(500);
await act(async () => { vi.runAllTimers(); });
expect(screen.getByTestId('status').textContent).toBe('error');
expect(screen.getByTestId('error').textContent).toBe('connection_failed');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
});
// 7
it('dismissReconnectBanner clears reconnectTimedOut without changing status', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
renderProvider(200);
await act(async () => { vi.advanceTimersByTime(201); });
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('true');
await act(async () => {
screen.getByTestId('dismiss-btn').click();
});
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
// Status unchanged — reconnect still in flight
expect(screen.getByTestId('status').textContent).toBe('reconnecting');
});
// 8
it('retryReconnect re-runs reconnect with a fresh timeout window', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
let callCount = 0;
vi.spyOn(walletUtils, 'connectWallet').mockImplementation(
() => new Promise((_, reject) => {
callCount++;
// First call → reject immediately; second call → stay pending
if (callCount === 1) reject({ type: 'connection_failed', message: 'fail' });
}),
);
renderProvider(200);
// Wait for first reconnect to fail
await act(async () => { vi.runAllTimers(); });
expect(screen.getByTestId('status').textContent).toBe('error');
// Now let the second call stay pending
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
await act(async () => {
screen.getByTestId('retry-btn').click();
});
expect(screen.getByTestId('status').textContent).toBe('reconnecting');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
});
// 9
it('retryReconnect is a no-op when no stored wallet exists', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(null);
renderProvider();
await act(async () => { vi.runAllTimers(); });
expect(screen.getByTestId('status').textContent).toBe('disconnected');
await act(async () => {
screen.getByTestId('retry-btn').click();
});
expect(walletUtils.connectWallet).not.toHaveBeenCalled();
expect(screen.getByTestId('status').textContent).toBe('disconnected');
});
// 10
it('disconnect clears wallet, resets status and reconnectTimedOut', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
renderProvider(200);
await act(async () => { vi.advanceTimersByTime(201); });
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('true');
await act(async () => {
screen.getByTestId('disconnect-btn').click();
});
expect(screen.getByTestId('status').textContent).toBe('disconnected');
expect(screen.getByTestId('wallet').textContent).toBe('null');
expect(screen.getByTestId('reconnect-timed-out').textContent).toBe('false');
expect(walletUtils.disconnectWallet).toHaveBeenCalled();
});
// 11
it('user-initiated connect() uses "connecting" state, not "reconnecting"', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(null);
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
renderProvider(200);
await act(async () => {
screen.getByTestId('connect-btn').click();
});
expect(screen.getByTestId('status').textContent).toBe('connecting');
});
// 12
it('cleans up timeout timer on unmount (no setState-on-unmounted warning)', async () => {
vi.spyOn(walletUtils, 'getStoredWallet').mockReturnValue(STORED_WALLET);
vi.spyOn(walletUtils, 'connectWallet').mockReturnValue(new Promise(() => {}));
const consoleSpy = vi.spyOn(console, 'error');
const { unmount } = renderProvider(200);
await act(async () => {
// Unmount before the timeout fires
unmount();
vi.advanceTimersByTime(500); // fire timers post-unmount
});
// React's "Can't perform a React state update on an unmounted component"
// warning (pre-18 wording) must not appear.
expect(consoleSpy).not.toHaveBeenCalledWith(
expect.stringContaining('unmounted'),
);
});
});