1 | const axios = require('axios');
|
2 | const EventEmitter = require('events');
|
3 | const TweetParser = require('./lib/parse_stream');
|
4 | const { finished } = require('stream');
|
5 | const RATE_LIMIT_WINDOW = 15 * 60 * 1000;
|
6 | const DATA_TIMEOUT = 30000;
|
7 |
|
8 |
|
9 |
|
10 |
|
11 |
|
12 | function isTimedout(error) {
|
13 | return error.code === 'ECONNABORTED' || error.isTimeout
|
14 | }
|
15 |
|
16 |
|
17 |
|
18 |
|
19 |
|
20 | function retriableStatus(resp) {
|
21 | let status = resp.status;
|
22 | const valid_statuses = [429, 420, 504, 503, 502, 500];
|
23 | return valid_statuses.includes(status);
|
24 | }
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
30 | function defaultNaN(num, def) {
|
31 | if(isNaN(num)) {
|
32 | return def;
|
33 | } else {
|
34 | return num;
|
35 | }
|
36 | }
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 | const sleep = (milliseconds) => { return new Promise(resolve => setTimeout(resolve, milliseconds)); }
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | function rateLimiting(resp, last_retry) {
|
52 | const now = Date.now()
|
53 | const fallback_rate = now + RATE_LIMIT_WINDOW;
|
54 | let backoff, ratelimit, remaining;
|
55 |
|
56 | if(resp && resp.headers) {
|
57 | const headers = resp.headers;
|
58 | remaining = defaultNaN(parseInt(headers['x-rate-limit-remaining']), 0);
|
59 | ratelimit = defaultNaN(parseInt(headers['x-rate-limit-reset']), fallback_rate / 1000);
|
60 | ratelimit = new Date(ratelimit * 1000);
|
61 | } else {
|
62 | remaining = -1;
|
63 | ratelimit = fallback_rate;
|
64 | }
|
65 |
|
66 | if(remaining === 0 || resp && (resp.status === 429 || resp.status === 420)) {
|
67 | backoff = Math.min(ratelimit - now, RATE_LIMIT_WINDOW);
|
68 | } else {
|
69 | let delta = Math.min(RATE_LIMIT_WINDOW, (now - last_retry)) / RATE_LIMIT_WINDOW;
|
70 |
|
71 | backoff = Math.max(Math.floor(delta * RATE_LIMIT_WINDOW), 1000);
|
72 | }
|
73 |
|
74 | return backoff;
|
75 | }
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 | class StreamClient extends EventEmitter {
|
93 | |
94 |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 | constructor({token, timeout = DATA_TIMEOUT, stream_timeout = DATA_TIMEOUT}) {
|
100 | super();
|
101 | this.timeout = timeout;
|
102 | this.twitrClient = axios.create({
|
103 | baseURL: 'https://api.twitter.com/2',
|
104 | headers: { 'Authorization': `Bearer ${token}`},
|
105 | timeout: timeout
|
106 | });
|
107 | this.stream_timeout = stream_timeout;
|
108 | }
|
109 |
|
110 | |
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 | async connect({ params = {}, max_reconnects = -1, writeable_stream = null} = {}) {
|
121 | let reconnects = -1;
|
122 | let last_try = Date.now();
|
123 | let last_error;
|
124 |
|
125 | while(max_reconnects === -1 || reconnects <= max_reconnects)
|
126 | {
|
127 | let disconnected = false;
|
128 | try
|
129 | {
|
130 | reconnects += 1;
|
131 | disconnected = await this.buildConnection(params, writeable_stream);
|
132 |
|
133 | if(disconnected) {
|
134 | Promise.resolve();
|
135 | }
|
136 | }
|
137 | catch(request_error)
|
138 | {
|
139 | last_error = request_error;
|
140 | let resp = request_error.response;
|
141 | if(axios.isCancel(request_error)) {
|
142 | return Promise.resolve();
|
143 | } else if(max_reconnects !== -1 && reconnects >= max_reconnects) {
|
144 | break;
|
145 | } else if(isTimedout(request_error) || resp && retriableStatus(resp)) {
|
146 | let timeout_wait = rateLimiting(resp, last_try);
|
147 | this.emit('reconnect', request_error, timeout_wait);
|
148 | await sleep(timeout_wait);
|
149 | } else {
|
150 | let error = new Error(`${request_error.message}`);
|
151 | return Promise.reject(error);
|
152 | }
|
153 | }
|
154 |
|
155 | last_try = Date.now();
|
156 | }
|
157 |
|
158 | let reject_error = new Error(`Max reconnects exceeded (${reconnects}):\n${last_error.message}`);
|
159 | reject_error.reconnects = reconnects;
|
160 | return Promise.reject(reject_error);
|
161 | }
|
162 |
|
163 | |
164 |
|
165 |
|
166 |
|
167 | disconnect() {
|
168 | if(this.cancelToken) {
|
169 | this.cancelToken.cancel('Disconnecting stream');
|
170 | this.cancelToken = null;
|
171 | }
|
172 | this.emit('disconnected');
|
173 | }
|
174 |
|
175 | |
176 |
|
177 |
|
178 |
|
179 |
|
180 | buildStreamPromise(resp, writable_stream) {
|
181 | return new Promise((resolve, reject) => {
|
182 | this.emit('connected');
|
183 | let error;
|
184 | let disconnected = false;
|
185 | let hose = resp.data;
|
186 | const timer = setTimeout(() => {
|
187 | const e = new Error(`Timed out after ${this.stream_timeout / 1000} seconds of no data`);
|
188 | e.isTimeout = true;
|
189 | hose.emit('error', e);
|
190 | }, this.stream_timeout);
|
191 | const jsonStream = hose.pipe(new TweetParser({
|
192 | emitter: this,
|
193 | timer: timer
|
194 | }));
|
195 | const streams = [hose, jsonStream];
|
196 | if(writable_stream) {
|
197 | streams.push(jsonStream.pipe(writable_stream));
|
198 | }
|
199 | const s_cleanup_fns = streams.map((s) => {
|
200 | return finished(s, (err) => {
|
201 | if(!s.destroyed) {
|
202 | s.destroy(err);
|
203 | }
|
204 | });
|
205 | });
|
206 | const stream_cleanup = () => s_cleanup_fns.forEach((fn) => fn());
|
207 | const disconnect_cb = () => {
|
208 | disconnected = true;
|
209 | hose.destroy();
|
210 | };
|
211 | this.once('disconnected', disconnect_cb);
|
212 | hose.on('close', () => {
|
213 | clearTimeout(timer);
|
214 | stream_cleanup();
|
215 | this.removeListener('disconnected', disconnect_cb)
|
216 | if(!error) {
|
217 | this.emit('close');
|
218 | resolve(disconnected);
|
219 | }
|
220 | });
|
221 | hose.on('error', stream_error => {
|
222 | error = stream_error;
|
223 | if(!hose.destroyed) {
|
224 | hose.destroy(error);
|
225 | }
|
226 | reject(error);
|
227 | });
|
228 | });
|
229 | }
|
230 |
|
231 | |
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 | buildConnection(params, writable_stream) {
|
238 | this.disconnect();
|
239 | this.cancelToken = axios.CancelToken.source();
|
240 |
|
241 | let streamReq = this.twitrClient.get('tweets/sample/stream', {
|
242 | responseType: 'stream',
|
243 | cancelToken: this.cancelToken.token,
|
244 | params: params,
|
245 | decompress: true,
|
246 | });
|
247 |
|
248 | return streamReq.then((resp) => {
|
249 | return this.buildStreamPromise(resp, writable_stream);
|
250 | });
|
251 | }
|
252 | }
|
253 |
|
254 | module.exports = StreamClient;
|