v13.0.0-11 -- distribution files

examples/quill/index.html

@@ -4,8 +4,8 @@
   <!-- quill does not include dist files! We are using the hosted version instead -->
   <!--link rel="stylesheet" href="../bower_components/quill/dist/quill.snow.css" /-->
   <link href="https://cdn.quilljs.com/1.0.4/quill.snow.css" rel="stylesheet">
-  <link href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css" rel="stylesheet">
-  <link href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/monokai-sublime.min.css" rel="stylesheet">
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css" rel="stylesheet">
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/monokai-sublime.min.css" rel="stylesheet">
   <style>
     #quill-container {
       border: 1px solid gray;
@@ -19,13 +19,17 @@
     </div>
   </div>
 
-  <script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.js" type="text/javascript"></script>
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/highlight.min.js" type="text/javascript"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.js" type="text/javascript"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/highlight.min.js" type="text/javascript"></script>
   <script src="https://cdn.quilljs.com/1.0.4/quill.js"></script>
   <!-- quill does not include dist files! We are using the hosted version instead (see above)
   <script src="../bower_components/quill/dist/quill.js"></script>
   -->
-  <script src="../bower_components/yjs/y.js"></script>
+  <script src="../../y.js"></script>
+  <script src="../../../y-array/y-array.js"></script>
+  <script src="../../../y-richtext/dist/y-richtext.js"></script>
+  <script src="../../../y-memory/y-memory.js"></script>
+  <script src="../../../y-websockets-client/y-websockets-client.js"></script>
   <script src="./index.js"></script>
 </body>
 </html>

examples/quill/index.js

