@pluv/client 1.0.0 → 1.0.2

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/client@1.0.0 build /home/runner/work/pluv/pluv/packages/client
+> @pluv/client@1.0.2 build /home/runner/work/pluv/pluv/packages/client
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 58.23 KB
-CJS ⚡️ Build success in 110ms
-ESM dist/index.mjs 56.91 KB
-ESM ⚡️ Build success in 114ms
+ESM dist/index.mjs 57.31 KB
+ESM ⚡️ Build success in 126ms
+CJS dist/index.js 58.63 KB
+CJS ⚡️ Build success in 126ms
 DTS Build start
-DTS ⚡️ Build success in 3353ms
-DTS dist/index.d.mts 25.38 KB
-DTS dist/index.d.ts  25.38 KB
+DTS ⚡️ Build success in 3638ms
+DTS dist/index.d.mts 25.31 KB
+DTS dist/index.d.ts  25.31 KB

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @pluv/client
 
+## 1.0.2
+
+### Patch Changes
+
+- d87159c: Restored `@pluv/addon-indexeddb` functionality, and fixed `@pluv/addon-indexeddb` sometimes duplicating storage operations based on `initialStorage` values.
+  - @pluv/crdt@1.0.2
+  - @pluv/types@1.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- c583be9: Fixed storage race condition that occurred when 2 users joined a room near simultaneously that would cause users to have mismatched storage states from the server (and thereby preventing updates from properly registering) until the user reconnected.
+  - @pluv/crdt@1.0.1
+  - @pluv/types@1.0.1
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -48,7 +48,6 @@ declare abstract class AbstractStorageStore {
 }
 
 type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
-    encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
 };
 
@@ -189,7 +188,6 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     undo: () => void;
     updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _addToStorageStore;
-    private _applyStorageStore;
     private _attachWindowListeners;
     private _attachWsListeners;
     private _clearInterval;

package/dist/index.d.ts

@@ -48,7 +48,6 @@ declare abstract class AbstractStorageStore {
 }
 
 type CrdtManagerOptions<TStorage extends Record<string, CrdtType<any, any>> = {}> = {
-    encodedState?: string | Uint8Array | null;
     initialStorage?: AbstractCrdtDocFactory<TStorage>;
 };
 
@@ -189,7 +188,6 @@ declare class PluvRoom<TIO extends IOLike<any, any>, TMetadata extends JsonObjec
     undo: () => void;
     updateMyPresence: (presence: UpdateMyPresenceAction<TPresence>) => void;
     private _addToStorageStore;
-    private _applyStorageStore;
     private _attachWindowListeners;
     private _attachWsListeners;
     private _clearInterval;

package/dist/index.js

