RFC: pubOp for creating and updating pubs more easily (#965)

* feat: new fluent pub mutation api

* feat: add ability to replace pub relations

* feat: beautiful better implementation

* fix: cleanup a bit

* feat: allow to properly purge orphans

* fix: get rid of the concept of a pubId map and just pregenerate the ids

* chore: add some comments

* feat: add ability to move stages

* fix: update test

* feat: allow inline specification of pubops

+ cleanup of api

* refactor: rename override option to 'replaceExisting'

* test: add test for multiple relate

* fix: fix type issues

* refactor: add slightly better error handling

* fix: add back deletePubValuesByValueId

* fix: add back pubvalue upsert functions

* fix: sort pubvalues deeply for tests

* fix: fix tests and imports

* feat: make upsert override by default

* docs: add better documentation to orphan

* refactor: simplify createPub logic a bit

* chore: clean up

* fix: update matcher types

---------

Co-authored-by: Eric McDaniel <[email protected]>

Author: tefkah

core/actions/_lib/runActionInstance.db.test.ts

@@ -10,7 +10,7 @@ const { getTrx, rollback, commit } = createForEachMockedTransaction();
 
 const pubTriggerTestSeed = async () => {
 	const slugName = `test-server-pub-${new Date().toISOString()}`;
-	const { createSeed } = await import("~/prisma/seed/seedCommunity");
+	const { createSeed } = await import("~/prisma/seed/createSeed");
 
 	return createSeed({
 		community: {

core/app/api/v0/c/[communitySlug]/site/[...ts-rest]/route.ts

@@ -373,7 +373,7 @@ const handler = createNextHandler(
 				};
 			},
 			archive: async ({ params }) => {
-				const { lastModifiedBy } = await checkAuthorization({
+				const { lastModifiedBy, community } = await checkAuthorization({
 					token: { scope: ApiAccessScope.pub, type: ApiAccessType.write },
 					cookies: {
 						capability: Capabilities.deletePub,
@@ -383,6 +383,7 @@ const handler = createNextHandler(
 
 				const result = await deletePub({
 					pubId: params.pubId as PubsId,
+					communityId: community.id,
 					lastModifiedBy,
 				});
 

core/app/components/pubs/PubEditor/actions.ts

@@ -178,7 +178,7 @@ export const removePub = defineServerAction(async function removePub({ pubId }:
 	}
 
 	try {
-		await deletePub({ pubId, lastModifiedBy });
+		await deletePub({ pubId, lastModifiedBy, communityId: community.id });
 
 		return {
 			success: true,

core/globalSetup.ts renamed to core/lib/__tests__/globalSetup.ts

@@ -7,7 +7,10 @@ import { logger } from "logger";
 
 export const setup = async () => {
 	config({
-		path: ["./.env.test", "./.env.test.local"],
+		path: [
+			new URL("../../.env.test", import.meta.url).pathname,
+			new URL("../../.env.test.local", import.meta.url).pathname,
+		],
 	});
 
 	if (process.env.SKIP_RESET) {

core/lib/__tests__/live.db.test.ts

@@ -1,13 +1,49 @@
 import { describe, expect, test } from "vitest";
 
+import { CoreSchemaType, MemberRole } from "db/public";
+
 import type { ClientException } from "../serverActions";
+import { createSeed } from "~/prisma/seed/createSeed";
 import { isClientException } from "../serverActions";
 import { mockServerCode } from "./utils";
 
 const { testDb, getLoginData, createForEachMockedTransaction } = await mockServerCode();
 
 const { getTrx, rollback, commit } = createForEachMockedTransaction();
 
+const communitySeed = createSeed({
+	community: {
+		name: "test",
+		slug: "test",
+	},
+	pubFields: {
+		Title: { schemaName: CoreSchemaType.String },
+	},
+	pubTypes: {
+		"Basic Pub": {
+			Title: { isTitle: true },
+		},
+	},
+	users: {
+		admin: {
+			role: MemberRole.admin,
+		},
+	},
+	pubs: [
+		{
+			pubType: "Basic Pub",
+			values: {
+				Title: "test",
+			},
+		},
+	],
+});
+
+const seed = async (trx = testDb) => {
+	const { seedCommunity } = await import("~/prisma/seed/seedCommunity");
+	return seedCommunity(communitySeed, undefined, trx);
+};
+
 describe("live", () => {
 	test("should be able to connect to db", async () => {
 		const result = await testDb.selectFrom("users").selectAll().execute();
@@ -17,6 +53,8 @@ describe("live", () => {
 	test("can rollback transactions", async () => {
 		const trx = getTrx();
 
+		const { community, users, pubs } = await seed(trx);
+
 		// Insert a user
 		const user = await trx
 			.insertInto("users")
@@ -58,6 +96,7 @@ describe("live", () => {
 	describe("transaction block example", () => {
 		test("can add a user that will not persist", async () => {
 			const trx = getTrx();
+
 			await trx
 				.insertInto("users")
 				.values({
@@ -79,6 +118,9 @@ describe("live", () => {
 
 	test("createForm needs a logged in user", async () => {
 		const trx = getTrx();
+
+		const { community, users, pubs } = await seed(trx);
+
 		getLoginData.mockImplementation(() => {
 			return undefined;
 		});
@@ -87,12 +129,6 @@ describe("live", () => {
 			(m) => m.createForm
 		);
 
-		const community = await trx
-			.selectFrom("communities")
-			.selectAll()
-			.where("slug", "=", "croccroc")
-			.executeTakeFirstOrThrow();
-
 		const pubType = await trx
 			.selectFrom("pub_types")
 			.select(["id"])
@@ -110,15 +146,11 @@ describe("live", () => {
 			return { id: "123", isSuperAdmin: true };
 		});
 
+		const { community, users, pubs } = await seed(trx);
 		const getForm = await import("../server/form").then((m) => m.getForm);
 		const createForm = await import("~/app/c/[communitySlug]/forms/actions").then(
 			(m) => m.createForm
 		);
-		const community = await trx
-			.selectFrom("communities")
-			.selectAll()
-			.where("slug", "=", "croccroc")
-			.executeTakeFirstOrThrow();
 
 		const forms = await getForm({ slug: "my-form-2", communityId: community.id }).execute();
 		expect(forms.length).toEqual(0);

core/lib/__tests__/matchers.ts

@@ -0,0 +1,66 @@
+import { expect } from "vitest";
+
+import type { ProcessedPub } from "contracts";
+import type { PubsId } from "db/public";
+
+import type { db } from "~/kysely/database";
+
+const deepSortValues = (pub: ProcessedPub): ProcessedPub => {
+	pub.values
+		.sort((a, b) => (a.value as string).localeCompare(b.value as string))
+		.map((item) => ({
+			...item,
+			relatedPub: item.relatedPub?.values ? deepSortValues(item.relatedPub) : item.relatedPub,
+		}));
+
+	return pub;
+};
+
+expect.extend({
+	async toExist(received: PubsId, expected?: typeof db) {
+		const { getPlainPub } = await import("../server/pub");
+
+		const pub = await getPlainPub(received, expected).executeTakeFirst();
+		const pass = Boolean(pub && pub.id === received);
+		const { isNot } = this;
+
+		return {
+			pass,
+			message: () =>
+				isNot
+					? `Expected pub with ID ${received} not to exist, but it ${pass ? "does" : "does not"}`
+					: `Expected pub with ID ${received} to exist, but it ${pass ? "does" : "does not"}`,
+		};
+	},
+
+	toHaveValues(received: ProcessedPub, expected: Partial<ProcessedPub["values"][number]>[]) {
+		const pub = received;
+		const sortedPubValues = deepSortValues(pub);
+
+		const expectedLength = expected.length;
+		const receivedLength = sortedPubValues.values.length;
+
+		const isNot = this.isNot;
+		if (!isNot && !this.equals(expectedLength, receivedLength)) {
+			return {
+				pass: false,
+				message: () =>
+					`Expected pub to have ${expectedLength} values, but it has ${receivedLength}`,
+			};
+		}
+
+		// equiv. to .toMatchObject
+		const pass = this.equals(sortedPubValues.values, expected, [
+			this.utils.iterableEquality,
+			this.utils.subsetEquality,
+		]);
+
+		return {
+			pass,
+			message: () =>
+				pass
+					? `Expected pub ${isNot ? "not" : ""} to have values ${JSON.stringify(expected)}, and it does ${isNot ? "not" : ""}`
+					: `Expected pub ${isNot ? "not to" : "to"} match values ${this.utils.diff(sortedPubValues.values, expected)}`,
+		};
+	},
+});

core/lib/server/pub-capabilities.db.test.ts

@@ -2,12 +2,12 @@ import { describe, expect, it } from "vitest";
 
 import { CoreSchemaType, MemberRole } from "db/public";
 
-import type { Seed } from "~/prisma/seed/seedCommunity";
+import { createSeed } from "~/prisma/seed/createSeed";
 import { mockServerCode } from "../__tests__/utils";
 
 await mockServerCode();
 
-const seed = {
+const seed = createSeed({
 	community: {
 		name: "test-pub-capabilities",
 		slug: "test-pub-capabilities",
@@ -97,7 +97,7 @@ const seed = {
 			},
 		},
 	],
-} as Seed;
+});
 
 describe("getPubsWithRelatedValuesAndChildren capabilities", () => {
 	it("should restrict pubs by visibility", async () => {