@seafile/sdoc-editor 0.1.118 → 0.1.119

package/dist/basic-sdk/socket/socket-client.js

@@ -25,11 +25,8 @@ var SocketClient = /*#__PURE__*/_createClass(function SocketClient(config) {
         // sync operations or document
         if (_this.isReconnect) {
           _this.isReconnect = false;
-          var serverVersion = result.version;
-          var clientVersion = socketManager.getDocumentVersion();
-          if (serverVersion !== clientVersion) {
-            _this.syncDocumentBySocket();
-          }
+          // The reconnect of socketManager needs to be triggered after entering the room again
+          socketManager.onReconnect(result);
         }
         socketManager.dispatchConnectState('onConnected', result);
         return;
@@ -92,14 +89,14 @@ var SocketClient = /*#__PURE__*/_createClass(function SocketClient(config) {
    * receive remote broadcast operations
    * @param {*} params {operations, version}
    */
-  this.receiveOperations = function (params) {
+  this.onReceiveRemoteOperations = function (params) {
     debug('********* receive operations *********');
     debug('%O', params);
     debug('**************************************');
     var socketManager = SocketManager.getInstance();
-    socketManager.receiveOperations(params);
+    socketManager.onReceiveRemoteOperations(params);
   };
-  this.syncDocumentBySocket = function () {
+  this.getRecentOperations = function () {
     var docUuid = _this.config.docUuid;
     var socketManager = SocketManager.getInstance();
     var clientVersion = socketManager.getDocumentVersion();
@@ -108,7 +105,7 @@ var SocketClient = /*#__PURE__*/_createClass(function SocketClient(config) {
       version: clientVersion
     }, function (result) {
       if (result.success) {
-        socketManager.syncDocumentBySocket(result);
+        socketManager.onGetRecentOperations(result);
       }
     });
   };
@@ -139,7 +136,7 @@ var SocketClient = /*#__PURE__*/_createClass(function SocketClient(config) {
   this.socket.on('connect_error', this.onConnectError);
   this.socket.on('join-room', this.onJoinRoom);
   this.socket.on('leave-room', this.onLeaveRoom);
-  this.socket.on('update-document', this.receiveOperations);
+  this.socket.on('update-document', this.onReceiveRemoteOperations);
   this.socket.on('update-cursor', this.receiveCursorLocation);
   this.socket.io.on('reconnect', this.onReconnect);
   this.socket.io.on('reconnect_attempt', this.onReconnectAttempt);

package/dist/basic-sdk/socket/socket-manager.js

@@ -6,6 +6,18 @@ import { syncRemoteOperations, reExecRevertOperationList, revertOperationList, s
 import SocketClient from './socket-client';
 import debug from '../utils/debug';
 import { deleteCursor } from '../cursor/helper';
+
+//  idle --> sending --> conflict --> idle
+//       --> conflict --> idle
+//       --> disconnect --> conflict --> idle
+//                      --> idle
+var STATE = {
+  IDLE: 'idle',
+  SENDING: 'sending',
+  CONFLICT: 'conflict',
+  DISCONNECT: 'disconnect',
+  NEED_RELOAD: 'need_reload'
+};
 var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, document, config) {
   var _this = this;
   _classCallCheck(this, SocketManager);
@@ -13,7 +25,7 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
     var version = _this.document.version;
     return version;
   };
-  this.addOperations = function (operations) {
+  this.onReceiveLocalOperations = function (operations) {
     _this.pendingOperationList.push(operations);
     if (_this.pendingOperationList.length > 5) {
       _this.dispatchConnectState('pending_operations_exceed_limit');
@@ -21,16 +33,16 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
     _this.sendOperations();
   };
   this.sendOperations = function () {
-    if (_this.isSending || _this.pendingOperationList.length === 0) return;
-    _this.isSending = true;
+    if (_this.state !== STATE.IDLE) return;
+    _this.state = STATE.SENDING;
     _this.sendNextOperations();
   };
   this.sendNextOperations = function () {
+    if (_this.state !== STATE.SENDING) return;
     if (_this.pendingOperationList.length === 0) {
-      _this.isSending = false;
+      _this.state = STATE.IDLE;
       return;
     }
-    if (_this._sendingOperations || _this.disconnect) return;
     _this.dispatchConnectState('is-saving');
     var version = _this.document.version;
     var operations = _this.pendingOperationList.shift();
@@ -40,11 +52,13 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
   };
   this.sendOperationsCallback = function (result) {
     if (result && result.success) {
-      _this._sendingOperations = null;
       var serverVersion = result.version;
       _this.document['version'] = serverVersion;
       var lastSavedAt = new Date().getTime();
       _this.dispatchConnectState('saved', lastSavedAt);
+
+      // send next operations
+      _this._sendingOperations = null;
       _this.sendNextOperations();
       return;
     }
@@ -52,154 +66,82 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
     // Operations are execute failure
     var error_type = result.error_type;
     if (error_type === 'version_behind_server') {
-      var dupSendingOperations = _toConsumableArray(_this._sendingOperations);
       // Put the failed operation into the pending list and re-execute it
-      _this.pendingOperationList.unshift(dupSendingOperations);
+      _this.pendingOperationList.unshift(_toConsumableArray(_this._sendingOperations));
+      _this.state = STATE.CONFLICT;
       var lose_operations = result.lose_operations;
-      _this.execLoseOperations(lose_operations);
+      _this.resolveConflicting(lose_operations);
     } else if (error_type === 'document_content_load_failed') {
-      _this._sendingOperations = null;
       // After a short-term reconnection, the content of the document fails to load
       _this.dispatchConnectState(error_type);
-    } else if (error_type === 'Internal_server_error') {
+
+      // reset sending control
+      _this.state = STATE.NEED_RELOAD;
       _this._sendingOperations = null;
+    } else if (error_type === 'Internal_server_error') {
       _this.dispatchConnectState(error_type);
-    } else if (error_type === 'operation_exec_error') {
-      var _dupSendingOperations = _toConsumableArray(_this._sendingOperations);
+
+      // reset sending control
+      _this.state = STATE.NEED_RELOAD;
       _this._sendingOperations = null;
+    } else if (error_type === 'operation_exec_error') {
       _this.editor.isRemote = true;
-      revertOperationList(_this.editor, [_dupSendingOperations]);
+      var dupSendingOperations = _toConsumableArray(_this._sendingOperations);
+      revertOperationList(_this.editor, [dupSendingOperations]);
 
-      // reset control flag
+      // Set isRemote to false must be in Promise.resolve function, make sure the modification of isRemote is later than the onChange event
       Promise.resolve().then(function (_) {
         _this.editor.isRemote = false;
         _this.dispatchConnectState(error_type);
+
+        // send next operations
+        _this._sendingOperations = null;
         _this.sendNextOperations();
       });
     }
   };
-  this.execLoseOperations = function (loseOperations) {
-    // 1. Revert operations
-    // 1.1 record reverted operationList & clear pendingOperationList
-    _this.revertOperationList = _this.pendingOperationList.slice();
-    _this.pendingOperationList = [];
-
-    // 1.2 Revert operationList
-    debug('revert locale operations: %O', _this.revertOperationList);
-    revertOperationList(_this.editor, _this.revertOperationList);
-    _this.editor.isRemote = true;
-    loseOperations = loseOperations.sort(function (prev, next) {
-      return prev.version - next.version;
-    });
-    debug('Editor isRemote is true: %s', _this.editor.isRemote);
-    while (loseOperations.length > 0) {
-      var operationParams = loseOperations.shift();
-      // 2. execute operations
-      var operations = operationParams.operations,
-        serverVersion = operationParams.version;
-      // 2.1 Update content & version
+  this.onReceiveRemoteOperations = function (params) {
+    // if this.disconnect is true, Then the message sent by the remote end cannot be received
+    if (_this.state !== STATE.IDLE) return;
+    var serverVersion = params.version;
+    var clientVersion = _this.document.version;
+    if (serverVersion === clientVersion + 1) {
+      // update execute remote operations flag
+      _this.editor.isRemote = true;
+      debug('Editor isRemote is true: %s', _this.editor.isRemote);
+      var operations = params.operations;
+      // Update content & version
       debug('execute remote operations: %O', operations);
       syncRemoteOperations(_this.editor, operations);
 
-      // 2.2 Update document
+      // Update document
       _this.document.version = serverVersion;
       _this.document.children = _this.editor.children;
+      Promise.resolve().then(function () {
+        _this.editor.isRemote = false;
+        _this.revertOperationList = [];
+      });
+    } else {
+      // isConflict
+      _this.onConflictHappen();
     }
-
-    // Re-execute undone operations after isRemote is set to false
-    // Need resend this operations to server
-
-    // reset execute remote operations flag
-    _this.editor.isRemote = false;
-    _this.isSending = false;
-    _this._sendingOperations = null;
-
-    // 3. Execute pending operations
-    // 3.1 Re-execute operations
-    debug('Editor isRemote is false: %s', _this.editor.isRemote);
-    debug('Re-execute pending operations, %O', _this.revertOperationList);
-    reExecRevertOperationList(_this.editor, _this.revertOperationList);
-
-    // 3.2 Clear revert operationList
-    _this.revertOperationList = [];
   };
-  this.receiveOperations = function (params) {
-    _this.remoteOperationsList.push(params);
-    // sort operations by version
-    if (_this.remoteOperationsList.length > 1) {
-      _this.remoteOperationsList = _this.remoteOperationsList.sort(function (prev, next) {
-        return prev.version - next.version;
-      });
-      var clientVersion = _this.document.version;
-      _this.remoteOperationsList = _this.remoteOperationsList.filter(function (item) {
-        return item.version > clientVersion;
-      });
+  this.onReconnect = function (result) {
+    var serverVersion = result.version;
+    var clientVersion = _this.getDocumentVersion();
+    // The client version is inconsistent with the server version, and the latest operations performed by the server need to be loaded
+    if (serverVersion !== clientVersion) {
+      _this.onConflictHappen();
     }
-    if (_this.isExecRemoteOperations || _this._sendingOperations) return;
 
-    // update execute remote operations flag
-    _this.isExecRemoteOperations = true;
-    _this.editor.isRemote = true;
-    _this.execRemoteOperations();
+    // The version consistency indicates that there is no conflict and no processing is required
+    _this.state = STATE.IDLE;
   };
-  this.execRemoteOperations = function () {
-    if (_this.remoteOperationsList.length > 0) {
-      var params = _this.remoteOperationsList.shift();
-      var serverVersion = params.version;
-      var clientVersion = _this.document.version;
-      if (serverVersion === clientVersion + 1) {
-        // When performing remote operations, the revert operation is only required for the first time
-        if (_this.revertOperationList.length === 0) {
-          // 1. Revert operations
-          // 1.1 record reverted operationList & clear pendingOperationList
-          _this.revertOperationList = _this.pendingOperationList.slice();
-          _this.pendingOperationList = [];
-
-          // 1.2 Revert operationList
-          debug('revert locale operations: %O', _this.revertOperationList);
-          revertOperationList(_this.editor, _this.revertOperationList);
-        }
-
-        // 2. execute operations
-        var operations = params.operations;
-        // 2.1 Update content & version
-        debug('execute remote operations: %O', operations);
-        syncRemoteOperations(_this.editor, operations);
-
-        // 2.2 Update document
-        _this.document.version = serverVersion;
-        _this.document.children = _this.editor.children;
-
-        // Execute next operations
-        if (_this.remoteOperationsList.length > 0) {
-          _this.execRemoteOperations();
-          return;
-        }
-
-        // Re-execute undone operations after isRemote is set to false
-        // Need resend this operations to server
-        Promise.resolve().then(function (_) {
-          // reset execute remote operations flag
-          _this.isExecRemoteOperations = false;
-          _this.editor.isRemote = false;
-
-          // 3. Execute pending operations
-          // 3.1 Re-execute operations
-          debug('Editor isRemote is false: %s', _this.editor.isRemote);
-          debug('Re-execute pending operations, %O', _this.revertOperationList);
-          reExecRevertOperationList(_this.editor, _this.revertOperationList);
-
-          // 3.2 Clear revert operationList
-          _this.revertOperationList = [];
-        });
-      } else {
-        // conflict:
-        // remote operations is not empty, waiting until remote operations all executed
-        debug('remote operations is not empty, and local version is not match remote version.');
-      }
-    }
+  this.onConflictHappen = function () {
+    _this.state = STATE.CONFLICT;
+    _this.socketClient.getRecentOperations();
   };
-  this.syncDocumentBySocket = function (result) {
+  this.onGetRecentOperations = function (result) {
     var mode = result.mode,
       content = result.content;
     // sync document
@@ -213,6 +155,8 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
       _this.editor.isRemote = true;
       _this.editor.onChange();
       _this.editor.isRemote = false;
+      _this.state = STATE.IDLE;
+      _this._sendingOperations = null;
 
       // 2. exec client operationList
       var pendingOperationList = _this.pendingOperationList.slice();
@@ -224,14 +168,67 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
       return;
     }
 
-    // sync operations
+    // mode os operations: sync operations
     // content is [{version, operations}, {version, operations}, ...]
-    _this.remoteOperationsList = content;
-
-    // update execute remote operations flag
-    _this.isExecRemoteOperations = true;
+    var loseOperations = content;
+    _this.resolveConflicting(loseOperations);
+  };
+  this.resolveConflicting = function (loseOperations) {
     _this.editor.isRemote = true;
-    _this.execRemoteOperations();
+    debug('Editor isRemote is true: %s', _this.editor.isRemote);
+    if (_this.pendingOperationList.length !== 0) {
+      // 1. Revert operations
+      // 1.1 record reverted operationList & clear pendingOperationList
+      _this.revertOperationList = _this.pendingOperationList.slice();
+      _this.pendingOperationList = [];
+
+      // 1.2 Revert operationList
+      debug('revert locale operations: %O', _this.revertOperationList);
+      revertOperationList(_this.editor, _this.revertOperationList);
+    }
+    loseOperations = loseOperations.sort(function (prev, next) {
+      return prev.version - next.version;
+    });
+    debug('lose operations length: %s', loseOperations.length);
+    while (loseOperations.length > 0) {
+      var operationParams = loseOperations.shift();
+      // 2. execute operations
+      var operations = operationParams.operations,
+        serverVersion = operationParams.version;
+      // 2.1 Update content & version
+      debug('execute lose operations: %O', operations);
+      syncRemoteOperations(_this.editor, operations);
+
+      // 2.2 Update document
+      _this.document.version = serverVersion;
+      _this.document.children = _this.editor.children;
+    }
+    if (_this.revertOperationList.length === 0) {
+      Promise.resolve().then(function () {
+        _this.editor.isRemote = false;
+        _this.state = STATE.IDLE;
+        _this._sendingOperations = null;
+        _this.revertOperationList = [];
+      });
+      return;
+    }
+
+    // Set isRemote to false must be in Promise.resolve function, make sure the modification of isRemote is later than the onChange event
+    Promise.resolve().then(function () {
+      // reset execute remote operations flag
+      _this.editor.isRemote = false;
+      _this.state = STATE.IDLE;
+      _this._sendingOperations = null;
+
+      // 3. Execute pending operations
+      // 3.1 Re-execute operations
+      debug('Editor isRemote is false: %s', _this.editor.isRemote);
+      debug('Re-execute pending operations, %O', _this.revertOperationList);
+      reExecRevertOperationList(_this.editor, _this.revertOperationList);
+
+      // 3.2 Clear revert operationList
+      _this.revertOperationList = [];
+    });
   };
   this.sendCursorLocation = function (location) {
     _this.socketClient.sendCursorLocation(location);
@@ -253,16 +250,12 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
         _this.pendingOperationList.unshift(_this._sendingOperations.slice());
         _this._sendingOperations = null;
       }
-      _this.isSending = false;
-      _this.disconnect = true;
+      _this.state = STATE.DISCONNECT;
 
       // Update saved state
       var lastSavedAt = new Date().getTime();
       _this.dispatchConnectState('saved', lastSavedAt);
     }
-    if (type === 'reconnect') {
-      _this.disconnect = false;
-    }
     _this.eventBus.dispatch(type, message);
   };
   this.closeSocketConnect = function () {
@@ -271,11 +264,11 @@ var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, doc
   this.editor = editor;
   this.document = document;
   this.socketClient = new SocketClient(config);
-  this.isSending = false;
   this.pendingOperationList = []; // Two-dimensional arrays： [operations, operations, ...]
   this.remoteOperationsList = []; // Same with pending operations
   this.revertOperationList = [];
   this.eventBus = EventBus.getInstance();
+  this.state = STATE.IDLE;
 });
 SocketManager.getInstance = function (editor, document, socketConfig) {
   if (SocketManager.instance) {

package/dist/basic-sdk/socket/with-socket-io.js

@@ -30,7 +30,7 @@ var withSocketIO = function withSocketIO(editor, options) {
         var updateOperations = operations.filter(function (operation) {
           return operation.type !== 'set_selection';
         });
-        _socketManager.addOperations && _socketManager.addOperations(updateOperations);
+        _socketManager.onReceiveLocalOperations(updateOperations);
       }
       _socketManager.sendCursorLocation(editor.selection);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seafile/sdoc-editor",
-  "version": "0.1.118",
+  "version": "0.1.119",
   "private": false,
   "description": "This is a sdoc editor",
   "main": "dist/index.js",