@liveblocks/core 1.1.0-beta2 → 1.1.0-beta4

package/dist/index.js

@@ -157,7 +157,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.1.0-beta2"
+  "1.1.0-beta4"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -924,10 +924,6 @@ var logPermanentClose = log(
   1 /* WARN */,
   "Connection to WebSocket closed permanently. Won't retry."
 );
-function sendHeartbeat(ctx) {
-  var _a;
-  (_a = ctx.socket) == null ? void 0 : _a.send("ping");
-}
 function isCloseEvent(error2) {
   return !(error2 instanceof Error) && error2.type === "close";
 }
@@ -1168,20 +1164,18 @@ function createConnectionStateMachine(delegates, enableDebugLogging) {
       };
     }
   );
-  machine.addTimedTransition("@ok.connected", HEARTBEAT_INTERVAL, {
+  const sendHeartbeat = {
     target: "@ok.awaiting-pong",
-    effect: sendHeartbeat
-  }).addTransitions("@ok.connected", {
-    WINDOW_GOT_FOCUS: { target: "@ok.awaiting-pong", effect: sendHeartbeat }
-  });
-  const noPongAction = {
-    target: "@connecting.busy",
-    // Log implicit connection loss and drop the current open socket
-    effect: log(
-      1 /* WARN */,
-      "Received no pong from server, assume implicit connection loss."
-    )
+    effect: (ctx) => {
+      var _a;
+      (_a = ctx.socket) == null ? void 0 : _a.send("ping");
+    }
   };
+  machine.addTimedTransition("@ok.connected", HEARTBEAT_INTERVAL, sendHeartbeat).addTransitions("@ok.connected", {
+    NAVIGATOR_OFFLINE: sendHeartbeat,
+    // Don't take the browser's word for it when it says it's offline. Do a ping/pong to make sure.
+    WINDOW_GOT_FOCUS: sendHeartbeat
+  });
   machine.onEnter("@ok.*", (ctx) => {
     ctx.patch({ successCount: ctx.successCount + 1 });
     const timerID = setTimeout(
@@ -1197,7 +1191,14 @@ function createConnectionStateMachine(delegates, enableDebugLogging) {
       clearTimeout(timerID);
       onMessage.pause();
     };
-  }).addTimedTransition("@ok.awaiting-pong", PONG_TIMEOUT, noPongAction).addTransitions("@ok.awaiting-pong", { PONG_TIMEOUT: noPongAction }).addTransitions("@ok.awaiting-pong", { PONG: "@ok.connected" }).addTransitions("@ok.*", {
+  }).addTransitions("@ok.awaiting-pong", { PONG: "@ok.connected" }).addTimedTransition("@ok.awaiting-pong", PONG_TIMEOUT, {
+    target: "@connecting.busy",
+    // Log implicit connection loss and drop the current open socket
+    effect: log(
+      1 /* WARN */,
+      "Received no pong from server, assume implicit connection loss."
+    )
+  }).addTransitions("@ok.*", {
     // When a socket receives an error, this can cause the closing of the
     // socket, or not. So always check to see if the socket is still OPEN or
     // not. When still OPEN, don't transition.
@@ -1248,7 +1249,10 @@ function createConnectionStateMachine(delegates, enableDebugLogging) {
     const win = typeof window !== "undefined" ? window : void 0;
     const root = win != null ? win : doc;
     machine.onEnter("*", (ctx) => {
-      function onBackOnline() {
+      function onNetworkOffline() {
+        machine.send({ type: "NAVIGATOR_OFFLINE" });
+      }
+      function onNetworkBackOnline() {
         machine.send({ type: "NAVIGATOR_ONLINE" });
       }
       function onVisibilityChange() {
@@ -1256,11 +1260,13 @@ function createConnectionStateMachine(delegates, enableDebugLogging) {
           machine.send({ type: "WINDOW_GOT_FOCUS" });
         }
       }
-      win == null ? void 0 : win.addEventListener("online", onBackOnline);
+      win == null ? void 0 : win.addEventListener("online", onNetworkBackOnline);
+      win == null ? void 0 : win.addEventListener("offline", onNetworkOffline);
       root == null ? void 0 : root.addEventListener("visibilitychange", onVisibilityChange);
       return () => {
         root == null ? void 0 : root.removeEventListener("visibilitychange", onVisibilityChange);
-        win == null ? void 0 : win.removeEventListener("online", onBackOnline);
+        win == null ? void 0 : win.removeEventListener("online", onNetworkBackOnline);
+        win == null ? void 0 : win.removeEventListener("offline", onNetworkOffline);
         teardownSocket(ctx.socket);
       };
     });
@@ -4340,10 +4346,10 @@ function createRoom(options, config) {
       )
     };
     context.idFactory = makeIdFactory(sessionInfo.id);
-    if (context.root) {
-      context.buffer.messages.push({ type: 200 /* FETCH_STORAGE */ });
+    if (_getStorage$ !== null) {
+      refreshStorage({ flush: false });
     }
-    tryFlushing();
+    flushNowOrSoon();
   }
   function onDidDisconnect() {
     clearTimeout(context.buffer.flushTimerID);
@@ -4471,7 +4477,7 @@ function createRoom(options, config) {
     if (message.items.length === 0) {
       throw new Error("Internal error: cannot load storage without items");
     }
-    if (context.root) {
+    if (context.root !== void 0) {
       updateRoot(message.items, batchedUpdatesWrapper);
     } else {
       context.root = LiveObject._fromItems(message.items, pool);
@@ -4483,7 +4489,7 @@ function createRoom(options, config) {
     }
   }
   function updateRoot(items, batchedUpdatesWrapper) {
-    if (!context.root) {
+    if (context.root === void 0) {
       return;
     }
     const currentItems = /* @__PURE__ */ new Map();
@@ -4681,7 +4687,7 @@ function createRoom(options, config) {
       }
       context.activeBatch.updates.presence = true;
     } else {
-      tryFlushing();
+      flushNowOrSoon();
       batchUpdates(() => {
         if (options2 == null ? void 0 : options2.addToHistory) {
           addToUndoStack(
@@ -4768,7 +4774,7 @@ function createRoom(options, config) {
       data: context.me.current,
       targetActor: message.actor
     });
-    tryFlushing();
+    flushNowOrSoon();
     const user = context.others.getUser(message.actor);
     return user ? { type: "enter", user } : void 0;
   }
@@ -4854,9 +4860,7 @@ function createRoom(options, config) {
             const unacknowledgedOps = new Map(context.unacknowledgedOps);
             createOrUpdateRootFromMessage(message, doNotBatchUpdates);
             applyAndSendOps(unacknowledgedOps, doNotBatchUpdates);
-            if (_resolveInitialStatePromise !== null) {
-              _resolveInitialStatePromise();
-            }
+            _resolveStoragePromise == null ? void 0 : _resolveStoragePromise();
             notifyStorageStatus();
             eventHub.storageDidLoad.notify();
             break;
@@ -4903,7 +4907,7 @@ ${Array.from(traces).join("\n\n")}`
       notify(updates, doNotBatchUpdates);
     });
   }
-  function tryFlushing() {
+  function flushNowOrSoon() {
     const storageOps = context.buffer.storageOperations;
     if (storageOps.length > 0) {
       for (const op of storageOps) {
@@ -4933,7 +4937,7 @@ ${Array.from(traces).join("\n\n")}`
     } else {
       clearTimeout(context.buffer.flushTimerID);
       context.buffer.flushTimerID = setTimeout(
-        tryFlushing,
+        flushNowOrSoon,
         config.throttleDelay - elapsedMillis
       );
     }
@@ -4976,24 +4980,32 @@ ${Array.from(traces).join("\n\n")}`
       type: 103 /* BROADCAST_EVENT */,
       event
     });
-    tryFlushing();
+    flushNowOrSoon();
   }
   function dispatchOps(ops) {
     context.buffer.storageOperations.push(...ops);
-    tryFlushing();
+    flushNowOrSoon();
+  }
+  let _getStorage$ = null;
+  let _resolveStoragePromise = null;
+  function refreshStorage(options2) {
+    const messages = context.buffer.messages;
+    if (!messages.some((msg) => msg.type === 200 /* FETCH_STORAGE */)) {
+      messages.push({ type: 200 /* FETCH_STORAGE */ });
+    }
+    if (options2.flush) {
+      flushNowOrSoon();
+    }
   }
-  let _getInitialStatePromise = null;
-  let _resolveInitialStatePromise = null;
   function startLoadingStorage() {
-    if (_getInitialStatePromise === null) {
-      context.buffer.messages.push({ type: 200 /* FETCH_STORAGE */ });
-      tryFlushing();
-      _getInitialStatePromise = new Promise(
-        (resolve) => _resolveInitialStatePromise = resolve
-      );
+    if (_getStorage$ === null) {
+      refreshStorage({ flush: true });
+      _getStorage$ = new Promise((resolve) => {
+        _resolveStoragePromise = resolve;
+      });
       notifyStorageStatus();
     }
-    return _getInitialStatePromise;
+    return _getStorage$;
   }
   function getStorageSnapshot() {
     const root = context.root;
@@ -5006,7 +5018,7 @@ ${Array.from(traces).join("\n\n")}`
   }
   function getStorage() {
     return __async(this, null, function* () {
-      if (context.root) {
+      if (context.root !== void 0) {
         return Promise.resolve({
           root: context.root
         });
@@ -5037,7 +5049,7 @@ ${Array.from(traces).join("\n\n")}`
         context.buffer.storageOperations.push(op);
       }
     }
-    tryFlushing();
+    flushNowOrSoon();
   }
   function redo() {
     if (context.activeBatch) {
@@ -5059,7 +5071,7 @@ ${Array.from(traces).join("\n\n")}`
         context.buffer.storageOperations.push(op);
       }
     }
-    tryFlushing();
+    flushNowOrSoon();
   }
   function batch(callback) {
     if (context.activeBatch) {
@@ -5091,7 +5103,7 @@ ${Array.from(traces).join("\n\n")}`
           dispatchOps(currentBatch.ops);
         }
         notify(currentBatch.updates, doNotBatchUpdates);
-        tryFlushing();
+        flushNowOrSoon();
       }
     });
     return returnValue;
@@ -5107,13 +5119,11 @@ ${Array.from(traces).join("\n\n")}`
     }
   }
   function getStorageStatus() {
-    if (_getInitialStatePromise === null) {
-      return "not-loaded";
-    }
     if (context.root === void 0) {
-      return "loading";
+      return _getStorage$ === null ? "not-loaded" : "loading";
+    } else {
+      return context.unacknowledgedOps.size === 0 ? "synchronized" : "synchronizing";
     }
-    return context.unacknowledgedOps.size === 0 ? "synchronized" : "synchronizing";
   }
   let _lastStorageStatus = getStorageStatus();
   function notifyStorageStatus() {
@@ -5164,7 +5174,7 @@ ${Array.from(traces).join("\n\n")}`
       send: {
         // These exist only for our E2E testing app
         explicitClose: (event) => managedSocket._privateSendMachineEvent({ type: "EXPLICIT_SOCKET_CLOSE", event }),
-        implicitClose: () => managedSocket._privateSendMachineEvent({ type: "PONG_TIMEOUT" })
+        implicitClose: () => managedSocket._privateSendMachineEvent({ type: "NAVIGATOR_OFFLINE" })
       }
     },
     id: config.roomId,
@@ -5301,7 +5311,7 @@ function makeCreateSocketDelegateForRoom(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.1.0-beta2"
+        "1.1.0-beta4"
       ) : "dev"}`
     );
   };
@@ -5404,20 +5414,28 @@ function fetchAuthEndpoint(fetch2, endpoint, body) {
 var MIN_THROTTLE = 16;
 var MAX_THROTTLE = 1e3;
 var DEFAULT_THROTTLE = 100;
+var MIN_LOST_CONNECTION_TIMEOUT = 200;
+var RECOMMENDED_MIN_LOST_CONNECTION_TIMEOUT = 1e3;
+var MAX_LOST_CONNECTION_TIMEOUT = 3e4;
+var DEFAULT_LOST_CONNECTION_TIMEOUT = 5e3;
 function getServerFromClientOptions(clientOptions) {
   const rawOptions = clientOptions;
   return typeof rawOptions.liveblocksServer === "string" ? rawOptions.liveblocksServer : "wss://api.liveblocks.io/v6";
 }
 function createClient(options) {
+  var _a, _b;
   const clientOptions = options;
-  const throttleDelay = getThrottleDelayFromOptions(clientOptions);
+  const throttleDelay = getThrottle((_a = clientOptions.throttle) != null ? _a : DEFAULT_THROTTLE);
+  const lostConnectionTimeout = getLostConnectionTimeout(
+    (_b = clientOptions.lostConnectionTimeout) != null ? _b : DEFAULT_LOST_CONNECTION_TIMEOUT
+  );
   const rooms = /* @__PURE__ */ new Map();
   function getRoom(roomId) {
     const room = rooms.get(roomId);
     return room ? room : null;
   }
   function enter(roomId, options2) {
-    var _a, _b, _c, _d;
+    var _a2, _b2, _c;
     const existingRoom = rooms.get(roomId);
     if (existingRoom !== void 0) {
       return existingRoom;
@@ -5428,13 +5446,13 @@ function createClient(options) {
     );
     const newRoom = createRoom(
       {
-        initialPresence: (_a = options2.initialPresence) != null ? _a : {},
+        initialPresence: (_a2 = options2.initialPresence) != null ? _a2 : {},
         initialStorage: options2.initialStorage
       },
       {
         roomId,
         throttleDelay,
-        lostConnectionTimeout: (_b = clientOptions.lostConnectionTimeout) != null ? _b : 5e3,
+        lostConnectionTimeout,
         polyfills: clientOptions.polyfills,
         delegates: clientOptions.mockedDelegates,
         enableDebugLogging: clientOptions.enableDebugLogging,
@@ -5451,10 +5469,10 @@ function createClient(options) {
     rooms.set(roomId, newRoom);
     setupDevTools(() => Array.from(rooms.keys()));
     linkDevTools(roomId, newRoom);
-    const shouldConnect = (_c = options2.shouldInitiallyConnect) != null ? _c : true;
+    const shouldConnect = (_b2 = options2.shouldInitiallyConnect) != null ? _b2 : true;
     if (shouldConnect) {
       if (typeof atob === "undefined") {
-        if (((_d = clientOptions.polyfills) == null ? void 0 : _d.atob) === void 0) {
+        if (((_c = clientOptions.polyfills) == null ? void 0 : _c.atob) === void 0) {
           throw new Error(
             "You need to polyfill atob to use the client in your environment. Please follow the instructions at https://liveblocks.io/docs/errors/liveblocks-client/atob-polyfill"
           );
@@ -5479,16 +5497,25 @@ function createClient(options) {
     leave
   };
 }
-function getThrottleDelayFromOptions(options) {
-  if (options.throttle === void 0) {
-    return DEFAULT_THROTTLE;
-  }
-  if (typeof options.throttle !== "number" || options.throttle < MIN_THROTTLE || options.throttle > MAX_THROTTLE) {
+function checkBounds(option, value, min, max, recommendedMin) {
+  if (typeof value !== "number" || value < min || value > max) {
     throw new Error(
-      `throttle should be a number between ${MIN_THROTTLE} and ${MAX_THROTTLE}.`
+      `${option} should be a number between ${recommendedMin != null ? recommendedMin : min} and ${max}.`
     );
   }
-  return options.throttle;
+  return value;
+}
+function getThrottle(value) {
+  return checkBounds("throttle", value, MIN_THROTTLE, MAX_THROTTLE);
+}
+function getLostConnectionTimeout(value) {
+  return checkBounds(
+    "lostConnectionTimeout",
+    value,
+    MIN_LOST_CONNECTION_TIMEOUT,
+    MAX_LOST_CONNECTION_TIMEOUT,
+    RECOMMENDED_MIN_LOST_CONNECTION_TIMEOUT
+  );
 }
 function prepareAuthentication(clientOptions, roomId) {
   const { publicApiKey, authEndpoint } = clientOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "1.1.0-beta2",
+  "version": "1.1.0-beta4",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",