@liveblocks/server 1.6.0 → 1.6.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
+import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, CreateOp, HasOpId, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
 export { BroadcastEventClientMsg, ClientMsg, ClientWireOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, FetchYDocClientMsg, HasOpId, IgnoredOp, Op, RoomStateServerMsg, ServerMsg, ServerWireOp, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UpdateYDocClientMsg } from '@liveblocks/core';
 import * as decoders from 'decoders';
 import { Decoder } from 'decoders';
@@ -1121,7 +1121,18 @@ declare class Logger {
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 
-type ApplyOpResult = OpAccepted | OpIgnored;
+/**
+ * The three possible outcomes of applying a client op. They differ along
+ * when the op (first) changed storage state, who hears about it, and what
+ * gets sent back to the originating client:
+ *
+ * |             | state change | fan out to others | reply to sender  |
+ * |-------------|--------------|-------------------|------------------|
+ * | OpAccepted  | now          | yes               | ack echo (+ fix) |
+ * | OpRectified | in the past  | no                | ack echo + fix   |
+ * | OpIgnored   | never        | no                | bare (H)Ack      |
+ */
+type ApplyOpResult = OpAccepted | OpIgnored | OpRectified;
 type OpAccepted = {
     action: "accepted";
     op: ClientWireOp;
@@ -1131,6 +1142,24 @@ type OpIgnored = {
     action: "ignored";
     ignoredOpId?: string;
 };
+type OpRectified = {
+    action: "rectified";
+    /**
+     * Echo of the client's op, with the stored, authoritative parentKey. Sent
+     * back to the originating client as the acknowledgement, instead of the
+     * bare (H)Ack. Used for re-sent CREATE ops whose node the server already
+     * stored: the echo carries the authoritative position, so the client can
+     * correct any optimistic local position it may have predicted while the op
+     * was pending. Never fanned out to others: they already received the op
+     * when it was originally accepted.
+     */
+    ackOp: CreateOp & HasOpId;
+    /**
+     * A corrective op to send back to the originating client, stating that
+     * same authoritative position (see ackOp).
+     */
+    fix: FixOp;
+};
 declare class Storage {
     readonly driver: IStorageDriver;
     constructor(driver: IStorageDriver);

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
+import { Json, asPos, IUserInfo, SerializedCrdt, JsonObject, DistributiveOmit, SetParentKeyOp, DeleteCrdtOp, ClientMsg as ClientMsg$1, Brand, SerializedRootObject, SerializedChild, StorageNode, CompactNode, PlainLsonObject, NodeMap as NodeMap$1, NodeStream as NodeStream$1, ClientWireOp, CreateOp, HasOpId, ServerMsg as ServerMsg$1, BaseUserMeta, IgnoredOp } from '@liveblocks/core';
 export { BroadcastEventClientMsg, ClientMsg, ClientWireOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, FetchYDocClientMsg, HasOpId, IgnoredOp, Op, RoomStateServerMsg, ServerMsg, ServerWireOp, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UpdateYDocClientMsg } from '@liveblocks/core';
 import * as decoders from 'decoders';
 import { Decoder } from 'decoders';
@@ -1121,7 +1121,18 @@ declare class Logger {
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
  */
 
-type ApplyOpResult = OpAccepted | OpIgnored;
+/**
+ * The three possible outcomes of applying a client op. They differ along
+ * when the op (first) changed storage state, who hears about it, and what
+ * gets sent back to the originating client:
+ *
+ * |             | state change | fan out to others | reply to sender  |
+ * |-------------|--------------|-------------------|------------------|
+ * | OpAccepted  | now          | yes               | ack echo (+ fix) |
+ * | OpRectified | in the past  | no                | ack echo + fix   |
+ * | OpIgnored   | never        | no                | bare (H)Ack      |
+ */
+type ApplyOpResult = OpAccepted | OpIgnored | OpRectified;
 type OpAccepted = {
     action: "accepted";
     op: ClientWireOp;
@@ -1131,6 +1142,24 @@ type OpIgnored = {
     action: "ignored";
     ignoredOpId?: string;
 };
+type OpRectified = {
+    action: "rectified";
+    /**
+     * Echo of the client's op, with the stored, authoritative parentKey. Sent
+     * back to the originating client as the acknowledgement, instead of the
+     * bare (H)Ack. Used for re-sent CREATE ops whose node the server already
+     * stored: the echo carries the authoritative position, so the client can
+     * correct any optimistic local position it may have predicted while the op
+     * was pending. Never fanned out to others: they already received the op
+     * when it was originally accepted.
+     */
+    ackOp: CreateOp & HasOpId;
+    /**
+     * A corrective op to send back to the originating client, stating that
+     * same authoritative position (see ackOp).
+     */
+    fix: FixOp;
+};
 declare class Storage {
     readonly driver: IStorageDriver;
     constructor(driver: IStorageDriver);

package/dist/index.js

@@ -1563,6 +1563,13 @@ function accept(op2, fix) {
 function ignore(ignoredOp) {
   return { action: "ignored", ignoredOpId: ignoredOp.opId };
 }
+function rectify(op2, parentKey) {
+  return {
+    action: "rectified",
+    ackOp: { ...op2, parentKey },
+    fix: { type: OpCode2.SET_PARENT_KEY, id: op2.id, parentKey }
+  };
+}
 function nodeFromCreateChildOp(op2) {
   switch (op2.type) {
     case OpCode2.CREATE_LIST:
@@ -1652,6 +1659,12 @@ var Storage = class {
   }
   applyCreateOp(op2) {
     if (this.driver.has_node(op2.id)) {
+      if (op2.intent === "push") {
+        const stored = this.driver.get_node(op2.id);
+        if (stored?.parentId !== void 0 && this.driver.get_node(stored.parentId)?.type === CrdtType5.LIST) {
+          return rectify(op2, stored.parentKey);
+        }
+      }
       return ignore(op2);
     }
     const node = nodeFromCreateChildOp(op2);
@@ -3109,17 +3122,21 @@ var Room = class {
         const opsToForward = result.flatMap(
           (r) => r.action === "accepted" ? [r.op] : []
         );
-        const opsToSendBack = result.flatMap((r) => {
-          switch (r.action) {
-            case "ignored":
-              return r.ignoredOpId !== void 0 ? [ackIgnoredOp(r.ignoredOpId)] : [];
-            case "accepted":
-              return r.fix !== void 0 ? [r.fix] : [];
-            // istanbul ignore next
-            default:
-              return assertNever3(r, "Unhandled case");
+        const opsToSendBack = result.flatMap(
+          (r) => {
+            switch (r.action) {
+              case "ignored":
+                return r.ignoredOpId !== void 0 ? [ackIgnoredOp(r.ignoredOpId)] : [];
+              case "rectified":
+                return [r.ackOp, r.fix];
+              case "accepted":
+                return r.fix !== void 0 ? [r.fix] : [];
+              // istanbul ignore next
+              default:
+                return assertNever3(r, "Unhandled case");
+            }
           }
-        });
+        );
         if (opsToForward.length > 0) {
           scheduleFanOut({
             type: ServerMsgCode2.UPDATE_STORAGE,