feat: 🎸 add util.info route

Author: streamich

src/server/__tests__/util.spec.ts

@@ -1,15 +1,15 @@
 import {setup} from './setup';
 
-describe('util', () => {
-  describe('ping', () => {
+describe('util.*', () => {
+  describe('util.ping', () => {
     test('returns pong', async () => {
       const {caller} = setup();
       const res = await caller.call('util.ping', {}, {});
       expect(res.data).toBe('pong');
     });
   });
 
-  describe('echo', () => {
+  describe('util.echo', () => {
     test('returns strings', async () => {
       const {caller} = setup();
       const res = await caller.call('util.echo', 'hello world', {});
@@ -22,4 +22,29 @@ describe('util', () => {
       expect(res.data).toStrictEqual({foo: 'bar'});
     });
   });
+
+  describe('util.info', () => {
+    test('returns stats object', async () => {
+      const {call} = setup();
+      const res = await call('util.info', {}, {});
+      expect(res).toMatchObject({
+        now: expect.any(Number),
+        stats: {
+          pubsub: {
+            channels: expect.any(Number),
+            observers: expect.any(Number),
+          },
+          presence: {
+            rooms: expect.any(Number),
+            entries: expect.any(Number),
+            observers: expect.any(Number),
+          },
+          blocks: {
+            blocks: expect.any(Number),
+            patches: expect.any(Number),
+          },
+        },
+      });
+    });
+  });
 });

src/server/routes/util/index.ts

@@ -24,8 +24,45 @@ export const echo =
     return router.fn('util.echo', func);
   };
 
+export const info =
+  ({services}: RouteDeps) =>
+  <R extends RoutesBase>(router: TypeRouter<R>) => {
+    const t = router.t;
+    const Request = t.any;
+    const Response = t.Object(
+      t.prop('now', t.num),
+      t.prop('stats', t.Object(
+        t.prop('pubsub', t.Object(
+          t.prop('channels', t.num),
+          t.prop('observers', t.num),
+        )),
+        t.prop('presence', t.Object(
+          t.prop('rooms', t.num),
+          t.prop('entries', t.num),
+          t.prop('observers', t.num),
+        )),
+        t.prop('blocks', t.Object(
+          t.prop('blocks', t.num),
+          t.prop('patches', t.num),
+        )),
+      )),
+    );
+    const Func = t.Function(Request, Response).implement<MyCtx>(async () => {
+      return {
+        now: Date.now(),
+        stats: {
+          pubsub: services.pubsub.stats(),
+          presence: services.presence.stats(),
+          blocks: services.blocks.stats(),
+        },
+      };
+    });
+    return router.fn('util.info', Func);
+  };
+
 // prettier-ignore
 export const util = (deps: RouteDeps) => <R extends RoutesBase>(r: TypeRouter<R>) =>
   ( ping(deps)
   ( echo(deps)
-  ( r )));
+  ( info(deps)
+  ( r ))));

src/server/services/PresenceService.ts

@@ -90,4 +90,12 @@ export class PresenceService {
     }
     if (!room.size) this.rooms.delete(roomId);
   }
+
+  public stats(): {rooms: number, entries: number, observers: number} {
+    return {
+      rooms: this.rooms.size,
+      entries: [...this.rooms.values()].reduce((acc, v) => acc + v.size, 0),
+      observers: [...this.observers.values()].reduce((acc, v) => acc + v.length, 0),
+    };
+  }
 }

src/server/services/PubSubService.ts

@@ -26,4 +26,11 @@ export class PubsubService {
     if (!observers) return;
     for (const observer of observers) observer.next(message);
   }
+
+  public stats(): {channels: number, observers: number} {
+    return {
+      channels: this.observers.size,
+      observers: [...this.observers.values()].reduce((acc, v) => acc + v.length, 0),
+    };
+  }
 }

src/server/services/blocks/BlocksServices.ts

@@ -59,4 +59,8 @@ export class BlocksServices {
       patches: patchesBack,
     };
   }
+
+  public stats() {
+    return this.store.stats();
+  }
 }

src/server/services/blocks/MemoryStore.ts

@@ -75,4 +75,11 @@ export class MemoryStore implements types.Store {
     this.blocks.delete(id);
     this.patches.delete(id);
   }
+
+  public stats(): {blocks: number, patches: number} {
+    return {
+      blocks: this.blocks.size,
+      patches: [...this.patches.values()].reduce((acc, v) => acc + v.length, 0),
+    };
+  }
 }