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.

Remove the staging slug retry

Rafi916350d411eb
diff --git a/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts b/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts
index 8977c22afb..c0d2293505 100644
--- a/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts
+++ b/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts
@@ -1,8 +1,5 @@
import { prisma } from "@/lib/prisma";
-import {
- getPreferredStagingSlug,
- isSlugUniqueConstraintError,
-} from "@/lib/sandbox/staging-slug";
+import { getPreferredStagingSlug } from "@/lib/sandbox/staging-slug";
import { Project } from "@prisma/client";
import * as z from "zod/v4";
import { defineJob } from "../index";
@@ -181,56 +178,17 @@ async function syncWorkspace({
return;
}
- const preferredSlug = getPreferredStagingSlug(workspace.slug);
-
- // `{slug}-staging` may belong to another workspace, in which case the staging
- // workspace keeps its current (suffixed) slug. A concurrent claim between
- // this check and the update is handled the same way.
- const slugOwner = await prisma.project.findUnique({
+ await prisma.project.update({
where: {
- slug: preferredSlug,
+ id: workspace.stagingWorkspaceId,
},
- select: {
- id: true,
+ data: {
+ logo: workspace.logo,
+ name: `${workspace.name} (Staging)`,
+ slug: getPreferredStagingSlug(workspace.slug),
+ plan: workspace.plan,
+ planTier: workspace.planTier,
+ planPeriod: workspace.planPeriod,
},
});
-
- const canUsePreferredSlug =
- !slugOwner || slugOwner.id === workspace.stagingWorkspaceId;
-
- const data: Pick<
- Project,
- "logo" | "name" | "plan" | "planTier" | "planPeriod"
- > = {
- logo: workspace.logo,
- name: `${workspace.name} (Staging)`,
- plan: workspace.plan,
- planTier: workspace.planTier,
- planPeriod: workspace.planPeriod,
- };
-
- try {
- await prisma.project.update({
- where: {
- id: workspace.stagingWorkspaceId,
- },
- data: {
- ...data,
- ...(canUsePreferredSlug && { slug: preferredSlug }),
- },
- });
- } catch (error) {
- // Another workspace claimed `{slug}-staging` after the ownership check.
- // Keep the current slug and still apply plan and branding.
- if (!canUsePreferredSlug || !isSlugUniqueConstraintError(error)) {
- throw error;
- }
-
- await prisma.project.update({
- where: {
- id: workspace.stagingWorkspaceId,
- },
- data,
- });
- }
}
diff --git a/apps/web/lib/sandbox/create-staging-program.ts b/apps/web/lib/sandbox/create-staging-program.ts
index a59b73f547..07eae42ee0 100644
--- a/apps/web/lib/sandbox/create-staging-program.ts
+++ b/apps/web/lib/sandbox/create-staging-program.ts
@@ -4,7 +4,7 @@ import { createId } from "../api/create-id";
import { getPlanCapabilities } from "../plan-capabilities";
import { DEFAULT_PARTNER_GROUP } from "../zod/schemas/groups";
import { STAGING_DUB_DOMAIN_SUFFIX } from "./constants";
-import { withStagingSlugRetry } from "./staging-slug";
+import { getPreferredStagingSlug } from "./staging-slug";
export async function createStagingProgram(workspaceId: string) {
const workspace = await prisma.project.findUnique({
@@ -130,91 +130,88 @@ export async function createStagingProgram(workspaceId: string) {
const defaultFolderId = createId({ prefix: "fold_" });
const defaultGroupId = createId({ prefix: "grp_" });
- await withStagingSlugRetry(program.slug, (stagingSlug) =>
- prisma.$transaction(async (tx) => {
- await tx.folder.create({
- data: {
- id: defaultFolderId,
- name: "Partner Links",
- projectId: stagingWorkspaceId,
- accessLevel: "write",
- users: {
- createMany: {
- data: folderUsers.map((user) => ({
- userId: user.userId,
- role: user.role,
- })),
- },
+ await prisma.$transaction(async (tx) => {
+ await tx.folder.create({
+ data: {
+ id: defaultFolderId,
+ name: "Partner Links",
+ projectId: stagingWorkspaceId,
+ accessLevel: "write",
+ users: {
+ createMany: {
+ data: folderUsers.map((user) => ({
+ userId: user.userId,
+ role: user.role,
+ })),
},
},
- });
-
- await tx.partnerGroup.create({
- data: {
- id: defaultGroupId,
- programId: stagingProgramId,
- name: DEFAULT_PARTNER_GROUP.name,
- slug: DEFAULT_PARTNER_GROUP.slug,
- color: DEFAULT_PARTNER_GROUP.color,
- maxPartnerLinks: defaultGroup?.maxPartnerLinks,
- applicationFormData:
- defaultGroup?.applicationFormData ?? Prisma.DbNull,
- landerData: defaultGroup?.landerData ?? Prisma.DbNull,
- logo: defaultGroup?.logo,
- wordmark: defaultGroup?.wordmark,
- brandColor: defaultGroup?.brandColor,
- holdingPeriodDays: defaultGroup?.holdingPeriodDays,
- partnerGroupDefaultLinks: {
- create: {
- id: createId({ prefix: "pgdl_" }),
- programId: stagingProgramId,
- domain,
- url: program.url!,
- },
+ },
+ });
+
+ await tx.partnerGroup.create({
+ data: {
+ id: defaultGroupId,
+ programId: stagingProgramId,
+ name: DEFAULT_PARTNER_GROUP.name,
+ slug: DEFAULT_PARTNER_GROUP.slug,
+ color: DEFAULT_PARTNER_GROUP.color,
+ maxPartnerLinks: defaultGroup?.maxPartnerLinks,
+ applicationFormData: defaultGroup?.applicationFormData ?? Prisma.DbNull,
+ landerData: defaultGroup?.landerData ?? Prisma.DbNull,
+ logo: defaultGroup?.logo,
+ wordmark: defaultGroup?.wordmark,
+ brandColor: defaultGroup?.brandColor,
+ holdingPeriodDays: defaultGroup?.holdingPeriodDays,
+ partnerGroupDefaultLinks: {
+ create: {
+ id: createId({ prefix: "pgdl_" }),
+ programId: stagingProgramId,
+ domain,
+ url: program.url!,
},
},
- });
-
- await tx.program.create({
- data: {
- id: stagingProgramId,
- workspaceId: stagingWorkspaceId,
- defaultFolderId,
- defaultGroupId,
- name: `${program.name} (Staging)`,
- slug: stagingSlug,
- domain,
- url: program.url,
- logo: program.logo,
- description: program.description,
- primaryRewardEvent: program.primaryRewardEvent,
- minPayoutAmount: program.minPayoutAmount,
- payoutMode: program.payoutMode,
- applicationRequirements:
- program.applicationRequirements ?? Prisma.DbNull,
- termsUrl: program.termsUrl,
- helpUrl: program.helpUrl,
- supportEmail: program.supportEmail,
- environment: WorkspaceEnvironment.staging,
- },
- });
+ },
+ });
+
+ await tx.program.create({
+ data: {
+ id: stagingProgramId,
+ workspaceId: stagingWorkspaceId,
+ defaultFolderId,
+ defaultGroupId,
+ name: `${program.name} (Staging)`,
+ slug: getPreferredStagingSlug(program.slug),
+ domain,
+ url: program.url,
+ logo: program.logo,
+ description: program.description,
+ primaryRewardEvent: program.primaryRewardEvent,
+ minPayoutAmount: program.minPayoutAmount,
+ payoutMode: program.payoutMode,
+ applicationRequirements:
+ program.applicationRequirements ?? Prisma.DbNull,
+ termsUrl: program.termsUrl,
+ helpUrl: program.helpUrl,
+ supportEmail: program.supportEmail,
+ environment: WorkspaceEnvironment.staging,
+ },
+ });
- const { count } = await tx.project.updateMany({
- where: {
- id: stagingWorkspaceId,
- defaultProgramId: null,
- },
- data: {
- defaultProgramId: stagingProgramId,
- defaultProduct: "program",
- },
- });
+ const { count } = await tx.project.updateMany({
+ where: {
+ id: stagingWorkspaceId,
+ defaultProgramId: null,
+ },
+ data: {
+ defaultProgramId: stagingProgramId,
+ defaultProduct: "program",
+ },
+ });
- if (count === 0) {
- throw new Error(
- `Staging program already exists for workspace ${workspace.id}`,
- );
- }
- }),
- );
+ if (count === 0) {
+ throw new Error(
+ `Staging program already exists for workspace ${workspace.id}`,
+ );
+ }
+ });
}
diff --git a/apps/web/lib/sandbox/create-staging-workspace.ts b/apps/web/lib/sandbox/create-staging-workspace.ts
index 7f07bf28e6..551f1b215c 100644
--- a/apps/web/lib/sandbox/create-staging-workspace.ts
+++ b/apps/web/lib/sandbox/create-staging-workspace.ts
@@ -9,7 +9,7 @@ import { generateRandomString } from "../api/utils/generate-random-string";
import { createWorkspaceId } from "../api/workspaces/create-workspace-id";
import { STAGING_DUB_DOMAIN_SUFFIX } from "./constants";
import { isProductionEnvironment } from "./environment";
-import { withStagingSlugRetry } from "./staging-slug";
+import { getPreferredStagingSlug } from "./staging-slug";
export async function createStagingWorkspace(workspaceId: string) {
const workspace = await prisma.project.findUnique({
@@ -75,55 +75,53 @@ export async function createStagingWorkspace(workspaceId: string) {
workspace.stagingWorkspaceId ?? createWorkspaceId();
if (!workspace.stagingWorkspaceId) {
- await withStagingSlugRetry(workspace.slug, (stagingSlug) =>
- prisma.$transaction(async (tx) => {
- await tx.project.create({
- data: {
- id: stagingWorkspaceId,
- name: `${workspace.name} (Staging)`,
- slug: stagingSlug,
- logo: workspace.logo,
- environment: WorkspaceEnvironment.staging,
- plan: workspace.plan,
- defaultProduct: "program",
- billingCycleStart: new Date().getDate(),
- invoicePrefix: generateRandomString(8),
- // Staging workspace will uses the trial limits
- usageLimit: TRIAL_LIMITS.clicks,
- linksLimit: TRIAL_LIMITS.links,
- domainsLimit: TRIAL_LIMITS.domains,
- aiLimit: TRIAL_LIMITS.ai,
- tagsLimit: TRIAL_LIMITS.tags,
- foldersLimit: TRIAL_LIMITS.folders,
- usersLimit: TRIAL_LIMITS.users,
- partnersLimit: TRIAL_LIMITS.partners,
- payoutsLimit: TRIAL_LIMITS.payouts,
- partnerTagsLimit: TRIAL_LIMITS.partnerTags,
- groupsLimit: TRIAL_LIMITS.groups,
- networkInvitesLimit: TRIAL_LIMITS.networkInvites,
- defaultDomains: {
- create: {},
- },
+ await prisma.$transaction(async (tx) => {
+ await tx.project.create({
+ data: {
+ id: stagingWorkspaceId,
+ name: `${workspace.name} (Staging)`,
+ slug: getPreferredStagingSlug(workspace.slug),
+ logo: workspace.logo,
+ environment: WorkspaceEnvironment.staging,
+ plan: workspace.plan,
+ defaultProduct: "program",
+ billingCycleStart: new Date().getDate(),
+ invoicePrefix: generateRandomString(8),
+ // Staging workspace will uses the trial limits
+ usageLimit: TRIAL_LIMITS.clicks,
+ linksLimit: TRIAL_LIMITS.links,
+ domainsLimit: TRIAL_LIMITS.domains,
+ aiLimit: TRIAL_LIMITS.ai,
+ tagsLimit: TRIAL_LIMITS.tags,
+ foldersLimit: TRIAL_LIMITS.folders,
+ usersLimit: TRIAL_LIMITS.users,
+ partnersLimit: TRIAL_LIMITS.partners,
+ payoutsLimit: TRIAL_LIMITS.payouts,
+ partnerTagsLimit: TRIAL_LIMITS.partnerTags,
+ groupsLimit: TRIAL_LIMITS.groups,
+ networkInvitesLimit: TRIAL_LIMITS.networkInvites,
+ defaultDomains: {
+ create: {},
},
- });
+ },
+ });
- const { count } = await tx.project.updateMany({
- where: {
- id: workspace.id,
- stagingWorkspaceId: null,
- },
- data: {
- stagingWorkspaceId,
- },
- });
-
- if (count === 0) {
- throw new Error(
- `Staging workspace already exist for the workspace ${workspace.id}`,
- );
- }
- }),
- );
+ const { count } = await tx.project.updateMany({
+ where: {
+ id: workspace.id,
+ stagingWorkspaceId: null,
+ },
+ data: {
+ stagingWorkspaceId,
+ },
+ });
+
+ if (count === 0) {
+ throw new Error(
+ `Staging workspace already exist for the workspace ${workspace.id}`,
+ );
+ }
+ });
}
// Copy non-machine users to the staging workspace
diff --git a/apps/web/lib/sandbox/staging-slug.ts b/apps/web/lib/sandbox/staging-slug.ts
index 0bc4b6ca3a..0732d973e7 100644
--- a/apps/web/lib/sandbox/staging-slug.ts
+++ b/apps/web/lib/sandbox/staging-slug.ts
@@ -1,76 +1,5 @@
-import { Prisma } from "@prisma/client";
-import { generateRandomString } from "../api/utils/generate-random-string";
-
-const MAX_SLUG_ATTEMPTS = 3;
-
+// Workspace create and rename reject slugs ending in `-staging`, so this slug
+// is only ever taken by the workspace's own staging workspace or program.
export function getPreferredStagingSlug(slug: string) {
return `${slug}-staging`;
}
-
-export function isSlugUniqueConstraintError(error: unknown) {
- if (
- !(error instanceof Prisma.PrismaClientKnownRequestError) ||
- error.code !== "P2002"
- ) {
- return false;
- }
-
- const target = error.meta?.target;
- const fields = Array.isArray(target) ? target : [target];
-
- if (
- fields.some((field) => typeof field === "string" && field.includes("slug"))
- ) {
- return true;
- }
-
- // The PlanetScale adapter often cannot parse the key name, so Prisma reports
- // "(not available)" and `meta.target` is empty. The raw MySQL error still
- // names the unique index, for example `Project.Project_slug_key`.
- const cause = (
- error.meta?.driverAdapterError as
- | {
- cause?: {
- constraint?: { index?: string };
- originalMessage?: string;
- };
- }
- | undefined
- )?.cause;
-
- return [cause?.constraint?.index, cause?.originalMessage].some(
- (value) => typeof value === "string" && value.includes("_slug_key"),
- );
-}
-
-// Workspace and program slugs are globally unique, and `{slug}-staging` can
-// already belong to an unrelated workspace or program (e.g. one created
-// manually before staging existed). Retry with a random suffix so staging
-// provisioning still completes. The staging short domain is derived from the
-// production slug, so it does not depend on this value.
-export async function withStagingSlugRetry<T>(
- slug: string,
- create: (stagingSlug: string) => Promise<T>,
-) {
- const preferredSlug = getPreferredStagingSlug(slug);
-
- for (let attempt = 0; attempt < MAX_SLUG_ATTEMPTS; attempt++) {
- const stagingSlug =
- attempt === 0
- ? preferredSlug
- : `${preferredSlug}-${generateRandomString(4).toLowerCase()}`;
-
- try {
- return await create(stagingSlug);
- } catch (error) {
- if (
- !isSlugUniqueConstraintError(error) ||
- attempt === MAX_SLUG_ATTEMPTS - 1
- ) {
- throw error;
- }
- }
- }
-
- throw new Error(`Failed to find an available staging slug for ${slug}.`);
-}
diff --git a/apps/web/tests/misc/staging-slug.test.ts b/apps/web/tests/misc/staging-slug.test.ts
deleted file mode 100644
index 0b19c6e1f4..0000000000
--- a/apps/web/tests/misc/staging-slug.test.ts
+++ /dev/null
@@ -1,78 +0,0 @@
-import { isSlugUniqueConstraintError } from "@/lib/sandbox/staging-slug";
-import { Prisma } from "@prisma/client";
-import { describe, expect, it } from "vitest";
-
-function uniqueConstraintError(meta: Record<string, unknown>) {
- return new Prisma.PrismaClientKnownRequestError(
- "Unique constraint failed on the (not available)",
- {
- code: "P2002",
- clientVersion: "6.19.1",
- meta,
- },
- );
-}
-
-describe("isSlugUniqueConstraintError", () => {
- it("detects a slug conflict from meta.target", () => {
- expect(
- isSlugUniqueConstraintError(uniqueConstraintError({ target: ["slug"] })),
- ).toBe(true);
- });
-
- it("detects a slug conflict from the driver adapter's original message", () => {
- const error = uniqueConstraintError({
- modelName: "Project",
- driverAdapterError: {
- cause: {
- kind: "UniqueConstraintViolation",
- originalCode: "1062",
- originalMessage:
- "Duplicate entry 'acme-staging' for key 'Project.Project_slug_key' (errno 1062) (sqlstate 23000)",
- },
- },
- });
-
- expect(isSlugUniqueConstraintError(error)).toBe(true);
- });
-
- it("detects a slug conflict from the driver adapter's constraint index", () => {
- const error = uniqueConstraintError({
- modelName: "Program",
- driverAdapterError: {
- cause: {
- kind: "UniqueConstraintViolation",
- constraint: { index: "Program_slug_key" },
- },
- },
- });
-
- expect(isSlugUniqueConstraintError(error)).toBe(true);
- });
-
- it("ignores a conflict on another unique key", () => {
- const error = uniqueConstraintError({
- modelName: "Project",
- driverAdapterError: {
- cause: {
- kind: "UniqueConstraintViolation",
- originalCode: "1062",
- originalMessage:
- "Duplicate entry 'abc12345' for key 'Project.Project_invoicePrefix_key' (errno 1062) (sqlstate 23000)",
- },
- },
- });
-
- expect(isSlugUniqueConstraintError(error)).toBe(false);
- });
-
- it("ignores errors that are not unique constraint violations", () => {
- const error = new Prisma.PrismaClientKnownRequestError("Not found", {
- code: "P2025",
- clientVersion: "6.19.1",
- });
-
- expect(isSlugUniqueConstraintError(error)).toBe(false);
- expect(isSlugUniqueConstraintError(new Error("boom"))).toBe(false);
- });
-});