Page MenuHomeWickedGov Phorge
Files F4120535

ve.dm.CollabTransportServer.js
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ve.dm.CollabTransportServer.js
View Options

/*!
* VisualEditor collab transport server class.
*
* @copyright See AUTHORS.txt
*/
'use strict';
/**
* Transport server for Socket IO transport
*
* @constructor
* @param {number} startHeight Length of shared completeHistory
*/
ve.dm.CollabTransportServer = function VeDmCollabTransportServer( startHeight ) {
const startTimestamp = Date.now();
this.startHeight = startHeight;
this.protocolServer = new ve.dm.ProtocolServer(
{
startHeight: startHeight,
// The server ID is arbitrary
serverId: 've-collab-server',
load: function () {
return Promise.resolve(
ve.dm.Change.static.deserialize( { transactions: [] } )
);
},
onNewChange: function () {
return Promise.resolve();
}
},
{
/* eslint-disable-next-line no-console */
logServerEvent: ( x ) => console.log( x ),
/* eslint-disable-next-line no-console */
logEvent: ( x ) => console.log( x ),
getRelativeTimestamp: () => Date.now() - startTimestamp
}
);
this.connections = [];
};
OO.initClass( ve.dm.CollabTransportServer );
/**
* Generic connection handler
*
* @param {Object} conn The connection
*/
ve.dm.CollabTransportServer.prototype.onConnection = function ( conn ) {
const context = this.protocolServer.authenticate( 've-collab-doc', null, null ),
connections = this.connections,
server = this.protocolServer,
startHeight = this.startHeight;
connections.push( conn );
context.broadcast = function ( type, data ) {
const serialized = ve.collab.serialize( data );
connections.forEach( ( connection ) => {
connection.send( { type: type, data: serialized } );
} );
};
context.sendAuthor = function ( type, data ) {
const serialized = ve.collab.serialize( data );
conn.send( { type: type, data: serialized } );
};
conn.on( 'data', ( data ) => {
const type = data.type;
if ( type === 'submitChange' ) {
server.onSubmitChange( context, data.data );
} else if ( type === 'changeAuthor' ) {
server.onChangeAuthor( context, data.data );
} else if ( type === 'disconnect' ) {
server.onDisconnect( context, data.data );
} else if ( type === 'logEvent' ) {
// do nothing
} else {
throw new Error( 'Unknown type "' + type + '"' );
}
} );
conn.on( 'open', () => {
server.welcomeClient(
context,
startHeight,
( authorId ) => ve.msg( 'visualeditor-collab-user-placeholder', authorId )
);
} );
};

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 04:05 (4 d, 21 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
63/39/0a063cd37b4acec08e89f15791e2
Default Alt Text
ve.dm.CollabTransportServer.js (2 KB)

Event Timeline