v13.0.0-9 -- distribution files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yjs",
-  "version": "13.0.0-12",
+  "version": "13.0.0-9",
   "description": "A framework for real-time p2p shared editing on any data",
   "main": "./y.node.js",
   "browser": "./y.js",

src/Connector.js

@@ -43,12 +43,10 @@ export default function extendConnector (Y/* :any */) {
         this.setUserId(Y.utils.generateUserId())
       }
     }
-
     reconnect () {
       this.log('reconnecting..')
       return this.y.db.startGarbageCollector()
     }
-
     disconnect () {
       this.log('discronnecting..')
       this.connections = new Map()
@@ -58,16 +56,13 @@ export default function extendConnector (Y/* :any */) {
       this.y.db.stopGarbageCollector()
       return this.y.db.whenTransactionsFinished()
     }
-
     repair () {
       this.log('Repairing the state of Yjs. This can happen if messages get lost, and Yjs detects that something is wrong. If this happens often, please report an issue here: https://github.com/y-js/yjs/issues')
+      this.connections.forEach(user => { user.isSynced = false })
       this.isSynced = false
-      this.connections.forEach((user, userId) => {
+      this.currentSyncTarget = null
-        user.isSynced = false
+      this.findNextSyncTarget()
-        this._syncWithUser(userId)
-      })
     }
-
     setUserId (userId) {
       if (this.userId == null) {
         if (!Number.isInteger(userId)) {
@@ -82,21 +77,20 @@ export default function extendConnector (Y/* :any */) {
         return null
       }
     }
-
     onUserEvent (f) {
       this.userEventListeners.push(f)
     }
-
     removeUserEventListener (f) {
       this.userEventListeners = this.userEventListeners.filter(g => f !== g)
     }
-
     userLeft (user) {
       if (this.connections.has(user)) {
         this.log('%s: User left %s', this.userId, user)
         this.connections.delete(user)
-        // check if isSynced event can be sent now
+        if (user === this.currentSyncTarget) {
-        this._setSyncedWith(null)
+          this.currentSyncTarget = null
+          this.findNextSyncTarget()
+        }
         for (var f of this.userEventListeners) {
           f({
             action: 'userLeft',
@@ -105,7 +99,7 @@ export default function extendConnector (Y/* :any */) {
         }
       }
     }
-    userJoined (user, role, auth) {
+    userJoined (user, role) {
       if (role == null) {
         throw new Error('You must specify the role of the joined user!')
       }
@@ -118,7 +112,7 @@ export default function extendConnector (Y/* :any */) {
         isSynced: false,
         role: role,
         processAfterAuth: [],
-        auth: auth || null,
+        auth: null,
         receivedSyncStep2: false
       })
       let defer = {}
@@ -131,7 +125,9 @@ export default function extendConnector (Y/* :any */) {
           role: role
         })
       }
-      this._syncWithUser(user)
+      if (this.currentSyncTarget == null) {
+        this.findNextSyncTarget()
+      }
     }
     // Execute a function _when_ we are connected.
     // If not connected, wait until connected
@@ -142,25 +138,39 @@ export default function extendConnector (Y/* :any */) {
         this.whenSyncedListeners.push(f)
       }
     }
-    _syncWithUser (userid) {
+    findNextSyncTarget () {
-      if (this.role === 'slave') {
+      if (this.currentSyncTarget != null || this.role === 'slave') {
         return // "The current sync has not finished or this is controlled by a master!"
       }
-      sendSyncStep1(this, userid)
+
-    }
+      var syncUser = null
-    _fireIsSyncedListeners () {
+      for (var [uid, user] of this.connections) {
-      this.y.db.whenTransactionsFinished().then(() => {
+        if (!user.isSynced) {
-        if (!this.isSynced) {
+          syncUser = uid
-          this.isSynced = true
+          break
-          // It is safer to remove this!
-          // TODO: remove: yield * this.garbageCollectAfterSync()
-          // call whensynced listeners
-          for (var f of this.whenSyncedListeners) {
-            f()
-          }
-          this.whenSyncedListeners = []
         }
-      })
+      }
+      var conn = this
+      if (syncUser != null) {
+        this.currentSyncTarget = syncUser
+        sendSyncStep1(this, syncUser)
+      } else {
+        if (!conn.isSynced) {
+          this.y.db.requestTransaction(function * () {
+            if (!conn.isSynced) {
+              // it is crucial that isSynced is set at the time garbageCollectAfterSync is called
+              conn.isSynced = true
+              // It is safer to remove this!
+              // TODO: remove: yield * this.garbageCollectAfterSync()
+              // call whensynced listeners
+              for (var f of conn.whenSyncedListeners) {
+                f()
+              }
+              conn.whenSyncedListeners = []
+            }
+          })
+        }
+      }
     }
     send (uid, buffer) {
       if (!(buffer instanceof ArrayBuffer || buffer instanceof Uint8Array)) {
@@ -212,10 +222,10 @@ export default function extendConnector (Y/* :any */) {
     */
     receiveMessage (sender, buffer) {
       if (!(buffer instanceof ArrayBuffer || buffer instanceof Uint8Array)) {
-        return Promise.reject(new Error('Expected Message to be an ArrayBuffer or Uint8Array!'))
+        throw new Error('Expected Message to be an ArrayBuffer or Uint8Array!')
       }
       if (sender === this.userId) {
-        return Promise.resolve()
+        return
       }
       let decoder = new BinaryDecoder(buffer)
       let encoder = new BinaryEncoder()
@@ -234,33 +244,29 @@ export default function extendConnector (Y/* :any */) {
       if (messageType === 'sync step 1' || messageType === 'sync step 2') {
         let auth = decoder.readVarUint()
         if (senderConn.auth == null) {
-          senderConn.processAfterAuth.push([messageType, senderConn, decoder, encoder, sender])
+          senderConn.processAfterAuth.push([sender, buffer])
+
           // check auth
           return this.checkAuth(auth, this.y, sender).then(authPermissions => {
-            if (senderConn.auth == null) {
+            senderConn.auth = authPermissions
-              senderConn.auth = authPermissions
+            this.y.emit('userAuthenticated', {
-              this.y.emit('userAuthenticated', {
+              user: senderConn.uid,
-                user: senderConn.uid,
+              auth: authPermissions
-                auth: authPermissions
+            })
-              })
+            return senderConn.syncStep2.promise
+          }).then(() => {
+            if (senderConn.processAfterAuth == null) {
+              return Promise.resolve()
             }
             let messages = senderConn.processAfterAuth
-            senderConn.processAfterAuth = []
+            senderConn.processAfterAuth = null
-
+            return Promise.all(messages.map(m =>
-            return messages.reduce((p, m) =>
+              this.receiveMessage(m[0], m[1])
-              p.then(() => this.computeMessage(m[0], m[1], m[2], m[3], m[4]))
+            ))
-            , Promise.resolve())
           })
         }
       }
-      if (senderConn.auth != null) {
-        return this.computeMessage(messageType, senderConn, decoder, encoder, sender)
-      } else {
-        senderConn.processAfterAuth.push([messageType, senderConn, decoder, encoder, sender])
-      }
-    }
 
-    computeMessage (messageType, senderConn, decoder, encoder, sender) {
       if (messageType === 'sync step 1' && (senderConn.auth === 'write' || senderConn.auth === 'read')) {
         // cannot wait for sync step 1 to finish, because we may wait for sync step 2 in sync step 1 (->lock)
         computeMessageSyncStep1(decoder, encoder, this, senderConn, sender)
@@ -270,20 +276,19 @@ export default function extendConnector (Y/* :any */) {
       } else if (messageType === 'update' && senderConn.auth === 'write') {
         return computeMessageUpdate(decoder, encoder, this, senderConn, sender)
       } else {
-        return Promise.reject(new Error('Unable to receive message'))
+        Promise.reject(new Error('Unable to receive message'))
       }
     }
-
     _setSyncedWith (user) {
-      if (user != null) {
+      var conn = this.connections.get(user)
-        this.connections.get(user).isSynced = true
+      if (conn != null) {
+        conn.isSynced = true
       }
-      let conns = Array.from(this.connections.values())
+      if (user === this.currentSyncTarget) {
-      if (conns.length > 0 && conns.every(u => u.isSynced)) {
+        this.currentSyncTarget = null
-        this._fireIsSyncedListeners()
+        this.findNextSyncTarget()
       }
     }
-
     /*
       Currently, the HB encodes operations as JSON. For the moment I want to keep it
       that way. Maybe we support encoding in the HB as XML in the future, but for now I don't want

src/MessageHandler.js

@@ -92,30 +92,27 @@ export function computeMessageSyncStep1 (decoder, encoder, conn, senderConn, sen
     conn.y.destroy()
   }
 
-  return conn.y.db.whenTransactionsFinished().then(() => {
+  // send sync step 2
-    // send sync step 2
+  conn.y.db.requestTransaction(function * () {
-    conn.y.db.requestTransaction(function * () {
+    encoder.writeVarString('sync step 2')
-      encoder.writeVarString('sync step 2')
+    encoder.writeVarString(conn.authInfo || '')
-      encoder.writeVarString(conn.authInfo || '')
 
-      if (preferUntransformed) {
+    if (preferUntransformed) {
-        encoder.writeUint8(1)
+      encoder.writeUint8(1)
-        yield * this.writeOperationsUntransformed(encoder)
+      yield * this.writeOperationsUntransformed(encoder)
-      } else {
+    } else {
-        encoder.writeUint8(0)
+      encoder.writeUint8(0)
-        yield * this.writeOperations(encoder, decoder)
+      yield * this.writeOperations(encoder, decoder)
-      }
+    }
 
-      yield * this.writeDeleteSet(encoder)
+    yield * this.writeDeleteSet(encoder)
-      conn.send(senderConn.uid, encoder.createBuffer())
+    conn.send(senderConn.uid, encoder.createBuffer())
-      senderConn.receivedSyncStep2 = true
+    senderConn.receivedSyncStep2 = true
-    })
-    return conn.y.db.whenTransactionsFinished().then(() => {
-      if (conn.role === 'slave') {
-        sendSyncStep1(conn, sender)
-      }
-    })
   })
+  if (conn.role === 'slave') {
+    sendSyncStep1(conn, sender)
+  }
+  return conn.y.db.whenTransactionsFinished()
 }
 
 export function logSS (decoder, strBuilder) {

tests-lib/helper.js

@@ -141,7 +141,7 @@ export async function initArrays (t, opts) {
     let connOpts
     if (i === 0) {
       // Only one instance can gc!
-      dbOpts = Object.assign({ gc: false }, opts.db)
+      dbOpts = Object.assign({ gc: true }, opts.db)
       connOpts = Object.assign({ role: 'master' }, connector)
     } else {
       dbOpts = Object.assign({ gc: false }, opts.db)

y.node.js

@@ -1,7 +1,7 @@
 
 /**
  * yjs - A framework for real-time p2p shared editing on any data
- * @version v13.0.0-12
+ * @version v13.0.0-9
  * @license MIT
  */
 
@@ -506,30 +506,27 @@ function computeMessageSyncStep1 (decoder, encoder, conn, senderConn, sender) {
     conn.y.destroy();
   }
 
-  return conn.y.db.whenTransactionsFinished().then(() => {
+  // send sync step 2
-    // send sync step 2
+  conn.y.db.requestTransaction(function * () {
-    conn.y.db.requestTransaction(function * () {
+    encoder.writeVarString('sync step 2');
-      encoder.writeVarString('sync step 2');
+    encoder.writeVarString(conn.authInfo || '');
-      encoder.writeVarString(conn.authInfo || '');
 
-      if (preferUntransformed) {
+    if (preferUntransformed) {
-        encoder.writeUint8(1);
+      encoder.writeUint8(1);
-        yield * this.writeOperationsUntransformed(encoder);
+      yield * this.writeOperationsUntransformed(encoder);
-      } else {
+    } else {
-        encoder.writeUint8(0);
+      encoder.writeUint8(0);
-        yield * this.writeOperations(encoder, decoder);
+      yield * this.writeOperations(encoder, decoder);
-      }
+    }
 
-      yield * this.writeDeleteSet(encoder);
+    yield * this.writeDeleteSet(encoder);
-      conn.send(senderConn.uid, encoder.createBuffer());
+    conn.send(senderConn.uid, encoder.createBuffer());
-      senderConn.receivedSyncStep2 = true;
+    senderConn.receivedSyncStep2 = true;
-    });
+  });
-    return conn.y.db.whenTransactionsFinished().then(() => {
+  if (conn.role === 'slave') {
-      if (conn.role === 'slave') {
+    sendSyncStep1(conn, sender);
-        sendSyncStep1(conn, sender);
+  }
-      }
+  return conn.y.db.whenTransactionsFinished()
-    })
-  })
 }
 
 function logSS (decoder, strBuilder) {
@@ -643,12 +640,10 @@ function extendConnector (Y/* :any */) {
         this.setUserId(Y.utils.generateUserId());
       }
     }
-
     reconnect () {
       this.log('reconnecting..');
       return this.y.db.startGarbageCollector()
     }
-
     disconnect () {
       this.log('discronnecting..');
       this.connections = new Map();
@@ -658,16 +653,13 @@ function extendConnector (Y/* :any */) {
       this.y.db.stopGarbageCollector();
       return this.y.db.whenTransactionsFinished()
     }
-
     repair () {
       this.log('Repairing the state of Yjs. This can happen if messages get lost, and Yjs detects that something is wrong. If this happens often, please report an issue here: https://github.com/y-js/yjs/issues');
+      this.connections.forEach(user => { user.isSynced = false; });
       this.isSynced = false;
-      this.connections.forEach((user, userId) => {
+      this.currentSyncTarget = null;
-        user.isSynced = false;
+      this.findNextSyncTarget();
-        this._syncWithUser(userId);
-      });
     }
-
     setUserId (userId) {
       if (this.userId == null) {
         if (!Number.isInteger(userId)) {
@@ -682,21 +674,20 @@ function extendConnector (Y/* :any */) {
         return null
       }
     }
-
     onUserEvent (f) {
       this.userEventListeners.push(f);
     }
-
     removeUserEventListener (f) {
       this.userEventListeners = this.userEventListeners.filter(g => f !== g);
     }
-
     userLeft (user) {
       if (this.connections.has(user)) {
         this.log('%s: User left %s', this.userId, user);
         this.connections.delete(user);
-        // check if isSynced event can be sent now
+        if (user === this.currentSyncTarget) {
-        this._setSyncedWith(null);
+          this.currentSyncTarget = null;
+          this.findNextSyncTarget();
+        }
         for (var f of this.userEventListeners) {
           f({
             action: 'userLeft',
@@ -705,7 +696,7 @@ function extendConnector (Y/* :any */) {
         }
       }
     }
-    userJoined (user, role, auth) {
+    userJoined (user, role) {
       if (role == null) {
         throw new Error('You must specify the role of the joined user!')
       }
@@ -718,7 +709,7 @@ function extendConnector (Y/* :any */) {
         isSynced: false,
         role: role,
         processAfterAuth: [],
-        auth: auth || null,
+        auth: null,
         receivedSyncStep2: false
       });
       let defer = {};
@@ -731,7 +722,9 @@ function extendConnector (Y/* :any */) {
           role: role
         });
       }
-      this._syncWithUser(user);
+      if (this.currentSyncTarget == null) {
+        this.findNextSyncTarget();
+      }
     }
     // Execute a function _when_ we are connected.
     // If not connected, wait until connected
@@ -742,25 +735,39 @@ function extendConnector (Y/* :any */) {
         this.whenSyncedListeners.push(f);
       }
     }
-    _syncWithUser (userid) {
+    findNextSyncTarget () {
-      if (this.role === 'slave') {
+      if (this.currentSyncTarget != null || this.role === 'slave') {
         return // "The current sync has not finished or this is controlled by a master!"
       }
-      sendSyncStep1(this, userid);
+
-    }
+      var syncUser = null;
-    _fireIsSyncedListeners () {
+      for (var [uid, user] of this.connections) {
-      this.y.db.whenTransactionsFinished().then(() => {
+        if (!user.isSynced) {
-        if (!this.isSynced) {
+          syncUser = uid;
-          this.isSynced = true;
+          break
-          // It is safer to remove this!
-          // TODO: remove: yield * this.garbageCollectAfterSync()
-          // call whensynced listeners
-          for (var f of this.whenSyncedListeners) {
-            f();
-          }
-          this.whenSyncedListeners = [];
         }
-      });
+      }
+      var conn = this;
+      if (syncUser != null) {
+        this.currentSyncTarget = syncUser;
+        sendSyncStep1(this, syncUser);
+      } else {
+        if (!conn.isSynced) {
+          this.y.db.requestTransaction(function * () {
+            if (!conn.isSynced) {
+              // it is crucial that isSynced is set at the time garbageCollectAfterSync is called
+              conn.isSynced = true;
+              // It is safer to remove this!
+              // TODO: remove: yield * this.garbageCollectAfterSync()
+              // call whensynced listeners
+              for (var f of conn.whenSyncedListeners) {
+                f();
+              }
+              conn.whenSyncedListeners = [];
+            }
+          });
+        }
+      }
     }
     send (uid, buffer) {
       if (!(buffer instanceof ArrayBuffer || buffer instanceof Uint8Array)) {
@@ -812,10 +819,10 @@ function extendConnector (Y/* :any */) {
     */
     receiveMessage (sender, buffer) {
       if (!(buffer instanceof ArrayBuffer || buffer instanceof Uint8Array)) {
-        return Promise.reject(new Error('Expected Message to be an ArrayBuffer or Uint8Array!'))
+        throw new Error('Expected Message to be an ArrayBuffer or Uint8Array!')
       }
       if (sender === this.userId) {
-        return Promise.resolve()
+        return
       }
       let decoder = new BinaryDecoder(buffer);
       let encoder = new BinaryEncoder();
@@ -834,33 +841,29 @@ function extendConnector (Y/* :any */) {
       if (messageType === 'sync step 1' || messageType === 'sync step 2') {
         let auth = decoder.readVarUint();
         if (senderConn.auth == null) {
-          senderConn.processAfterAuth.push([messageType, senderConn, decoder, encoder, sender]);
+          senderConn.processAfterAuth.push([sender, buffer]);
+
           // check auth
           return this.checkAuth(auth, this.y, sender).then(authPermissions => {
-            if (senderConn.auth == null) {
+            senderConn.auth = authPermissions;
-              senderConn.auth = authPermissions;
+            this.y.emit('userAuthenticated', {
-              this.y.emit('userAuthenticated', {
+              user: senderConn.uid,
-                user: senderConn.uid,
+              auth: authPermissions
-                auth: authPermissions
+            });
-              });
+            return senderConn.syncStep2.promise
+          }).then(() => {
+            if (senderConn.processAfterAuth == null) {
+              return Promise.resolve()
             }
             let messages = senderConn.processAfterAuth;
-            senderConn.processAfterAuth = [];
+            senderConn.processAfterAuth = null;
-
+            return Promise.all(messages.map(m =>
-            return messages.reduce((p, m) =>
+              this.receiveMessage(m[0], m[1])
-              p.then(() => this.computeMessage(m[0], m[1], m[2], m[3], m[4]))
+            ))
-            , Promise.resolve())
           })
         }
       }
-      if (senderConn.auth != null) {
-        return this.computeMessage(messageType, senderConn, decoder, encoder, sender)
-      } else {
-        senderConn.processAfterAuth.push([messageType, senderConn, decoder, encoder, sender]);
-      }
-    }
 
-    computeMessage (messageType, senderConn, decoder, encoder, sender) {
       if (messageType === 'sync step 1' && (senderConn.auth === 'write' || senderConn.auth === 'read')) {
         // cannot wait for sync step 1 to finish, because we may wait for sync step 2 in sync step 1 (->lock)
         computeMessageSyncStep1(decoder, encoder, this, senderConn, sender);
@@ -870,20 +873,19 @@ function extendConnector (Y/* :any */) {
       } else if (messageType === 'update' && senderConn.auth === 'write') {
         return computeMessageUpdate(decoder, encoder, this, senderConn, sender)
       } else {
-        return Promise.reject(new Error('Unable to receive message'))
+        Promise.reject(new Error('Unable to receive message'));
       }
     }
-
     _setSyncedWith (user) {
-      if (user != null) {
+      var conn = this.connections.get(user);
-        this.connections.get(user).isSynced = true;
+      if (conn != null) {
+        conn.isSynced = true;
       }
-      let conns = Array.from(this.connections.values());
+      if (user === this.currentSyncTarget) {
-      if (conns.length > 0 && conns.every(u => u.isSynced)) {
+        this.currentSyncTarget = null;
-        this._fireIsSyncedListeners();
+        this.findNextSyncTarget();
       }
     }
-
     /*
       Currently, the HB encodes operations as JSON. For the moment I want to keep it
       that way. Maybe we support encoding in the HB as XML in the future, but for now I don't want