const logger = require('logger-sharelatex') const metrics = require('@overleaf/metrics') const settings = require('@overleaf/settings') const OError = require('@overleaf/o-error') const ClientMap = new Map() // for each redis client, store a Map of subscribed channels (channelname -> subscribe promise) // Manage redis pubsub subscriptions for individual projects and docs, ensuring // that we never subscribe to a channel multiple times. The socket.io side is // handled by RoomManager. module.exports = { getClientMapEntry(rclient) { // return the per-client channel map if it exists, otherwise create and // return an empty map for the client. return ( ClientMap.get(rclient) || ClientMap.set(rclient, new Map()).get(rclient) ) }, subscribe(rclient, baseChannel, id) { const clientChannelMap = this.getClientMapEntry(rclient) const channel = `${baseChannel}:${id}` const actualSubscribe = function () { // subscribe is happening in the foreground and it should reject return rclient .subscribe(channel) .finally(function () { if (clientChannelMap.get(channel) === subscribePromise) { clientChannelMap.delete(channel) } }) .then(function () { logger.debug({ channel }, 'subscribed to channel') metrics.inc(`subscribe.${baseChannel}`) }) .catch(function (err) { logger.error({ channel, err }, 'failed to subscribe to channel') metrics.inc(`subscribe.failed.${baseChannel}`) // add context for the stack-trace at the call-site throw new OError('failed to subscribe to channel', { channel, }).withCause(err) }) } const pendingActions = clientChannelMap.get(channel) || Promise.resolve() const subscribePromise = pendingActions.then( actualSubscribe, actualSubscribe ) clientChannelMap.set(channel, subscribePromise) logger.debug({ channel }, 'planned to subscribe to channel') return subscribePromise }, unsubscribe(rclient, baseChannel, id) { const clientChannelMap = this.getClientMapEntry(rclient) const channel = `${baseChannel}:${id}` const actualUnsubscribe = function () { // unsubscribe is happening in the background, it should not reject return rclient .unsubscribe(channel) .finally(function () { if (clientChannelMap.get(channel) === unsubscribePromise) { clientChannelMap.delete(channel) } }) .then(function () { logger.debug({ channel }, 'unsubscribed from channel') metrics.inc(`unsubscribe.${baseChannel}`) }) .catch(function (err) { logger.error({ channel, err }, 'unsubscribed from channel') metrics.inc(`unsubscribe.failed.${baseChannel}`) }) } const pendingActions = clientChannelMap.get(channel) || Promise.resolve() const unsubscribePromise = pendingActions.then( actualUnsubscribe, actualUnsubscribe ) clientChannelMap.set(channel, unsubscribePromise) logger.debug({ channel }, 'planned to unsubscribe from channel') return unsubscribePromise }, publish(rclient, baseChannel, id, data) { let channel metrics.summary(`redis.publish.${baseChannel}`, data.length) if (id === 'all' || !settings.publishOnIndividualChannels) { channel = baseChannel } else { channel = `${baseChannel}:${id}` } // we publish on a different client to the subscribe, so we can't // check for the channel existing here rclient.publish(channel, data) }, }