-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
useSubscription.ts
183 lines (166 loc) · 5.72 KB
/
useSubscription.ts
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
import '../../utilities/globals';
import { useState, useRef, useEffect } from 'react';
import { DocumentNode } from 'graphql';
import { TypedDocumentNode } from '@graphql-typed-document-node/core';
import { invariant } from '../../utilities/globals'
import { equal } from '@wry/equality';
import { DocumentType, verifyDocumentType } from '../parser';
import {
SubscriptionHookOptions,
SubscriptionResult
} from '../types/types';
import { OperationVariables } from '../../core';
import { useApolloClient } from './useApolloClient';
export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(
subscription: DocumentNode | TypedDocumentNode<TData, TVariables>,
options?: SubscriptionHookOptions<TData, TVariables>,
) {
const hasIssuedDeprecationWarningRef = useRef(false);
const client = useApolloClient(options?.client);
verifyDocumentType(subscription, DocumentType.Subscription);
const [result, setResult] = useState<SubscriptionResult<TData>>({
loading: !options?.skip,
error: void 0,
data: void 0,
variables: options?.variables,
});
if (!hasIssuedDeprecationWarningRef.current) {
hasIssuedDeprecationWarningRef.current = true;
if (options?.onSubscriptionData) {
invariant.warn(
options.onData
? "'useSubscription' supports only the 'onSubscriptionData' or 'onData' option, but not both. Only the 'onData' option will be used."
: "'onSubscriptionData' is deprecated and will be removed in a future major version. Please use the 'onData' option instead."
);
}
if (options?.onSubscriptionComplete) {
invariant.warn(
options.onComplete
? "'useSubscription' supports only the 'onSubscriptionComplete' or 'onComplete' option, but not both. Only the 'onComplete' option will be used."
: "'onSubscriptionComplete' is deprecated and will be removed in a future major version. Please use the 'onComplete' option instead."
);
}
}
const [observable, setObservable] = useState(() => {
if (options?.skip) {
return null;
}
return client.subscribe({
query: subscription,
variables: options?.variables,
fetchPolicy: options?.fetchPolicy,
context: options?.context,
});
});
const canResetObservableRef = useRef(false);
useEffect(() => {
return () => {
canResetObservableRef.current = true;
};
}, []);
const ref = useRef({ client, subscription, options });
useEffect(() => {
let shouldResubscribe = options?.shouldResubscribe;
if (typeof shouldResubscribe === 'function') {
shouldResubscribe = !!shouldResubscribe(options!);
}
if (options?.skip) {
if (!options?.skip !== !ref.current.options?.skip || canResetObservableRef.current) {
setResult({
loading: false,
data: void 0,
error: void 0,
variables: options?.variables,
});
setObservable(null);
canResetObservableRef.current = false;
}
} else if (
(shouldResubscribe !== false &&
(client !== ref.current.client ||
subscription !== ref.current.subscription ||
options?.fetchPolicy !== ref.current.options?.fetchPolicy ||
!options?.skip !== !ref.current.options?.skip ||
!equal(options?.variables, ref.current.options?.variables))) ||
canResetObservableRef.current
) {
setResult({
loading: true,
data: void 0,
error: void 0,
variables: options?.variables,
});
setObservable(client.subscribe({
query: subscription,
variables: options?.variables,
fetchPolicy: options?.fetchPolicy,
context: options?.context,
}));
canResetObservableRef.current = false;
}
Object.assign(ref.current, { client, subscription, options });
}, [client, subscription, options, canResetObservableRef.current]);
useEffect(() => {
if (!observable) {
return;
}
let subscriptionStopped = false;
const subscription = observable.subscribe({
next(fetchResult) {
if (subscriptionStopped) {
return;
}
const result = {
loading: false,
// TODO: fetchResult.data can be null but SubscriptionResult.data
// expects TData | undefined only
data: fetchResult.data!,
error: void 0,
variables: options?.variables,
};
setResult(result);
if (ref.current.options?.onData) {
ref.current.options.onData({
client,
data: result
});
} else if (ref.current.options?.onSubscriptionData) {
ref.current.options.onSubscriptionData({
client,
subscriptionData: result
});
}
},
error(error) {
if (!subscriptionStopped) {
setResult({
loading: false,
data: void 0,
error,
variables: options?.variables,
});
ref.current.options?.onError?.(error);
};
},
complete() {
if (!subscriptionStopped) {
if (ref.current.options?.onComplete) {
ref.current.options.onComplete();
} else if (ref.current.options?.onSubscriptionComplete) {
ref.current.options.onSubscriptionComplete();
}
}
},
});
return () => {
// immediately stop receiving subscription values, but do not unsubscribe
// until after a short delay in case another useSubscription hook is
// reusing the same underlying observable and is about to subscribe
subscriptionStopped = true;
setTimeout(() => {
subscription.unsubscribe();
});
};
}, [observable]);
return result;
}