Add instance config and instance state endpoint

core/lib/server/errors.ts

@@ -2,11 +2,11 @@ import { type NextApiRequest, type NextApiResponse } from "next/types";
 import { ErrorHttpStatusCode } from "@ts-rest/core";
 import { NextRequest, NextResponse } from "next/server";
 
-export class HTTPStatusError <Status extends ErrorHttpStatusCode> extends Error {
+export class HTTPStatusError<Status extends ErrorHttpStatusCode> extends Error {
 	readonly status: ErrorHttpStatusCode;
 
 	constructor(status: Status, message?: string) {
-		super(`HTTP Error ${status}${message ? ': ' + message : ''}`);
+		super(`HTTP Error ${status}${message ? ": " + message : ""}`);
 		this.status = status;
 	}
 }
@@ -38,18 +38,17 @@ export class NotFoundError extends HTTPStatusError<404> {
 // For use in app router API routes
 export const handleErrors = async (routeHandler) => {
 	try {
-		return await routeHandler()
-	} catch(error) {
+		return await routeHandler();
+	} catch (error) {
 		if (error instanceof HTTPStatusError) {
-			return NextResponse.json({ message: error.message }, { status: error.status })
+			return NextResponse.json({ message: error.message }, { status: error.status });
 		}
 		if (error instanceof Error) {
 			console.error(error.message);
 		}
-		return NextResponse.json({ message: "Internal Server Error"}, { status: 500 })
+		return NextResponse.json({ message: "Internal Server Error" }, { status: 500 });
 	}
-
-}
+};
 
 export const tsRestHandleErrors = (error: unknown, req: NextApiRequest, res: NextApiResponse) => {
 	if (error instanceof HTTPStatusError) {
@@ -59,4 +58,4 @@ export const tsRestHandleErrors = (error: unknown, req: NextApiRequest, res: Nex
 		console.error(error.message);
 	}
 	return res.status(500).json({ message: "Internal Server Error" });
-};
+};

core/lib/server/index.ts

@@ -1,3 +1,4 @@
 export * from "./pub";
 export * from "./members";
-export * from "./errors";
+export * from "./errors";
+export * from "./integrations";

core/lib/server/integrations.ts

@@ -0,0 +1,56 @@
+import prisma from "~/prisma/db";
+
+export async function setIntegrationInstanceConfig(instanceId: string, config: object) {
+	return await prisma.integrationInstance.update({
+		where: {
+			id: instanceId,
+		},
+		data: {
+			config,
+		},
+	});
+}
+
+export const getIntegrationInstanceConfig = async (instanceId: string) => {
+	return await prisma.integrationInstance.findFirst({
+		where: {
+			id: instanceId,
+		},
+		select: {
+			config: true,
+		},
+	});
+};
+
+export const setIntegrationInstanceState = async (instanceId: string, pubId: string, state) => {
+	return await prisma.integrationInstanceState.upsert({
+		where: {
+			pub_instance: {
+				instanceId,
+				pubId,
+			},
+		},
+		update: {
+			state,
+		},
+		create: {
+			instanceId,
+			pubId,
+			state,
+		},
+	});
+};
+
+export const getIntegrationInstanceState = async (instanceId: string, pubId: string) => {
+	return await prisma.integrationInstanceState.findUnique({
+		where: {
+			pub_instance: {
+				instanceId,
+				pubId,
+			},
+		},
+		select: {
+			state: true,
+		},
+	});
+};

core/pages/api/v0/[...ts-rest].ts

@@ -3,18 +3,23 @@ import { api } from "contracts";
 import { compareAPIKeys, getBearerToken } from "~/lib/auth/api";
 import {
 	createPub,
-	getSuggestedMembers,
+	deletePub,
+	getIntegrationInstanceConfig,
+	getIntegrationInstanceState,
 	getMembers,
 	getPub,
 	getPubType,
+	getSuggestedMembers,
+	setIntegrationInstanceConfig,
+	setIntegrationInstanceState,
 	tsRestHandleErrors,
 	updatePub,
-	deletePub,
 } from "~/lib/server";
 import { emailUser } from "~/lib/server/email";
 import { getJobsClient } from "~/lib/server/jobs";
 import { validateToken } from "~/lib/server/token";
 import { findOrCreateUser } from "~/lib/server/user";
+import prisma from "~/prisma/db";
 
 const checkAuthentication = (authHeader: string) => {
 	const apiKey = getBearerToken(authHeader);
@@ -124,6 +129,26 @@ const integrationsRouter = createNextRoute(api.integrations, {
 			body: members,
 		};
 	},
+	setInstanceConfig: async ({ headers, params, body }) => {
+		checkAuthentication(headers.authorization);
+		const config = await setIntegrationInstanceConfig(params.instanceId, { ...body });
+		return { status: 200, body: config };
+	},
+	getInstanceConfig: async ({ headers, params }) => {
+		checkAuthentication(headers.authorization);
+		const config = await getIntegrationInstanceConfig(params.instanceId);
+		return { status: 200, body: config };
+	},
+	setInstanceState: async ({ headers, params, body }) => {
+		checkAuthentication(headers.authorization);
+		const state = await setIntegrationInstanceState(params.instanceId, params.pubId, body);
+		return { status: 200, body: state };
+	},
+	getInstanceState: async ({ headers, params }) => {
+		checkAuthentication(headers.authorization);
+		const state = await getIntegrationInstanceState(params.instanceId, params.pubId);
+		return { status: 200, body: state };
+	},
 });
 
 const router = {

core/prisma/exampleCommunitySeeds/unjournal.ts

@@ -779,6 +779,13 @@ export default async function main(prisma: PrismaClient, communityUUID: string)
 			name: "Unjournal Evaluation Manager",
 			integrationId: evaluationsIntegration.id,
 			stageId: stageIds[3],
+			config: {
+				pubTypeId: submissionTypeId,
+				template: {
+					subject: "You've been invited to review a submission on PubPub",
+					message: `Please reach out if you have any questions.`,
+				},
+			},
 		},
 	];
 

