refactor(server): deprecate unstable redis manager (#4567)

apps/server/tests/doc.spec.ts

@@ -75,7 +75,8 @@ test('should poll when intervel due', async t => {
   const interval = m.get(Config).doc.manager.updatePollInterval;
 
   let resolve: any;
-  const fake = mock.method(manager, 'apply', () => {
+  // @ts-expect-error private method
+  const fake = mock.method(manager, 'autoSquash', () => {
     return new Promise(_resolve => {
       resolve = _resolve;
     });
@@ -121,19 +122,22 @@ test('should merge update when intervel due', async t => {
         id: '1',
         workspaceId: '1',
         blob: Buffer.from([0, 0]),
+        seq: 1,
       },
       {
         id: '1',
         workspaceId: '1',
         blob: Buffer.from(update),
+        seq: 2,
       },
     ],
   });
 
-  await manager.apply();
+  // @ts-expect-error private method
+  await manager.autoSquash();
 
   t.deepEqual(
-    (await manager.getLatestUpdate(ws.id, '1'))?.toString('hex'),
+    (await manager.getBinary(ws.id, '1'))?.toString('hex'),
     Buffer.from(update.buffer).toString('hex')
   );
 
@@ -148,13 +152,95 @@ test('should merge update when intervel due', async t => {
       workspaceId: ws.id,
       id: '1',
       blob: appendUpdate,
+      seq: 3,
     },
   });
 
-  await manager.apply();
+  // @ts-expect-error private method
+  await manager.autoSquash();
 
   t.deepEqual(
-    (await manager.getLatestUpdate(ws.id, '1'))?.toString('hex'),
+    (await manager.getBinary(ws.id, '1'))?.toString('hex'),
     Buffer.from(encodeStateAsUpdate(doc)).toString('hex')
   );
 });
+
+test('should have sequential update number', async t => {
+  const db = m.get(PrismaService);
+  const manager = m.get(DocManager);
+  const doc = new YDoc();
+  const text = doc.getText('content');
+  const updates: Buffer[] = [];
+
+  doc.on('update', update => {
+    updates.push(Buffer.from(update));
+  });
+
+  text.insert(0, 'hello');
+  text.insert(5, 'world');
+  text.insert(5, ' ');
+
+  await Promise.all(updates.map(update => manager.push('2', '2', update)));
+
+  // [1,2,3]
+  // @ts-expect-error private method
+  let records = await manager.getUpdates('2', '2');
+
+  t.deepEqual(
+    records.map(({ seq }) => seq),
+    [1, 2, 3]
+  );
+
+  // @ts-expect-error private method
+  await manager.autoSquash();
+
+  await db.snapshot.update({
+    where: {
+      id_workspaceId: {
+        id: '2',
+        workspaceId: '2',
+      },
+    },
+    data: {
+      seq: 0x3ffffffe,
+    },
+  });
+
+  await Promise.all(updates.map(update => manager.push('2', '2', update)));
+
+  // @ts-expect-error private method
+  records = await manager.getUpdates('2', '2');
+
+  // push a new update with new seq num
+  await manager.push('2', '2', updates[0]);
+
+  // let the manager ignore update with the new seq num
+  // @ts-expect-error private method
+  const stub = Sinon.stub(manager, 'getUpdates').resolves(records);
+
+  // @ts-expect-error private method
+  await manager.autoSquash();
+  stub.restore();
+
+  // @ts-expect-error private method
+  records = await manager.getUpdates('2', '2');
+
+  // should not merge in one run
+  t.not(records.length, 0);
+});
+
+test('should retry if seq num conflict', async t => {
+  const manager = m.get(DocManager);
+
+  // @ts-expect-error private method
+  const stub = Sinon.stub(manager, 'getUpdateSeq');
+
+  stub.onCall(0).resolves(1);
+  // seq num conflict
+  stub.onCall(1).resolves(1);
+  stub.onCall(2).resolves(2);
+  await t.notThrowsAsync(() => manager.push('1', '1', Buffer.from([0, 0])));
+  await t.notThrowsAsync(() => manager.push('1', '1', Buffer.from([0, 0])));
+
+  t.is(stub.callCount, 3);
+});