store counter and current state in the DB to order and verify events on the server

Author: nikgraf

apps/server/prisma/migrations/20241113083927_introduce_counter_and_state_to_space_events/migration.sql

@@ -0,0 +1,25 @@
+/*
+  Warnings:
+
+  - Added the required column `counter` to the `SpaceEvent` table without a default value. This is not possible if the table is not empty.
+  - Added the required column `state` to the `SpaceEvent` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- RedefineTables
+PRAGMA defer_foreign_keys=ON;
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_SpaceEvent" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "event" TEXT NOT NULL,
+    "state" TEXT NOT NULL,
+    "counter" INTEGER NOT NULL,
+    "spaceId" TEXT NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    CONSTRAINT "SpaceEvent_spaceId_fkey" FOREIGN KEY ("spaceId") REFERENCES "Space" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);
+INSERT INTO "new_SpaceEvent" ("event", "id", "spaceId") SELECT "event", "id", "spaceId" FROM "SpaceEvent";
+DROP TABLE "SpaceEvent";
+ALTER TABLE "new_SpaceEvent" RENAME TO "SpaceEvent";
+CREATE UNIQUE INDEX "SpaceEvent_spaceId_counter_key" ON "SpaceEvent"("spaceId", "counter");
+PRAGMA foreign_keys=ON;
+PRAGMA defer_foreign_keys=OFF;

apps/server/prisma/schema.prisma

@@ -11,10 +11,15 @@ datasource db {
 }
 
 model SpaceEvent {
-  id      String @id
-  event   String
-  space   Space  @relation(fields: [spaceId], references: [id])
-  spaceId String
+  id        String   @id
+  event     String
+  state     String
+  counter   Int
+  space     Space    @relation(fields: [spaceId], references: [id])
+  spaceId   String
+  createdAt DateTime @default(now())
+
+  @@unique([spaceId, counter])
 }
 
 model Space {

apps/server/src/handlers/applySpaceEvent.ts

@@ -0,0 +1,44 @@
+import { Effect, Exit } from 'effect';
+import type { SpaceEvent } from 'graph-framework-space-events';
+import { applyEvent } from 'graph-framework-space-events';
+import { prisma } from '../prisma.js';
+
+type Params = {
+  accountId: string;
+  spaceId: string;
+  event: SpaceEvent;
+};
+
+export async function applySpaceEvent({ accountId, spaceId, event }: Params) {
+  return await prisma.$transaction(async (transaction) => {
+    if (event.transaction.type === 'create-space') {
+      throw new Error('applySpaceEvent does not support create-space events.');
+    }
+
+    // verify that the account is a member of the space
+    // TODO verify that the account is a admin of the space
+    await transaction.space.findUniqueOrThrow({
+      where: { id: spaceId, members: { some: { id: accountId } } },
+    });
+
+    const lastEvent = await transaction.spaceEvent.findFirstOrThrow({
+      where: { spaceId },
+      orderBy: { counter: 'desc' },
+    });
+
+    const result = await Effect.runPromiseExit(applyEvent({ event }));
+    if (Exit.isFailure(result)) {
+      throw new Error('Invalid event');
+    }
+
+    return await transaction.spaceEvent.create({
+      data: {
+        spaceId,
+        counter: lastEvent.counter + 1,
+        event: JSON.stringify(event),
+        id: event.transaction.id,
+        state: JSON.stringify(result.value),
+      },
+    });
+  });
+}

apps/server/src/handlers/createSpace.ts

@@ -1,4 +1,5 @@
-import type { CreateSpaceEvent } from 'graph-framework-space-events';
+import { Effect, Exit } from 'effect';
+import { type CreateSpaceEvent, applyEvent } from 'graph-framework-space-events';
 import { prisma } from '../prisma.js';
 
 type Params = {
@@ -7,10 +8,17 @@ type Params = {
 };
 
 export const createSpace = async ({ accountId, event }: Params) => {
+  const result = await Effect.runPromiseExit(applyEvent({ event }));
+  if (Exit.isFailure(result)) {
+    throw new Error('Invalid event');
+  }
+
   return await prisma.spaceEvent.create({
     data: {
       event: JSON.stringify(event),
       id: event.transaction.id,
+      counter: 0,
+      state: JSON.stringify(result.value),
       space: {
         create: {
           id: event.transaction.id,

apps/server/src/handlers/getSpace.ts

@@ -16,7 +16,11 @@ export const getSpace = async ({ spaceId, accountId }: Params) => {
       },
     },
     include: {
-      events: true,
+      events: {
+        orderBy: {
+          counter: 'asc',
+        },
+      },
     },
   });
 };

packages/graph-framework-space-events/src/apply-event.ts

@@ -2,7 +2,7 @@ import { secp256k1 } from '@noble/curves/secp256k1';
 import { Effect, Schema } from 'effect';
 import type { ParseError } from 'effect/ParseResult';
 import { canonicalize, stringToUint8Array } from 'graph-framework-utils';
-import { hashEvent } from './hashEvent.js';
+import { hashEvent } from './hash-event.js';
 import {
   InvalidEventError,
   SpaceEvent,

…-framework-space-events/src/hashEvent.ts …framework-space-events/src/hash-event.tspackages/graph-framework-space-events/src/hashEvent.ts renamed to packages/graph-framework-space-events/src/hash-event.ts packages/graph-framework-space-events/src/hashEvent.ts renamed to packages/graph-framework-space-events/src/hash-event.ts

@@ -2,4 +2,5 @@ export * from './apply-event.js';
 export * from './create-invitation.js';
 export * from './create-space.js';
 export * from './delete-space.js';
+export * from './hash-event.js';
 export * from './types.js';