techref: Pub tables and Workflows

TECH_REF.MD

@@ -1,5 +1,24 @@
 # Technical Reference
 
+## For Next Time
+- Review and confirm our workflow terminology:
+  - Workflow actions: do not modify Pub metadata
+  - Internal side effects: modify Pub metadata, but directly in the app
+  - External side effects: modify Pub metadata, but via an integration
+- How do we handle internal and external side effects?
+
+## Thursday, June 22, 2023
+
+### Pub Tables
+- Existence of a field on a pub is sufficient validation for PubTypes for the MVP -- both for integrations and stages.
+- EAV vs. JSONB: going to maintain both for now so we can look into performance as we build.
+
+### Workflows
+- Integrations can be connected to any workflow stage.
+  - An integration doesn't know anything about the workflow or stage. Either modifies pub metadata or performs a side effect.
+- Anything that modifies a Pub's relationship with the workflow is an action.
+  - Actions shouldn't change Pub metadata — Pub metadata should be directly edited or changed via integrations.
+
 ## Wednesday, June 21, 2023
 
 ### Pub Types

app/@community/(community)/pubs/page.tsx

@@ -8,15 +8,21 @@ export default async function Page() {
 	}
 	const pubs = await prisma.pub.findMany({
 		where: { communityId: onlyCommunity.id, parentId: null },
-		select: {
-			id: true,
-			pubType: { select: { name: true, fields: true } },
-			metadata: { select: { type: true, value: true } },
+		include: {
+			pubType: {
+				include: {
+					metadataFields: true,
+				},
+			},
+			metadataValues: true,
 			children: {
-				select: {
-					id: true,
-					pubType: { select: { name: true, fields: true } },
-					metadata: { select: { type: true, value: true } },
+				include: {
+					pubType: {
+						include: {
+							metadataFields: true,
+						},
+					},
+					metadataValues: true,
 				},
 			},
 		},

app/@community/(community)/workflows/page.tsx

@@ -1,7 +1,25 @@
-export default function Page() {
+import prisma from "prisma/db";
+
+export default async function Page() {
+	/* Normally, we would get the community based on the url or logged in user session */
+	const onlyCommunity = await prisma.community.findFirst();
+	if (!onlyCommunity) {
+		return null;
+	}
+	const workflows = await prisma.workflow.findMany({
+		where: { communityId: onlyCommunity.id },
+		include: {
+			stages: {
+				include: {
+					moveConstraints: true,
+				},
+			},
+		},
+	});
 	return (
 		<>
 			<h1>Workflows</h1>
+			<pre>{JSON.stringify(workflows, null, 4)}</pre>
 		</>
 	);
 }

package.json

@@ -46,14 +46,16 @@
 		"jsonwebtoken": "^9.0.0",
 		"next": "13.4.5",
 		"react": "18.2.0",
-		"react-dom": "18.2.0"
+		"react-dom": "18.2.0",
+		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
 		"@types/diacritics": "^1.3.1",
 		"@types/jsonwebtoken": "^9.0.2",
 		"@types/node": "20.3.1",
 		"@types/react": "18.2.12",
 		"@types/react-dom": "18.2.5",
+		"@types/uuid": "^9.0.2",
 		"dotenv-cli": "^7.2.1",
 		"lint-staged": "^13.2.2",
 		"prettier": "^2.8.8",

prisma/migrations/20230622182329_metadata_refactor/migration.sql

@@ -0,0 +1,51 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `fields` on the `pub_types` table. All the data in the column will be lost.
+  - You are about to drop the `metadata` table. If the table is not empty, all the data it contains will be lost.
+  - Added the required column `metadataBlob` to the `pubs` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- DropForeignKey
+ALTER TABLE "metadata" DROP CONSTRAINT "metadata_pub_id_fkey";
+
+-- AlterTable
+ALTER TABLE "pub_types" DROP COLUMN "fields";
+
+-- AlterTable
+ALTER TABLE "pubs" ADD COLUMN     "metadataBlob" JSONB NOT NULL;
+
+-- DropTable
+DROP TABLE "metadata";
+
+-- CreateTable
+CREATE TABLE "metadata_fields" (
+    "id" TEXT NOT NULL,
+    "name" TEXT NOT NULL,
+    "pub_type_id" TEXT NOT NULL,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "metadata_fields_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "metadata_values" (
+    "id" TEXT NOT NULL,
+    "field_id" TEXT NOT NULL,
+    "value" JSONB NOT NULL,
+    "pub_id" TEXT NOT NULL,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "metadata_values_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "metadata_fields" ADD CONSTRAINT "metadata_fields_pub_type_id_fkey" FOREIGN KEY ("pub_type_id") REFERENCES "pub_types"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "metadata_values" ADD CONSTRAINT "metadata_values_field_id_fkey" FOREIGN KEY ("field_id") REFERENCES "metadata_fields"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "metadata_values" ADD CONSTRAINT "metadata_values_pub_id_fkey" FOREIGN KEY ("pub_id") REFERENCES "pubs"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

prisma/migrations/20230622182626_blob_optional/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "pubs" ALTER COLUMN "metadataBlob" DROP NOT NULL;

prisma/migrations/20230622194921_workflow_init/migration.sql

@@ -0,0 +1,94 @@
+/*
+  Warnings:
+
+  - Added the required column `workflow_id` to the `stages` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "stages" ADD COLUMN     "workflow_id" TEXT NOT NULL;
+
+-- CreateTable
+CREATE TABLE "move_constraint" (
+    "id" TEXT NOT NULL,
+    "stage_id" TEXT NOT NULL,
+    "destination_id" TEXT NOT NULL,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "move_constraint_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "action_claim" (
+    "id" TEXT NOT NULL,
+    "stage_id" TEXT NOT NULL,
+    "pub_id" TEXT NOT NULL,
+    "user_id" TEXT NOT NULL,
+    "releasedAt" TIMESTAMP(3),
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "action_claim_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "action_move" (
+    "id" TEXT NOT NULL,
+    "source_stage_id" TEXT NOT NULL,
+    "destination_stage_id" TEXT NOT NULL,
+    "pub_id" TEXT NOT NULL,
+    "user_id" TEXT NOT NULL,
+    "note" TEXT NOT NULL,
+    "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "action_move_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "_PubToStage" (
+    "A" TEXT NOT NULL,
+    "B" TEXT NOT NULL
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "_PubToStage_AB_unique" ON "_PubToStage"("A", "B");
+
+-- CreateIndex
+CREATE INDEX "_PubToStage_B_index" ON "_PubToStage"("B");
+
+-- AddForeignKey
+ALTER TABLE "stages" ADD CONSTRAINT "stages_workflow_id_fkey" FOREIGN KEY ("workflow_id") REFERENCES "workflows"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "move_constraint" ADD CONSTRAINT "move_constraint_stage_id_fkey" FOREIGN KEY ("stage_id") REFERENCES "stages"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "move_constraint" ADD CONSTRAINT "move_constraint_destination_id_fkey" FOREIGN KEY ("destination_id") REFERENCES "stages"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_claim" ADD CONSTRAINT "action_claim_stage_id_fkey" FOREIGN KEY ("stage_id") REFERENCES "stages"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_claim" ADD CONSTRAINT "action_claim_pub_id_fkey" FOREIGN KEY ("pub_id") REFERENCES "pubs"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_claim" ADD CONSTRAINT "action_claim_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_move" ADD CONSTRAINT "action_move_source_stage_id_fkey" FOREIGN KEY ("source_stage_id") REFERENCES "stages"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_move" ADD CONSTRAINT "action_move_destination_stage_id_fkey" FOREIGN KEY ("destination_stage_id") REFERENCES "stages"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_move" ADD CONSTRAINT "action_move_pub_id_fkey" FOREIGN KEY ("pub_id") REFERENCES "pubs"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "action_move" ADD CONSTRAINT "action_move_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "_PubToStage" ADD CONSTRAINT "_PubToStage_A_fkey" FOREIGN KEY ("A") REFERENCES "pubs"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "_PubToStage" ADD CONSTRAINT "_PubToStage_B_fkey" FOREIGN KEY ("B") REFERENCES "stages"("id") ON DELETE CASCADE ON UPDATE CASCADE;

prisma/migrations/20230622195031_workflows_to_community/migration.sql

@@ -0,0 +1,11 @@
+/*
+  Warnings:
+
+  - Added the required column `community_id` to the `workflows` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "workflows" ADD COLUMN     "community_id" TEXT NOT NULL;
+
+-- AddForeignKey
+ALTER TABLE "workflows" ADD CONSTRAINT "workflows_community_id_fkey" FOREIGN KEY ("community_id") REFERENCES "communities"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

prisma/migrations/20230622195558_stage_names_order/migration.sql

@@ -0,0 +1,14 @@
+/*
+  Warnings:
+
+  - Added the required column `name` to the `stages` table without a default value. This is not possible if the table is not empty.
+  - Added the required column `order` to the `stages` table without a default value. This is not possible if the table is not empty.
+  - Added the required column `name` to the `workflows` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "stages" ADD COLUMN     "name" TEXT NOT NULL,
+ADD COLUMN     "order" TEXT NOT NULL;
+
+-- AlterTable
+ALTER TABLE "workflows" ADD COLUMN     "name" TEXT NOT NULL;