// @flow import * as React from 'react'; import { observable } from 'mobx'; import { inject, observer } from 'mobx-react'; import { find } from 'lodash'; import io from 'socket.io-client'; import DocumentsStore from 'stores/DocumentsStore'; import CollectionsStore from 'stores/CollectionsStore'; import MembershipsStore from 'stores/MembershipsStore'; import DocumentPresenceStore from 'stores/DocumentPresenceStore'; import PoliciesStore from 'stores/PoliciesStore'; import ViewsStore from 'stores/ViewsStore'; import AuthStore from 'stores/AuthStore'; import UiStore from 'stores/UiStore'; export const SocketContext: any = React.createContext(); type Props = { children: React.Node, documents: DocumentsStore, collections: CollectionsStore, memberships: MembershipsStore, presence: DocumentPresenceStore, policies: PoliciesStore, views: ViewsStore, auth: AuthStore, ui: UiStore, }; @observer class SocketProvider extends React.Component { @observable socket; componentDidMount() { if (!process.env.WEBSOCKETS_ENABLED) return; this.socket = io(window.location.origin, { path: '/realtime', }); this.socket.authenticated = false; const { auth, ui, documents, collections, memberships, policies, presence, views, } = this.props; if (!auth.token) return; this.socket.on('connect', () => { // immediately send current users token to the websocket backend where it // is verified, if all goes well an 'authenticated' message will be // received in response this.socket.emit('authentication', { token: auth.token, }); }); this.socket.on('disconnect', () => { // when the socket is disconnected we need to clear all presence state as // it's no longer reliable. presence.clear(); }); this.socket.on('authenticated', () => { this.socket.authenticated = true; }); this.socket.on('unauthorized', err => { this.socket.authenticated = false; ui.showToast(err.message); throw err; }); this.socket.on('entities', async event => { if (event.documentIds) { for (const documentDescriptor of event.documentIds) { const documentId = documentDescriptor.id; let document = documents.get(documentId) || {}; if (event.event === 'documents.delete') { const document = documents.get(documentId); if (document) { document.deletedAt = documentDescriptor.updatedAt; } continue; } // if we already have the latest version (it was us that performed // the change) then we don't need to update anything either. const { title, updatedAt } = document; if (updatedAt === documentDescriptor.updatedAt) { continue; } // otherwise, grab the latest version of the document try { document = await documents.fetch(documentId, { force: true, }); } catch (err) { if (err.statusCode === 404 || err.statusCode === 403) { documents.remove(documentId); return; } } // if the title changed then we need to update the collection also if (title !== document.title) { if (!event.collectionIds) { event.collectionIds = []; } const existing = find(event.collectionIds, { id: document.collectionId, }); if (!existing) { event.collectionIds.push({ id: document.collectionId, }); } } // TODO: Move this to the document scene once data loading // has been refactored to be friendlier there. if ( auth.user && documentId === ui.activeDocumentId && document.updatedBy.id !== auth.user.id ) { ui.showToast(`Document updated by ${document.updatedBy.name}`, { timeout: 30 * 1000, action: { text: 'Refresh', onClick: () => window.location.reload(), }, }); } } } if (event.collectionIds) { for (const collectionDescriptor of event.collectionIds) { const collectionId = collectionDescriptor.id; const collection = collections.get(collectionId) || {}; if (event.event === 'collections.delete') { documents.remove(collectionId); continue; } // if we already have the latest version (it was us that performed // the change) then we don't need to update anything either. const { updatedAt } = collection; if (updatedAt === collectionDescriptor.updatedAt) { continue; } try { await collections.fetch(collectionId, { force: true }); } catch (err) { if (err.statusCode === 404 || err.statusCode === 403) { collections.remove(collectionId); documents.removeCollectionDocuments(collectionId); memberships.removeCollectionMemberships(collectionId); return; } } } } }); this.socket.on('documents.star', event => { documents.starredIds.set(event.documentId, true); }); this.socket.on('documents.unstar', event => { documents.starredIds.set(event.documentId, false); }); // received when a user is given access to a collection // if the user is us then we go ahead and load the collection from API. this.socket.on('collections.add_user', event => { if (auth.user && event.userId === auth.user.id) { collections.fetch(event.collectionId, { force: true }); } // Document policies might need updating as the permission changes documents.inCollection(event.collectionId).forEach(document => { policies.remove(document.id); }); }); // received when a user is removed from having access to a collection // to keep state in sync we must update our UI if the user is us, // or otherwise just remove any membership state we have for that user. this.socket.on('collections.remove_user', event => { if (auth.user && event.userId === auth.user.id) { collections.remove(event.collectionId); memberships.removeCollectionMemberships(event.collectionId); documents.removeCollectionDocuments(event.collectionId); } else { memberships.remove(`${event.userId}-${event.collectionId}`); } }); // received a message from the API server that we should request // to join a specific room. Forward that to the ws server. this.socket.on('join', event => { this.socket.emit('join', event); }); // received a message from the API server that we should request // to leave a specific room. Forward that to the ws server. this.socket.on('leave', event => { this.socket.emit('leave', event); }); // received whenever we join a document room, the payload includes // userIds that are present/viewing and those that are editing. this.socket.on('document.presence', event => { presence.init(event.documentId, event.userIds, event.editingIds); }); // received whenever a new user joins a document room, aka they // navigate to / start viewing a document this.socket.on('user.join', event => { presence.touch(event.documentId, event.userId, event.isEditing); views.touch(event.documentId, event.userId); }); // received whenever a new user leaves a document room, aka they // navigate away / stop viewing a document this.socket.on('user.leave', event => { presence.leave(event.documentId, event.userId); views.touch(event.documentId, event.userId); }); // received when another client in a document room wants to change // or update it's presence. Currently the only property is whether // the client is in editing state or not. this.socket.on('user.presence', event => { presence.touch(event.documentId, event.userId, event.isEditing); }); } componentWillUnmount() { if (this.socket) { this.socket.disconnect(); this.socket.authenticated = false; } } render() { return ( {this.props.children} ); } } export default inject( 'auth', 'ui', 'documents', 'collections', 'memberships', 'presence', 'policies', 'views' )(SocketProvider);