forked from rinafcode/teachLink_web
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuseSubscription.ts
More file actions
359 lines (316 loc) · 10.1 KB
/
Copy pathuseSubscription.ts
File metadata and controls
359 lines (316 loc) · 10.1 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
'use client';
import { useEffect, useRef, useState, useCallback, Dispatch, SetStateAction } from 'react';
import { ApolloClient, DocumentNode, ApolloError, OperationVariables } from '@apollo/client';
import {
ConnectionState,
getConnectionManager,
isConnectionError,
formatSubscriptionError,
} from '@/lib/graphql/subscriptions';
export { ConnectionState, getConnectionManager, isConnectionError, formatSubscriptionError };
/**
* Subscription variable constraints
*/
export interface UseSubscriptionOptions {
/** Skip subscription execution */
skip?: boolean;
/** Callback when subscription connects */
onConnect?: () => void;
/** Callback when subscription disconnects */
onDisconnect?: () => void;
/** Callback when subscription error occurs */
onError?: (error: ApolloError) => void;
/** Callback when data updates */
onData?: (data: any) => void;
/** Retry failed subscriptions */
shouldResubscribe?: boolean;
/** Cache policy for subscription data */
cachePolicy?: 'cache-first' | 'cache-and-network' | 'network-only' | 'no-cache';
}
/**
* Result of a subscription hook
*/
export interface UseSubscriptionResult<TData> {
/** Current subscription data */
data: TData | undefined;
/** Loading state (true initially or during reconnection) */
loading: boolean;
/** Current error if any */
error: ApolloError | SubscriptionError | null;
/** Current connection state */
connectionState: ConnectionState;
/** Error message formatted for UI */
errorMessage: string | null;
/** Resubscribe to the subscription */
resubscribe: () => void;
/** Manually update data */
updateData: Dispatch<SetStateAction<TData | undefined>>;
}
/**
* Custom error for subscription-specific issues
*/
export class SubscriptionError extends Error {
constructor(
public reason: 'connection' | 'subscription' | 'timeout' | 'unknown',
message: string,
) {
super(message);
this.name = 'SubscriptionError';
}
}
/**
* Hook for managing GraphQL subscriptions
* Handles connection lifecycle, reconnection, and error recovery
*
* @example
* ```tsx
* const { data, loading, error, connectionState } = useSubscription(
* POSTS_SUBSCRIPTION,
* {
* variables: { limit: 10 },
* onData: (data) => console.log('New post:', data),
* },
* apolloClient,
* );
* ```
*/
export function useSubscription<TData = any, TVariables extends OperationVariables = any>(
subscription: DocumentNode,
options: UseSubscriptionOptions & { variables?: TVariables } = {},
client?: ApolloClient<any>,
): UseSubscriptionResult<TData> {
const {
skip = false,
onConnect,
onDisconnect,
onError,
onData,
shouldResubscribe = true,
} = options;
const [data, setData] = useState<TData | undefined>();
const [loading, setLoading] = useState(!skip);
const [error, setError] = useState<ApolloError | SubscriptionError | null>(null);
const [connectionState, setConnectionState] = useState<ConnectionState>(
ConnectionState.DISCONNECTED,
);
const subscriptionRef = useRef<any>(null);
const unsubscribeRef = useRef<(() => void) | null>(null);
const connectionListenerRef = useRef<(() => void) | null>(null);
const reconnectTimeoutRef = useRef<NodeJS.Timeout | null>(null);
const attemptCountRef = useRef(0);
const handleConnectionStateChange = useCallback(
(event: any) => {
setConnectionState(event.state);
if (event.state === ConnectionState.CONNECTED) {
onConnect?.();
} else if (event.state === ConnectionState.DISCONNECTED) {
onDisconnect?.();
}
},
[onConnect, onDisconnect],
);
/**
* Execute the subscription
*/
const executeSubscription = useCallback(async () => {
if (!client || skip) {
return;
}
try {
setLoading(true);
setError(null);
subscriptionRef.current = client.subscribe({
query: subscription,
variables: options.variables,
});
unsubscribeRef.current = subscriptionRef.current.subscribe({
next: (response: any) => {
attemptCountRef.current = 0; // Reset on successful data
setLoading(false);
// Extract data from response
const resultData = response.data;
setData(resultData);
onData?.(resultData);
},
error: (err: any) => {
setLoading(false);
const apolloError =
err instanceof ApolloError ? err : new ApolloError({ errorMessage: err.message });
setError(apolloError);
if (isConnectionError(err)) {
setConnectionState(ConnectionState.ERROR);
if (shouldResubscribe && attemptCountRef.current < 3) {
attemptCountRef.current++;
// Exponential backoff for reconnection
const delay = Math.min(1000 * Math.pow(2, attemptCountRef.current), 10000);
reconnectTimeoutRef.current = setTimeout(() => {
executeSubscription();
}, delay);
}
}
onError?.(apolloError);
},
complete: () => {
setLoading(false);
// Handle completion if needed
},
});
} catch (err) {
const wrappedError =
err instanceof ApolloError
? err
: new SubscriptionError('unknown', err instanceof Error ? err.message : 'Unknown error');
setError(wrappedError);
setLoading(false);
onError?.(wrappedError as any);
}
}, [client, skip, subscription, options.variables, onData, onError, shouldResubscribe]);
/**
* Cleanup function
*/
const cleanup = useCallback(() => {
if (unsubscribeRef.current) {
if (typeof unsubscribeRef.current === 'function') {
(unsubscribeRef.current as any)();
} else if ((unsubscribeRef.current as any).unsubscribe) {
(unsubscribeRef.current as any).unsubscribe();
}
unsubscribeRef.current = null;
}
if (reconnectTimeoutRef.current) {
clearTimeout(reconnectTimeoutRef.current);
reconnectTimeoutRef.current = null;
}
if (connectionListenerRef.current) {
connectionListenerRef.current();
connectionListenerRef.current = null;
}
}, []);
/**
* Setup subscription on mount and when dependencies change
*/
useEffect(() => {
const manager = getConnectionManager();
// Listen to connection state changes
connectionListenerRef.current = manager.onStateChange(handleConnectionStateChange);
// Set initial connection state
setConnectionState(manager.getState());
// Execute subscription if not skipped
if (!skip && client) {
executeSubscription();
}
// Cleanup on unmount or when dependencies change
return cleanup;
}, [client, skip, executeSubscription, cleanup, handleConnectionStateChange]);
/**
* Resubscribe to the subscription
*/
const resubscribe = useCallback(() => {
cleanup();
attemptCountRef.current = 0;
executeSubscription();
}, [cleanup, executeSubscription]);
/**
* Format error message
*/
const errorMessage =
error instanceof ApolloError
? error.message || 'Subscription error'
: error instanceof SubscriptionError
? formatSubscriptionError(error)
: (error as any)?.message || null;
return {
data,
loading,
error,
connectionState,
errorMessage,
resubscribe,
updateData: setData,
};
}
/**
* Hook for listening to connection state changes without data subscription
* Useful for implementing real-time status indicators
*
* @example
* ```tsx
* const state = useSubscriptionConnection();
* return <StatusIndicator state={state} />;
* ```
*/
export function useSubscriptionConnection(): ConnectionState {
const [state, setState] = useState<ConnectionState>(ConnectionState.DISCONNECTED);
useEffect(() => {
const manager = getConnectionManager();
setState(manager.getState());
const unsubscribe = manager.onStateChange((event) => {
setState(event.state);
});
return unsubscribe;
}, []);
return state;
}
/**
* Hook for managing multiple subscriptions with fallback to polling
*/
export interface UsePollableSubscriptionOptions<T> extends UseSubscriptionOptions {
/** Polling interval in milliseconds (fallback when subscription unavailable) */
pollIntervalMs?: number;
/** Fallback fetch function for polling */
pollFn?: () => Promise<T>;
}
export function usePollableSubscription<TData = any, TVariables extends OperationVariables = any>(
subscription: DocumentNode,
options: UsePollableSubscriptionOptions<TData> & { variables?: TVariables } = {},
client?: ApolloClient<any>,
): UseSubscriptionResult<TData> {
const { pollIntervalMs = 5000, pollFn } = options;
const [isPolling, setIsPolling] = useState(false);
const pollTimeoutRef = useRef<NodeJS.Timeout | null>(null);
const subscriptionResult = useSubscription<TData, TVariables>(subscription, options, client);
const { connectionState, updateData } = subscriptionResult;
/**
* Fallback to polling when subscription unavailable
*/
useEffect(() => {
// If subscription is working, don't poll
if (connectionState === ConnectionState.CONNECTED) {
setIsPolling(false);
if (pollTimeoutRef.current) {
clearTimeout(pollTimeoutRef.current);
pollTimeoutRef.current = null;
}
return;
}
// Start polling if connection is down and poll function available
if (
pollFn &&
(connectionState === ConnectionState.DISCONNECTED ||
connectionState === ConnectionState.ERROR)
) {
setIsPolling(true);
const poll = async () => {
try {
const data = await pollFn();
updateData(data);
} catch (err) {
console.error('Poll failed:', err);
}
pollTimeoutRef.current = setTimeout(poll, pollIntervalMs);
};
// Start first poll after delay
poll();
}
return () => {
if (pollTimeoutRef.current) {
clearTimeout(pollTimeoutRef.current);
pollTimeoutRef.current = null;
}
};
}, [pollFn, pollIntervalMs, connectionState, updateData]);
return {
...subscriptionResult,
loading: subscriptionResult.loading || isPolling,
};
}