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.

Fall back to a unique staging slug when the preferred slug is taken

Kiran K7752841e7fa8
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 44e03bb1c8..e445a875dc 100644
--- a/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts
+++ b/apps/web/lib/jobs/handlers/sync-staging-workspace-job.ts
@@ -1,4 +1,5 @@
import { prisma } from "@/lib/prisma";
+import { getPreferredStagingSlug } from "@/lib/sandbox/staging-slug";
import { Project } from "@prisma/client";
import * as z from "zod/v4";
import { defineJob } from "../index";
@@ -177,6 +178,22 @@ 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.
+ const slugOwner = await prisma.project.findUnique({
+ where: {
+ slug: preferredSlug,
+ },
+ select: {
+ id: true,
+ },
+ });
+
+ const canUsePreferredSlug =
+ !slugOwner || slugOwner.id === workspace.stagingWorkspaceId;
+
await prisma.project.update({
where: {
id: workspace.stagingWorkspaceId,
@@ -184,7 +201,7 @@ async function syncWorkspace({
data: {
logo: workspace.logo,
name: `${workspace.name} (Staging)`,
- slug: `${workspace.slug}-staging`,
+ ...(canUsePreferredSlug && { slug: preferredSlug }),
plan: workspace.plan,
planTier: workspace.planTier,
planPeriod: workspace.planPeriod,
diff --git a/apps/web/lib/sandbox/create-staging-program.ts b/apps/web/lib/sandbox/create-staging-program.ts
index 1b1d4887ae..b455e11605 100644
--- a/apps/web/lib/sandbox/create-staging-program.ts
+++ b/apps/web/lib/sandbox/create-staging-program.ts
@@ -4,6 +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";
export async function createStagingProgram(workspaceId: string) {
const workspace = await prisma.project.findUnique({
@@ -129,87 +130,90 @@ export async function createStagingProgram(workspaceId: string) {
const defaultFolderId = createId({ prefix: "fold_" });
const defaultGroupId = createId({ prefix: "grp_" });
- 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 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 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: `${program.slug}-staging`,
- 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,
- },
- });
+ });
+
+ 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,
+ },
+ });
- 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 8504da604e..7f07bf28e6 100644
--- a/apps/web/lib/sandbox/create-staging-workspace.ts
+++ b/apps/web/lib/sandbox/create-staging-workspace.ts
@@ -9,6 +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";
export async function createStagingWorkspace(workspaceId: string) {
const workspace = await prisma.project.findUnique({
@@ -74,53 +75,55 @@ export async function createStagingWorkspace(workspaceId: string) {
workspace.stagingWorkspaceId ?? createWorkspaceId();
if (!workspace.stagingWorkspaceId) {
- await prisma.$transaction(async (tx) => {
- await tx.project.create({
- data: {
- id: stagingWorkspaceId,
- name: `${workspace.name} (Staging)`,
- slug: `${workspace.slug}-staging`,
- 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 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: {},
+ },
},
- },
- });
-
- 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
new file mode 100644
index 0000000000..0b56ac8f09
--- /dev/null
+++ b/apps/web/lib/sandbox/staging-slug.ts
@@ -0,0 +1,56 @@
+import { Prisma } from "@prisma/client";
+import { generateRandomString } from "../api/utils/generate-random-string";
+
+const MAX_SLUG_ATTEMPTS = 3;
+
+export function getPreferredStagingSlug(slug: string) {
+ return `${slug}-staging`;
+}
+
+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];
+
+ return fields.some(
+ (field) => typeof field === "string" && field.includes("slug"),
+ );
+}
+
+// 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}.`);
+}