@vuer-ai/vuer-rtc-server 0.2.0 → 0.2.2

package/src/journal/rle-demo.ts

@@ -0,0 +1,193 @@
+/**
+ * RLE Compression Demonstration
+ *
+ * Shows real-world compression stats for different journal patterns.
+ * Run with: node --loader ts-node/esm src/journal/rle-demo.ts
+ */
+
+import type { CRDTMessage } from '@vuer-ai/vuer-rtc';
+import {
+  encodeJournalRLE,
+  getCompressionStats,
+  verifyRLEIntegrity,
+} from './JournalRLE.js';
+
+/**
+ * Create a test message
+ */
+function createMessage(
+  id: string,
+  sessionId: string,
+  lamportTime: number,
+  timestamp: number,
+  key: string = 'cube-1',
+  value: any = [lamportTime, 0, 0]
+): CRDTMessage {
+  return {
+    id,
+    sessionId,
+    clock: { [sessionId]: lamportTime },
+    lamportTime,
+    timestamp,
+    ops: [
+      {
+        key,
+        otype: 'vector3.set',
+        path: 'position',
+        value,
+      },
+    ],
+  };
+}
+
+/**
+ * Run demonstrations
+ */
+function main() {
+  console.log('\n=== RLE Journal Compression Demo ===\n');
+
+  // Scenario 1: Single user, sequential edits
+  console.log('SCENARIO 1: Single user (50 sequential edits)');
+  console.log('─'.repeat(50));
+  {
+    const messages = Array.from({ length: 50 }, (_, i) =>
+      createMessage(`msg-${i}`, 'user-1', i, 1000 + i)
+    );
+
+    const encoded = encodeJournalRLE(messages);
+    const stats = getCompressionStats(encoded);
+    const verification = verifyRLEIntegrity(messages, encoded);
+
+    console.log(`Messages:        ${stats.originalBytes.toLocaleString()} bytes`);
+    console.log(`Encoded:         ${stats.compressedBytes.toLocaleString()} bytes`);
+    console.log(`Segments:        ${stats.segmentCount}`);
+    console.log(`Avg/Segment:     ${stats.avgMessagesPerSegment.toFixed(1)}`);
+    console.log(`Ratio:           ${stats.ratio.toFixed(3)}`);
+    console.log(`Saved:           ${stats.percentSaved.toFixed(1)}%`);
+    console.log(`Integrity:       ${verification.valid ? 'PASS' : 'FAIL'}`);
+  }
+
+  // Scenario 2: Two users, alternating edits
+  console.log('\n\nSCENARIO 2: Two users (50 alternating edits)');
+  console.log('─'.repeat(50));
+  {
+    const messages: CRDTMessage[] = [];
+    for (let i = 0; i < 50; i++) {
+      const user = i % 2 === 0 ? 'user-1' : 'user-2';
+      messages.push(createMessage(`msg-${i}`, user, i, 1000 + i));
+    }
+
+    const encoded = encodeJournalRLE(messages);
+    const stats = getCompressionStats(encoded);
+    const verification = verifyRLEIntegrity(messages, encoded);
+
+    console.log(`Messages:        ${stats.originalBytes.toLocaleString()} bytes`);
+    console.log(`Encoded:         ${stats.compressedBytes.toLocaleString()} bytes`);
+    console.log(`Segments:        ${stats.segmentCount}`);
+    console.log(`Avg/Segment:     ${stats.avgMessagesPerSegment.toFixed(1)}`);
+    console.log(`Ratio:           ${stats.ratio.toFixed(3)}`);
+    console.log(`Saved:           ${stats.percentSaved.toFixed(1)}%`);
+    console.log(`Integrity:       ${verification.valid ? 'PASS' : 'FAIL'}`);
+  }
+
+  // Scenario 3: Four users, burst patterns
+  console.log('\n\nSCENARIO 3: Four users (100 bursts of 5 edits)');
+  console.log('─'.repeat(50));
+  {
+    const messages: CRDTMessage[] = [];
+    let msgId = 0;
+    let lamportTime = 0;
+
+    for (let burst = 0; burst < 20; burst++) {
+      const user = `user-${(burst % 4) + 1}`;
+      for (let i = 0; i < 5; i++) {
+        messages.push(
+          createMessage(`msg-${msgId++}`, user, lamportTime++, 1000 + lamportTime)
+        );
+      }
+    }
+
+    const encoded = encodeJournalRLE(messages);
+    const stats = getCompressionStats(encoded);
+    const verification = verifyRLEIntegrity(messages, encoded);
+
+    console.log(`Messages:        ${stats.originalBytes.toLocaleString()} bytes`);
+    console.log(`Encoded:         ${stats.compressedBytes.toLocaleString()} bytes`);
+    console.log(`Segments:        ${stats.segmentCount}`);
+    console.log(`Avg/Segment:     ${stats.avgMessagesPerSegment.toFixed(1)}`);
+    console.log(`Ratio:           ${stats.ratio.toFixed(3)}`);
+    console.log(`Saved:           ${stats.percentSaved.toFixed(1)}%`);
+    console.log(`Integrity:       ${verification.valid ? 'PASS' : 'FAIL'}`);
+  }
+
+  // Scenario 4: Realistic editing with large ops
+  console.log('\n\nSCENARIO 4: Large operations (node tree modifications)');
+  console.log('─'.repeat(50));
+  {
+    const messages: CRDTMessage[] = [];
+
+    for (let i = 0; i < 30; i++) {
+      const user = i < 15 ? 'user-1' : 'user-2';
+      const msg: CRDTMessage = {
+        id: `msg-${i}`,
+        sessionId: user,
+        clock: { [user]: i },
+        lamportTime: i,
+        timestamp: 1000 + i,
+        ops: [
+          {
+            key: `node-${i % 5}`,
+            otype: 'node.insert',
+            path: 'children',
+            value: {
+              key: `child-${i}`,
+              tag: 'Mesh',
+              name: `Node ${i}`,
+              position: [i * 0.1, 0, 0],
+              rotation: [0, Math.PI * (i % 4) / 4, 0],
+              scale: [1, 1, 1],
+            },
+          },
+          {
+            key: `node-${i % 5}`,
+            otype: 'vector3.set',
+            path: 'color',
+            value: [Math.random(), Math.random(), Math.random()],
+          },
+        ],
+      };
+      messages.push(msg);
+    }
+
+    const encoded = encodeJournalRLE(messages);
+    const stats = getCompressionStats(encoded);
+    const verification = verifyRLEIntegrity(messages, encoded);
+
+    console.log(`Messages:        ${stats.originalBytes.toLocaleString()} bytes`);
+    console.log(`Encoded:         ${stats.compressedBytes.toLocaleString()} bytes`);
+    console.log(`Segments:        ${stats.segmentCount}`);
+    console.log(`Avg/Segment:     ${stats.avgMessagesPerSegment.toFixed(1)}`);
+    console.log(`Ratio:           ${stats.ratio.toFixed(3)}`);
+    console.log(`Saved:           ${stats.percentSaved.toFixed(1)}%`);
+    console.log(`Integrity:       ${verification.valid ? 'PASS' : 'FAIL'}`);
+  }
+
+  // Summary
+  console.log('\n\n=== Summary ===');
+  console.log('─'.repeat(50));
+  console.log(`
+RLE encoding works by:
+1. Grouping consecutive messages from the same agent
+2. Storing agent ID once per segment instead of per message
+3. Reducing redundancy in causality metadata
+
+Key insights:
+- More effective with binary codecs (not JSON strings)
+- Best for single-agent or burst patterns
+- Maintains all CRDT semantics and causality
+- Zero overhead for integrity verification
+- Ready for integration with storage backends
+  `);
+}
+
+main();