@@ -8,7 +8,8 @@ Y({
   },
   connector: {
     name: 'websockets-client',
-    room: 'richtext-example-quill-1.0-test'
+    room: 'richtext-example-quill-1.0-test',
+    url: 'http://localhost:1234'
   },
   sourceDir: '/bower_components',
   share: {

package.json

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

src/Connector.js

@@ -43,10 +43,12 @@ 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()
@@ -56,13 +58,16 @@ 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.currentSyncTarget = null
-      this.findNextSyncTarget()
+      this.connections.forEach((user, userId) => {
+        user.isSynced = false
+        this._syncWithUser(userId)
+      })
     }
+
     setUserId (userId) {
       if (this.userId == null) {
         if (!Number.isInteger(userId)) {
@@ -77,20 +82,21 @@ 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)
-        if (user === this.currentSyncTarget) {
-          this.currentSyncTarget = null
-          this.findNextSyncTarget()
-        }
+        // check if isSynced event can be sent now
+        this._setSyncedWith(null)
         for (var f of this.userEventListeners) {
           f({
             action: 'userLeft',
@@ -99,7 +105,7 @@ export default function extendConnector (Y/* :any */) {
         }
       }
     }
-    userJoined (user, role) {
+    userJoined (user, role, auth) {
       if (role == null) {
         throw new Error('You must specify the role of the joined user!')
       }
@@ -112,7 +118,7 @@ export default function extendConnector (Y/* :any */) {
         isSynced: false,
         role: role,
         processAfterAuth: [],
-        auth: null,
+        auth: auth || null,
         receivedSyncStep2: false
       })
       let defer = {}
@@ -125,9 +131,7 @@ export default function extendConnector (Y/* :any */) {
           role: role
         })
       }
-      if (this.currentSyncTarget == null) {
-        this.findNextSyncTarget()
-      }
+      this._syncWithUser(user)
     }
     // Execute a function _when_ we are connected.
     // If not connected, wait until connected
@@ -138,39 +142,25 @@ export default function extendConnector (Y/* :any */) {
         this.whenSyncedListeners.push(f)
       }
     }
-    findNextSyncTarget () {
-      if (this.currentSyncTarget != null || this.role === 'slave') {
+    _syncWithUser (userid) {
+      if (this.role === 'slave') {
         return // "The current sync has not finished or this is controlled by a master!"
       }
-
-      var syncUser = null
-      for (var [uid, user] of this.connections) {
-        if (!user.isSynced) {
-          syncUser = uid
-          break
+      sendSyncStep1(this, userid)
+    }
+    _fireIsSyncedListeners () {
+      this.y.db.whenTransactionsFinished().then(() => {
+        if (!this.isSynced) {
+          this.isSynced = true
+          // 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)) {
@@ -220,12 +210,12 @@ export default function extendConnector (Y/* :any */) {
     /*
       You received a raw message, and you know that it is intended for Yjs. Then call this function.
     */
-    async receiveMessage (sender, buffer) {
+    receiveMessage (sender, buffer) {
       if (!(buffer instanceof ArrayBuffer || buffer instanceof Uint8Array)) {
-        throw new Error('Expected Message to be an ArrayBuffer or Uint8Array!')
+        return Promise.reject(new Error('Expected Message to be an ArrayBuffer or Uint8Array!'))
       }
       if (sender === this.userId) {
-        return
+        return Promise.resolve()
       }
       let decoder = new BinaryDecoder(buffer)
       let encoder = new BinaryEncoder()
@@ -244,31 +234,33 @@ 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])
           // check auth
-          let authPermissions = await this.checkAuth(auth, this.y, sender)
-          senderConn.auth = authPermissions
-          this.y.emit('userAuthenticated', {
-            user: senderConn.uid,
-            auth: authPermissions
-          })
-          senderConn.syncStep2.promise.then(() => {
-            if (senderConn.processAfterAuth == null) {
-              return
+          return this.checkAuth(auth, this.y, sender).then(authPermissions => {
+            if (senderConn.auth == null) {
+              senderConn.auth = authPermissions
+              this.y.emit('userAuthenticated', {
+                user: senderConn.uid,
+                auth: authPermissions
+              })
             }
-            for (let i = 0; i < senderConn.processAfterAuth.length; i++) {
-              let m = senderConn.processAfterAuth[i]
-              this.receiveMessage(m[0], m[1])
-            }
-            senderConn.processAfterAuth = null
+            let messages = senderConn.processAfterAuth
+            senderConn.processAfterAuth = []
+
+            return messages.reduce((p, m) =>
+              p.then(() => this.computeMessage(m[0], m[1], m[2], m[3], m[4]))
+            , Promise.resolve())
           })
         }
       }
-
-      if (senderConn.auth == null) {
-        senderConn.processAfterAuth.push([sender, buffer])
-        return
+      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)
@@ -278,19 +270,20 @@ export default function extendConnector (Y/* :any */) {
       } else if (messageType === 'update' && senderConn.auth === 'write') {
         return computeMessageUpdate(decoder, encoder, this, senderConn, sender)
       } else {
-        console.error('Unable to receive message')
+        return Promise.reject(new Error('Unable to receive message'))
       }
     }
+
     _setSyncedWith (user) {
-      var conn = this.connections.get(user)
-      if (conn != null) {
-        conn.isSynced = true
+      if (user != null) {
+        this.connections.get(user).isSynced = true
       }
-      if (user === this.currentSyncTarget) {
-        this.currentSyncTarget = null
-        this.findNextSyncTarget()
+      let conns = Array.from(this.connections.values())
+      if (conns.length > 0 && conns.every(u => u.isSynced)) {
+        this._fireIsSyncedListeners()
       }
     }
+
     /*
       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

@@ -26,14 +26,14 @@ export function formatYjsMessageType (buffer) {
   return decoder.readVarString()
 }
 
-export async function logMessageUpdate (decoder, strBuilder) {
+export function logMessageUpdate (decoder, strBuilder) {
   let len = decoder.readUint32()
   for (let i = 0; i < len; i++) {
     strBuilder.push(JSON.stringify(Y.Struct.binaryDecodeOperation(decoder)) + '\n')
   }
 }
 
-export async function computeMessageUpdate (decoder, encoder, conn) {
+export function computeMessageUpdate (decoder, encoder, conn) {
   if (conn.y.db.forwardAppliedOperations) {
     let messagePosition = decoder.pos
     let len = decoder.readUint32()
@@ -78,7 +78,7 @@ export function logMessageSyncStep1 (decoder, strBuilder) {
   logSS(decoder, strBuilder)
 }
 
-export async function computeMessageSyncStep1 (decoder, encoder, conn, senderConn, sender) {
+export function computeMessageSyncStep1 (decoder, encoder, conn, senderConn, sender) {
   let protocolVersion = decoder.readVarUint()
   let preferUntransformed = decoder.readUint8() === 1
 
@@ -112,7 +112,7 @@ export async function computeMessageSyncStep1 (decoder, encoder, conn, senderCon
   if (conn.role === 'slave') {
     sendSyncStep1(conn, sender)
   }
-  await conn.y.db.whenTransactionsFinished()
+  return conn.y.db.whenTransactionsFinished()
 }
 
 export function logSS (decoder, strBuilder) {
@@ -161,7 +161,7 @@ export function logMessageSyncStep2 (decoder, strBuilder) {
   logDS(decoder, strBuilder)
 }
 
-export async function computeMessageSyncStep2 (decoder, encoder, conn, senderConn, sender) {
+export function computeMessageSyncStep2 (decoder, encoder, conn, senderConn, sender) {
   var db = conn.y.db
   let defer = senderConn.syncStep2
 
@@ -178,7 +178,8 @@ export async function computeMessageSyncStep2 (decoder, encoder, conn, senderCon
   db.requestTransaction(function * () {
     yield * this.applyDeleteSet(decoder)
   })
-  await db.whenTransactionsFinished()
-  conn._setSyncedWith(sender)
-  defer.resolve()
+  return db.whenTransactionsFinished().then(() => {
+    conn._setSyncedWith(sender)
+    defer.resolve()
+  })
 }

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: true }, opts.db)
+      dbOpts = Object.assign({ gc: false }, opts.db)
       connOpts = Object.assign({ role: 'master' }, connector)
     } else {
       dbOpts = Object.assign({ gc: false }, opts.db)