feat: 🎸 cleanup block.scan method

Author: streamich

src/__demos__/json-crdt-server/routes/block/index.ts

@@ -41,6 +41,6 @@ export const block =
     ( upd(d)
     ( del(d)
     // ( listen(d)
-    // ( scan(d)
-    ( r ))))));
+    ( scan(d)
+    ( r )))))));
   };

src/__demos__/json-crdt-server/routes/block/methods/scan.ts

@@ -1,15 +1,15 @@
-import type {BlockPatch, BlockId} from '../schema';
+import {BlockIdRef, BlockCurRef, BlockPatchRef} from '../schema';
 import type {RouteDeps, Router, RouterBase} from '../../types';
 
 export const scan =
   ({t, services}: RouteDeps) =>
   <R extends RouterBase>(r: Router<R>) => {
     const Request = t.Object(
-      t.prop('id', t.Ref<typeof BlockId>('BlockId')).options({
+      t.prop('id', BlockIdRef).options({
         title: 'Block ID',
         description: 'The ID of the block.',
       }),
-      t.propOpt('seq', t.num.options({format: 'u32'})).options({
+      t.propOpt('cur', BlockCurRef).options({
         title: 'Starting Sequence Number',
         description: 'The sequence number to start from. Defaults to the latest sequence number.',
       }),
@@ -20,21 +20,13 @@ export const scan =
           'When positive, returns the patches ahead of the starting sequence number. ' +
           'When negative, returns the patches behind the starting sequence number.',
       }),
-      t.propOpt('model', t.bool).options({
-        title: 'With Model',
-        intro: 'Whether to include the model.',
-        description:
-          'Whether to include the model in the response. ' +
-          'Defaults to `false`, when `len` is positive; and, defaults to `true`, when `len` is negative.',
-      }),
     );
 
     const Response = t.Object(
-      t.prop('patches', t.Array(t.Ref<typeof BlockPatch>('BlockPatch'))).options({
+      t.prop('patches', t.Array(BlockPatchRef)).options({
         title: 'Patches',
         description: 'The list of patches.',
       }),
-      t.propOpt('model', t.bin),
     );
 
     const Func = t.Function(Request, Response).options({
@@ -43,9 +35,11 @@ export const scan =
       description: 'Returns a list of specified change patches for a block.',
     });
 
-    return r.prop('block.scan', Func, async ({id, seq, limit = 10, model: returnModel = limit > 0}) => {
-      const {patches, model} = await services.blocks.scan(id, seq, limit, returnModel);
-      const modelBlob: Uint8Array | undefined = model?.toBinary();
-      return {patches, model: modelBlob};
+    return r.prop('block.scan', Func, async ({id, cur, limit = 10}) => {
+      const {patches} = await services.blocks.scan(id, cur, limit);
+      return {patches: patches.map(p => ({
+        blob: p.blob,
+        ts: p.created,
+      }))};
     });
   };

src/__demos__/json-crdt-server/services/blocks/BlocksServices.ts

@@ -93,7 +93,6 @@ export class BlocksServices {
     id: string,
     offset: number | undefined,
     limit: number | undefined = 10,
-    returnStartSnapshot: boolean = limit < 0,
   ) {
     const {store} = this;
     if (typeof offset !== 'number') offset = await store.seq(id);
@@ -112,14 +111,7 @@ export class BlocksServices {
       max = Math.abs(limit);
     }
     const patches = await store.history(id, min, max);
-    let model: Model | undefined;
-    if (returnStartSnapshot) {
-      const startPatches = await store.history(id, 0, min);
-      if (startPatches.length) {
-        model = Model.fromPatches(startPatches.map((p) => Patch.fromBinary(p.blob)));
-      }
-    }
-    return {patches, model};
+    return {patches};
   }
 
   public async edit(id: string, patches: Pick<StorePatch, 'blob'>[]) {

src/__tests__/json-crdt-server/block.ts

@@ -323,68 +323,61 @@ export const runBlockTests = (_setup: ApiTestSetup, params: {staticOnly?: true}
     //   });
     // }
 
-    // describe('block.scan', () => {
-    //   test('can retrieve change history', async () => {
-    //     const {call, stop} = await setup();
-    //     const id = getId();
-    //     const model = Model.withLogicalClock();
-    //     model.api.root({
-    //       text: 'Hell',
-    //     });
-    //     const patch1 = model.api.flush();
-    //     await call('block.new', {
-    //       id,
-    //       patches: [
-    //         {
-    //           blob: patch1.toBinary(),
-    //         },
-    //       ],
-    //     });
-    //     await tick(11);
-    //     model.api.str(['text']).ins(4, 'o');
-    //     const patch2 = model.api.flush();
-    //     model.api.obj([]).set({
-    //       age: 26,
-    //     });
-    //     const patch3 = model.api.flush();
-    //     await call('block.upd', {
-    //       id,
-    //       patches: [
-    //         {
-    //           seq: 1,
-    //           created: Date.now(),
-    //           blob: patch2.toBinary(),
-    //         },
-    //         {
-    //           seq: 2,
-    //           created: Date.now(),
-    //           blob: patch3.toBinary(),
-    //         },
-    //       ],
-    //     });
-    //     const history = await call('block.scan', {id, seq: 0, limit: 3});
-    //     expect(history).toMatchObject({
-    //       patches: [
-    //         {
-    //           seq: 0,
-    //           created: expect.any(Number),
-    //           blob: patch1.toBinary(),
-    //         },
-    //         {
-    //           seq: 1,
-    //           created: expect.any(Number),
-    //           blob: patch2.toBinary(),
-    //         },
-    //         {
-    //           seq: 2,
-    //           created: expect.any(Number),
-    //           blob: patch3.toBinary(),
-    //         },
-    //       ],
-    //     });
-    //     stop();
-    //   });
-    // });
+    describe('block.scan', () => {
+      test('can retrieve change history', async () => {
+        const {call, stop} = await setup();
+        const id = getId();
+        const model = Model.withLogicalClock();
+        model.api.root({
+          text: 'Hell',
+        });
+        const patch1 = model.api.flush();
+        await call('block.new', {
+          id,
+          patches: [
+            {
+              blob: patch1.toBinary(),
+            },
+          ],
+        });
+        await tick(11);
+        model.api.str(['text']).ins(4, 'o');
+        const patch2 = model.api.flush();
+        model.api.obj([]).set({
+          age: 26,
+        });
+        const patch3 = model.api.flush();
+        await call('block.upd', {
+          id,
+          patches: [
+            {
+              blob: patch2.toBinary(),
+            },
+            {
+              blob: patch3.toBinary(),
+            },
+          ],
+        });
+        const history = await call('block.scan', {id, cur: 0, limit: 3});
+        expect(history).toMatchObject({
+          patches: [
+            {
+              ts: expect.any(Number),
+              blob: patch1.toBinary(),
+            },
+            {
+              ts: expect.any(Number),
+              blob: patch2.toBinary(),
+            },
+            {
+              ts: expect.any(Number),
+              blob: patch3.toBinary(),
+            },
+          ],
+        });
+        stop();
+      });
+    });
 
     describe('block.get', () => {
       test('can load a block', async () => {