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 | import { forEach, SubstanceError as Err } from '../util' import Server from './Server' import CollabEngine from './CollabEngine' /* Implements Substance CollabServer API. */ class CollabServer extends Server { constructor(config) { super(config) this.scope = 'substance/collab' this.configurator = config.configurator this.documentEngine = this.configurator.getDocumentEngine() this.collabEngine = new CollabEngine(this.documentEngine) } /* Send an error */ _error(req, res, err) { console.error(err) res.error({ scope: this.scope, type: 'error', error: { name: req.message.type+'Error', cause: { name: err.name } }, documentId: req.message.documentId }) this.next(req, res) } /* Configurable authenticate method */ authenticate(req, res) { if (this.config.authenticate) { this.config.authenticate(req, (err, session) => { if (err) { console.error(err) // Send the response with some delay this._error(req, res, new Err('AuthenticationError', {cause: err})) return } req.setAuthenticated(session) this.next(req, res) }) } else { super.authenticate.apply(this, arguments); } } /* Configureable enhanceRequest method */ enhanceRequest(req, res) { if (this.config.enhanceRequest) { this.config.enhanceRequest(req, (err) => { if (err) { console.error('enhanceRequest returned an error', err) this._error(req, res, err) return } req.setEnhanced() this.next(req, res) }) } else { super.enhanceRequest.apply(this, arguments) } } /* Called when a collaborator disconnects */ onDisconnect(collaboratorId) { // console.info('CollabServer.onDisconnect ', collaboratorId) // All documents collaborator is currently collaborating to let documentIds = this.collabEngine.getDocumentIds(collaboratorId) documentIds.forEach(function(documentId) { this._disconnectDocument(collaboratorId, documentId) }.bind(this)) } /* Execute CollabServer API method based on msg.type */ execute(req, res) { let msg = req.message let method = this[msg.type] if (method) { method.call(this, req, res) } else { console.error('Method', msg.type, 'not implemented for CollabServer') } } /* Client initiates a sync */ sync(req, res) { let args = req.message // Takes an optional argument collaboratorInfo this.collabEngine.sync(args, (err, result) => { // result: changes, version, change if (err) { this._error(req, res, err) return } // Get enhanced collaborators (e.g. including some app-specific user-info) let collaborators = this.collabEngine.getCollaborators(args.documentId, args.collaboratorId) // Send the response res.send({ scope: this.scope, type: 'syncDone', documentId: args.documentId, version: result.version, serverChange: result.serverChange, }) // We need to broadcast a new change if there is one forEach(collaborators, (collaborator) => { this.send(collaborator.collaboratorId, { scope: this.scope, type: 'update', documentId: args.documentId, version: result.version, change: result.change }) }) this.next(req, res) }) } /* Expcicit disconnect. User wants to exit a collab session. */ disconnect(req, res) { let args = req.message let collaboratorId = args.collaboratorId let documentId = args.documentId this._disconnectDocument(collaboratorId, documentId) // Notify client that disconnect has completed successfully res.send({ scope: this.scope, type: 'disconnectDone', documentId: args.documentId }) this.next(req, res) } _disconnectDocument(collaboratorId, documentId) { // Exit from each document session this.collabEngine.disconnect({ documentId: documentId, collaboratorId: collaboratorId }) } } export default CollabServer |