Simplify outbound queue API

Author: marcus-pousette

examples/playground/src/App.tsx

@@ -469,7 +469,7 @@ export default function App() {
     liveAllEnabled,
     setLiveAllEnabled,
     toggleLiveChildren,
-    queueLocalOpsForSync,
+    queueOpsForSync,
     handleSync,
     handleScopedSync,
     postBroadcastMessage,
@@ -500,10 +500,10 @@ export default function App() {
   const handleCommittedLocalOps = React.useCallback(
     (ops: Operation[]) => {
       // The local write already committed. This only feeds playground sync and debug UI state.
-      queueLocalOpsForSync(ops);
+      queueOpsForSync(ops);
       recordOps(ops, { assumeSorted: true });
     },
-    [queueLocalOpsForSync, recordOps]
+    [queueOpsForSync, recordOps]
   );
 
   const grantSubtreeToReplicaPubkey = React.useCallback(

examples/playground/src/playground/hooks/usePlaygroundSync.ts

@@ -96,7 +96,7 @@ type PlaygroundSyncApi = {
   liveAllEnabled: boolean;
   setLiveAllEnabled: React.Dispatch<React.SetStateAction<boolean>>;
   toggleLiveChildren: (parentId: string) => void;
-  queueLocalOpsForSync: (ops?: Operation[]) => void;
+  queueOpsForSync: (ops?: Operation[]) => void;
   handleSync: (filter: Filter) => Promise<void>;
   handleScopedSync: () => Promise<void>;
   postBroadcastMessage: (
@@ -204,9 +204,9 @@ export function usePlaygroundSync(opts: UsePlaygroundSyncOptions): PlaygroundSyn
   const autoSyncAttemptRef = useRef(0);
   const autoSyncPeerIdRef = useRef<string | null>(null);
 
-  const queueLocalOpsForSync = (ops?: Operation[]) => {
+  const queueOpsForSync = (ops?: Operation[]) => {
     void syncPeerRef.current?.notifyLocalUpdate(ops);
-    outboundSyncRef.current?.queueLocalOps(ops);
+    outboundSyncRef.current?.queue(ops);
   };
 
   const dropPeerConnection = (peerId: string) => {
@@ -729,7 +729,7 @@ export function usePlaygroundSync(opts: UsePlaygroundSyncOptions): PlaygroundSyn
     liveAllEnabled,
     setLiveAllEnabled,
     toggleLiveChildren,
-    queueLocalOpsForSync,
+    queueOpsForSync,
     handleSync,
     handleScopedSync,
     postBroadcastMessage,

packages/treecrdt-sync/README.md

@@ -64,7 +64,7 @@ outbound.addPeer('remote:server', websocketTransport);
 
 const op = await client.local.payload(replica, node, payload);
 await peer.notifyLocalUpdate([op]); // local mesh fanout
-outbound.queueLocalOps([op]); // remote websocket upload/retry
+outbound.queue([op]); // remote websocket upload/retry
 ```
 
 ## When not to

packages/treecrdt-sync/src/controller.ts

@@ -110,7 +110,7 @@ export type OutboundSync<Op = Operation> = {
   addPeer: (peerId: string, transport: DuplexTransport<SyncMessage<Op>>) => void;
   removePeer: (peerId: string) => void;
   clearPeers: () => void;
-  queueLocalOps: (ops?: readonly Op[]) => void;
+  queue: (ops?: readonly Op[]) => void;
   flush: () => Promise<void>;
   close: () => void;
 };
@@ -525,7 +525,7 @@ export function createOutboundSync<Op = Operation>(
       peers.clear();
       emitStatus();
     },
-    queueLocalOps: (ops = []) => {
+    queue: (ops = []) => {
       if (closed) return;
       if (ops.length > 0) addPendingOps(ops);
       else needsFullSync = true;

packages/treecrdt-sync/tests/controller.test.ts

@@ -220,7 +220,7 @@ test('outbound sync queues local ops until a selected peer is available', async
     shouldSyncPeer: (peerId) => peerId.startsWith('remote:'),
   });
 
-  controller.queueLocalOps([op, op]);
+  controller.queue([op, op]);
   await controller.flush();
 
   expect(controller.pendingOpCount).toBe(1);
@@ -250,7 +250,7 @@ test('outbound sync keeps failed direct pushes queued', async () => {
   });
   controller.addPeer('remote:server', {} as any);
 
-  controller.queueLocalOps([op]);
+  controller.queue([op]);
   await controller.flush();
 
   expect(controller.pendingOpCount).toBe(1);
@@ -272,7 +272,7 @@ test('outbound sync runs fallback sync when no exact ops are available', async (
   });
   controller.addPeer('remote:server', {} as any);
 
-  controller.queueLocalOps();
+  controller.queue();
   await controller.flush();
 
   expect(controller.pendingOpCount).toBe(0);