@@ -126,9 +126,9 @@ var import_crdt = require("@pluv/crdt");
 var CrdtManager = class {
   constructor(options) {
     this.initialized = false;
-    const { encodedState, initialStorage = import_crdt.noop.doc({}) } = options;
+    const { initialStorage = import_crdt.noop.doc({}) } = options;
     this._docFactory = initialStorage;
-    this.doc = encodedState ? initialStorage.getFresh().applyEncodedState({ update: encodedState }) : initialStorage.getFresh();
+    this.doc = initialStorage.getEmpty();
   }
   /**
    * !HACK
@@ -136,40 +136,50 @@ var CrdtManager = class {
    * update. This unfortunately means updates can be dropped entirely
    * @date June 13, 2023
    */
-  applyUpdate(update, origin) {
+  applyUpdate(params) {
+    const { origin, update } = params;
     if (!this.initialized) return this;
     const updates = typeof update === "string" ? [update] : update;
     this._applyDocUpdates(this.doc, updates, origin);
     return this;
   }
   destroy() {
+    this.initialized = false;
     this.doc.destroy();
+    this.doc = this._docFactory.getEmpty();
   }
   get(key) {
     return this.doc.get(key);
   }
+  getInitialState() {
+    return this._docFactory.getInitialized().getEncodedState();
+  }
   initialize(params) {
-    const { onInitialized, origin, update } = params;
-    const updates = typeof update === "string" ? [update] : update;
-    if (!updates.length) return this;
+    const { origin, update } = params;
     if (this.initialized) {
-      this.doc = this._applyDocUpdates(this.doc, updates, origin).track();
+      console.warn("Attempted to initialize storage multiple times");
       return this;
     }
-    const onEmpty = this._applyDocUpdates(this._docFactory.getEmpty(), updates, origin);
-    if (!onEmpty.isEmpty()) {
-      onEmpty.destroy();
-      this.doc = this._applyDocUpdates(this._docFactory.getFresh(), updates, origin).track();
-      this.initialized = true;
-      onInitialized == null ? void 0 : onInitialized(this.doc.getEncodedState());
+    if (!this.doc.isEmpty()) {
+      console.warn("Attempted to initialize over a non-empty storage");
       return this;
     }
-    onEmpty.destroy();
-    this.doc = this._docFactory.getInitialized().track();
+    const updates = typeof update === "string" ? [update] : update;
+    if (!updates.length) return this;
+    const initialized = this._docFactory.getInitialized();
+    const reference = initialized.get();
+    this.doc = this._applyDocUpdates(
+      this._docFactory.getEmpty(),
+      updates,
+      origin
+    ).rebuildStorage(reference);
     this.initialized = true;
-    onInitialized == null ? void 0 : onInitialized(this.doc.getEncodedState());
+    initialized.destroy();
     return this;
   }
+  resolveEncodedState(updates) {
+    return this._docFactory.resolveEncodedState(updates);
+  }
   _applyDocUpdates(doc, updates, origin) {
     doc.transact(() => {
       doc.batchApplyEncodedState({ origin, updates });
@@ -264,7 +274,10 @@ var PluvRouter = class _PluvRouter {
     this._defs = { events };
   }
   static merge(...routers) {
-    const events = Object.assign(/* @__PURE__ */ Object.create(null), ...routers.map((router) => router._defs.events));
+    const events = Object.assign(
+      /* @__PURE__ */ Object.create(null),
+      ...routers.map((router) => router._defs.events)
+    );
     if (Object.keys(events).some((key) => key.startsWith("$"))) {
       throw new Error('Procedures may not start with "$"');
     }
@@ -417,7 +430,11 @@ var UsersManager = class {
     const userInfo = (_a = this._others.get(clientId)) != null ? _a : null;
     if (!userInfo) return null;
     const remaining = (_c = (_b = this._getConnectionIds(clientId)) == null ? void 0 : _b.size) != null ? _c : 0;
-    const result = { clientId, remaining, data: userInfo };
+    const result = {
+      clientId,
+      remaining,
+      data: userInfo
+    };
     if (!remaining) this._others.delete(clientId);
     return result;
   }
@@ -454,7 +471,10 @@ var UsersManager = class {
     const other = this._others.get(clientId);
     if (!other) return null;
     const cleanedPatch = pickBy(patch != null ? patch : {}, (value) => typeof value !== "undefined");
-    const cleanedPresence = pickBy((_a = other.presence) != null ? _a : {}, (value) => typeof value !== "undefined");
+    const cleanedPresence = pickBy(
+      (_a = other.presence) != null ? _a : {},
+      (value) => typeof value !== "undefined"
+    );
     const presence = __spreadValues(__spreadValues(__spreadValues({}, this.initialPresence), cleanedPresence), cleanedPatch);
     const validated = this._presence ? this._presence.parse(presence) : presence;
     this._others.set(clientId, __spreadProps(__spreadValues({}, other), { presence: validated }));
@@ -623,10 +643,7 @@ var PluvRoom = class extends AbstractRoom {
           room: this.id,
           user: myself
         };
-        const output = yield procedure.config.broadcast(
-          parsed,
-          context
-        );
+        const output = yield procedure.config.broadcast(parsed, context);
         Object.entries(output).forEach(([_type, _data]) => {
           this._sendMessage({ data: _data, type: _type });
         });
@@ -722,7 +739,7 @@ var PluvRoom = class extends AbstractRoom {
         const shouldFlatten = yield this._storageStore.getShouldFlatten();
         if (!shouldFlatten) return;
         const updates = yield this._storageStore.getUpdates();
-        this._crdtManager.applyUpdate(updates, this);
+        this._crdtManager.applyUpdate({ update: updates, origin: this });
         const encodedState = this._crdtManager.doc.getEncodedState();
         yield this._storageStore.flatten(encodedState);
       }),
@@ -749,7 +766,11 @@ var PluvRoom = class extends AbstractRoom {
       }
     };
     this._router = router != null ? router : new PluvRouter({});
-    this._usersManager = new UsersManager({ initialPresence, limits: this._limits, presence });
+    this._usersManager = new UsersManager({
+      initialPresence,
+      limits: this._limits,
+      presence
+    });
     this._crdtManager = new CrdtManager({ initialStorage });
   }
   get storageLoaded() {
@@ -764,9 +785,11 @@ var PluvRoom = class extends AbstractRoom {
       const params = (_a = args[0]) != null ? _a : {};
       const metadata = params.metadata;
       this._setMetadata(metadata);
-      const canConnect = [ConnectionState.Closed, ConnectionState.Unavailable, ConnectionState.Untouched].some(
-        (state) => this._state.connection.state === state
-      );
+      const canConnect = [
+        ConnectionState.Closed,
+        ConnectionState.Unavailable,
+        ConnectionState.Untouched
+      ].some((state) => this._state.connection.state === state);
       if (!canConnect) return;
       this._clearTimeout(this._timeouts.reconnect);
       this._updateState((oldState) => {
@@ -774,7 +797,6 @@ var PluvRoom = class extends AbstractRoom {
         return oldState;
       });
       yield this._storageStore.initialize();
-      yield this._applyStorageStore();
       const wsEndpoint = this._getWsEndpoint(this.id, params);
       const url = new URL(wsEndpoint);
       let authToken = null;
@@ -839,20 +861,6 @@ var PluvRoom = class extends AbstractRoom {
       this._flattenStorageStore();
     });
   }
-  _applyStorageStore() {
-    return __async(this, null, function* () {
-      const updates = yield this._storageStore.getUpdates();
-      this._crdtManager.initialize({
-        onInitialized: () => {
-          this._stateNotifier.subjects["storage-loaded"].next(true);
-          this._observeCrdt();
-        },
-        origin: ORIGIN_INITIALIZED,
-        update: updates
-      });
-      this._emitSharedTypes();
-    });
-  }
   _attachWindowListeners() {
     if (typeof window === "undefined") return;
     if (typeof document === "undefined") return;
@@ -1043,32 +1051,35 @@ var PluvRoom = class extends AbstractRoom {
     this._stateNotifier.subjects.others.next(others);
   }
   _handleRegisteredMessage(message) {
-    var _a, _b, _c;
-    const { connectionId } = message;
-    const user = message.user;
-    if (!connectionId) return;
-    if (!this._state.webSocket) throw new Error("Could not find WebSocket");
-    const data = message.data;
-    this._updateState((oldState) => {
-      oldState.connection.count += 1;
-      oldState.connection.id = connectionId;
-      oldState.authorization.user = user != null ? user : null;
-      return oldState;
-    });
-    const userInfo = {
-      connectionId,
-      presence: (_a = data.presence) != null ? _a : void 0,
-      user
-    };
-    this._usersManager.setMyself(userInfo);
-    const presence = this._usersManager.myPresence;
-    const myself = (_b = this._usersManager.myself) != null ? _b : null;
-    this._stateNotifier.subjects["my-presence"].next(presence);
-    this._stateNotifier.subjects.myself.next(myself);
-    const update = this._state.connection.count > 1 ? (_c = this._crdtManager.doc.getEncodedState()) != null ? _c : null : null;
-    this._sendMessage({
-      type: "$initializeSession",
-      data: { presence, update }
+    return __async(this, null, function* () {
+      var _a, _b, _c;
+      const { connectionId } = message;
+      const user = message.user;
+      if (!connectionId) return;
+      if (!this._state.webSocket) throw new Error("Could not find WebSocket");
+      const data = message.data;
+      const state = data.state;
+      this._updateState((oldState) => {
+        oldState.connection.count += 1;
+        oldState.connection.id = connectionId;
+        oldState.authorization.user = user != null ? user : null;
+        return oldState;
+      });
+      const userInfo = {
+        connectionId,
+        presence: (_a = data.presence) != null ? _a : void 0,
+        user
+      };
+      this._usersManager.setMyself(userInfo);
+      const presence = this._usersManager.myPresence;
+      const myself = (_b = this._usersManager.myself) != null ? _b : null;
+      this._stateNotifier.subjects["my-presence"].next(presence);
+      this._stateNotifier.subjects.myself.next(myself);
+      const update = !state ? (_c = this._crdtManager.resolveEncodedState(yield this._storageStore.getUpdates())) != null ? _c : this._crdtManager.getInitialState() : this._crdtManager.getInitialState();
+      this._sendMessage({
+        type: "$initializeSession",
+        data: { presence, update }
+      });
     });
   }
   _handleStorageReceivedMessage(message) {
@@ -1077,23 +1088,34 @@ var PluvRoom = class extends AbstractRoom {
       if (!connectionId) return;
       if (!this._state.webSocket) throw new Error("Could not find WebSocket");
       const data = message.data;
-      this._crdtManager.initialize({
-        onInitialized: (update2) => __async(this, null, function* () {
-          this._addToStorageStore(update2);
-          this._emitSharedTypes();
-          this._observeCrdt();
-          this._stateNotifier.subjects["storage-loaded"].next(true);
-        }),
-        origin: ORIGIN_INITIALIZED,
-        update: data.state
-      });
+      const changeKind = data.changeKind;
+      const state = data.state;
+      const updates = yield this._storageStore.getUpdates();
+      const origin = ORIGIN_INITIALIZED;
+      const updateStorage = (update) => {
+        return this._crdtManager.initialized ? this._crdtManager.applyUpdate({ update, origin }) : this._crdtManager.initialize({ update, origin });
+      };
+      if (changeKind === "empty") {
+        this._crdtManager.destroy();
+        this._crdtManager.initialize({ origin, update: updates });
+      } else if (changeKind === "initialized") {
+        if (!!updates.length) updateStorage(updates);
+        else {
+          const encodedState2 = updateStorage(state).doc.getEncodedState();
+          this._addToStorageStore(encodedState2);
+        }
+      } else {
+        const encodedState2 = updateStorage(state).doc.getEncodedState();
+        if (!!updates.length) this._crdtManager.applyUpdate({ update: updates, origin });
+        yield this._addToStorageStore(encodedState2);
+      }
       const encodedState = this._crdtManager.doc.getEncodedState();
-      yield this._storageStore.addUpdate(encodedState);
       this._emitSharedTypes();
-      const update = this._crdtManager.doc.getEncodedState();
+      this._observeCrdt();
+      this._stateNotifier.subjects["storage-loaded"].next(true);
       this._sendMessage({
         type: "$updateStorage",
-        data: { origin: ORIGIN_INITIALIZED, update }
+        data: { origin, update: encodedState }
       });
     });
   }
@@ -1102,7 +1124,6 @@ var PluvRoom = class extends AbstractRoom {
     if (!connectionId) return;
     if (!this._state.webSocket) throw new Error("Could not find WebSocket");
     const data = message.data;
-    if (!this._crdtManager) return;
     this._crdtManager.doc.applyEncodedState({
       origin: ORIGIN_STORAGE_UPDATED,
       update: data.state
@@ -1110,7 +1131,6 @@ var PluvRoom = class extends AbstractRoom {
     const sharedTypes = this._crdtManager.doc.get();
     const storageRoot = Object.keys(sharedTypes).reduce(
       (acc, prop) => {
-        if (!this._crdtManager) return acc;
         const serialized = this._crdtManager.doc.toJson(prop);
         this._crdtNotifier.subject(prop).next(serialized);
         return __spreadProps(__spreadValues({}, acc), { [prop]: serialized });
@@ -1157,7 +1177,10 @@ var PluvRoom = class extends AbstractRoom {
   }
   _heartbeat() {
     this._clearTimeout(this._timeouts.pong);
-    this._timeouts.pong = setTimeout(this._reconnect.bind(this), PONG_TIMEOUT_MS);
+    this._timeouts.pong = setTimeout(
+      this._reconnect.bind(this),
+      PONG_TIMEOUT_MS
+    );
     this._sendMessage('{"type":"$ping","data":{}}');
   }
   _logDebug(...data) {
@@ -1168,15 +1191,14 @@ var PluvRoom = class extends AbstractRoom {
   _observeCrdt() {
     var _a, _b;
     (_b = (_a = this._subscriptions).observeCrdt) == null ? void 0 : _b.call(_a);
-    if (!this._crdtManager) return;
     const unsubscribe = this._crdtManager.doc.subscribe((event) => {
       var _a2;
       const origin = (_a2 = event.origin) != null ? _a2 : null;
-      this._addToStorageStore(event.update);
       this._emitSharedTypes();
       if (origin === ORIGIN_INITIALIZED || origin === ORIGIN_STORAGE_UPDATED) {
         return;
       }
+      this._addToStorageStore(event.update);
       if (!this._state.webSocket) return;
       if (!this._state.connection.id) return;
       if (this._state.webSocket.readyState !== WebSocket.OPEN) return;
@@ -1298,7 +1320,10 @@ var PluvRoom = class extends AbstractRoom {
       return oldState;
     });
     this._clearInterval(this._intervals.heartbeat);
-    this._intervals.heartbeat = setInterval(this._heartbeat.bind(this), HEARTBEAT_INTERVAL_MS);
+    this._intervals.heartbeat = setInterval(
+      this._heartbeat.bind(this),
+      HEARTBEAT_INTERVAL_MS
+    );
   }
   _onNavigatorOffline() {
     return __async(this, null, function* () {
@@ -1353,8 +1378,14 @@ var PluvRoom = class extends AbstractRoom {
   _pollReconnect() {
     this._clearTimeout(this._timeouts.reconnect);
     const timeoutMs = typeof this._reconnectTimeoutMs === "number" ? this._reconnectTimeoutMs : this._reconnectTimeoutMs({ attempts: this._state.connection.attempts });
-    const clampedMs = Math.max(Math.min(MIN_RECONNECT_TIMEOUT_MS, timeoutMs), MAX_RECONNECT_TIMEOUT_MS);
-    this._timeouts.reconnect = setTimeout(this._reconnect.bind(this), clampedMs);
+    const clampedMs = Math.max(
+      Math.min(MIN_RECONNECT_TIMEOUT_MS, timeoutMs),
+      MAX_RECONNECT_TIMEOUT_MS
+    );
+    this._timeouts.reconnect = setTimeout(
+      this._reconnect.bind(this),
+      clampedMs
+    );
   }
   _reconnect() {
     return __async(this, null, function* () {
@@ -1553,10 +1584,7 @@ var MockedRoom = class extends AbstractRoom {
           room: this.id,
           user: myself
         };
-        const output = yield procedure.config.broadcast(
-          parsed,
-          context
-        );
+        const output = yield procedure.config.broadcast(parsed, context);
         Object.entries(output).forEach(([_type, _data]) => {
           this._simulateEvent(_type, _data);
         });
@@ -1647,7 +1675,11 @@ var MockedRoom = class extends AbstractRoom {
       presenceMaxSize: MAX_PRESENCE_SIZE_BYTES
     }, limits);
     this._router = router != null ? router : new PluvRouter({});
-    this._usersManager = new UsersManager({ initialPresence, limits: this._limits, presence });
+    this._usersManager = new UsersManager({
+      initialPresence,
+      limits: this._limits,
+      presence
+    });
     this._crdtManager = new CrdtManager({
       initialStorage
     });