core/prisma/migrations/20231030180206_add_config_column_to_schema/migration.sql

@@ -0,0 +1,6 @@
+-- AlterTable
+ALTER TABLE "integration_instances" ADD COLUMN     "config" JSONB;
+
+-- AlterTable
+ALTER TABLE "users" ALTER COLUMN "firstName" DROP DEFAULT,
+ALTER COLUMN "lastName" DROP DEFAULT;

core/prisma/migrations/20231031164256_add_integration_instance_state_table/migration.sql

@@ -0,0 +1,15 @@
+-- CreateTable
+CREATE TABLE "IntegrationInstanceState" (
+    "pub_id" TEXT NOT NULL,
+    "instance_id" TEXT NOT NULL,
+    "value" JSONB NOT NULL
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "IntegrationInstanceState_pub_id_instance_id_key" ON "IntegrationInstanceState"("pub_id", "instance_id");
+
+-- AddForeignKey
+ALTER TABLE "IntegrationInstanceState" ADD CONSTRAINT "IntegrationInstanceState_pub_id_fkey" FOREIGN KEY ("pub_id") REFERENCES "pubs"("id") ON DELETE RESTRICT ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "IntegrationInstanceState" ADD CONSTRAINT "IntegrationInstanceState_instance_id_fkey" FOREIGN KEY ("instance_id") REFERENCES "integration_instances"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

core/prisma/migrations/20231107143830_change_to_state/migration.sql

@@ -0,0 +1,10 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `value` on the `IntegrationInstanceState` table. All the data in the column will be lost.
+  - Added the required column `state` to the `IntegrationInstanceState` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "IntegrationInstanceState" DROP COLUMN "value",
+ADD COLUMN     "state" JSONB NOT NULL;

core/prisma/schema.prisma

@@ -76,12 +76,13 @@ model Pub {
   parentId String? @map(name: "parent_id")
   children Pub[]   @relation("pub_parent")
 
-  values               PubValue[]
-  stages               Stage[]
-  claims               ActionClaim[]
-  moves                ActionMove[]
-  integrationInstances IntegrationInstance[]
-  permissions          Permission[]
+  values                   PubValue[]
+  stages                   Stage[]
+  claims                   ActionClaim[]
+  moves                    ActionMove[]
+  integrationInstances     IntegrationInstance[]
+  permissions              Permission[]
+  IntegrationInstanceState IntegrationInstanceState[]
 
   @@map(name: "pubs")
 }
@@ -295,8 +296,20 @@ model IntegrationInstance {
   updatedAt     DateTime    @default(now()) @updatedAt @map(name: "updated_at")
   stage         Stage?      @relation(fields: [stageId], references: [id])
   stageId       String?     @map(name: "stage_id")
+  config        Json?
 
-  pubs Pub[]
+  pubs                     Pub[]
+  IntegrationInstanceState IntegrationInstanceState[]
 
   @@map(name: "integration_instances")
 }
+
+model IntegrationInstanceState {
+  pub        Pub                 @relation(fields: [pubId], references: [id])
+  pubId      String              @map(name: "pub_id")
+  instance   IntegrationInstance @relation(fields: [instanceId], references: [id])
+  instanceId String              @map(name: "instance_id")
+  state      Json
+
+  @@unique([pubId, instanceId], name: "pub_instance")
+}

integrations/evaluations/app/actions/evaluate/actions.ts

@@ -11,7 +11,7 @@ export const evaluate = async (instanceId: string, pubId: string, values: PubVal
 	}
 	try {
 		const pub = await client.createPub(instanceId, {
-			pubTypeId: instance.pubTypeId,
+			pubTypeId: instance.config.pubTypeId,
 			parentId: pubId,
 			values: values,
 		});

integrations/evaluations/app/actions/evaluate/page.tsx

@@ -15,6 +15,6 @@ export default async function Page(props: Props) {
 
 	const instance = await getInstanceConfig(instanceId);
 	//dangerously assert instance exists
-	const pubType = await client.getPubType(instanceId, instance!.pubTypeId);
+	const pubType = await client.getPubType(instanceId, instance!.config.pubTypeId);
 	return <Evaluate instanceId={instanceId} pub={pub} pubType={pubType} />;
 }

integrations/evaluations/app/actions/manage/actions.ts

@@ -23,7 +23,7 @@ export const save = async (
 		}
 		const pub = await client.getPub(instanceId, pubId);
 		const evaluations = pub.children.filter(
-			(child) => child.pubTypeId === instanceConfig.pubTypeId
+			(child) => child.pubTypeId === instanceConfig.config.pubTypeId
 		);
 		const evaluationsByEvaluator = evaluations.reduce((acc, evaluation) => {
 			acc[evaluation.values["unjournal:evaluator"] as string] = evaluation;
@@ -45,7 +45,7 @@ export const save = async (
 				// New evaluator added. Make the corresponding evaluation pub.
 				await client.createPub(instanceId, {
 					parentId: pubId,
-					pubTypeId: instanceConfig.pubTypeId,
+					pubTypeId: instanceConfig.config.pubTypeId,
 					values: {
 						"unjournal:title": `Evaluation of ${pubTitle} by ${invite.firstName} ${invite.lastName}`,
 						"unjournal:evaluator": invite.userId,
@@ -76,12 +76,12 @@ export const save = async (
 				}
 			);
 			// Save updated email template and job run time
-			instanceState[invite.userId] = {
+			instanceState.state[invite.userId] = {
 				inviteTemplate: invite.template,
-				inviteTime: instanceState[invite.userId]?.inviteTime ?? runAt.toString(),
+				inviteTime: instanceState.state[invite.userId]?.inviteTime ?? runAt.toString(),
 			};
 		}
-		await setInstanceState(instanceId, pubId, instanceState);
+		await setInstanceState(instanceId, pubId, instanceState.state);
 		revalidatePath("/");
 		return { success: true };
 	} catch (error) {
@@ -109,7 +109,7 @@ export const remove = async (instanceId: string, pubId: string, userId: string)
 			await client.deletePub(instanceId, evaluation.id);
 		}
 		if (instanceState !== undefined) {
-			const { [userId]: _, ...instanceStateWithoutEvaluator } = instanceState;
+			const { [userId]: _, ...instanceStateWithoutEvaluator } = instanceState.state;
 			setInstanceState(instanceId, pubId, instanceStateWithoutEvaluator);
 		}
 		await client.unscheduleEmail(instanceId, makeInviteJobKey(instanceId, pubId, userId));

integrations/evaluations/app/actions/manage/page.tsx

@@ -14,6 +14,7 @@ export default async function Page(props: Props) {
 	const { instanceId, pubId } = props.searchParams;
 	const instanceConfig = expect(await getInstanceConfig(instanceId));
 	const instanceState = (await getInstanceState(instanceId, pubId)) ?? {};
+	console.log(instanceState);
 	// Fetch the pub and its children
 	const pub = await client.getPub(instanceId, pubId);
 	// Load user info for each of the child evaluations
@@ -23,25 +24,25 @@ export default async function Page(props: Props) {
 					instanceId,
 					pub.children
 						// Only consider the children that are evaluations
-						.filter((child) => child.pubTypeId === instanceConfig.pubTypeId)
+						.filter((child) => child.pubTypeId === instanceConfig.config.pubTypeId)
 						// Extract the evaluator user id
 						.map((evaluation) => evaluation.values["unjournal:evaluator"] as string)
 			  )
 			: [];
 
 	evaluators.sort(
 		(a, b) =>
-			new Date(instanceState[a.id]?.inviteTime).getTime() -
-			new Date(instanceState[b.id]?.inviteTime).getTime()
+			new Date(instanceState.state[a.id]?.inviteTime).getTime() -
+			new Date(instanceState.state[b.id]?.inviteTime).getTime()
 	);
 
 	return (
 		<EvaluatorInviteForm
 			instanceId={instanceId}
 			pub={pub}
 			evaluators={evaluators}
-			instanceConfig={instanceConfig}
-			instanceState={instanceState}
+			instanceConfig={instanceConfig.config}
+			instanceState={instanceState.state}
 		/>
 	);
 }

integrations/evaluations/app/configure/page.tsx

@@ -13,8 +13,8 @@ export default async function Page(props: Props) {
 	return (
 		<Configure
 			instanceId={instanceId}
-			pubTypeId={instance?.pubTypeId}
-			template={instance?.template}
+			pubTypeId={instance?.config.pubTypeId}
+			template={instance?.config.template}
 		/>
 	);
 }