Bring v2 up to date with current changes on master

.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches:
+      - '**'
+    paths-ignore:
+      - 'dist/**'
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        node-version: [18.x, 16.x, 14.x]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: 📥 Install
+        run: npm install
+
+      - name: Unit tests
+        run: npm test
+
+      - name: ESLint checks
+        run: npm run lint
+
+      - name: Build
+        run: npm run dist
+
+      - name: Preversion
+        run: npm run preversion

README.md

@@ -24,7 +24,7 @@ This repository implements a basic server that you can adopt to your specific us
 Start a y-websocket server:
 
 ```sh
-HOST=localhost PORT=1234 npx y-websocket-server
+HOST=localhost PORT=1234 npx y-websocket
 ```
 
 ### Client Code:
@@ -71,7 +71,9 @@ wsOpts = {
   // E.g. In nodejs, you could specify WebsocketPolyfill = require('ws')
   WebsocketPolyfill: Websocket,
   // Specify an existing Awareness instance - see https://github.com/yjs/y-protocols
-  awareness: new awarenessProtocol.Awareness(ydoc)
+  awareness: new awarenessProtocol.Awareness(ydoc),
+  // Specify the maximum amount to wait between reconnects (we use exponential backoff).
+  maxBackoffTime: 2500
 }
 ```
 
@@ -94,17 +96,23 @@ wsOpts = {
   <dd>Destroy this wsProvider instance. Disconnects from the server and removes all event handlers.</dd>
   <b><code>wsProvider.on('sync', function(isSynced: boolean))</code></b>
   <dd>Add an event listener for the sync event that is fired when the client received content from the server.</dd>
+  <b><code>wsProvider.on('status', function({ status: 'disconnected' | 'connecting' | 'connected' }))</code></b>
+  <dd>Receive updates about the current connection status.</dd>
+  <b><code>wsProvider.on('connection-close', function(WSClosedEvent))</code></b>
+  <dd>Fires when the underlying websocket connection is closed. It forwards the websocket event to this event handler.</dd>
+  <b><code>wsProvider.on('connection-error', function(WSErrorEvent))</code></b>
+  <dd>Fires when the underlying websocket connection closes with an error. It forwards the websocket event to this event handler.</dd>
 </dl>
 
 ## Websocket Server
 
 Start a y-websocket server:
 
 ```sh
-HOST=localhost PORT=1234 npx y-websocket-server
+HOST=localhost PORT=1234 npx y-websocket
 ```
 
-Since npm symlinks the `y-websocket-server` executable from your local `./node_modules/.bin` folder, you can simply run npx. The `PORT` environment variable already defaults to 1234, and `HOST` defaults to `localhost`.
+Since npm symlinks the `y-websocket` executable from your local `./node_modules/.bin` folder, you can simply run npx. The `PORT` environment variable already defaults to 1234, and `HOST` defaults to `localhost`.
 
 ### Websocket Server with Persistence
 

bin/callback.js

@@ -17,7 +17,7 @@ export const isCallbackSet = !!CALLBACK_URL
 export const callbackHandler = (update, origin, doc) => {
   const room = doc.name
   const dataToSend = {
-    room: room,
+    room,
     data: {}
   }
   const sharedObjectList = Object.keys(CALLBACK_OBJECTS)
@@ -42,7 +42,7 @@ const callbackRequest = (url, timeout, data) => {
     hostname: url.hostname,
     port: url.port,
     path: url.pathname,
-    timeout: timeout,
+    timeout,
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',

bin/server.js

@@ -21,6 +21,7 @@ wss.on('connection', setupWSConnection)
 
 server.on('upgrade', (request, socket, head) => {
   // You may check auth of request here..
+  // See https://github.com/websockets/ws#client-authentication
   /**
    * @param {any} ws
    */
@@ -30,6 +31,6 @@ server.on('upgrade', (request, socket, head) => {
   wss.handleUpgrade(request, /** @type {any} */ (socket), head, handleAuth)
 })
 
-server.listen(port, () => {
+server.listen(port, host, () => {
   console.log(`running at '${host}' on port ${port}`)
 })

bin/utils.js

@@ -4,7 +4,6 @@ import * as awarenessProtocol from 'y-protocols/awareness'
 
 import * as encoding from 'lib0/encoding'
 import * as decoding from 'lib0/decoding'
-import * as mutex from 'lib0/mutex'
 import * as map from 'lib0/map'
 
 import debounce from 'lodash.debounce'
@@ -89,7 +88,6 @@ export class WSSharedDoc extends Y.Doc {
   constructor (name) {
     super({ gc: gcEnabled })
     this.name = name
-    this.mux = mutex.createMutex()
     /**
      * Maps from conn to set of controlled user ids. Delete all user ids from awareness when this conn is closed
      * @type {Map<Object, Set<number>>}
@@ -164,7 +162,11 @@ const messageListener = (conn, doc, message) => {
     switch (messageType) {
       case messageSync:
         encoding.writeVarUint(encoder, messageSync)
-        syncProtocol.readSyncMessage(decoder, encoder, doc, null)
+        syncProtocol.readSyncMessage(decoder, encoder, doc, conn)
+
+        // If the `encoder` only contains the type of reply message and no
+        // message, there is no need to send the message. When `encoder` only
+        // contains the type of reply, its length is 1.
         if (encoding.length(encoder) > 1) {
           send(doc, conn, encoding.toUint8Array(encoder))
         }