Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Move partner ban tests to Playwright and refuse non-local databases.

Kiran K3ed5669ca5f8
diff --git a/apps/web/playwright.config.ts b/apps/web/playwright.config.ts
index e7b51a10f4..52af39edda 100644
--- a/apps/web/playwright.config.ts
+++ b/apps/web/playwright.config.ts
@@ -1,6 +1,9 @@
import "dotenv-flow/config";
import { defineConfig, devices } from "@playwright/test";
+import { assertLocalDatabaseEnv } from "./playwright/assert-local-database";
+
+assertLocalDatabaseEnv();
const workspaceBaseURL = "http://localhost:8888";
const partnersBaseURL = "http://partners.localhost:8888";
diff --git a/apps/web/playwright/api/partners/ban-partner.spec.ts b/apps/web/playwright/api/partners/ban-partner.spec.ts
new file mode 100644
index 0000000000..2ee5ae7b5b
--- /dev/null
+++ b/apps/web/playwright/api/partners/ban-partner.spec.ts
@@ -0,0 +1,237 @@
+import { conn } from "@/lib/planetscale";
+import { prisma } from "@/lib/prisma";
+import type { EnrolledPartnerProps } from "@/lib/types";
+import { nanoid } from "@dub/utils";
+import { expect } from "@playwright/test";
+import { randomName, randomPartnerEmail } from "../../utils";
+import { test, type ApiClient } from "../fixtures";
+
+test.describe.configure({
+ mode: "parallel",
+});
+
+async function createPartner(
+ api: ApiClient,
+ overrides: Record<string, unknown> = {},
+) {
+ return api.post<EnrolledPartnerProps>("/api/partners", {
+ name: randomName(),
+ email: randomPartnerEmail(),
+ ...overrides,
+ });
+}
+
+async function deletePartner(partnerId: string | undefined) {
+ if (!partnerId) return;
+
+ await prisma.link.deleteMany({
+ where: {
+ partnerId,
+ },
+ });
+
+ await prisma.programEnrollment.deleteMany({
+ where: {
+ partnerId,
+ },
+ });
+
+ // Prisma partner.delete hits a PlanetScale relation quirk; raw SQL matches
+ // bulkDeletePartners cleanup used by e2e cron.
+ await conn.execute(`DELETE FROM Partner WHERE id = ?`, [partnerId]);
+}
+
+async function expectPartnerBanned(
+ api: ApiClient,
+ partnerId: string,
+ reason: string,
+) {
+ const { status, data } = await api.get<EnrolledPartnerProps>(
+ `/api/partners/${partnerId}`,
+ );
+
+ expect(status).toEqual(200);
+ expect(data).toMatchObject({
+ id: partnerId,
+ status: "banned",
+ bannedReason: reason,
+ bannedAt: expect.any(String),
+ });
+}
+
+test("POST /partners/ban – by partnerId", async ({ api, program }) => {
+ let partnerId: string | undefined;
+
+ try {
+ const { status: createStatus, data: created } = await createPartner(api, {
+ groupId: program.defaultGroupId,
+ });
+ partnerId = created.id;
+ expect(createStatus).toEqual(201);
+
+ const { status, data } = await api.post<{ partnerId: string }>(
+ "/api/partners/ban",
+ {
+ partnerId,
+ reason: "fraud",
+ },
+ );
+
+ expect(status).toEqual(200);
+ expect(data).toStrictEqual({ partnerId });
+
+ await expectPartnerBanned(api, partnerId, "fraud");
+ } finally {
+ await deletePartner(partnerId);
+ }
+});
+
+test("POST /partners/ban – by tenantId", async ({ api, program }) => {
+ let partnerId: string | undefined;
+ const tenantId = nanoid();
+
+ try {
+ const { status: createStatus, data: created } = await createPartner(api, {
+ tenantId,
+ groupId: program.defaultGroupId,
+ });
+ partnerId = created.id;
+ expect(createStatus).toEqual(201);
+ expect(created.tenantId).toBe(tenantId);
+
+ const { status, data } = await api.post<{ partnerId: string }>(
+ "/api/partners/ban",
+ {
+ tenantId,
+ reason: "fraud",
+ },
+ );
+
+ expect(status).toEqual(200);
+ expect(data).toStrictEqual({ partnerId });
+
+ await expectPartnerBanned(api, partnerId, "fraud");
+ } finally {
+ await deletePartner(partnerId);
+ }
+});
+
+test("POST /partners/ban – already banned", async ({ api, program }) => {
+ let partnerId: string | undefined;
+
+ try {
+ const { data: created } = await createPartner(api, {
+ groupId: program.defaultGroupId,
+ });
+ partnerId = created.id;
+
+ const { status } = await api.post("/api/partners/ban", {
+ partnerId,
+ reason: "fraud",
+ });
+ expect(status).toEqual(200);
+
+ expect(
+ await api.post("/api/partners/ban", {
+ partnerId,
+ reason: "spam",
+ }),
+ ).toEqual({
+ status: 400,
+ data: {
+ error: {
+ code: "bad_request",
+ message: "This partner is already banned from your program.",
+ doc_url: "https://dub.co/docs/api-reference/errors#bad-request",
+ },
+ },
+ });
+ } finally {
+ await deletePartner(partnerId);
+ }
+});
+
+test("POST /partners/ban – partner not found", async ({ api, program }) => {
+ const partnerId = `pn_${nanoid()}`;
+
+ expect(
+ await api.post("/api/partners/ban", {
+ partnerId,
+ reason: "fraud",
+ }),
+ ).toEqual({
+ status: 404,
+ data: {
+ error: {
+ code: "not_found",
+ message: `Partner ${partnerId} is not enrolled in program ${program.id}.`,
+ doc_url: "https://dub.co/docs/api-reference/errors#not-found",
+ },
+ },
+ });
+});
+
+test("POST /partners/ban – tenantId not found", async ({ api }) => {
+ const tenantId = nanoid();
+
+ expect(
+ await api.post("/api/partners/ban", {
+ tenantId,
+ reason: "fraud",
+ }),
+ ).toEqual({
+ status: 404,
+ data: {
+ error: {
+ code: "not_found",
+ message: `Partner with tenantId ${tenantId} not found in program.`,
+ doc_url: "https://dub.co/docs/api-reference/errors#not-found",
+ },
+ },
+ });
+});
+
+const invalidReasonError = {
+ status: 422,
+ data: {
+ error: {
+ code: "unprocessable_entity",
+ message:
+ 'invalid_value: reason: Invalid option: expected one of "tos_violation"|"inappropriate_content"|"fake_traffic"|"fraud"|"spam"|"brand_abuse"',
+ doc_url: "https://dub.co/docs/api-reference/errors#unprocessable-entity",
+ },
+ },
+};
+
+const banErrorCases = [
+ {
+ name: "POST /partners/ban – missing partnerId and tenantId",
+ body: { reason: "fraud" },
+ expected: {
+ status: 400,
+ data: {
+ error: {
+ code: "bad_request",
+ message: "Either `partnerId` or `tenantId` must be provided.",
+ doc_url: "https://dub.co/docs/api-reference/errors#bad-request",
+ },
+ },
+ },
+ },
+ {
+ name: "POST /partners/ban – missing reason",
+ body: { partnerId: "pn_test" },
+ expected: invalidReasonError,
+ },
+ {
+ name: "POST /partners/ban – invalid reason",
+ body: { partnerId: "pn_test", reason: "not_a_reason" },
+ expected: invalidReasonError,
+ },
+];
+
+for (const { name, body, expected } of banErrorCases) {
+ test(name, async ({ api }) => {
+ expect(await api.post("/api/partners/ban", body)).toEqual(expected);
+ });
+}
diff --git a/apps/web/playwright/api/setup-test-workspace.ts b/apps/web/playwright/api/setup-test-workspace.ts
index 4e7a792a9f..36cead5225 100644
--- a/apps/web/playwright/api/setup-test-workspace.ts
+++ b/apps/web/playwright/api/setup-test-workspace.ts
@@ -188,14 +188,12 @@ async function setupTestProgram({
update: {
projectId: workspaceId,
verified: true,
- primary: true,
},
create: {
id: createId({ prefix: "dom_" }),
slug: TEST_WORKSPACE.program.domain,
projectId: workspaceId,
verified: true,
- primary: true,
},
});
@@ -280,6 +278,15 @@ async function setupTestProgram({
},
});
+ await prisma.program.update({
+ where: {
+ id: program.id,
+ },
+ data: {
+ defaultGroupId: group.id,
+ },
+ });
+
await prisma.partnerGroupDefaultLink.upsert({
where: {
groupId_url: {
diff --git a/apps/web/playwright/assert-local-database.ts b/apps/web/playwright/assert-local-database.ts
new file mode 100644
index 0000000000..897f6279ba
--- /dev/null
+++ b/apps/web/playwright/assert-local-database.ts
@@ -0,0 +1,46 @@
+const LOCAL_HOSTNAMES = new Set(["localhost", "127.0.0.1", "::1"]);
+
+const LOCAL_URL_HINT =
+ "Use the local docker URLs from .env.example: mysql://root:@localhost:3306/planetscale and http://root:unused@localhost:3900/planetscale";
+
+function hostnameFromDatabaseUrl(url: string): string {
+ const hostname = new URL(url).hostname.replace(/^\[|\]$/g, "");
+ return hostname.toLowerCase();
+}
+
+function assertUrl(
+ name: "DATABASE_URL" | "PLANETSCALE_DATABASE_URL",
+ value: string | undefined,
+ required: boolean,
+): void {
+ if (!value) {
+ if (required) {
+ throw new Error(
+ `${name} is not set. Playwright tests require a local database. ${LOCAL_URL_HINT}`,
+ );
+ }
+ return;
+ }
+
+ let hostname: string;
+ try {
+ hostname = hostnameFromDatabaseUrl(value);
+ } catch {
+ throw new Error(
+ `${name} is not a valid URL. Playwright tests require a local database. ${LOCAL_URL_HINT}`,
+ );
+ }
+
+ if (!LOCAL_HOSTNAMES.has(hostname)) {
+ throw new Error(
+ `Refusing to run Playwright tests: ${name} host "${hostname}" is not a local database. Only localhost / 127.0.0.1 / ::1 are allowed. ${LOCAL_URL_HINT}`,
+ );
+ }
+}
+
+export function assertLocalDatabaseEnv(
+ env: NodeJS.ProcessEnv = process.env,
+): void {
+ assertUrl("DATABASE_URL", env.DATABASE_URL, true);
+ assertUrl("PLANETSCALE_DATABASE_URL", env.PLANETSCALE_DATABASE_URL, false);
+}
diff --git a/apps/web/playwright/global-setup.ts b/apps/web/playwright/global-setup.ts
index f0fd5b2946..351af7722a 100644
--- a/apps/web/playwright/global-setup.ts
+++ b/apps/web/playwright/global-setup.ts
@@ -1,12 +1,14 @@
import type { FullConfig } from "@playwright/test";
import { config as loadEnv } from "dotenv-flow";
import { setupTestWorkspace } from "./api/setup-test-workspace";
+import { assertLocalDatabaseEnv } from "./assert-local-database";
loadEnv({
silent: true,
});
async function globalSetup(_config: FullConfig) {
+ assertLocalDatabaseEnv();
await setupTestWorkspace();
}
diff --git a/apps/web/playwright/seed.ts b/apps/web/playwright/seed.ts
index aaa09229c5..5955fe7f3d 100644
--- a/apps/web/playwright/seed.ts
+++ b/apps/web/playwright/seed.ts
@@ -2,6 +2,7 @@ import "dotenv-flow/config";
import { PrismaClient } from "@prisma/client";
import { hashSync } from "bcryptjs";
+import { assertLocalDatabaseEnv } from "./assert-local-database";
const prisma = new PrismaClient();
@@ -12,6 +13,8 @@ const E2E_PARTNER = {
};
async function main() {
+ assertLocalDatabaseEnv();
+
const passwordHash = hashSync(E2E_PARTNER.password, 10);
const user = await prisma.user.upsert({
diff --git a/apps/web/tests/partners/ban-partner.test.ts b/apps/web/tests/partners/ban-partner.test.ts
deleted file mode 100644
index 30c17bcfd9..0000000000
--- a/apps/web/tests/partners/ban-partner.test.ts
+++ /dev/null
@@ -1,93 +0,0 @@
-import { generateRandomName } from "@/lib/names";
-import { EnrolledPartnerSchema as EnrolledPartnerSchemaDate } from "@/lib/zod/schemas/partners";
-import { describe, expect, test } from "vitest";
-import { fetchPartner } from "../utils/fetch-partner";
-import { randomId, randomPartnerEmail } from "../utils/helpers";
-import { IntegrationHarness } from "../utils/integration";
-import { E2E_PARTNER_GROUP } from "../utils/resource";
-import { normalizedPartnerDateFields } from "./resource";
-
-const EnrolledPartnerSchema = EnrolledPartnerSchemaDate.extend(
- normalizedPartnerDateFields.shape,
-);
-
-describe.sequential("POST /partners/ban", async () => {
- const h = new IntegrationHarness();
- const { http } = await h.init();
-
- test("ban partner by partnerId", async () => {
- const partner = {
- name: generateRandomName(),
- email: randomPartnerEmail(),
- groupId: E2E_PARTNER_GROUP.id,
- };
-
- const { data: createdData, status: createStatus } = await http.post({
- path: "/partners",
- body: partner,
- });
-
- expect(createStatus).toEqual(201);
- const createdPartner = EnrolledPartnerSchema.parse(createdData);
-
- const { data: banData, status: banStatus } = await http.post<{
- partnerId: string;
- }>({
- path: "/partners/ban",
- body: {
- partnerId: createdPartner.id,
- reason: "fraud",
- },
- });
-
- expect(banStatus).toEqual(200);
- expect(banData.partnerId).toBe(createdPartner.id);
-
- // Verify the partner is banned
- const fetchedPartner = await fetchPartner({
- http,
- partnerId: createdPartner.id,
- });
- expect(fetchedPartner.status).toBe("banned");
- });
-
- test("ban partner by tenantId", async () => {
- const tenantId = randomId();
-
- const partner = {
- name: generateRandomName(),
- email: randomPartnerEmail(),
- tenantId,
- groupId: E2E_PARTNER_GROUP.id,
- };
-
- const { data: createdData, status: createStatus } = await http.post({
- path: "/partners",
- body: partner,
- });
-
- expect(createStatus).toEqual(201);
- const createdPartner = EnrolledPartnerSchema.parse(createdData);
- expect(createdPartner.tenantId).toBe(tenantId);
-
- const { data: banData, status: banStatus } = await http.post<{
- partnerId: string;
- }>({
- path: "/partners/ban",
- body: {
- tenantId,
- reason: "fraud",
- },
- });
-
- expect(banStatus).toEqual(200);
- expect(banData.partnerId).toBe(createdPartner.id);
-
- // Verify the partner is banned
- const fetchedPartner = await fetchPartner({
- http,
- partnerId: createdPartner.id,
- });
- expect(fetchedPartner.status).toBe("banned");
- });
-});