2020-08-11 11:24:59 -05:00
|
|
|
// @ts-check
|
|
|
|
|
2019-12-04 05:45:49 -06:00
|
|
|
import WebSocketClient from '@gamestdio/websocket';
|
2017-02-03 17:34:31 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
/**
|
|
|
|
* @type {WebSocketClient | undefined}
|
|
|
|
*/
|
|
|
|
let sharedConnection;
|
2018-05-27 12:42:45 -05:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
/**
|
|
|
|
* @typedef Subscription
|
|
|
|
* @property {string} channelName
|
|
|
|
* @property {Object.<string, string>} params
|
|
|
|
* @property {function(): void} onConnect
|
|
|
|
* @property {function(StreamEvent): void} onReceive
|
|
|
|
* @property {function(): void} onDisconnect
|
|
|
|
*/
|
2020-01-21 11:57:21 -06:00
|
|
|
|
2020-11-23 10:35:14 -06:00
|
|
|
/**
|
2020-08-11 11:24:59 -05:00
|
|
|
* @typedef StreamEvent
|
|
|
|
* @property {string} event
|
|
|
|
* @property {object} payload
|
|
|
|
*/
|
2018-05-27 12:42:45 -05:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
/**
|
|
|
|
* @type {Array.<Subscription>}
|
|
|
|
*/
|
|
|
|
const subscriptions = [];
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
/**
|
|
|
|
* @type {Object.<string, number>}
|
|
|
|
*/
|
|
|
|
const subscriptionCounters = {};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {Subscription} subscription
|
|
|
|
*/
|
|
|
|
const addSubscription = subscription => {
|
|
|
|
subscriptions.push(subscription);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {Subscription} subscription
|
|
|
|
*/
|
|
|
|
const removeSubscription = subscription => {
|
|
|
|
const index = subscriptions.indexOf(subscription);
|
|
|
|
|
|
|
|
if (index !== -1) {
|
|
|
|
subscriptions.splice(index, 1);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {Subscription} subscription
|
|
|
|
*/
|
|
|
|
const subscribe = ({ channelName, params, onConnect }) => {
|
|
|
|
const key = channelNameWithInlineParams(channelName, params);
|
|
|
|
|
|
|
|
subscriptionCounters[key] = subscriptionCounters[key] || 0;
|
|
|
|
|
|
|
|
if (subscriptionCounters[key] === 0) {
|
|
|
|
sharedConnection.send(JSON.stringify({ type: 'subscribe', stream: channelName, ...params }));
|
|
|
|
}
|
|
|
|
|
|
|
|
subscriptionCounters[key] += 1;
|
|
|
|
onConnect();
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {Subscription} subscription
|
|
|
|
*/
|
|
|
|
const unsubscribe = ({ channelName, params, onDisconnect }) => {
|
|
|
|
const key = channelNameWithInlineParams(channelName, params);
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
subscriptionCounters[key] = subscriptionCounters[key] || 1;
|
|
|
|
|
|
|
|
if (subscriptionCounters[key] === 1 && sharedConnection.readyState === WebSocketClient.OPEN) {
|
|
|
|
sharedConnection.send(JSON.stringify({ type: 'unsubscribe', stream: channelName, ...params }));
|
|
|
|
}
|
|
|
|
|
|
|
|
subscriptionCounters[key] -= 1;
|
|
|
|
onDisconnect();
|
|
|
|
};
|
|
|
|
|
|
|
|
const sharedCallbacks = {
|
|
|
|
connected () {
|
|
|
|
subscriptions.forEach(subscription => subscribe(subscription));
|
|
|
|
},
|
|
|
|
|
|
|
|
received (data) {
|
|
|
|
const { stream } = data;
|
|
|
|
|
|
|
|
subscriptions.filter(({ channelName, params }) => {
|
|
|
|
const streamChannelName = stream[0];
|
|
|
|
|
|
|
|
if (stream.length === 1) {
|
|
|
|
return channelName === streamChannelName;
|
2017-11-15 09:04:15 -06:00
|
|
|
}
|
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
const streamIdentifier = stream[1];
|
2019-03-07 15:17:52 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
if (['hashtag', 'hashtag:local'].includes(channelName)) {
|
|
|
|
return channelName === streamChannelName && params.tag === streamIdentifier;
|
|
|
|
} else if (channelName === 'list') {
|
|
|
|
return channelName === streamChannelName && params.list === streamIdentifier;
|
|
|
|
}
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
return false;
|
|
|
|
}).forEach(subscription => {
|
|
|
|
subscription.onReceive(data);
|
|
|
|
});
|
|
|
|
},
|
2018-05-27 12:42:45 -05:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
disconnected () {
|
2020-08-24 07:06:45 -05:00
|
|
|
subscriptions.forEach(subscription => unsubscribe(subscription));
|
2020-08-11 11:24:59 -05:00
|
|
|
},
|
|
|
|
|
|
|
|
reconnected () {
|
|
|
|
},
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {string} channelName
|
|
|
|
* @param {Object.<string, string>} params
|
|
|
|
* @return {string}
|
|
|
|
*/
|
|
|
|
const channelNameWithInlineParams = (channelName, params) => {
|
|
|
|
if (Object.keys(params).length === 0) {
|
|
|
|
return channelName;
|
|
|
|
}
|
|
|
|
|
|
|
|
return `${channelName}&${Object.keys(params).map(key => `${key}=${params[key]}`).join('&')}`;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {string} channelName
|
|
|
|
* @param {Object.<string, string>} params
|
|
|
|
* @param {function(Function, Function): { onConnect: (function(): void), onReceive: (function(StreamEvent): void), onDisconnect: (function(): void) }} callbacks
|
|
|
|
* @return {function(): void}
|
|
|
|
*/
|
|
|
|
export const connectStream = (channelName, params, callbacks) => (dispatch, getState) => {
|
|
|
|
const streamingAPIBaseURL = getState().getIn(['meta', 'streaming_api_base_url']);
|
|
|
|
const accessToken = getState().getIn(['meta', 'access_token']);
|
|
|
|
const { onConnect, onReceive, onDisconnect } = callbacks(dispatch, getState);
|
|
|
|
|
|
|
|
// If we cannot use a websockets connection, we must fall back
|
|
|
|
// to using individual connections for each channel
|
|
|
|
if (!streamingAPIBaseURL.startsWith('ws')) {
|
|
|
|
const connection = createConnection(streamingAPIBaseURL, accessToken, channelNameWithInlineParams(channelName, params), {
|
|
|
|
connected () {
|
|
|
|
onConnect();
|
2017-11-15 09:04:15 -06:00
|
|
|
},
|
|
|
|
|
|
|
|
received (data) {
|
|
|
|
onReceive(data);
|
|
|
|
},
|
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
disconnected () {
|
|
|
|
onDisconnect();
|
|
|
|
},
|
2019-03-07 15:17:52 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
reconnected () {
|
2019-03-07 15:17:52 -06:00
|
|
|
onConnect();
|
2017-11-15 09:04:15 -06:00
|
|
|
},
|
|
|
|
});
|
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
return () => {
|
|
|
|
connection.close();
|
2017-11-15 09:04:15 -06:00
|
|
|
};
|
2020-08-11 11:24:59 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
const subscription = {
|
|
|
|
channelName,
|
|
|
|
params,
|
|
|
|
onConnect,
|
|
|
|
onReceive,
|
|
|
|
onDisconnect,
|
|
|
|
};
|
|
|
|
|
|
|
|
addSubscription(subscription);
|
|
|
|
|
|
|
|
// If a connection is open, we can execute the subscription right now. Otherwise,
|
|
|
|
// because we have already registered it, it will be executed on connect
|
|
|
|
|
|
|
|
if (!sharedConnection) {
|
|
|
|
sharedConnection = /** @type {WebSocketClient} */ (createConnection(streamingAPIBaseURL, accessToken, '', sharedCallbacks));
|
|
|
|
} else if (sharedConnection.readyState === WebSocketClient.OPEN) {
|
|
|
|
subscribe(subscription);
|
|
|
|
}
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
return () => {
|
|
|
|
removeSubscription(subscription);
|
|
|
|
unsubscribe(subscription);
|
2017-11-15 09:04:15 -06:00
|
|
|
};
|
2020-08-11 11:24:59 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
const KNOWN_EVENT_TYPES = [
|
|
|
|
'update',
|
|
|
|
'delete',
|
|
|
|
'notification',
|
|
|
|
'conversation',
|
|
|
|
'filters_changed',
|
|
|
|
'encrypted_message',
|
|
|
|
'announcement',
|
|
|
|
'announcement.delete',
|
|
|
|
'announcement.reaction',
|
|
|
|
];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {MessageEvent} e
|
|
|
|
* @param {function(StreamEvent): void} received
|
|
|
|
*/
|
|
|
|
const handleEventSourceMessage = (e, received) => {
|
|
|
|
received({
|
|
|
|
event: e.type,
|
|
|
|
payload: e.data,
|
|
|
|
});
|
|
|
|
};
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
/**
|
|
|
|
* @param {string} streamingAPIBaseURL
|
|
|
|
* @param {string} accessToken
|
|
|
|
* @param {string} channelName
|
|
|
|
* @param {{ connected: Function, received: function(StreamEvent): void, disconnected: Function, reconnected: Function }} callbacks
|
|
|
|
* @return {WebSocketClient | EventSource}
|
|
|
|
*/
|
|
|
|
const createConnection = (streamingAPIBaseURL, accessToken, channelName, { connected, received, disconnected, reconnected }) => {
|
|
|
|
const params = channelName.split('&');
|
2017-11-15 09:04:15 -06:00
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
channelName = params.shift();
|
2020-01-21 11:57:21 -06:00
|
|
|
|
|
|
|
if (streamingAPIBaseURL.startsWith('ws')) {
|
|
|
|
const ws = new WebSocketClient(`${streamingAPIBaseURL}/api/v1/streaming/?${params.join('&')}`, accessToken);
|
|
|
|
|
|
|
|
ws.onopen = connected;
|
|
|
|
ws.onmessage = e => received(JSON.parse(e.data));
|
|
|
|
ws.onclose = disconnected;
|
|
|
|
ws.onreconnect = reconnected;
|
|
|
|
|
|
|
|
return ws;
|
|
|
|
}
|
|
|
|
|
2020-08-11 11:24:59 -05:00
|
|
|
channelName = channelName.replace(/:/g, '/');
|
|
|
|
|
|
|
|
if (channelName.endsWith(':media')) {
|
|
|
|
channelName = channelName.replace('/media', '');
|
|
|
|
params.push('only_media=true');
|
|
|
|
}
|
|
|
|
|
2020-01-21 11:57:21 -06:00
|
|
|
params.push(`access_token=${accessToken}`);
|
2020-08-11 11:24:59 -05:00
|
|
|
|
|
|
|
const es = new EventSource(`${streamingAPIBaseURL}/api/v1/streaming/${channelName}?${params.join('&')}`);
|
2020-01-21 11:57:21 -06:00
|
|
|
|
|
|
|
es.onopen = () => {
|
2020-08-24 07:06:45 -05:00
|
|
|
connected();
|
2020-01-21 11:57:21 -06:00
|
|
|
};
|
2020-08-11 11:24:59 -05:00
|
|
|
|
|
|
|
KNOWN_EVENT_TYPES.forEach(type => {
|
|
|
|
es.addEventListener(type, e => handleEventSourceMessage(/** @type {MessageEvent} */ (e), received));
|
|
|
|
});
|
|
|
|
|
|
|
|
es.onerror = /** @type {function(): void} */ (disconnected);
|
2017-02-03 17:34:31 -06:00
|
|
|
|
2020-01-21 11:57:21 -06:00
|
|
|
return es;
|
2017-02-03 17:34:31 -06:00
|
|
|
};
|