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.

Add staging workspace support and auto-create on plan upgrade

Kiran K886b3e41d9df
diff --git a/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts b/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts
index 09309a2fea..a9603c2853 100644
--- a/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts
+++ b/apps/web/app/(ee)/api/stripe/webhook/utils/update-workspace-plan.ts
@@ -3,6 +3,7 @@ import { deleteWorkspaceFolders } from "@/lib/api/folders/delete-workspace-folde
import { stripAdvancedRewardModifiersForProgram } from "@/lib/api/partners/strip-advanced-reward-modifiers";
import { deactivateProgram } from "@/lib/api/programs/deactivate-program";
import { reactivateProgram } from "@/lib/api/programs/reactivate-program";
+import { createStagingWorkspace } from "@/lib/api/workspaces/staging-workspace";
import { tokenCache } from "@/lib/auth/token-cache";
import { syncUserPlanToPlain } from "@/lib/plain/sync-user-plan";
import { getPlanCapabilities } from "@/lib/plan-capabilities";
@@ -46,6 +47,7 @@ export async function updateWorkspacePlan({
| "billingCycleEndsAt"
| "subscriptionCanceledAt"
| "partnersLimit"
+ | "stagingWorkspaceId"
> & {
plan: string;
restrictedTokens: {
@@ -241,6 +243,17 @@ export async function updateWorkspacePlan({
console.log(`Reactivated program for workspace ${workspace.id}.`);
}
+ if (
+ !workspace.stagingWorkspaceId &&
+ wouldGainPartnerAccess({
+ currentPlan: workspace.plan,
+ newPlan: newPlanName,
+ })
+ ) {
+ await createStagingWorkspace(workspace.id);
+ console.log(`Created staging workspace for workspace ${workspace.id}.`);
+ }
+
const workspaceOwners =
updatedWorkspace.status === "fulfilled"
? updatedWorkspace.value.users.map((user) => user.user)
diff --git a/apps/web/lib/api/workspaces/staging-workspace.ts b/apps/web/lib/api/workspaces/staging-workspace.ts
new file mode 100644
index 0000000000..e9221a3b43
--- /dev/null
+++ b/apps/web/lib/api/workspaces/staging-workspace.ts
@@ -0,0 +1,96 @@
+import { getPlanCapabilities } from "@/lib/plan-capabilities";
+import { prisma } from "@dub/prisma";
+import { nanoid } from "@dub/utils";
+import { generateRandomString } from "../utils/generate-random-string";
+import { createWorkspaceId } from "./create-workspace-id";
+
+export async function createStagingWorkspace(workspaceId: string) {
+ const workspace = await prisma.project.findUnique({
+ where: {
+ id: workspaceId,
+ },
+ include: {
+ users: {
+ select: {
+ role: true,
+ userId: true,
+ },
+ },
+ },
+ });
+
+ if (!workspace) {
+ console.error(
+ "Failed to find workspace in createStagingWorkspace",
+ workspaceId,
+ );
+ return;
+ }
+
+ if (workspace.stagingWorkspaceId) {
+ console.log(
+ `Staging workspace already exists for the workspace ${workspace.id}.`,
+ );
+ return;
+ }
+
+ const { canUseStagingWorkspace } = getPlanCapabilities(workspace.plan);
+
+ if (!canUseStagingWorkspace) {
+ console.log(
+ `The workspace ${workspace.id} does not have required plan to use staging workspace.`,
+ );
+ return;
+ }
+
+ // TODO:
+ // Add the limit
+
+ const stagingWorkspaceId = createWorkspaceId();
+
+ await prisma.$transaction([
+ // Create a staging workspace
+ prisma.project.create({
+ data: {
+ id: stagingWorkspaceId,
+ name: `${workspace.name} [STAGING]`,
+ slug: `${workspace.slug}-staging`,
+ logo: workspace.logo,
+ plan: workspace.plan,
+ billingCycleStart: new Date().getDate(),
+ invoicePrefix: generateRandomString(8),
+ inviteCode: nanoid(24),
+ defaultDomains: {
+ create: {},
+ },
+ },
+ }),
+
+ // Update live to point to the staging workspace
+ prisma.project.update({
+ where: {
+ id: workspace.id,
+ },
+ data: {
+ stagingWorkspaceId,
+ },
+ }),
+ ]);
+
+ // Copy the users to the staging workspace
+ const { users } = workspace;
+
+ if (users.length > 0) {
+ await prisma.projectUsers.createMany({
+ data: users.map((user) => ({
+ projectId: stagingWorkspaceId,
+ role: user.role,
+ userId: user.userId,
+ notificationPreference: {
+ create: {},
+ },
+ })),
+ skipDuplicates: true,
+ });
+ }
+}
diff --git a/apps/web/lib/plan-capabilities.ts b/apps/web/lib/plan-capabilities.ts
index 0250ff649a..c9952d9409 100644
--- a/apps/web/lib/plan-capabilities.ts
+++ b/apps/web/lib/plan-capabilities.ts
@@ -27,5 +27,6 @@ export const getPlanCapabilities = (
!!plan && ["enterprise", "advanced"].includes(plan),
canCreateReferralReward:
!!plan && ["enterprise", "advanced"].includes(plan),
+ canUseStagingWorkspace: !!plan && !["free", "pro"].includes(plan),
};
};
diff --git a/apps/web/lib/zod/schemas/workspaces.ts b/apps/web/lib/zod/schemas/workspaces.ts
index 9507b3a894..c47244e96e 100644
--- a/apps/web/lib/zod/schemas/workspaces.ts
+++ b/apps/web/lib/zod/schemas/workspaces.ts
@@ -1,5 +1,9 @@
import { workspaceSiteVisitTrackingSettingsFieldSchema } from "@/lib/sitemaps/site-visit-tracking";
-import { PlanPeriod, WorkspaceRole } from "@dub/prisma/client";
+import {
+ PlanPeriod,
+ WorkspaceEnvironment,
+ WorkspaceRole,
+} from "@dub/prisma/client";
import { DEFAULT_REDIRECTS, RESERVED_SLUGS, validSlugRegex } from "@dub/utils";
import slugify from "@sindresorhus/slugify";
import * as z from "zod/v4";
@@ -180,6 +184,7 @@ export const WorkspaceSchema = z
.meta({ example: ["dub.sh"] }),
ssoEmailDomain: z.string().nullable(),
ssoEnforcedAt: z.date().nullable(),
+ environment: z.enum(WorkspaceEnvironment).nullable(),
})
.meta({
title: "Workspace",
diff --git a/packages/prisma/schema/workspace.prisma b/packages/prisma/schema/workspace.prisma
index 46d8d1a354..212eb7ffa6 100644
--- a/packages/prisma/schema/workspace.prisma
+++ b/packages/prisma/schema/workspace.prisma
@@ -5,6 +5,12 @@ enum PlanPeriod {
biweekly
}
+enum WorkspaceEnvironment {
+ live
+ staging
+ sandbox
+}
+
model Project {
id String @id @default(cuid())
name String
@@ -24,6 +30,10 @@ model Project {
paymentFailedAt DateTime?
invoicePrefix String? @unique // prefix used to generate unique invoice numbers (for Dub Payouts)
+ environment WorkspaceEnvironment @default(live)
+ stagingWorkspaceId String? @unique
+ sandboxId String? @unique
+
stripeConnectId String? @unique // for Stripe Integration
shopifyStoreId String? @unique // for Shopify Integration